本设备是一款支持二次开发的导轨式单路磁保持智能通断器，AC 220V电压输入，最大工作电流63A，可承载12KW功率。支持远程控制通断电、用电数据采集并定时上报。
2.4GHz WiFi 通信方式，支持自定义MQTT/TCP协议连接用户自建服务器平台，可在内网、专网环境使用。用户可通过API接口调用，实现自定义功能开发与系统集成；设备亦支持接入阿里云、腾讯云、华为云等主流物联网云平台，以及ThingsBoard、HomeAssistant等开源系统，满足多样化部署需求。
适用实验室、机房/数据中心、无人自助、企业/学校宿舍、温室大棚、室内家居等多种场景。
## 全部指令
### 控制设备
*controller-event*
通断器、空开、10A-86插座、16A-86插座、10A转换器插座、16A转换器插座等单路设备的通电或断电操作
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"key" : 0,
"type" : "event"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| type | String | 控制设备开合闸固定传"event" | event |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"bssid" : "742ad779046",
"code" : "GSBR2T2",
"commandName" : "controller-event",
"ip" : "192.168.122.119
",
"key" : 0,
"keyLock" : 0,
"mac" : "dc54759195d0",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GemeOpen",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.2.3",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| bssid | String | 路由器 MAC 地址 | 742ad779046 |
| code | String | 设备类型 | GSBR2T2 |
| commandName | String | 指令名称 | controller-event |
| ip | String | 设备连接WIFI后获取的IP | 192.168.122.119
|
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| mac | String | 设备的mac地址，唯一标识 | dc54759195d0 |
| onState | int | 设备上电的默认状态：
0：记忆；是指记忆最后一次设备断电前的状态，如断电前设备是通电状态（指示灯是蓝的），设备下次上电默认是通电状态（指示灯是蓝的）。
1：关闭，即断电状态（指示灯是灭的），如断电前，设备是通电状态（指示灯是蓝的），设备下次上电默认是依旧是断电状态（指示灯是灭的）。需要手动/远程开启通电状态。
2：开启，即通电状态（指示灯是蓝色的），是指设备上电之后，默认是通电状态，此刻需要注意，插在设备上的负载会通电运行，会有安全风险，所以建议是默认上电状态为关闭。 | 1 |
| 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 |
| ssid | String | 设备当前连接的WIFI名称 | GemeOpen |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.2.3 |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
### 重置/恢复出厂设置
*controller-reset*
恢复出厂设置后配网信息和自定义信息都会清空，请谨慎操作！
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"system" : "reset",
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| system | String | 重置/恢复出厂设置默认填"reset" | reset |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "controller-reset",
"mac" : "dc54759195d0",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | controller-reset |
| mac | String | 设备的mac地址，唯一标识 | dc54759195d0 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设备软重启
*controller-restart*
软重启后，通过指令设置的参数将生效，同时设备将重新连接Wifi/4G网络，注意设备IP地址可能发生变化
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"system" : "restart",
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| system | String | 设备软重启固定传"restart" | restart |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "controller-restart",
"mac" : "dc54759195d0",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | controller-restart |
| mac | String | 设备的mac地址，唯一标识 | dc54759195d0 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设置定时上报任务
*device-timer-interval*
设置定时上报电量信息
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| timerEnable | int | 设备电量信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 电量信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"bssid" : "742ad779046",
"code" : "GSBR2T2",
"commandName" : "device-timer-interval",
"ip" : "192.168.122.119
",
"key" : 0,
"keyLock" : 0,
"mac" : "dc54759195d0",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GemeOpen",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.2.3",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| bssid | String | 路由器 MAC 地址 | 742ad779046 |
| code | String | 设备产品型号 | GSBR2T2 |
| commandName | String | 指令名称 | device-timer-interval |
| ip | String | 设备连接WIFI后获取的IP | 192.168.122.119
|
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| mac | String | 设备的mac地址，唯一标识 | dc54759195d0 |
| onState | int | 设备上电的默认状态：
0：记忆；是指记忆最后一次设备断电前的状态，如断电前设备是通电状态（指示灯是蓝的），设备下次上电默认是通电状态（指示灯是蓝的）。
1：关闭，即断电状态（指示灯是灭的），如断电前，设备是通电状态（指示灯是蓝的），设备下次上电默认是依旧是断电状态（指示灯是灭的）。需要手动/远程开启通电状态。
2：开启，即通电状态（指示灯是蓝色的），是指设备上电之后，默认是通电状态，此刻需要注意，插在设备上的负载会通电运行，会有安全风险，所以建议是默认上电状态为关闭。 | 1 |
| 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 |
| ssid | String | 设备当前连接的WIFI名称 | GemeOpen |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.2.3 |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
### 自动上报任务（定时上报）
*device-timer-task*
此项非主动下发的指令，只展示用户开启定时上报任务后，定时返回的消息样式
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "device-timer-task",
"current" : 15.027,
"energy" : 25.047,
"key" : 0,
"leakage" : 30.000,
"mac" : "2026bb16aa14",
"power" : 2921.511,
"source" : "command",
"temperature" : 28,
"voltage" : 226.024
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | device-timer-task |
| current | float | 当前电流，单位A，保留三位小数 | 15.027 |
| energy | float | 累计用电量，单位KW*H，保留三位小数，断电后不会归零，重置后会归零 | 25.047 |
| key | int | 设备通断电状态，0：断电，1：通电 | 0 |
| leakage | float | 漏电电流（单位mA） | 30.000 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | 2026bb16aa14 |
| power | float | 当前功率，单位W，保留三位小数 | 2921.511 |
| source | String | 指令回复“command" | command |
| temperature | float | 温度 (单位:摄氏度) | 28 |
| voltage | float | 当前电压，单位V，保留三位小数 | 226.024
|
---
### 电量清零
*energy-clear*
电量清零
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"system" : "energy-clear",
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| system | String | energy-clear 电量清零 | energy-clear |
| type | String | 设置设备固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "energy-clear",
"mac" : "2026bb16aa14",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | energy-clear |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | 2026bb16aa14 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 获取设备信息
*info-all*
获取设备信息一般会包含：设备通断电状态、MAC/IMEI、固件版本、设备内网IP地址、设备WIFI网络名称等信息，不同的产品返回的信息有所差异
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"type" : "info"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| type | String | 获取设备基本信息固定传"info" | info |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"code" : "GSBR2T2",
"commandName" : "info-all",
"ip" : "192.168.122.119 ",
"key" : 0,
"keyLock" : 0,
"mac" : "dc54759195d0",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "gemeopen",
"timerEnable" : 0,
"version" : "1.2.3",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| code | String | 设备代号 | GSBR2T2 |
| commandName | String | 指令名称 | info-all |
| ip | String | 设备连接WIFI后获取的IP | 192.168.122.119
|
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| onState | int | 设备上电的默认状态：
0：记忆；是指记忆最后一次设备断电前的状态，如断电前设备是通电状态（指示灯是蓝的），设备下次上电默认是通电状态（指示灯是蓝的）。
1：关闭，即断电状态（指示灯是灭的），如断电前，设备是通电状态（指示灯是蓝的），设备下次上电默认是依旧是断电状态（指示灯是灭的）。需要手动/远程开启通电状态。
2：开启，即通电状态（指示灯是蓝色的），是指设备上电之后，默认是通电状态，此刻需要注意，插在设备上的负载会通电运行，会有安全风险，所以建议是默认上电状态为关闭。 | 1 |
| 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 |
| ssid | String | 设备当前连接的WIFI名称 | gemeopen |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 0 |
| version | String | 当前固件版本号 | 1.2.3 |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
### 获取设备全部告警设置
*info-allset*
获取设备全部告警设置
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"type" : "allset"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| type | String | 获取设备告警设置信息固定传"allset" | allset |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"balance" : 10,
"balance_set" : 0,
"leak" : 30,
"leak_set" : 1,
"overcurrent" : 63,
"overcur_set" : 1,
"overpower" : 13,
"overpow_set" : 0,
"overtemp" : 80,
"overtem_set" : 1,
"overvoltage" : 275,
"overvol_set" : 1,
"type" : "allset",
"undervoltage" : 160,
"undervol_set" : 1
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| balance | int | 余额不足阈值，如余额不足阈值为：10kwh | 10 |
| balance_set | int | 余额不足时是否跳闸，1：跳闸，0：不跳闸 | 0 |
| leak | int | 漏电阈值，如漏电阈值为：30ma | 30 |
| leak_set | int | 漏电时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| overcurrent | int | 过流阈值，如过流阈值为：63A | 63 |
| overcur_set | int | 过流时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| overpower | int | 过载阈值，如过载阈值为：13kw | 13 |
| overpow_set | int | 过载时是否跳闸，1：跳闸，0：不跳闸 | 0 |
| overtemp | int | 过温阈值，如过温阈值为：80℃ | 80 |
| overtem_set | int | 过温时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| overvoltage | int | 过压阈值，如过压阈值为：275V | 275 |
| overvol_set | int | 过压时是否跳闸：1:跳闸，0:不跳闸
| 1 |
| type | String | 指令类型 | allset |
| undervoltage | int | 欠压阈值，如欠压阈值为：160V | 160 |
| undervol_set | int | 欠压时是否跳闸，1：跳闸，0：不跳闸 | 1 |
---
### 获取剩余电量
*info-chargeenergy*
该指令只针对开启了预付费功能的设备有效。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"type" : "chargeenergy"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| type | String | 设备设置固定传“chargeenergy” | chargeenergy |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"chargeenergy" : 1200
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| chargeenergy | int | “1200”为剩余电量，即剩余12KWH电量可用 | 1200 |
---
### 获取设备统计信息
*info-statistic*
获取设备采集的累积电量、实时电压、实时电流、实时功率信息，注意不同的设备数值单位有区别，取决于设备设计的精度
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"type" : "statistic"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| type | String | 获取设备电量信息固定传"statistic" | statistic |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "info-statistic",
"current" : 15.027,
"energy" : 25.047,
"key" : 0,
"leakage" : 30.000,
"mac" : "dc54759195d0",
"power" : 2921.511,
"source" : "command",
"temperature" : 28,
"voltage" : 226.024
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | info-statistic |
| current | float | 当前电流，单位A，保留三位小数 | 15.027 |
| energy | float | 累计用电量，单位KW*H，保留三位小数，断电后不会归零，重置后会归零 | 25.047 |
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| leakage | float | 漏电电流（单位mA） | 30.000 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| power | float | 当前功率，单位W，保留三位小数 | 2921.511 |
| source | String | 指令回复“command" | command |
| temperature | float | 温度 (单位:摄氏度) | 28 |
| voltage | float | 当前电压，单位V，保留三位小数 | 226.024
|
---
### 电量充值
*setting-chargeenergy*
该指令只针对开启了预付费功能的设备有效。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"chargeenergy" : 1200,
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| chargeenergy | int | 充值的电量数值，如：充值12KWH, chargeenergy为1200，可设置范围为：0~999999 | 1200 |
| type | String | 设备设置固定传“setting” | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "setting-chargeenergy",
"mac" : "dc54759195d0",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | setting-chargeenergy |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 自定义HTTP
*setting-http*
用于配置http回调地址，用来设备事件推送地址，注意不支持https
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"protocol" : "http",
"type" : "custom",
"url" : "http://192.168.0.44:8080/command"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| protocol | String | 协议类型 | http |
| type | String | 设备自定义固定传"custom" | custom |
| url | String | 地址 | http://192.168.0.44:8080/command |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "setting-http",
"mac" : "dc54759195d0",
"protocol" : "mqtt",
"source" : "command",
"url" : "http://192.168.0.103:8080/command"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | setting-http |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| protocol | String | 协议类型 | mqtt |
| source | String | 指令回复“command" | command |
| url | String | 地址 | http://192.168.0.103:8080/command |
---
### 设置按键控制锁
*setting-key-lock*
功能按键锁定后，设备仅能通过MQTT/TCP协议操作，例如控制开关的通断、插座的通断电，都只能通过指令操作
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"keyLock" : 0,
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| type | String | 设备设置固定传"setting" | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"code" : "GSBR2T2",
"commandName" : "setting-key-lock",
"ip" : "192.168.122.119
",
"key" : 0,
"keyLock" : 0,
"mac" : "dc54759195d0",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GemeOpen",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.2.3",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| code | String | 设备代号 | GSBR2T2 |
| commandName | String | 指令名称 | setting-key-lock |
| ip | String | 设备连接WIFI后获取的IP | 192.168.122.119
|
| key | int | 通断器通断电状态，0：断电，1：通电 | 0 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| onState | int | 设备上电的默认状态：
0：记忆；是指记忆最后一次设备断电前的状态，如断电前设备是通电状态（指示灯是蓝的），设备下次上电默认是通电状态（指示灯是蓝的）。
1：关闭，即断电状态（指示灯是灭的），如断电前，设备是通电状态（指示灯是蓝的），设备下次上电默认是依旧是断电状态（指示灯是灭的）。需要手动/远程开启通电状态。
2：开启，即通电状态（指示灯是蓝色的），是指设备上电之后，默认是通电状态，此刻需要注意，插在设备上的负载会通电运行，会有安全风险，所以建议是默认上电状态为关闭。 | 1 |
| 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 |
| ssid | String | 设备当前连接的WIFI名称 | GemeOpen |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.2.3 |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
### 自定义MQTT
*setting-mqtt*
设备支持自定义MQTT，注意：在通过MQTT自定义MQTT信息后，需要将设备断电重启或者向设备发送重启命令才可生效。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"clientId" : "custom",
"messageId" : "20260520",
"password" : "password",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"subcribe" : "/topic/qos1",
"type" : "custom",
"username" : "username"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| clientId | String | 自定义MQTT客户端ID注意：不可重复
| custom |
| messageId | String | 业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。 | 20260520 |
| password | String | 密码 | password |
| 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",
"mac" : "dc54759195d0",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"source" : "command",
"subcribe" : "/topic/qos1",
"subcribe2" : "/topic/qos2",
"username" : "username"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| clientId | String | 自定义MQTT客户端ID注意：不可重复
| admin |
| commandName | String | 指令名称 | setting-mqtt |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| port | String | 端口号 | 1883 |
| protocol | String | 协议类型 | mqtt |
| publish | String | 自定义发布主题 注意:不可重复 | /topic/qos0 |
| server | String | 自定义服务器地址 | 192.168.0.66 |
| source | String | 指令回复“command" | command |
| subcribe | String | 自定义订阅主题，注意：不可重复 | /topic/qos1 |
| subcribe2 | String | 订阅第2个主题 | /topic/qos2 |
| username | String | 自定义服务器用户名 | username |
---
### 预付费功能设置
*setting-prepayment*
预付费功能设置
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"prepayment" : "0",
"type" : "setting"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| prepayment | String | 是否开启预付费功能， 0：关闭；1：开启 | 0 |
| type | String | 设备设置固定传“setting” | setting |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "setting-prepayment",
"mac" : "dc54759195d0",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | setting-prepayment |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设置设备过载/漏电/过温告警信息
*setting-seterror1*
设置设备过载/漏电/过温告警信息
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"leak" : 30,
"leak_set" : 1,
"overpower" : 13,
"overpow_set" : 0,
"overtemp" : 80,
"overtem_set" : 1,
"type" : "seterror1"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| leak | int | 漏电阈值，如漏电阈值为：30ma | 30 |
| leak_set | int | 漏电时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| overpower | int | 过载阈值，如过载阈值为：13kw | 13 |
| overpow_set | int | 过载时是否跳闸，1：跳闸，0：不跳闸 | 0 |
| overtemp | int | 过温阈值，如过温阈值为：80℃ | 80 |
| overtem_set | int | 过温时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| type | String | 设备设置固定值"seterror1" | seterror1 |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "seterror1",
"mac" : "2026bb16aa14",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | seterror1 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | 2026bb16aa14 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 设置过流/欠压/过压告警信息
*setting-seterror2*
设置过流/欠压/过压告警信息
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"balance" : 10,
"balance_set" : 0,
"overcurrent" : 63,
"overcur_set" : 1,
"overvoltage" : 275,
"overvol_set" : 1,
"type" : "seterror2",
"undervoltage" : 160,
"undervol_set" : 1
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| balance | int | 余额不足阈值，如余额不足阈值为：10kwh | 10 |
| balance_set | int | 余额不足时是否跳闸，1：跳闸，0：不跳闸 | 0 |
| overcurrent | int | 过流阈值，如过流阈值为：63A | 63 |
| overcur_set | int | 过流时是否跳闸，1：跳闸，0：不跳闸 | 1 |
| overvoltage | int | 过压阈值，如过压阈值为：275V | 275 |
| overvol_set | int | 过压时是否跳闸：1:跳闸，0:不跳闸
| 1 |
| type | String | 设备设置固定值"seterror2" | seterror2 |
| undervoltage | int | 欠压阈值，如欠压阈值为：160V | 160 |
| undervol_set | int | 欠压时是否跳闸，1：跳闸，0：不跳闸 | 1 |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "seterror2",
"mac" : "2026bb16aa14",
"message" : "ok",
"source" : "command",
"success" : true
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | seterror2 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | 2026bb16aa14 |
| message | String | 执行返回结果 | ok |
| source | String | 指令回复“command" | command |
| success | boolean | 执行结果 | true |
---
### 自定义TCP
*setting-tcp*
设备支持通过MQTT方式自定义TCP信息，注意：通过MQTT自定义TCP信息后，需要将设备断电重启或者向设备发送重启命令才可生效。
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.103",
"type" : "custom"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| port | String | 端口号 | 8080 |
| protocol | String | 协议类型 | tcp |
| server | String | 自定义服务器地址 | 192.168.0.103 |
| type | String | 设备自定义固定传"custom" | custom |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"commandName" : "setting-tcp",
"mac" : "dc54759195d0",
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.103",
"source" : "command"
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| commandName | String | 指令名称 | setting-tcp |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| port | String | 端口号 | 8080 |
| protocol | String | 协议类型 | tcp |
| server | String | 自定义服务器地址 | 192.168.0.103 |
| source | String | 指令回复“command" | command |
---
### 设置WiFi配网锁
*setting-wifi-lock*
wifi配网锁定后，设备无法通过长按配网按钮进入配网操作，仅能通过MQTT/TCP协议解锁配网功能<br/>
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
{
"type" : "setting",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| type | String | 设备设置固定传"setting" | setting |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"code" : "GSBR2T2",
"commandName" : "setting-wifi-lock",
"ip" : "192.168.122.119",
"key" : 0,
"keyLock" : 0,
"mac" : "dc54759195d0",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GemeOpen",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.2.3",
"wifiLock" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| code | String | 设备代号 | GSBR2T2 |
| commandName | String | 指令名称 | setting-wifi-lock |
| ip | String | 设备连接WIFI后获取的IP | 192.168.122.119 |
| key | int | 断路器通断电状态，0：断电，1：通电 | 0 |
| keyLock | int | 按键锁，0：关闭，1：开启 | 0 |
| mac | String | wifi设备MAC地址或4G设备的IMEI号，唯一标识 | dc54759195d0 |
| onState | int | 设备上电的默认状态：
0：记忆；是指记忆最后一次设备断电前的状态，如断电前设备是通电状态（指示灯是蓝的），设备下次上电默认是通电状态（指示灯是蓝的）。
1：关闭，即断电状态（指示灯是灭的），如断电前，设备是通电状态（指示灯是蓝的），设备下次上电默认是依旧是断电状态（指示灯是灭的）。需要手动/远程开启通电状态。
2：开启，即通电状态（指示灯是蓝色的），是指设备上电之后，默认是通电状态，此刻需要注意，插在设备上的负载会通电运行，会有安全风险，所以建议是默认上电状态为关闭。 | 1 |
| 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 |
| ssid | String | 设备当前连接的WIFI名称 | GemeOpen |
| timerEnable | int | 设备统计信息定时上报状态，0：关闭；1：开启 | 1 |
| timerInterval | int | 设备统计信息上报时间间隔（单位秒），取值范围5-86400 | 15 |
| version | String | 当前固件版本号 | 1.2.3 |
| wifiLock | int | 配网锁，0：关闭，1：开启 | 0 |
---
### 错误告警提示
*system-error*
设备主动上报字段，主动上报异常
**向设备发送指令（服务端向设备订阅topic发送消息）**
```json
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
---
**设备返回信息（设备向服务端订阅topic上报消息）**
```json
{
"error" : 0
}
```
#### 字段属性
---
| 字段名称 | 字段类型 | 字段说明 | 示例值 |
|------|------|------|------|
| error | int | 0，无告警；1，短路告警；2，浪涌告警；4，过载告警；8，漏电告警；16，温度异常告警；32，打火告警；64，高功率告警；128，漏电自检不正常；256，过流告警；512，三相电流不平衡告警；1024，过压告警；2048，欠压告警；4096，三相缺相告警；8192，停电事件告警；16384，磁影响告警；32768，余额不足告警；65535，欠费告警； | 0 |
---
下载
复制
