MQTT 消息参考
本页描述每个 API 定义的细节
锚点配置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
启动器 |
bool |
必填 |
|
位置 |
位置 |
可选 |
锚点位置坐标 |
路由配置 |
路由锚点配置 |
必填 |
路由配置 |
路由状态 |
路由锚点状态 |
可选 |
路由信息 - 仅对上行链路有效,只读 |
Fw 版本
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
发布 |
字符串 |
可选 |
|
固件 |
字符串 |
重复 |
内核位置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
x |
字节 |
必填 |
坐标为不透明字节序列,内核驱动无法在内核空间中使用浮点运算
|
y |
字节 |
必填 |
|
z |
字节 |
必填 |
|
质量 |
uint32 |
必填 |
质量因子(0-100),PB 使用可变长度编码,无需担心长度问题.
|
MacConfig
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
地址 |
字符串 |
必填 |
|
类型 |
字符串 |
必填 |
空, 默认, 用户指定, 可变默认 |
网关配置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
ip地址 |
字符串 |
重复 |
IP 地址, 掩码和 IP 网关列表 |
ipMask |
字符串 |
重复 |
|
ip网关 |
字符串 |
重复 |
|
dns |
字符串 |
重复 |
DNS 配置 |
界面 |
字符串 |
必填 |
接口类型 ETHERNET, WIFI, … |
dhcp |
bool |
必填 |
DHCP 配置 |
tls |
字符串 |
必填 |
TLS 配置 OFF, SERVER, MUTUAL, SERVER_CN, MUTUAL_CN |
服务器 |
字符串 |
必填 |
服务器地址和端口 |
port |
uint32 |
必填 |
|
mac过滤 |
bool |
必填 |
MAC 过滤 配置 |
wifi |
WifiConfig |
可选 |
WIFI 配置,如果此字段出现在上行链路信息中,则 WIFI 是可用的,并且可以进行配置 |
mac |
MacConfig |
重复 |
接口 MAC 地址的只读列表
|
标签 |
字符串 |
必填 |
UWB 节点标签 |
uwbMode |
UwbMode |
必填 |
UWB 模式 0 - 离线,1 - 被动,2 - 主动 |
leds |
bool |
必填 |
启用或禁用 LED 指示灯 |
uw bFirmwareUpdate |
bool |
必填 |
启用/禁用固件更新 |
启动器 |
bool |
必填 |
UWB 锚点启动器 |
uwbBridge |
bool |
必填 |
UWB 桥接 |
位置 |
位置 |
必填 |
网关位置 |
网关状态和配置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
networkId |
uint32 |
可选 |
UWB网络 ID |
bridgeNodeId |
sfixed64 |
可选 |
连接KD到服务器的桥接节点的标识 |
版本 |
Fw 版本 |
可选 |
固件版本号 |
uwb |
字符串 |
可选 |
|
配置 |
网关配置 |
可选 |
配置选项 |
调试日志 |
调试日志 |
可选 |
将传递给网关 |
时间戳 |
uint64 |
可选 |
以微秒为单位的时间戳 |
节点配置链接
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
配置 |
节点配置 |
必填 |
可通过API修改配置 |
时间戳 |
uint64 |
可选 |
以微秒为单位的时间戳 |
节点数据下行链路
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
数据 |
字节 |
必填 |
不透明数据(最多36字节) |
重写 |
bool |
可选 |
标志 |
NodeServiceDownlink
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
类型 |
字符串 |
必填 |
TLV_API |
数据 |
字节 |
必填 |
表示 API 调用的 TLV 编码二进制数据 |
NodeServiceUplink
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
类型 |
字符串 |
必填 |
TLV_API_ACK, TLV_API_NACK |
数据 |
字节 |
可选 |
TLV 编码的API调用响应 |
时间戳 |
uint64 |
可选 |
以微秒为单位的时间戳 |
NodeStatusUplink
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
现在 |
bool |
可选 |
存在时为 true,不存在时为 false |
下行链路 |
bool |
可选 |
如果可能则为true,如果不可能则为false |
lqi |
uint32 |
可选 |
链接质量指示: 0=差 1=好 |
batt |
uint32 |
可选 |
电池电量百分比 |
temp |
uint32 |
可选 |
温度摄氏度 |
时间戳 |
uint64 |
可选 |
以微秒为单位的时间戳 |
NodeConfiguration
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
标签 |
字符串 |
必填 |
通用配置属性 |
nodeType |
操作模式 |
必填 |
|
ble |
bool |
必填 |
|
leds |
bool |
必填 |
|
uw bFirmwareUpdate |
bool |
必填 |
|
锚点 |
锚点配置 |
可选 |
either-or: 与操作模式锚点特定同步 |
标签 |
标签配置 |
可选 |
特定标签 |
位置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
x |
浮动 |
必填 |
坐标 |
y |
浮动 |
必填 |
|
z |
浮动 |
必填 |
|
质量 |
uint32 |
必填 |
质量因子(0-100),PB 使用可变长度编码,无需担心长度问题.
|
标签配置
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
静态检测 |
bool |
必填 |
检测静止状态~加速计 |
响应 |
bool |
必填 |
响应模式~低功耗 |
定位引擎 |
bool |
必填 |
定位? |
nomUpdateRate |
uint32 |
必填 |
名义(常规)更新率 |
statUpdateRate |
uint32 |
必填 |
静态更新率(如果启用了统计检测) |
WifiConfig
字段 |
类型 |
标签 |
描述 |
---|---|---|---|
ssid |
字符串 |
必填 |
|
密码 |
字符串 |
必填 |
|
地区 |
字符串 |
必填 |
EUROPE, NORTH_AMERICA, ASIA |
操作固件
名称 |
编号 |
描述 |
---|---|---|
FW1 |
0 |
|
FW2 |
1 |
操作模式
名称 |
编号 |
描述 |
---|---|---|
标签 |
0 |
|
锚点 |
1 |
路由锚配置
名称 |
编号 |
描述 |
---|---|---|
ROUTING_CFG_OFF |
0 |
|
ROUTING_CFG_ON |
1 |
|
ROUTING_CFG_AUTO |
2 |
路由锚定状态
名称 |
编号 |
描述 |
---|---|---|
ROUTING_STAT_INACTIVE |
0 |
|
ROUTING_STAT_SELECTED |
1 |
|
ROUTING_STAT_ACTIVE |
2 |
UwbMode
名称 |
编号 |
描述 |
---|---|---|
UWB_MODE_OFFLINE |
0 |
|
UWB_MODE_PASSIVE |
1 |
|
UWB_MODE_ACTIVE |
2 |
服务器节点列表
领域 |
类型 |
标签 |
描述 |
---|---|---|---|
网络 |
uint32 |
必填 |
UWB网络panID. |
节点 |
字符串 |
重复 |
UWB节点ID/地址为十六进制数. |