Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

MQTT Broker Integration

Overview

The Embedded MQTT Broker integration provides a built-in MQTT interface within the Tektelic Network Server, allowing applications to publish and subscribe to device, gateway, and integration events without relying on external MQTT infrastructure.

This integration supports secure communication using per-integration credentials and isolated topic namespaces.


Creating an MQTT Broker Integration

  1. Navigate to Integrations
  2. Click Create Integration
  3. Filled in Name field
  4. Select MQTT_BROKER Integration type
  5. Select Data Converter (only V2 converter is allowed)
  6. Click Save

Figure 1 MQTT Broker Integration


Connection Details

After creating the integration, the following parameters are generated:

Parameter Description
MQTT Broker Address Broker hostname or IP
MQTT Port Non-TLS port (e.g., 1885)
MQTTS Port TLS port (e.g., 8885)
Username Integration-specific username/token
Password Generated API key
Uplink Topic Topic for receiving uplink messages
Downlink Topic Topic for sending downlink messages

MQTT Topics

integrations/v1/{integrationId}/{deviceEui}/uplink

To receive uplinks from all devices:

integrations/v1/{integrationId}/+/uplink

integrations/v1/{integrationId}/downlink

Connecting to the Broker

Example using mosquitto

mosquitto_sub -h <host> -p <port> -u <username> -P <password> -t "integrations/v1/{integrationId}/+/uplink"

Supported Payload Format (Standard)

{
  "deviceEui": "647FDA0300000000",
  "fPort": 10,
  "data": "AQID"
}

Parameters

Field Description
deviceEui Target device EUI
fPort LoRaWAN FPort
data Base64 encoded payload

Example using mosquitto

mosquitto_pub -h <host> -p <port> -u <username> -P <password> \
-t "integrations/v1/{integrationId}/downlink" \
-m '{"deviceEui":"647FDA0300000000","fPort":10,"data":"AQID"}'

  • Each integration has unique credentials
  • Topics are isolated per integration
  • Cross-integration access is not allowed
  • Unauthorized access attempts are rejected by the broker

Important Notes:

  • Downlink messages may not be delivered immediately
  • Delivery depends on device activity (uplink/RX window)
  • Messages may be queued until the next uplink

  • Invalid JSON payloads are ignored
  • Missing required fields (deviceEui, data, fPort) will result in no downlink
  • Legacy formats (e.g., devEUI, port) are not supported