auth-verify
指令简介
连接后发送密码进行验证。验证通过后才能使用其他指令。密码功能未启用时直接返回成功。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
password |
String |
密码 |
123456 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
advInterval |
int |
广播频率 (单位: ms) |
1000 |
| 2 |
authEnable |
int |
密码开关 (0=关闭, 1=启用) |
0 |
| 3 |
authTimeout |
int |
密码超时时间 (秒), 仅 authEnable=1 时返回 |
15 |
| 4 |
code |
String |
设备型号代码 |
GSSBM1B |
| 5 |
commandName |
String |
指令名称 |
setting |
| 6 |
companyId |
String |
iBeacon Company ID (16进制) |
0x004C |
| 7 |
key |
int |
当前蜂鸣器状态 (1=响, 0=停) |
0 |
| 8 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 9 |
major |
int |
iBeacon Major值 (0~65535) |
10001 |
| 10 |
measuredPower |
int |
RSSI参考值 (1米处的RSSI) |
-59 |
| 11 |
message |
String |
执行返回结果。密码错误时,返回`wrong password` |
ok |
| 12 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 13 |
minor |
int |
iBeacon Minor值 (0~65535) |
12345 |
| 14 |
source |
String |
指令回复“command" |
command |
| 15 |
success |
boolean |
执行结果 |
true |
| 16 |
txPower |
int |
发射功率 (单位: dBm) |
0 |
| 17 |
uuid |
String |
iBeacon UUID (32位十六进制) |
47656D654F70656E0000000000000000 |
| 18 |
version |
String |
当前固件版本号 |
1.0.0 |
| 19 |
voltage |
float |
电池电压,单位 mV |
3000 |
auth-verify-a
指令简介
验证失败时,仅返回基本状态:
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
auth-verify |
| 2 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
wrong password |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
false |
auth-verify-b
指令简介
密码功能未启用时,`auth` 请求也会直接成功,但不会携带设备信息:
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
auth-verify |
| 2 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
auth not enabled |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
auth-verify-c
指令简介
当密码已启用但当前连接未验证时,除 `auth` 类型外的所有指令将返回
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
|
| 2 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
auth required |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
false |
controller-event
指令简介
控制设备蜂鸣器的开启和关闭,可用于寻找设备。key=1 时蜂鸣器每秒响一次,key=0 时停止。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
key |
int |
蜂鸣器控制 (1=开始响, 0=停止) |
0 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
key |
int |
当前蜂鸣器状态 (1=响, 0=停) |
0 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果。蜂鸣器控制缺少 `key`时,返回`missing key`。蜂鸣器 `key` 不是 0 或 1时,返回`invalid key` |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
controller-reset
指令简介
恢复出厂设置后配网信息和自定义信息都会清空,请谨慎操作!
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
system |
String |
重置/恢复出厂设置默认填"reset" |
reset
|
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
| 7 |
type |
String |
设备设置固定值"setting" |
setting |
error
指令简介
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
error |
| 2 |
mac |
String |
wifi设备MAC地址或4G设备的IMEI号,唯一标识 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果。响应内容超过发送缓冲区时,返回`response too large`。未知 `type`时,返回`unknown type` |
unknown type |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
false |
info-all
指令简介
获取设备信息一般会包含:设备通断电状态、MAC/IMEI、固件版本、设备内网IP地址、设备WIFI网络名称等信息,不同的产品返回的信息有所差异
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
查询类型固定值"info" |
info |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
advInterval |
int |
广播频率 (单位: ms) |
1000 |
| 2 |
authEnable |
int |
密码开关 (0=关闭, 1=启用) |
1 |
| 3 |
authTimeout |
int |
密码超时时间 (秒), 仅 authEnable=1 时返回 |
15 |
| 4 |
battery |
|
当前电量百分比 |
98 |
| 5 |
code |
String |
设备型号代码 |
GSSBM1B |
| 6 |
commandName |
String |
指令名称 |
info-all |
| 7 |
companyId |
String |
iBeacon Company ID (16进制) |
0x004C |
| 8 |
key |
int |
蜂鸣器状态 (0=停止, 1=响) |
0 |
| 9 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 10 |
major |
int |
iBeacon Major值 (0~65535) |
10001 |
| 11 |
measuredPower |
int |
RSSI参考值 (1米处的RSSI) |
-59 |
| 12 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 13 |
minor |
int |
iBeacon Minor值 (0~65535) |
12345 |
| 14 |
source |
String |
指令回复“command" |
command |
| 15 |
txPower |
int |
发射功率 (单位: dBm) |
0 |
| 16 |
uuid |
String |
iBeacon UUID (32位十六进制) |
47656D654F70656E0000000000000000 |
| 17 |
version |
String |
当前固件版本号 |
1.0.0 |
| 18 |
voltage |
float |
电池电压,单位 mV |
3000 |
setting-advInterval
指令简介
设置设备发送 iBeacon 广播包的时间间隔。值越小广播越频繁,手机扫描发现设备越快,但功耗也越高。默认 1000ms。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
advInterval |
int |
广播频率 (单位: ms) |
1000 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
|
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-auth
指令简介
设置设备的密码功能。启用后,BLE 连接建立时需在超时时间内通过密码验证,否则自动断开连接。可用于防止未授权用户修改设备配置。默认关闭,默认密码 0000,默认超时 15 秒。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
authEnable |
int |
密码开关 (0=关闭, 1=启用) |
0 |
| 2 |
authTimeout |
int |
密码超时时间 (秒), 仅 authEnable=1 时返回 |
15 |
| 3 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 4 |
password |
String |
密码 |
123456 |
| 5 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 3 |
message |
String |
执行返回结果。设置密码时缺少"authEnable"返回`missing authEnable`。`authEnable` 不是 0 或 1时,返回`invalid authEnable`。 |
ok |
| 4 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 5 |
source |
String |
指令回复“command" |
command |
| 6 |
success |
boolean |
执行结果 |
true |
| 7 |
type |
String |
设备设置固定值"setting" |
setting |
setting-companyId
指令简介
设置 iBeacon 广播包中的 Company ID(厂商标识)。标准 iBeacon 使用 Apple 的 Company ID 0x004C,如需自定义广播协议可修改此值。格式为十六进制字符串,默认 0x004C。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
companyId |
String |
iBeacon Company ID (16进制) |
0x004C |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-major
指令简介
设置 iBeacon 的 Major 值。Major 通常用于标识一组信标,例如同一栋建筑或同一楼层的所有信标可以共用相同的 Major 值。取值范围 0~65535,默认 10001。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
major |
int |
iBeacon Major值 (0~65535) |
10001 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-measuredPower
指令简介
设置设备在 1 米距离处的 RSSI 信号强度参考值,通过该值与实际接收到的 RSSI 对比来估算与信标的距离。需要在实际部署环境中测量校准。默认 -59。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
measuredPower |
int |
RSSI参考值 (1米处的RSSI) |
-59 |
| 2 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-minor
指令简介
设置 iBeacon 的 Minor 值。Minor 通常用于标识同一组内的单个信标,例如同一楼层中不同房间的信标使用不同的 Minor 值。取值范围 0~65535,默认 12345。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
minor |
int |
iBeacon Minor值 (0~65535) |
12345 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-txPower
指令简介
设置 BLE 射频发射功率。值越大信号越强、覆盖范围越远,但功耗也越高。默认 0 dBm。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
txPower |
int |
发射功率 (单位: dBm) |
0 |
| 3 |
type |
String |
设备设置固定值"setting" |
setting |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |
setting-uuid
指令简介
设置 iBeacon 的 UUID(通用唯一标识符)。UUID 用于标识信标所属的应用或组织,同一业务系统下的所有信标通常使用相同的 UUID。格式为 32 位十六进制字符(16 字节),默认 "GemeOpen" 对应的编码。
向设备发送指令
服务端向设备订阅topic发送消息
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 2 |
type |
String |
设备设置固定值"setting" |
setting |
| 3 |
uuid |
String |
iBeacon UUID (32位十六进制) |
47656D654F70656E0000000000000000 |
字段属性
| # |
字段名称 |
字段类型 |
字段说明 |
示例值 |
| 1 |
commandName |
String |
指令名称 |
setting |
| 2 |
count |
int |
本次成功应用的字段数量 |
1 |
| 3 |
mac |
String |
设备MAC地址 |
2026bb16aa14 |
| 4 |
message |
String |
执行返回结果 |
ok |
| 5 |
messageId |
String |
业务流水号。由请求方生成的唯一标识,响应方原样回显,用于请求与响应的关联匹配。
|
20260520 |
| 6 |
source |
String |
指令回复“command" |
command |
| 7 |
success |
boolean |
执行结果 |
true |
| 8 |
type |
String |
设备设置固定值"setting" |
setting |