重置恢复出厂
controller-reset
指令简介
恢复出厂设置后配网信息和自定义信息都会清空,请谨慎操作!
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"system" : "reset",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset |
| 3 |
type |
String |
设备设置固定传"setting" |
setting |
{
"commandName" : "controller-reset",
"mac" : "2026bb1cc514",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-reset |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb1cc514 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
设备软重启
controller-restart
指令简介
软重启后,通过指令设置的参数将生效,同时设备将重新连接Wifi网络,注意设备IP地址可能发生变化。特殊操作:长按按钮12s执行软重启。
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"system" : "restart",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 2 |
system |
String |
设备软重启默认填"restart" |
restart |
| 3 |
type |
String |
设备设置固定传"setting" |
setting |
{
"commandName" : "controller-restart",
"mac" : "2026bb1cc514",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
controller-restart |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb1cc514 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
获取设备信息
info-all
指令简介
获取设备信息一般会包含:设备通断电状态、MAC/IMEI、固件版本、设备内网IP地址、设备WIFI网络名称等信息,不同的产品返回的信息有所差异
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "202201241610366046",
"type" : "info"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 2 |
type |
String |
设备设置固定传"info" |
info |
{
"batteryCacheCount" : 15,
"batteryLevel" : 98,
"bssid" : "742ad779046",
"code" : "GSTMD1B",
"commandName" : "info-all",
"dhcpEnable" : 1,
"humidityOffset" : -2.5,
"ip" : "192.168.122.119",
"mac" : "2026bb16aa14",
"messageId" : "20260520",
"powerSource" : "Battery",
"samplingInterval" : 60,
"signal" : -75,
"source" : "command",
"ssid" : "gemeopen",
"tempOffset" : 0,
"typecCacheCount" : 1,
"version" : "1.0.0"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
batteryCacheCount |
int |
电池供电模式下,本地缓存达到该条数触发上报,仅电池供电生效。最大值为17280条 |
15 |
| 2 |
batteryLevel |
int |
当前电量百分比 |
98 |
| 3 |
bssid |
String |
路由器 MAC 地址 |
742ad779046 |
| 4 |
code |
String |
设备型号代码 |
GSTMD1B |
| 5 |
commandName |
String |
指令名称 |
info-all |
| 6 |
dhcpEnable |
int |
自动寻址1:开启, 0:关闭,默认开启 |
1 |
| 7 |
humidityOffset |
float |
湿度补偿偏移值,单位:%RH,范围:-20~+20。
计算公式:校准后数据=实际读取的数据+humidityOffset |
-2.5 |
| 8 |
ip |
String |
设备连接WIFI后获取的IP |
192.168.122.119 |
| 9 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb16aa14 |
| 10 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 11 |
powerSource |
String |
设备当前供电方式Type-C/Battery |
Battery |
| 12 |
samplingInterval |
int |
采集间隔(单位秒),最小值 5,范围 5-86400 |
60 |
| 13 |
signal |
int |
信号强度,显示规则为: signal<= 0 && signal>= -50
//信号最好 signal< -50 && signal>= -70
//信号较好 signal< -70 && signal>= -80
//信号一般 signal<-80 && signal>= -100
//信号较差 signal没有在0~(-100)之间,表示无信号 |
-75 |
| 14 |
source |
String |
指令回复“command" |
command |
| 15 |
ssid |
String |
设备当前连接的WIFI名称 |
gemeopen |
| 16 |
tempOffset |
float |
温度补偿偏移值,单位:℃,取值范围:+20~-20;
计算公式:校准后数据=实际读取的数据+tempOffset |
0 |
| 17 |
typecCacheCount |
int |
Type-C供电模式下,本地缓存达到该条数触发上报,仅Type‑C供电生效。最大值为17280条 |
1 |
| 18 |
version |
String |
当前固件版本号 |
1.0.0 |
获取设备工作模式信息
info-protocol
指令简介
查询设备当前使用的通信协议配置信息,设备支持MQTT或TCP工作模式,不同的工作模式,返回的字段信息不同
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"type" : "protocol"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 2 |
type |
String |
获取设备通讯协议固定传protocol
|
protocol |
{
"clientId" : "1C6920F083C4",
"commandName" : "info-protocol",
"mac" : "2026bb1cc514",
"messageId" : "202201241610366046",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/KIduUf/mSEiZxMFxOLD/1C6920F083C4/subscribe",
"server" : "mqtt.smart-bird.cn",
"source" : "command",
"subcribe" : "/KIduUf/mSEiZxMFxOLD/1C6920F083C4/publish",
"username" : "mSEiZxMFxOLD"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
clientId |
String |
自定义MQTT客户端ID注意:不可重复 |
1C6920F083C4 |
| 2 |
commandName |
String |
指令名称 |
info-protocol |
| 3 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb1cc514 |
| 4 |
messageId |
String |
消息ID字段 |
202201241610366046 |
| 5 |
port |
String |
端口号 |
1883 |
| 6 |
protocol |
String |
工作模式,协议类型,MQTT协议固定传"mqtt" |
mqtt |
| 7 |
publish |
String |
自定义MQTT发布主题 注意:不可重复 |
/KIduUf/mSEiZxMFxOLD/1C6920F083C4/subscribe |
| 8 |
server |
String |
自定义MQTT服务器地址 |
mqtt.smart-bird.cn |
| 9 |
source |
String |
指令回复“command" |
command |
| 10 |
subcribe |
String |
自定义MQTT订阅主题注意:不可重复 |
/KIduUf/mSEiZxMFxOLD/1C6920F083C4/publish |
| 11 |
username |
String |
自定义MQTT服务器用户名 |
mSEiZxMFxOLD |
自定义HTTP
setting-http
指令简介
配置http回调地址,作为设备事件推送地址,注意不支持https,仅常供电支持
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "202201241610366046",
"protocol" : "http",
"type" : "custom",
"url" : "http://192.168.0.66:8080/api/iot/upload"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
202201241610366046 |
| 2 |
protocol |
String |
协议类型 |
http |
| 3 |
type |
String |
设备自定义固定传"custom" |
custom |
| 4 |
url |
String |
自定义服务器地址 |
http://192.168.0.66:8080/api/iot/upload |
{
"commandName" : "setting-http",
"mac" : "2026bb1cc514",
"messageId" : "20260520",
"protocol" : "http",
"source" : "command",
"url" : "http://192.168.0.66:8080/api/iot/upload"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-http |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb1cc514 |
| 3 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 4 |
protocol |
String |
协议类型 |
http |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
url |
String |
自定义服务器地址 |
http://192.168.0.66:8080/api/iot/upload |
设置温湿度补偿
setting-humidity-compensate
指令简介
设置温度和湿度的补偿值,用于校准传感器采集数据的偏差。补偿公式:校准后数据=实际读取的数据+补偿偏移值
向设备发送指令
服务端向设备订阅topic发送消息
{
"humidityOffset" : -2.5,
"tempOffset" : 0,
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
humidityOffset |
float |
湿度补偿偏移值,单位:%RH,范围:-20~+20。
计算公式:校准后数据=实际读取的数据+humidityOffset |
-2.5 |
| 2 |
tempOffset |
float |
温度补偿偏移值,单位:℃,取值范围:+20~-20;
计算公式:校准后数据=实际读取的数据+tempOffset |
0 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
{
"commandName" : "",
"humidityOffset" : -2.5,
"mac" : "2026bb16aa14",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true,
"tempOffset" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
|
| 2 |
humidityOffset |
float |
湿度补偿偏移值,单位:%RH,范围:-20~+20。
计算公式:校准后数据=实际读取的数据+humidityOffset |
-2.5 |
| 3 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
tempOffset |
float |
温度补偿偏移值,单位:℃,取值范围:+20~-20;
计算公式:校准后数据=实际读取的数据+tempOffset |
0 |
自定义MQTT
setting-mqtt
指令简介
设备支持自定义 MQTT,注意:该配置重启后生效。若固件版本小于1.0.22,则将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协议固定传"mqtt" |
mqtt |
| 6 |
publish |
String |
自定义MQTT发布主题 注意:不可重复 |
/topic/qos0 |
| 7 |
server |
String |
自定义MQTT服务器地址 |
192.168.0.66 |
| 8 |
subscribe |
String |
自定义设备MQTT订阅主题 注意:不可与订阅主题重复。若固件版本小于1.0.22,则将subscribe改为subcribe。 |
/topic/qos1 |
| 9 |
type |
String |
设备自定义固定传"custom" |
custom |
| 10 |
username |
String |
自定义MQTT服务器用户名 |
username |
{
"clientId" : "custom",
"commandName" : "setting-mqtt",
"mac" : "2026bb1cc514",
"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号,唯一标识 |
2026bb1cc514 |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
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订阅主题 注意:不可与订阅主题重复 |
/topic/qos1 |
| 12 |
username |
String |
自定义服务器用户名 |
username |
自定义TCP
setting-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 |
{
"commandName" : "setting-tcp",
"mac" : "2026bb1cc514",
"messageId" : "20260520",
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.66",
"source" : "command"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-tcp |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb1cc514 |
| 3 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 4 |
port |
String |
端口号 |
8080 |
| 5 |
protocol |
String |
协议类型 |
tcp |
| 6 |
server |
String |
自定义服务器地址 |
192.168.0.66 |
| 7 |
source |
String |
指令回复“command" |
command |
设置静态IP
setting-wifi-dhcpEnable
指令简介
设备默认为动态获取ip,通过该接口开启静态IP,需重启生效
配置的静态IP需和路由器处于同一网段下
向设备发送指令
服务端向设备订阅topic发送消息
{
"dhcpEnable" : 1,
"dns" : "192.168.0.1",
"gateway" : "192.168.0.1",
"local_ip" : "192.168.0.118",
"messageId" : "20260520",
"subnet" : "255.255.255.0",
"type" : "setting"
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
dhcpEnable |
int |
自动寻址1:开启, 0:关闭,默认开启 |
1 |
| 2 |
dns |
String |
DNS服务器地址 |
192.168.0.1 |
| 3 |
gateway |
String |
默认网关 |
192.168.0.1 |
| 4 |
local_ip |
String |
IP地址 |
192.168.0.118 |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 6 |
subnet |
String |
子网掩码 |
255.255.255.0 |
| 7 |
type |
String |
设备设置固定值"setting" |
setting |
{
"commandName" : "setting-wifi-dhcpEnable",
"mac" : "2026bb16aa14",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-wifi-dhcpEnable |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
设置配网按键锁
setting-wifi-lock
指令简介
wifi配网锁定后,设备无法通过长按配网按钮进入配网操作。
向设备发送指令
服务端向设备订阅topic发送消息
{
"messageId" : "20260520",
"type" : "setting",
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 2 |
type |
String |
设备设置固定值"setting" |
setting |
| 3 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |
{
"commandName" : "setting-wifi-lock",
"mac" : "2026bb16aa14",
"message" : "ok",
"messageId" : "20260520",
"source" : "command",
"success" : true,
"wifiLock" : 0
}
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting-wifi-lock |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。 |
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
| 7 |
wifiLock |
int |
配网锁,0:关闭,1:开启 |
0 |