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