重置恢复出厂设置
controller-reset
指令简介
恢复出厂设置
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset |
| 3 |
type |
String |
设备设置固定传”setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-reset |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
设备软重启
controller-restart
指令简介
远程重启,设备重新读取最新配置参数
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
设备软重启固定传"restart" |
restart |
| 3 |
type |
String |
设备设置固定传"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-restart |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
累计用电量清零
energy-clear
指令简介
2.3.3版本以上支持
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
清除电量固定"energy-clear" |
energy-clear |
| 3 |
type |
String |
设置参数固定"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
energy-clear |
| 2 |
mac |
String |
设备的mac地址,唯一标识 |
4CEBD60BFD62 |
| 3 |
message |
String |
执行返回消息内容 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
获取设备通讯信息
info-protocol
指令简介
获取设备网络通讯信息
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
获取设备通讯协议固定传protocol |
protocol |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
8cce4e5136f6 |
| 2 |
commandName |
String |
指令名称 |
info-protocol |
| 3 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 4 |
messageId |
String |
消息ID字段 |
20260520 |
| 5 |
port |
String |
端口号 |
1883 |
| 6 |
protocol |
String |
协议类型,MQTT协议固定传"mqtt" |
mqtt |
| 7 |
publish |
String |
自定义MQTT发布主题 注意:不可重复 |
/KIduUf/MEYWsRCRgqWQ/8cce4e5136f6/subscribe |
| 8 |
server |
String |
自定义MQTT服务器地址 |
mqtt.smart-bird.cn |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
subcribe |
String |
自定义MQTT订阅主题注意:不可重复 |
/KIduUf/MEYWsRCRgqWQ/8cce4e5136f6/publish |
| 11 |
username |
String |
自定义MQTT服务器用户名 |
MEYWsRCRgqWQ |
设置按键控制锁
setting-key-lock
指令简介
功能按键锁定后,设备仅能通过MQTT/TCP协议操作,例如控制开关的通断、插座的通断电,都只能通过指令操作
向设备发送指令
服务端向设备订阅topic发送消息
{
"keyLock" : 0,
"messageId" : "20260520",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定传’setting" |
setting |
{
"commandName" : "setting-key-lock",
"ip" : "192.168.122.119",
"key" : 0,
"keyLock" : 0,
"mac" : "4CEBD60BFD62",
"messageId" : "20260520",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GeekOpen",
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "GSPW1B",
"version" : "2.3.4",
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-key-lock |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.122.119 |
| 3 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 6 |
messageId |
String |
消息ID字段 |
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)之间,表示无信号 |
-75 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
GeekOpen |
| 11 |
timerEnable |
int |
设备电量信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 13 |
type |
String |
设备类型 |
GSPW1B |
| 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" : "custom",
"messageId" : "20260520",
"password" : "password",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"subscribe" : "/topic/qos1",
"type" : "custom",
"username" : "username"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
custom |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
password |
String |
密码 |
password |
| 4 |
port |
String |
端口号 |
1883 |
| 5 |
protocol |
String |
协议类型 |
mqtt |
| 6 |
publish |
String |
自定义发布主题 注意:不可重复 |
/topic/qos0 |
| 7 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 8 |
subscribe |
String |
自定义设备MQTT订阅主题 注意:不可与发布主题重复 |
/topic/qos1 |
| 9 |
type |
String |
设备自定义固定传"custom" |
custom |
| 10 |
username |
String |
自定义服务器用户名 |
username |
{
"clientId" : "custom",
"commandName" : "setting-mqtt",
"mac" : "4CEBD60BFD62",
"messageId" : "20260520",
"password" : "password",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"source" : "command",
"subscribe" : "/topic/qos1 ",
"username" : "username"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复
|
custom |
| 2 |
commandName |
String |
指令名称 |
setting-mqtt |
| 3 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 4 |
messageId |
String |
消息ID字段 |
20260520 |
| 5 |
password |
String |
密码 |
password |
| 6 |
port |
String |
端口号 |
1883 |
| 7 |
protocol |
String |
协议类型 |
mqtt |
| 8 |
publish |
String |
自定义发布主题 注意:不可重复 |
/topic/qos0 |
| 9 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 10 |
source |
String |
指令回复“command" |
command |
| 11 |
subscribe |
String |
自定义设备MQTT订阅主题 注意:不可与发布主题重复。若固件版本小于2.3.8,则将subscribe改为subcribe。 |
/topic/qos1 |
| 12 |
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.122.119",
"key" : 0,
"keyLock" : 0,
"mac" : "4CEBD60BFD62",
"messageId" : "20260520",
"onState" : 1,
"signal" : -75,
"source" : "command",
"ssid" : "GeekOpen",
"timerEnable" : 1,
"type" : "setting",
"version" : "2.3.4",
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-on-state |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.122.119 |
| 3 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 6 |
messageId |
String |
消息ID字段 |
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)之间,表示无信号 |
-75 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
GeekOpen |
| 11 |
timerEnable |
int |
设备统计信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
type |
String |
设备设置固定传"setting" |
setting |
| 13 |
version |
String |
当前固件版本号 |
2.3.4 |
| 14 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |
自定义TCP
setting-tcp
指令简介
设备支持通过MQTT方式自定义TCP信息,注意:通过MQTT自定义TCP信息后,需要将设备断电重启或者向设备发送重启命令才可生效。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
port |
String |
端口号 |
8080 |
| 3 |
protocol |
String |
协议类型,TCP协议固定传"tcp" |
tcp |
| 4 |
server |
String |
自定义TCP服务器地址 |
192.168.0.66 |
| 5 |
type |
String |
设备自定义固定传"custom" |
custom |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-tcp |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 3 |
messageId |
String |
消息ID字段 |
20260520 |
| 4 |
port |
String |
端口号 |
8080 |
| 5 |
protocol |
String |
协议类型,TCP协议固定传"tcp" |
tcp |
| 6 |
server |
String |
自定义TCP服务器地址 |
192.168.0.66 |
| 7 |
source |
String |
指令回复“command" |
command |
设置WiFi配网锁
setting-wifi-lock
指令简介
wifi配网锁定后,设备无法通过长按配网按钮进入配网操作,仅能通过MQTT/TCP协议解锁配网功能
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
设备设置固定传"setting" |
setting |
| 3 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-wifi-lock |
| 2 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.122.119 |
| 3 |
key |
int |
插座通断电状态,0:断电,1:通电 |
0 |
| 4 |
keyLock |
int |
按键锁,0:关闭,1:开启 |
0 |
| 5 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
4CEBD60BFD62 |
| 6 |
messageId |
String |
消息ID字段 |
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)之间,表示无信号 |
-75 |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
ssid |
String |
设备当前连接的WIFI名称 |
GeekOpen |
| 11 |
timerEnable |
int |
设备电量信息定时上报状态,0:关闭;1:开启 |
1 |
| 12 |
timerInterval |
int |
设备统计信息上报时间间隔(单位秒),取值范围5-86400 |
15 |
| 13 |
type |
String |
设备类型 |
GSPW1B |
| 14 |
version |
String |
当前固件版本号 |
2.3.4 |
| 15 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |