## 控制采集
### 设置数据上报频率
*device-timer-interval*
设置20秒上报电量信息
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId":"202201241610366046",
"timerEnable":1,
"timerInterval":15,
"type":"setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 消息ID字段 | 202201241610366046 |
| timerEnable | int | 设备电量信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 电量信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| type | String | 固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm":1,
"code":"Power-off-Alarm-4G",
"commandName":"device-timer-interval",
"iccid":"898604B51026D0125842",
"imei":"866965087690928",
"keyLock":0,
"messageId":"20260520",
"powerState":1,
"resetLock":0,
"signal":-75,
"source":"command",
"timerEnable":1,
"timerInterval":15,
"version":"1.0.0"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| code | String | 设备型号代码 | Power-off-Alarm-4G |
| commandName | String | 指令名称 | device-timer-interval |
| iccid | String | SIM-卡ICCID值 | 898604B51026D0125842 |
| imei | String | 设备唯一标识 | 866965087690928 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 20260520 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.0.0 |
---
### 数据自动上报
*device-timer-task*
此项非主动下发的指令，只展示用户开启定时上报任务后，定时返回的消息样式
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm":1,
"commandName":"device-timer-interval",
"iccid":"898604B51026D0125842",
"imei":"866965087690928",
"powerState":1,
"source":"command"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| commandName | String | 指令名称 | device-timer-interval |
| iccid | String | SIM-卡ICCID值 | 898604B51026D0125842 |
| imei | String | 设备唯一标识 | 866965087690928 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| source | String | 指令回复“command" | command |
---
### 获取设备基础信息
*info-all*
查询当前设备的基础信息，如设备MAC地址、设备型号、固件版本号、信号强度及相关配置信息。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId" : "202201241610366046",
"type" : "info"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 消息ID字段 | 202201241610366046 |
| type | String | 获取设备基本信息固定传"info" | info |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm" : 1,
"code" : "Power-Off-Alarm-4G",
"commandName" : "info-all",
"iccid" : "89860323442024493210",
"imei" : "860065078868017",
"keyLock" : 0,
"messageId" : "202201241610366046",
"powerState" : 1,
"resetLock" : 0,
"signal" : -75,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.2.3",
"voiceNum" : 4
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| code | String | 当前设备类型 | Power-Off-Alarm-4G |
| commandName | String | 指令名称 | info-all |
| iccid | String | SIM-卡ICCID值 | 89860323442024493210 |
| imei | String | 设备唯一标识 | 860065078868017 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 消息ID字段 | 202201241610366046 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.2.3 |
| voiceNum | int | 播报语音编号，断电报警器内置9条播报语音，可以自行选择播报语音。语音播报设置范围1-9，超过范围维持原有不变。 | 4 |
---
## 设备维护
### 取消报警
*controller-alarm-cancel*
触发该指令后，将alarm置为0
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"alarm":0,
"messageId":"202201241610366046",
"type":"event"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 0 |
| messageId | String | 消息ID字段 | 202201241610366046 |
| type | String | 设备设置固定传"event" | event |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm":0,
"code":"Power-Off-Alarm-4G",
"commandName":"controller-alarm-cancel",
"iccid":"89860323442024493210",
"imei":"860065078868017",
"keyLock":0,
"messageId":"202201241610366046",
"powerState":1,
"resetLock":0,
"signal":-75,
"source":"command",
"timerEnable":1,
"version":"1.2.3"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 0 |
| code | String | 设备代号 | Power-Off-Alarm-4G |
| commandName | String | 指令名称 | controller-alarm-cancel |
| iccid | String | SIM-卡ICCID值 | 89860323442024493210 |
| imei | String | 设备唯一标识 | 860065078868017 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 消息ID字段 | 202201241610366046 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| version | String | 当前固件版本号 | 1.2.3 |
---
### 重置设备
*controller-reset*
恢复出厂设置后配网信息和自定义信息都会清空，请谨慎操作！
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId":"202201241610366046",
"system":"reset",
"type":"setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 消息ID字段 | 202201241610366046 |
| system | String | 重置/恢复出厂设置默认填"reset" | reset |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName":"controller-reset",
"imei":"866965087690928",
"message":"ok",
"messageId":"20260520",
"source":"command",
"success":true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | controller-reset |
| imei | String | 设备唯一标识 | 866965087690928 |
| message | String | 执行返回结果 | ok |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 20260520 |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 重启设备
*controller-restart*
远程重启，设备重新读取最新配置参数
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId" : "202201241610366046",
"system" : "restart",
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 消息ID字段 | 202201241610366046 |
| system | String | 设备软重启默认填"restart" | restart |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "controller-restart",
"imei" : "866965087690928",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | controller-restart |
| imei | String | 设备唯一标识 | 866965087690928 |
| message | String | 执行返回结果 | ok |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。 | 20260520 |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设置按键控制锁
*setting-key-lock*
keyLock=1时，无法通过设备上的按键关闭报警声音。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"keyLock":0,
"messageId":"202201241610366046",
"type":"setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 消息ID字段 | 202201241610366046 |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm":1,
"code":"Power-off-alarm-4G",
"commandName":"setting-key-lock",
"iccid":"898604B51026D0125842",
"imei":"869318067298139",
"keyLock":0,
"messageId":"20260520",
"powerState":1,
"resetLock":0,
"signal":-75,
"source":"command",
"timerEnable":1,
"version":"1.2.3"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| code | String | 设备代号 | Power-off-alarm-4G |
| commandName | String | 指令名称 | setting-key-lock |
| iccid | String | SIM-卡ICCID值 | 898604B51026D0125842 |
| imei | String | 设备唯一标识 | 869318067298139 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 20260520 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| version | String | 当前固件版本号 | 1.2.3 |
---
### 自定义MQTT
*setting-mqtt*
修改设备的 MQTT 服务器连接参数，使设备接入客户指定的MQTT 服务器（自建服务器、第三方平台等）。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"clientId":"admin",
"password":"123456",
"port":"1883",
"protocol":"mqtt",
"publish":"/topic/qos0",
"server":"192.168.0.66",
"subcribe":"/topic/qos1",
"type":"custom",
"username":"username"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| clientId | String | 自定义MQTT客户端ID注意：不可重复
| admin |
| password | String | 密码 | 123456 |
| port | String | 端口号 | 1883 |
| protocol | String | 协议类型 | mqtt |
| publish | String | 自定义发布主题 注意:不可重复 | /topic/qos0 |
| server | String | 自定义服务器地址 | 192.168.0.66 |
| subcribe | String | 自定义订阅主题，注意：不可重复 | /topic/qos1 |
| type | String | 设备自定义固定传"custom" | custom |
| username | String | 自定义服务器用户名 | username |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"clientId":"admin",
"commandName":"setting-mqtt",
"password":"123456",
"port":"1883",
"protocol":"mqtt",
"publish":"/topic/qos0 ",
"server":"192.168.0.66 ",
"source":"command",
"subcribe":"/topic/qos1 ",
"type":"custom",
"username":"username "
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| clientId | String | 自定义MQTT客户端ID注意：不可重复
| admin |
| commandName | String | 指令名称 | setting-mqtt |
| password | String | 密码 | 123456 |
| port | String | 端口号 | 1883 |
| protocol | String | 协议类型 | mqtt |
| publish | String | 自定义发布主题 注意:不可重复 | /topic/qos0
|
| server | String | 自定义服务器地址 | 192.168.0.66
|
| source | String | 指令回复“command" | command |
| subcribe | String | 自定义订阅主题，注意：不可重复 | /topic/qos1
|
| type | String | 固定值"xxx" | custom |
| username | String | 自定义服务器用户名 | username
|
---
### 设置重置锁
*setting-reset-lock*
resetLock=1，重置锁锁定时，设备的物理按键将无法执行设备重置操作。<br/>请确保设备所有设置准确后，再按需锁定设备重置锁。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId":"202201241610366046",
"resetLock":0,
"type":"setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 消息ID字段 | 202201241610366046 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm":1,
"code":"Power-off-Alarm-4G",
"commandName":"setting-reset-lock",
"iccid":"898604B51026D0125842",
"imei":"866965087690928",
"keyLock":0,
"messageId":"20260520",
"powerState":1,
"resetLock":0,
"signal":-75,
"source":"command",
"timerEnable":1,
"version":"1.0.0"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| code | String | 设备型号代码 | Power-off-Alarm-4G |
| commandName | String | 指令名称 | setting-reset-lock |
| iccid | String | SIM-卡ICCID值 | 898604B51026D0125842 |
| imei | String | 设备唯一标识 | 866965087690928 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 20260520 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| version | String | 当前固件版本号 | 1.0.0 |
---
### 关机
*setting-shutdown*
下发指令后，设备会停止报警并进入深度睡眠模式，重新上电即可唤醒
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"system":"shutdown",
"type":"setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| system | String | 关机默认填"shutdown" | shutdown |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName":"setting-shutdown",
"imei":"866965087690928",
"message":"ok",
"messageId":"20260520",
"source":"command",
"success":true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | setting-shutdown |
| imei | String | 设备唯一标识 | 866965087690928 |
| message | String | 执行返回结果 | ok |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 20260520 |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设置播报语音
*setting-voice-Num*
设置播报语音，断电报警器内置9条播报语音，可以自行选择播报语音。语音播报设置范围1-9，超过范围维持原有不变。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"messageId" : "202201241610366046",
"type" : "setting",
"voiceNum" : 4
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 202201241610366046 |
| type | String | 固定值"setting" | setting |
| voiceNum | int | 播报语音编号，断电报警器内置9条播报语音，可以自行选择播报语音。语音播报设置范围1-9，超过范围维持原有不变。 | 4 |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"alarm" : 1,
"code" : "Power-Off-Alarm-4G",
"commandName" : "setting-voice-Num",
"iccid" : "89860323442024493210",
"imei" : "860065078868017",
"keyLock" : 0,
"messageId" : "202201241610366046",
"powerState" : 1,
"resetLock" : 0,
"signal" : -75,
"source" : "command",
"timerEnable" : 1,
"version" : "1.2.3",
"voiceNum" : 4
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| alarm | int | 警报状态，0：未发生警报；1：发生警报 | 1 |
| code | String | 设备型号代码 | Power-Off-Alarm-4G |
| commandName | String | 指令名称 | setting-voice-Num |
| iccid | String | SIM-卡ICCID值 | 89860323442024493210 |
| imei | String | 设备唯一标识 | 860065078868017 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。
| 202201241610366046 |
| powerState | int | 报警器电源状态，1：市电供电：0：电池供电 | 1 |
| resetLock | int | 重置锁，0：关闭，1：开启 | 0 |
| signal | int | 信号强度，显示规则为： signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0～（-100)之间，表示无信号 | -75 |
| source | String | 指令回复“command" | command |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| version | String | 当前固件版本号 | 1.2.3 |
| voiceNum | int | 播报语音编号，断电报警器内置9条播报语音，可以自行选择播报语音。语音播报设置范围1-9，超过范围维持原有不变。 | 4 |
---
下载
复制
