重置/恢复出厂设置
controller-reset
指令简介
将设备恢复至出厂状态,清除全部用户数据与配置,并自动重启。
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "202201241610366046",
"system" : "reset",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
202201241610366046 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset |
| 3 |
type |
String |
设备设置固定传”setting" |
setting |
{
"commandName" : "controller-reset",
"imei" : "863304084073537",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-reset |
| 2 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
设备软重启
controller-restart
指令简介
软重启后,通过指令设置的参数将生效,同时设备将重新连接4G网络
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "202201241610366046",
"system" : "restart",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
202201241610366046 |
| 2 |
system |
String |
设备软重启固定传"restart" |
restart |
| 3 |
type |
String |
设备设置固定传"setting" |
setting |
{
"commandName" : "controller-restart",
"imei" : "863304084073537",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-restart |
| 2 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
累计用电量清零
energy-clear
指令简介
将设备累计用电量清零,清零后从零开始重新累计统计,仅清除累计用电量,不影响其他数据。清零为不可逆操作,清除后累计数据无法恢复!
向设备发送指令
服务端向设备订阅topic发送消息
{
"system" : "energy-clear",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
system |
String |
energy-clear 电量清零 |
energy-clear |
| 2 |
type |
String |
设置设备固定传"setting" |
setting |
{
"commandName" : "energy-clear",
"imei" : "863304084073537",
"message" : "ok",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
energy-clear |
| 2 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
source |
String |
指令回复“command" |
command |
| 5 |
success |
boolean |
执行结果 |
true |
设置按键控制锁
setting-key-lock
指令简介
功能按键锁定后,设备仅能通过MQTT/TCP协议操作,例如控制开关的通断、插座的通断电,都只能通过远程指令下发,不能通过物理按键来控制。
向设备发送指令
服务端向设备订阅topic发送消息
{
"keyLock" : 1,
"messageId" : "202201241610366046",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
202201241610366046 |
| 3 |
type |
String |
设备设置固定传’setting" |
setting |
{
"code" : "GSPW1B-4G",
"commandName" : "setting-keyLock",
"iccid" : "898608361924D2183331",
"imei" : "863304084073537",
"key" : 0,
"keyLock" : 1,
"messageId" : "202201241610366046",
"onState" : 1,
"resetLock" : 0,
"signal" : 17,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.6"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
code |
String |
设备型号 |
GSPW1B-4G |
| 2 |
commandName |
String |
指令名称 |
setting-keyLock |
| 3 |
iccid |
String |
SIM-卡ICCID值 |
898608361924D2183331 |
| 4 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 5 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 6 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 7 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 8 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 9 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
0 |
| 10 |
signal |
int |
信号强度,显示0 - 31, 越大越好,若失败返回0,显示规则为:
CSQ值小于10,网络较差。
CSQ值在10和25之间,网络中等。
CSQ值大于25,网络较好。
CSQ值等于99,一般是卡的问题,需要联系运营商确认卡状态。
信号较差 signal没有在0~(-100)之间,表示无信号 |
17 |
| 11 |
source |
String |
指令回复“command" |
command |
| 12 |
timerEnable |
int |
设备电量信息定时上报状态,0:关闭;1:开启 |
1 |
| 13 |
timerInterval |
int |
电量信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 14 |
version |
String |
当前固件版本号 |
1.1.6 |
自定义MQTT参数
setting-mqtt
指令简介
修改设备的 MQTT 服务器连接参数,使设备接入客户指定的MQTT 服务器(自建服务器、第三方平台等)。
向设备发送指令
服务端向设备订阅topic发送消息
{
"clientId" : "custom",
"messageId" : "API-5608869868",
"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 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
API-5608869868 |
| 3 |
password |
String |
密码 |
password |
| 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 |
type |
String |
设备自定义固定传"custom" |
custom |
| 10 |
username |
String |
自定义服务器用户名 |
username |
{
"clientId" : "custom",
"commandName" : "setting-mqtt",
"imei" : "863304084073537",
"messageId" : "API-5608869868",
"password" : "password",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "broker.emqx.io",
"source" : "command",
"subscribe" : "/topic/qos1",
"username" : "username"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复 |
custom |
| 2 |
commandName |
String |
指令名称 |
setting-mqtt |
| 3 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 4 |
messageId |
String |
消息ID字段 |
API-5608869868 |
| 5 |
password |
String |
密码 |
password |
| 6 |
port |
String |
端口号 |
1883 |
| 7 |
protocol |
String |
协议类型,MQTT协议固定传"mqtt" |
mqtt |
| 8 |
publish |
String |
自定义MQTT发布主题 注意:不可重复 |
/topic/qos0 |
| 9 |
server |
String |
自定义MQTT服务器地址 |
broker.emqx.io |
| 10 |
source |
String |
指令回复“command" |
command |
| 11 |
subscribe |
String |
自定义设备MQTT订阅主题 注意:不可与发布主题重复 |
/topic/qos1 |
| 12 |
username |
String |
自定义MQTT服务器用户名 |
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" : "GSPW1B-4G",
"commandName" : "setting-onState",
"iccid" : "898608361924D2183342",
"imei" : "863304084073537",
"key" : 0,
"keyLock" : 0,
"messageId" : "202201241610366046",
"onState" : 1,
"resetLock" : 0,
"signal" : 17,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.6"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
code |
String |
设备型号 |
GSPW1B-4G |
| 2 |
commandName |
String |
指令名称 |
setting-onState |
| 3 |
iccid |
String |
SIM-卡ICCID值 |
898608361924D2183342 |
| 4 |
imei |
String |
设备唯一标识 |
863304084073537 |
| 5 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 6 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 7 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 8 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 9 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
0 |
| 10 |
signal |
int |
信号强度 |
17 |
| 11 |
source |
String |
指令回复“command" |
command |
| 12 |
timerEnable |
int |
设备电量信息定时上报状态,0:关闭;1:开启 |
1 |
| 13 |
timerInterval |
int |
电量信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 14 |
version |
String |
当前固件版本号 |
1.1.6 |
设置重置锁
setting-reset-lock
指令简介
锁定/解锁设备的物理按键重置入口。锁定后,长按开关键无法触发恢复出厂(重置)操作,防止误触或现场人员擅自重置设备。
向设备发送指令
服务端向设备订阅topic发送消息
{
"resetLock" : 0,
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
0 |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
{
"code" : "GSPW1B-4G",
"commandName" : "setting-resetLock",
"iccid" : "898608361924D2183342",
"imei" : "863304084078494",
"key" : 0,
"keyLock" : 0,
"messageId" : "202201241610366046",
"onState" : 1,
"resetLock" : 1,
"signal" : 17,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.6"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
code |
String |
设备代号 |
GSPW1B-4G |
| 2 |
commandName |
String |
指令名称 |
setting-resetLock |
| 3 |
iccid |
String |
SIM-卡ICCID值 |
898608361924D2183342 |
| 4 |
imei |
String |
设备唯一标识 |
863304084078494 |
| 5 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 6 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 7 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 8 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 9 |
resetLock |
int |
重置锁,0:关闭,1:开启 |
1 |
| 10 |
signal |
int |
信号强度 |
17 |
| 11 |
source |
String |
指令回复“command" |
command |
| 12 |
timerEnable |
int |
设备电量信息定时上报状态,0:关闭;1:开启 |
1 |
| 13 |
timerInterval |
int |
电量信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 14 |
version |
String |
当前固件版本号 |
1.1.6 |