MQTT Connector

Following chapter describes messages specific to MQTT Connector. The Pan ID (network ID) in the uplink topics is optional and can be excluded by adjusting the configuration settings.

Uplink

Topic	Description
{prefix}/server	Last Will and testament of Leaps Server. Empty message is published when the server gets disconnected from the broker. retained = true qos = 1

Topic

Description

{prefix}/gateway/{device Id}/uplink

Device configuration message.

See GatewayStatusAndConfig.

retained = true
qos = 1

Example:

t opic: dwm/gateway/deca1e1cef720714/uplink

{
 "networkId": 1,
 "bridgeNodeId":
 "-2393067142368852204",
 "version": {
  "release": "2.2.2",
  "firmware": [
   "1.4.2.0",
   "1.4.8.1"
  ]
 },
 "uwb": "CONNECTED_BH",
 "configuration": {
  "ipAddress": [
   "10.0.1.10"
  ],
  "ipMask": [
   "255.255.255.0"
  ],
  "ipGateway": [
   "10.0.1.138"
  ],
  "dns": [
   "8.8.8.8"
  ],
  "interface": "ETHERNET",
  "dhcp": true,
  "tls": "OFF",
  "server": "10.0.1.13",
  "port": 7777,
  "macFilter": false,
  "label": "0714",
  "uwbMode":
  "UWB_MODE_ACTIVE", "leds":
  true,
  "uwbFirmwareUpdate": true,
  "initiator": false,
  "uwbBridge": true,
  "position": {
   "x": -0.2,
   "y": 0.5,
   "z": 1,
   "quality": 100
  },
  "mac": [
   {
    "address":
    "1e:1c:ef:72:07:14", "type":
    "UWB, Mutable Default"
   },
   {
    "address":
    "dd:04:ed:c5:c7:f5", "type":
    "BLE, Mutable Default"
   },
   {
    "address":
    "02:04:25:30:30:35", "type":
    "Ethernet, Mutable Default"
   },
   {
    "address":
    "00:00:00:00:00:00", "type":
    "Wi-Fi, Empty"
   }
  ]
 },
 "timestamp":"1679494386282429"
}

Topic

Description

{prefix}/node/{deviceId}/ uplink/status

Device status. This topic is read only. See NodeStatusUplink.

retained = true
qos = 1

Example:

topic: dwm/node/0f07/uplink/status

{
 "present": true,
 "downlink": true,
 "batt": 100,
 "temp": 25,
 "timestamp":"1679494411479191"
}

Topic

Description

{prefix}/node/{deviceId}/ uplink/config

See NodeConfigUplink.

retained = true

qos = 1

Example:

topic: dwm/node/0f07/uplink/config

{
 "configuration": {
  "label": "DW0F07",
  "nodeType": "ANCHOR",
  "ble": true,
  "leds": true,
  "uwbFirmwareUpdate": true,
  "anchor": {
   "initiator": true,
   "position": {
    "x": 0,
    "y": 0,
    "z": 0,
    "quality": 0
   },
   "routingConfig":
   "ROUTING_CFG_OFF",
   "routingStatus":
   "ROUTING_STAT_INACTIVE"
  }
 },
 "timestamp":"1679494543479526"
}

Topic	Description
{prefix}/node/{deviceId}/ uplink/data	retained = false qos = 1 Example: topic: dwm/node/0012/uplink/data { "data": "q80=", "superFrameNumber": 673, "timestamp":"1679495576782275" } { "data": "ASNFZ4mrze8=", "superFrameNumber": 1028, "timestamp":"1679495612282922" }

Topic	Description
{prefix}/node/{deviceId}/ uplink/service	retained = false qos = 1 Example: topic: dwm/node/204c/uplink/service { "type": "TLV_API_ACK", "data": "QAEARgJexA==", "timestamp":"1679495457581967" }

Topic	Description
{prefix}/node/{deviceId}/ uplink/location	See NodeLocationUplink. retained = true qos = 0 Example: topic: dwm/node/aa01/uplink/location { "position": { "x": 3.25238609, "y": -0.00895162672, "z": 0.42510426, "quality": 21 }, "superFrameNumber": 1144, "timestamp":"1679495047880989" }

Downlink

Topic	Description
{prefix}/server	Request to the LEAPS Server. See ServerMessage. Example: topic: dwm/server { "request":"REFRESH_TOPICS" }

Topic

Description

{prefix}/gateway/{devi ceId}/downlink

See GatewayStatusAndConfig.

Example:

topic: dwm/gateway/DECAFA9FC2B38B86/downlink

{
 "configuration": {
  "ipAddress": [
   "10.0.0.202",
   "2001:0db8:85a3::1319:8a2e:0370:7344"
  ],
  "ipMask": [
   "255.255.255.0",
   "64"
  ],
  "ipGateway": [
   "10.0.0.1",
   "fe80::1"
  ],
  "dns": [
   "8.8.8.8",
   "2001:4860:4860::8888"
  ],
  "dhcp": true,
  "interface": "ETHERNET",
  "tls": "OFF",
  "server": "10.0.0.35",
  "port": 7777,
  "macFilter": false,
  "wifi": {
   "ssid": "mywifi",
   "password": "pass",
   "region": "EUROPE"
  },
  "label": "0123456789abcdef",
  "uwbMode":
  "UWB_MODE_ACTIVE",
  "leds": true,
  "uwbFirmwareUpdate": false,
  "initiator": false,
  "uwbBridge": true,
  "position": {
   "x": 0,
   "y": 1,
   "z": 2.5,
   "quality": 100
  }
 }
}

Topic

Description

{prefix}/node/{deviceI d}/downlink/config

See NodeConfigDownlink.

Example:

topic: dwm/node/0f07/downlink/config

{
 "configuration": {
  "label": "DW0F07",
  "nodeType": "ANCHOR",
  "ble": true,
  "leds": true,
  "uwbFirmwareUpdate": true,
  "anchor": {
   "initiator": true,
   "position": {
    "x": 0,
    "y": 0,
    "z": 0,
    "quality": 0
   },
   "routingConfig":
   "ROUTING_CFG_OFF",
   "routingStatus":
   "ROUTING_STAT_INACTIVE"
  }
 }
}

Topic	Description
{prefix}/node/{deviceI d}/downlink/service	See NodeServiceDownlink. Example: topic: dwm/node/204c/downlink/service { "data": "CAA=", "type": "TLV_API_CMD" }

Topic	Description
{prefix}/node/{deviceI d}/downlink/data	Example: topic: dwm/node/204c/downlink/data { "data": "QUJDREVGR0hJSktMTU5PUFFSU1Q=", "overwrite": true }