重置设备
controller-reset
指令简介
恢复出厂设置后配网信息和自定义信息都会清空,请谨慎操作!
向设备发送指令
服务端向设备订阅topic发送消息
{{
"messageId" : "20260520",
"system" : "reset",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
restart |
| 3 |
type |
String |
固定值"xxx" |
setting |
{
"commandName" : "controller-reset",
"mac" : "8cce4e513a06",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-reset |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 3 |
message |
String |
执行结果描述:对命令执行结果的文本说明。执行完成且无异常:ok ;如果出现异常,返回异常结果描述。 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果,执行成功:true;执行失败:false |
true |
重启设备
controller-reset
指令简介
软重启后,通过指令设置的参数将生效,同时设备将重新连接Wifi/4G网络,注意设备IP地址可能发生变化
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"system" : "restart",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
restart |
| 3 |
type |
String |
固定值"xxx" |
setting |
{
"commandName": "controller-reset",
"mac": "8cce4e513a06",
"message": "ok",
"messageId": "20260520",
"source": "command",
"success": true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-reset |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 3 |
message |
String |
执行结果描述:对命令执行结果的文本说明。执行完成且无异常:ok ;如果出现异常,返回异常结果描述。 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果,执行成功:true;执行失败:false |
true |
累计用电量清零
energy-clear
指令简介
将设备累计用电量清零,清零后从零开始重新累计统计,仅清除累计用电量,不影响其他数据。清零为不可逆操作,清除后累计数据无法恢复!
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"system" : "energy-clear",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
energy-clear |
| 3 |
type |
String |
固定值"setting" |
setting |
{
"commandName" : "energy-clear",
"mac" : "8cce4e513a06",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
energy-clear |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 3 |
message |
String |
执行结果描述:对命令执行结果的文本说明。执行完成且无异常:ok ;如果出现异常,返回异常结果描述。 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果,执行成功:true;执行失败:false |
true |
获取设备通讯协议
info-protocol
指令简介
获取当前设备与服务端交互的通信协议及协议配置参数,目前支持MQTT、TCP Client和HTTP Server(固件版本2.0.0以上支持),设备出厂时默认接入GemeOpen厂家MQTT测试服务器,免费提供客户调试使用,如需接入自己的服务器或使用其他协议,请自行搭建服务器。
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"type" : "protocol"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
固定值"protocol" |
protocol |
{
"clientId" : "8cce4e513a06",
"commandName" : "info-protocol",
"mac" : "8cce4e513a06",
"messageId" : "20260520",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/GpTDLq/yibBCwLArHld/8cce4e513a06/subscribe",
"server" : "mqtt.smart-bird.cn",
"source" : "command",
"subcribe" : "/GpTDLq/yibBCwLArHld/8cce4e513a06/publish",
"username" : "yibBCwLArHld"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
8cce4e513a06 |
| 2 |
commandName |
String |
指令名称 |
info-protocol |
| 3 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
port |
String |
端口号 |
1883 |
| 6 |
protocol |
String |
协议类型 |
mqtt |
| 7 |
publish |
String |
自定义发布主题 注意:不可重复 |
/GpTDLq/yibBCwLArHld/8cce4e513a06/subscribe |
| 8 |
server |
String |
自定义服务器地址 |
mqtt.smart-bird.cn |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
subcribe |
String |
自定义订阅主题,注意:不可重复 |
/GpTDLq/yibBCwLArHld/8cce4e513a06/publish |
| 11 |
username |
String |
自定义服务器用户名 |
yibBCwLArHld |
设置按键控制锁
setting-key-lock
指令简介
功能按键锁定后,设备仅能通过MQTT/TCP协议操作,例如控制开关的通断、插座的通断电,都只能通过远程指令下发,不能通过物理按键来控制。
向设备发送指令
服务端向设备订阅topic发送消息
{
"keyLock" : 1,
"messageId" : "20260520",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
固定值"setting" |
setting |
{
"commandName" : "setting-key-lock",
"ip" : "192.168.0.44",
"key" : 0,
"keyLock" : 1,
"mac" : "8cce4e513a06",
"messageId" : "20260520",
"onState" : 1,
"signal" : -54,
"source" : "command",
"ssid" : "gemeopen",
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "GSPM1B-US",
"version" : "2.3.4",
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-key-lock |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.0.44 |
| 3 |
key |
int |
设备通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 6 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 7 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 8 |
signal |
int |
信号强度,显示规则为: signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0~(-100)之间,表示无信号 |
-54 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
gemeopen |
| 11 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 13 |
type |
String |
设备型号 |
GSPM1B-US |
| 14 |
version |
String |
当前固件版本号 |
2.3.4 |
| 15 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |
自定义MQTT参数
setting-mqtt
指令简介
设备支持自定义MQTT,注意:在通过MQTT自定义MQTT信息后,需要将设备断电重启或者向设备发送重启命令才可生效。若固件版本小于2.3.8,则将subscribe改为subcribe。
向设备发送指令
服务端向设备订阅topic发送消息
{
"clientId" : "admin",
"messageId" : "20260520",
"password" : "123456",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0 ",
"server" : "broker.emqx.io ",
"subscribe" : "/topic/qos1 ",
"type" : "custom",
"username" : "username "
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
admin |
| 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 |
type |
String |
固定值"custom" |
custom |
| 10 |
username |
String |
自定义服务器用户名 |
username |
{
"clientId" : "admin",
"messageId" : "20260520",
"password" : "123456",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0 ",
"server" : "broker.emqx.io ",
"subscribe" : "/topic/qos1 ",
"type" : "custom",
"username" : "username "
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
admin |
| 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订阅主题 注意:不可与发布主题重复。若固件版本小于2.3.8,则将subscribe改为subcribe。 |
/topic/qos1 |
| 9 |
type |
String |
固定值"custom" |
custom |
| 10 |
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 |
{
"commandName" : "setting-on-state",
"ip" : "192.168.0.44",
"key" : 0,
"keyLock" : 0,
"mac" : "8cce4e513a06",
"messageId" : "20260520",
"onState" : 1,
"signal" : -53,
"source" : "command",
"ssid" : "gemeopen",
"timerEnable" : 1,
"type" : "GSPM1B-US",
"version" : "2.3.4",
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-on-state |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.0.44 |
| 3 |
key |
int |
设备通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 6 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 7 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
1 |
| 8 |
signal |
int |
信号强度,显示规则为: signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0~(-100)之间,表示无信号 |
-53 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
gemeopen |
| 11 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
type |
String |
设备型号 |
GSPM1B-US |
| 13 |
version |
String |
当前固件版本号 |
2.3.4 |
| 14 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |
自定义TCP参数
setting-tcp
指令简介
设备支持通过MQTT方式自定义TCP信息,注意:通过MQTT自定义TCP信息后,需要将设备断电重启或者向设备发送重启命令才可生效。
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.66",
"type" : "custom"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
port |
String |
端口号 |
8080 |
| 3 |
protocol |
String |
协议类型 |
tcp |
| 4 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 5 |
type |
String |
固定值"custom" |
custom |
{
"messageId" : "20260520",
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.66",
"type" : "custom"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
port |
String |
端口号 |
8080 |
| 3 |
protocol |
String |
协议类型 |
tcp |
| 4 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 5 |
type |
String |
固定值"custom" |
custom |
设置WiFi配网锁
setting-wifi-lock
指令简介
wifi配网锁定后,设备无法通过长按配网按钮进入配网操作,仅能通过MQTT/TCP协议解锁配网功能
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"type" : "setting",
"wifiLock" : 1
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
固定值"setting" |
setting |
| 3 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
1 |
{
"commandName" : "setting-wifi-lock",
"ip" : "192.168.0.44",
"key" : 0,
"keyLock" : 1,
"mac" : "8cce4e513a06",
"messageId" : "20260520",
"onState" : 0,
"signal" : -54,
"source" : "command",
"ssid" : "gemeopen",
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "GSPM1B-US",
"version" : "2.3.4",
"wifiLock" : 1
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-wifi-lock |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.0.44 |
| 3 |
key |
int |
设备通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
1 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
8cce4e513a06 |
| 6 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 7 |
onState |
int |
设备上电的默认状态:
0:记忆;是指记忆最后一次设备断电前的状态,如断电前设备是通电状态(指示灯是蓝的),设备下次上电默认是通电状态(指示灯是蓝的)。
1:关闭,即断电状态(指示灯是灭的),如断电前,设备是通电状态(指示灯是蓝的),设备下次上电默认是依旧是断电状态(指示灯是灭的)。需要手动/远程开启通电状态。
2:开启,即通电状态(指示灯是蓝色的),是指设备上电之后,默认是通电状态,此刻需要注意,插在设备上的负载会通电运行,会有安全风险,所以建议是默认上电状态为关闭。 |
0 |
| 8 |
signal |
int |
信号强度,显示规则为: signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0~(-100)之间,表示无信号 |
-54 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
gemeopen |
| 11 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 13 |
type |
String |
设备型号 |
GSPM1B-US |
| 14 |
version |
String |
当前固件版本号 |
2.3.4 |
| 15 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
1 |