MQTT Message Reference

Common

anchor_config

Field	Type	Label	Description
initiator	bool	required	UWB initiator mode enable.
location	node_location	required	Location of the node.
routing	routing_config	required	Routing configuration.
bridge	bool	optional	UWB bridge mode enable.

node_location

Field	Type	Label	Description
x	float	required	X coordinate in meters.
y	float	required	Y coordinate in meters.
z	float	required	Z coordinate in meters.
quality	uint32	required	Quality factor from 0% to 100%.
sd_x	float	optional	Standard deviation of X coordinate in meters.
sd_y	float	optional	Standard deviation of Y coordinate in meters.
sd_z	float	optional	Standard deviation of Z coordinate in meters.
r95	float	optional	R95 of locations in meters.
x_err	float	optional	Error of X coordinate compared to reference location in meters.
y_err	float	optional	Error of Y coordinate compared to reference location in meters.
z_err	float	optional	Error of Z coordinate compared to reference location in meters.
toa	node_toa_measurement_statistics	repeated	Statistics of Time Of Arrival measurements.

node_status

Field	Type	Label	Description
origins	origin_info	repeated	List of origins.
profile	uwb_profile	optional	Current UWB profile.
uwb	uwb_status	optional	UWB status.
sensor	sensor_status	optional	Status of the sensors.
route_active	bool	optional	Indicate the gateway is a route candidate for the node.

node_toa_measurement_statistics

Field	Type	Label	Description
anchor_id	uint32	required	Anchor ID.
sd_tdoa	float	required	Standard deviation of Time of Arrival measurement.

origin_info

Field	Type	Label	Description
id	uint64	required
hop_level	uint32	required

sensor_status

Field	Type	Label	Description
batt	uint32	required	Battery level in mV.
batt_state	uint32	optional	Indicates the battery status, 0-Unknown \| 1-Empty \| 2-Low \| 3-Medium \| 4-Full.
temp	int32	required	Temperature in degrees.

service_data

Field	Type	Label	Description
type	service_type	required	Type of the service request or the type of the response. Refer to service_type.
data	bytes	optional	Opaque service data bytes encoded as base64.

tag_config

Field	Type	Label	Description
location_engine	bool	required	Internal location engine enable.
low_power	bool	required	Low power mode enable.
stationary_detection	bool	required	Stationary detection enable.
update_rate_nominal	uint32	required	Nominal update rate in multiply of superframe interval.
update_rate_stationary	uint32	required	Stationary update rate in multiply of superframe interval..
reference_location	node_location	optional	Reference location of the tag.

uwb_profile

Field	Type	Label	Description
sfn_range	uint32	required	Superframe number range.
microseconds_per_sf	uint32	required	Microseconds per superframe.
microseconds_per_slot	uint32	required	Microseconds per slot.
update_rate_default	uint32	required	Update rate is in multiple of superframes.
uplink_latency	uint32	optional	Number of slots to wait before the time of arrival data that has been received are processed by the internal location engine.
node_signup_optional	bool	optional	Setting this to “true” means that signup is not required for any of the edge nodes (not gateway nodes), signup is required by default if this parameter is not set or if it is set to “false”.
latency	uint32	optional	Ethernet latency in number of superframes, the latency is considered when sending downlink, latency is supposed ot be 0 if this is not set
max_buffer_size_downlink	uint32	optional	Size is supposed to be unlimited if not set.

uwb_rf_config

Field	Type	Label	Description
chnl	uint32	required	Channel configuration.
rf_cpl	uint32	required	RF compliance configuration.
pcode	uint32	optional	Preamble code configuration.

version_info

Field	Type	Label
maj	uint32	required
min	uint32	required
patch	uint32	required
var	uint32	optional

wifi_config

Field	Type	Label
ssid	string	required
password	string	required
region	wifi_region	optional

interface_config

Name	Number	Description
ETHERNET	0
WIFI	1

mac_address_type

Name	Number	Description
EMPTY	0	MAC address is empty meaning that the interface is not present.
DEFAULT	1	Default MAC address (cannot be changed).
USER_SPECIFIED	2	MAC address specified by the user (can be changed).
MUTABLE_DEFAULT	3	Default MAC address that can be changed only once by the user.

routing_config

Name	Number	Description
ROUTING_OFF	0	UWB routing is turned off.
ROUTING_ON	1	UWB routing is active.
ROUTING_AUTO	2	Automatic UWB routing.

service_type

Name	Number	Description
GET_CONFIG	0	Request to send configuration.
TLV_API_CMD	1	TLV API command.
TLV_API_ACK	2	TLV API command positive acknowledge.
TLV_API_NACK	3	TLV API command negative acknowledge.

tls_config

Name	Number	Description
OFF	0	TLS/SSL turned off.
SERVER	1	TLS authentication of server.
MUTUAL	2	Two way TLS authentication of server and the gateway/client.
SERVER_CN	3	TLS authentication of server with checking of the ‘Common Name’.
MUTUAL_CN	4	Two way TLS authentication of server and the gateway/client with checking of the ‘Common Name’.

uwb_mode_config

Name	Number	Description
UWB_MODE_OFFLINE	0
UWB_MODE_PASSIVE	1
UWB_MODE_ACTIVE	2

uwb_status

Name	Number	Description
DISCONNECTED	0	Disconnected from the UWB network.
CONNECTED	1	Connected to the UWB network.
CONNECTED_BH	2	Connected, backhaul possible.
UPDATING_FW	3	UWB firmware update is in progress.
UWBS_INACTIVE	4	Data from UWBS is not coming.

wifi_region

Name	Number	Description
EUROPE	0
NORTH_AMERICA	1
ASIA	2

leaps_api

leaps_api.inet_config

TCP/IP configuration options.

Field	Type	Label	Description
ip	leaps_api.ip_config	repeated	IP configuration.
dns	string	repeated	DNS host.
iface	interface_config	required	Interface selection.
tls	tls_config	required	TLS/SSL configuration.
dhcp	bool	required	DHCP enabled?
mac_filter	bool	required	MAC filter enabled?
server	leaps_api.inet_config.server_config	required	Leaps server configuration.

leaps_api.inet_config.server_config

Field	Type	Label	Description
host	string	required	Leaps server host configuration.
port	uint32	required	Leaps server port configuration.

leaps_api.ip_config

Field	Type	Label	Description
addr	string	required	IP address.
mask	string	optional	IP address mask.
gateway	string	optional	Gateway IP address.

leaps_api.location

Topic: {prefix}/{panId/}node/uplink/location/{deviceId}.

Field	Type	Label	Description
location	node_location	required	Location of the device.
timestamp	uint64	optional	Timestamp in microseconds.

leaps_api.mac_config

Configuration of the MAC address.

Field	Type	Label	Description
addr	string	required	MAC address in dot-notation.
type	mac_address_type	required	Type of the MAC address. Refer to mac_address_type.
iface	string	required	Interface that the MAC address belong to. Refer to mac_address_interface.

leaps_api.node_config

Topic: {prefix}/{panId/}{node|gateway}/{uplink|downlink}/config/{deviceId}.

Field	Type	Label	Description
label	string	required	Device label.
uwb_mode	uwb_mode_config	required	UWB mode configuration.
ble	bool	required	BLE enabled?
leds	bool	required	LEDs enabled?
fw_update	bool	required	Firmware update enabled?
anchor	anchor_config	optional	Anchor-specific configuration.
tag	tag_config	optional	Tag-specific configuration.
inet	leaps_api.inet_config	optional	TCP/IP configuration
wifi	wifi_config	optional	Wi-Fi configuration.
mac	leaps_api.mac_config	repeated	MAC address configuration.
timestamp	uint64	optional	Timestamp in microseconds.
uwb_rf_config	uwb_rf_config	optional	UWB channel, preamble code and RF compliance configuration.

leaps_api.server_status

Leaps server status uplink topic: {prefix}/server/status.

Field	Type	Label	Description
state	leaps_api.connection_state	optional	Status of the Leaps server. Refer to server_state.
version	string	optional	Leaps Server version.

leaps_api.server_request

Leaps server request downlink topic: {prefix}/server/request.

Field	Type	Label	Description
request	leaps_api.server_request.type:	optional	Request to the Leaps server.

leaps_api.server_request.type:

Name	Number	Description
REFRESH_TOPICS	0	DEPRECATED: Same as PUBLISH_ALL_TOPICS.
PUBLISH_ALL_TOPICS	1	Request to immediately publish all messages for all the nodes.

leaps_api.service_data

Topic: {prefix}/{panId/}node/{uplink|downlink}/service/{deviceId}.

Field	Type	Label	Description
type	service_type	required	Type of the server data.
data	bytes	optional	The data bytes encoded as base64.
timestamp	uint64	optional	Timestamp in microseconds.

leaps_api.status

Topic: {prefix}/{panId}/{node|gateway}/uplink/status/{deviceId}.

Field	Type	Label	Description
present	bool	required	Device is present or missing?
downlink	bool	optional	Sending downlink to the device is possible?
uwb	uwb_status	optional	Status of the UWB layer.
batt	uint32	optional	Battery status in mV.
batt_state	uint32	optional	Indicates the battery status, 0-Unknown \| 1-Empty \| 2-Low \| 3-Medium \| 4-Full.
temp	int32	optional	Temperature in degrees.
origins	origin_info	repeated	List of UWB origins.
profile	uwb_profile	optional	Current UWB profile status.
timestamp	uint64	optional	Timestamp in microseconds.

leaps_api.user_data

Topic: {prefix}/{panId}/node/{uplink|downlink}/data/{deviceId}.

Field	Type	Label	Description
data	bytes	required	The data bytes encoded as base64.
overwrite	bool	optional	Overwrite the pending data?
timestamp	uint64	optional	Timestamp in microseconds.

leaps_api.mac_address_interface

Supported interfaces in terms of MAC addresses configuration.

Name	Number	Description
UWB	0
BLE	1
ETHERNET	2
WIFI	3

leaps_api.connection_state

Name	Number	Description
DISCONNECTED	0	Leaps server is disconnected from MQTT broker.
CONNECTED	1	Leaps server is connected to MQTT broker.