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