MQTT Message Reference

This page describes the detail of each API definition

AnchorConfiguration

Field	Type	Label	Description
initiator	bool	required
position	Position	optional	Anchor position coordinates
routingConfig	Rout ingAnchorConfig uration	required	routing configuration
routingStatus	Rout ingAnchorStatus	optional	routing info - valid for uplink only, read-only

---

FwVersion

Field	Type	Label	Description
release	string	optional
firmware	string	repeated

---

KernelPosition

Field	Type	Label	Description
x	bytes	required	coordinate as opaque bytes sequence, kernel driver cannot operate with floats in kernel space
y	bytes	required
z	bytes	required
quality	uint32	required	quality factor (0-100), PB uses variable length encoding, no worries about the length

---

MacConfig

Field	Type	Label	Description
address	string	required
type	string	required	EMPTY, DEFAULT, USER_SPECIFIED, MUTABLE_DEFAULT

---

GatewayConfig

Field	Type	Label	Description
ipAddress	string	repeated	List of IP addresses, masks and IP gateways
ipMask	string	repeated
ipGateway	string	repeated
dns	string	repeated	DNS configuration
interface	string	required	Interface type ETHERNET,WIFI, …
dhcp	bool	required	DHCP configuration
tls	string	required	TLS configuration OFF, SERVER, MUTUAL, SERVER_CN, MUTUAL_CN
server	string	required	Server address and port
port	uint32	required
macFilter	bool	required	MAC filter configuration
wifi	WifiConfig	optional	WIFI configuration, the WIFI is available and it can be configured if this field appears in the uplink message
mac	MacConfig	repeated	read only list of MAC addresses of the interfaces
label	string	required	UWB node label
uwbMode	UwbMode	required	UWB mode 0 - offline, 1 - passive, 2 - active
leds	bool	required	enable or disable LEDs
uw bFirmwareUpdate	bool	required	firmware update enable/disable
initiator	bool	required	UWB anchor initiator
uwbBridge	bool	required	UWB bridge
position	Position	required	gateway position

---

GatewayStatusAndConfig

Field	Type	Label	Description
networkId	uint32	optional	UWB network id
bridgeNodeId	sfixed64	optional	Identification of the bridge node which is connected to KD to the server
version	FwVersion	optional	Firmware version numbers
uwb	string	optional	UWB status: connected, connected_bh, disconnected, updating_fw
configuration	GatewayConfig	optional	configuration options
debugLog	DebugLog	optional	to be passed to the Gateway
timestamp	uint64	optional	timestamp in microseconds

---

NodeConfigDownlink

Field	Type	Label	Description
configuration	Node Configuration	required	what can be changed from client

---

NodeConfigUplink

Field	Type	Label	Description
configuration	Node Configuration	required	modifiable configuration can be changed via API
timestamp	uint64	optional	timestamp in microseconds

---

NodeDataDownlink

Field	Type	Label	Description
data	bytes	required	opaque data (max 36 bytes)
overwrite	bool	optional	flags

---

NodeDataUplink

Field	Type	Label	Description
data	bytes	required	opaque data (max 40 bytes)
superFrameNumber	uint32	optional
timestamp	uint64	optional	timestamp in microseconds

---

NodeLocationUplink

Field	Type	Label	Description
position	Position	required	embedded position
superFrameNumber	uint32	optional	superframe
timestamp	uint64	optional	timestamp in microseconds

---

NodeServiceDownlink

Field	Type	Label	Description
type	string	required	TLV_API
data	bytes	required	TLV encoded binary data that represent API call

---

NodeServiceUplink

Field	Type	Label	Description
type	string	required	TLV_API_ACK, TLV_API_NACK
data	bytes	optional	TLV encoded API call response
timestamp	uint64	optional	timestamp in microseconds

---

NodeStatusUplink

Field	Type	Label	Description
present	bool	optional	true if present, false if non-present
downlink	bool	optional	true if possible, false if non-possible
lqi	uint32	optional	Link quality indication: 0=poor 1=good
batt	uint32	optional	battery level in percents
temp	uint32	optional	temperature in degrees of celsius
timestamp	uint64	optional	timestamp in microseconds

---

NodeConfiguration

Field	Type	Label	Description
label	string	required	common configuration properties
nodeType	OperationMode	required
ble	bool	required
leds	bool	required
uw bFirmwareUpdate	bool	required
anchor	AnchorConfiguration	optional	either-or: in sync with Operation Mode anchor specific
tag	TagConfiguration	optional	tag specific

---

Position

Field	Type	Label	Description
x	float	required	coordinates
y	float	required
z	float	required
quality	uint32	required	quality factor (0-100), PB uses variable length encoding, no worries about the length

---

TagConfiguration

Field	Type	Label	Description
stat ionaryDetection	bool	required	detect stationary state ~ accelerometer
responsive	bool	required	responsive mode ~ low-power
locationEngine	bool	required	locate?
nomUpdateRate	uint32	required	nominal (regular) update rate
statUpdateRate	uint32	required	static update rate (if stat ionaryDetection is turned on)

---

WifiConfig

Field	Type	Label	Description
ssid	string	required
password	string	required
region	string	required	EUROPE, NORTH_AMERICA, ASIA

---

OperatingFirmware

Name	Number	Description
FW1	0
FW2	1

---

OperationMode

Name	Number	Description
TAG	0
ANCHOR	1

---

RoutingAnchorConfiguration

Name	Number	Description
ROUTING_CFG_OFF	0
ROUTING_CFG_ON	1
ROUTING_CFG_AUTO	2

---

RoutingAnchorStatus

Name	Number	Description
ROUTING_STAT_INACTIVE	0
ROUTING_STAT_SELECTED	1
ROUTING_STAT_ACTIVE	2

---

UwbMode

Name	Number	Description
UWB_MODE_OFFLINE	0
UWB_MODE_PASSIVE	1
UWB_MODE_ACTIVE	2

---

UwbStatus

Name	Number	Description
DISCONNECTED	0
CONNECTED	1
CONNECTED_BH	2
UPDATING_FW	3

---

ServerRequest

Name	Number	Description
REFRESH_TOPICS	0	Request to immediately publish all messages for all the nodes.

---

ServerMessage

Field	Type	Label	Description
request	string	optional	Refer to ServerRequest

---

ServerNodeList

Field	Type	Label	Description
network	uint32	required	UWB network panID.
node	string	repeated	UWB node ID/address as hexadecimal number.