设备重置/恢复出厂设置
controller-reset
指令简介
恢复出厂设置后配网信息和自定义信息都会清空,请谨慎操作!
向设备发送指令
服务端向设备订阅topic发送消息
{
"system" : "reset",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
{
"system" : "reset",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset |
| 2 |
type |
String |
固定值"setting" |
setting |
设备软重启
controller-restart
指令简介
软重启后,通过指令设置的参数将生效,同时设备将重新连接Wifi/4G网络,注意设备IP地址可能发生变化
向设备发送指令
服务端向设备订阅topic发送消息
{
"system" : "restart",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
system |
String |
设备软重启固定传"restart" |
restart |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
{
"system" : "restart",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
system |
String |
重置/恢复出厂设置默认填"reset" |
restart |
| 2 |
type |
String |
固定值"setting" |
setting |
累计用电量清零
energy-clear
指令简介
将设备累计用电量清零,清零后从零开始重新累计统计,仅清除累计用电量,不影响其他数据。清零为不可逆操作,清除后累计数据无法恢复!
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "202201241610366046",
"system" : "energy-clear",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
202201241610366046 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
energy-clear |
| 3 |
type |
String |
固定值"setting" |
setting |
{
"commandName" : "energy-clear",
"mac" : "868926080844258",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
energy-clear |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
868926080844258 |
| 3 |
message |
String |
执行结果描述:对命令执行结果的文本说明。执行完成且无异常:ok ;如果出现异常,返回异常结果描述。 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
202201241610366046 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果,执行成功:true;执行失败:false |
true |
获取设备通信协议
info-protocol
指令简介
获取当前设备与服务端交互的通信协议及协议配置参数,目前支持MQTT,设备出厂时默认接入GemeOpen厂家MQTT测试服务器,免费提供客户调试使用,如需接入自己的服务器或使用其他协议,请自行搭建服务器。
向设备发送指令
服务端向设备订阅topic发送消息
{
"type" : "protocol"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
type |
String |
获取设备通讯协议固定传"protocol" |
protocol |
{
"subcribe": "/INIT/xpNsEyosAtDZ/868926080844258/subscribe",
"port": "1883",
"publish": "/INIT/xpNsEyosAtDZ/868926080844258/publish",
"server": "mqtt.smart-bird.cn",
"protocol": "mqtt",
"username": "xpNsEyosAtDZ",
"clientId": "868926080844258"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
868926080844258 |
| 2 |
port |
String |
端口号 |
1883 |
| 3 |
protocol |
String |
协议类型 |
mqtt |
| 4 |
publish |
String |
自定义发布主题 注意:不可重复 |
/INIT/xpNsEyosAtDZ/868926080844258/publish |
| 5 |
server |
String |
自定义服务器地址 |
mqtt.smart-bird.cn |
| 6 |
subcribe |
String |
自定义订阅主题,注意:不可重复 |
/INIT/xpNsEyosAtDZ/868926080844258/subscribe |
| 7 |
username |
String |
自定义服务器用户名 |
xpNsEyosAtDZ |
设置按键控制锁
setting-key-lock
指令简介
功能按键锁定后,设备仅能通过MQTT/TCP协议操作,例如控制开关的通断、插座的通断电,都只能通过指令操作
向设备发送指令
服务端向设备订阅topic发送消息
{
"keyLock" : 1,
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
{
"iccid" : "898608911026D0257696",
"imei" : "868926080844258",
"key" : 0,
"keyLock" : 1,
"mcu" : "Air780EPM",
"onState" : 1,
"resetLock" : 0,
"signal" : 16,
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "GSMM1P1-4G",
"version" : "1.0.1"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
iccid |
String |
SIM-卡ICCID值 |
898608911026D0257696 |
| 2 |
imei |
String |
设备唯一标识 |
868926080844258 |
| 3 |
key |
int |
设备通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 5 |
mcu |
String |
芯片型号 |
Air780EPM |
| 6 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 7 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
0 |
| 8 |
signal |
int |
信号强度,显示规则为:signal int 信号强度,取值范围(0~31),值越大越好 |
16 |
| 9 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 10 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 11 |
type |
String |
设备型号 |
GSMM1P1-4G |
| 12 |
version |
String |
当前固件版本号 |
1.0.1 |
自定义MQTT参数
setting-mqtt
指令简介
设备支持自定义MQTT,注意:在通过MQTT自定义MQTT信息后,需要将设备断电重启或者向设备发送重启命令才可生效。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
admin |
| 2 |
password |
String |
密码 |
123456 |
| 3 |
port |
String |
端口号 |
1883 |
| 4 |
protocol |
String |
协议类型 |
mqtt |
| 5 |
publish |
String |
自定义发布主题 注意:不可重复 |
/topic/qos0 |
| 6 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 7 |
subcribe |
String |
自定义订阅主题,注意:不可重复 |
/topic/qos1 |
| 8 |
type |
String |
设备自定义固定传"custom" |
custom |
| 9 |
username |
String |
自定义服务器用户名 |
username |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
admin |
| 2 |
imei |
String |
设备唯一标识 |
862323080739884 |
| 3 |
password |
String |
密码 |
123456 |
| 4 |
port |
String |
端口号 |
1883 |
| 5 |
protocol |
String |
协议类型 |
mqtt |
| 6 |
publish |
String |
自定义发布主题 注意:不可重复 |
/topic/qos0 |
| 7 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 8 |
subcribe |
String |
自定义订阅主题,注意:不可重复 |
/topic/qos1 |
| 9 |
type |
String |
设备自定义固定传"custom" |
custom |
| 10 |
username |
String |
自定义服务器用户名 |
username |
设置上电默认状态
setting-on-state
指令简介
配置设备断电恢复后输出的默认状态,即断电恢复瞬间设备是通电还是断电。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
imei |
String |
设备唯一标识 |
861556071286636 |
| 2 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 3 |
type |
String |
设备设置固定传"setting" |
setting |
设置按键重置锁
setting-reset-lock
指令简介
开启后设备只能通过mqtt,tcp方式重置.
向设备发送指令
服务端向设备订阅topic发送消息
{
"resetLock" : 1,
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
1 |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
{
"iccid" : "898608911026D0257696",
"imei" : "868926080844258",
"key" : 0,
"keyLock" : 0,
"mcu" : "Air780EPM",
"onState" : 1,
"resetLock" : 1,
"signal" : 17,
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "GSMM1P1-4G",
"version" : "1.0.1"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
iccid |
String |
SIM-卡ICCID值 |
898608911026D0257696 |
| 2 |
imei |
String |
设备唯一标识 |
868926080844258 |
| 3 |
key |
int |
设备通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 5 |
mcu |
String |
芯片型号 |
Air780EPM |
| 6 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 7 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
1 |
| 8 |
signal |
int |
信号强度,显示规则为:signal int 信号强度,取值范围(0~31),值越大越好 |
17 |
| 9 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 10 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 11 |
type |
String |
设备型号 |
GSMM1P1-4G |
| 12 |
version |
String |
当前固件版本号 |
1.0.1 |