Appearance
单次告警
通过单次告警来触发报警灯进行自定义声光播报
注意:该接口触发的声光播报仅能执行一次
提示
单次告警接口数据类型支持 form-data 和 json
接口配置
请求地址:http://<设备IP地址>/api/api/send_msg
请求方式:POST
数据类型:form-data
请求参数
参数名 | 变量类型 | 说明 | 是否必填 |
---|---|---|---|
led_style | string | led样式参数,详情见下表。 | |
color | json | key为灯层数,value为led颜色数组,支持RGB颜色代码和 W3C规范颜色名称 举例:{"1":["blue"]}或者{"2":["#00ffff"]} 1表示第一层,2表示第二层 只有转亮支持多颜色数组。 | |
led_flag | json | led样式参数,详情见下表。 | |
text | string | 播报的文本内容,最长150个文字,当前版本超出不会报错,但是会被截断 | |
tts_speed | int | 语音播报速率,范围1~10,不存在则默认中速 | |
play_time | int | 播报时长 当该值存在时,如果超过播报时间没有播报完成,播报内容会被截断。 | |
repeat_count | int | 重复播报次数,默认为:1 | |
tone | string | 铃声编号,该值可在通知组设置中的提示音获得。 | |
time | string | 当前秒级时间戳 该值会参与签名计算。请求时间戳与设备时间误差需在120s以内。 | 是 |
sign | string | 签名字符串,具体算法见生成签名章节。 | 是 |
sound | string | 0:指定女声播报(默认为女声);1:指定男声播报; |
led相关参数提醒
led_style
、color
、led_flag
这三个参数必须同时使用,如果不用则全都不传。
可选参数提醒
led_style
、color
、led_flag
和text
这两组选项至少要存在一组
LED样式参数
样式值 | 效果 | 参数下标 | 参数说明 | 推荐值 |
---|---|---|---|---|
15 | 转亮 | 0 | 旋转间隔时间(秒) | [0.03,1] |
1 | 加速因子 | |||
20 | 闪亮 | 0 | 闪亮时间(秒) | [1, 1] |
1 | 熄灯时间(秒) | |||
25 | 常亮 | 无参数,填写[0]进行占位即可 | ||
30 | 脉动 | 无参数,填写[0]进行占位即可 |
调试案例
操作步骤请参照下图,可点击图片放大查看。
除手动创建请求外,资料下载处提供了PostMan测试配置文件,其中内置了签名自动计算脚本,您只需要修改参数即可快速发送请求进行测试!点我下载。