Configure MQTT from the Administration dashboard

You can configure MQTT for a device group.

  1. Access the Digi Axess Admin page. You must have Admin or Device User privileges to access this page.

  2. From the Data Export section in the Admin dashboard, click Add next to the MQTT Configuration label. As an alternative, you can click MQTT Configuration from the dashboard pane to the left of the page and then click Add MQTT Configuration at the top of the page. The General Settings page displays.

  3. Begin configuration in the General Settings page.

    1. From the Device Group list box, select the device group for which you want to configure MQTT. This configuration is available for all devices in the device group.

    2. In the Description field, enter a descriptive name for the configuration. The name must be unique for the device group.

  4. Click the green arrow at the top of the page. The MQTT Configuration page displays.

  5. Enable the MQTT service and continue with configuration in the MQTT Configuration page.

    Field Description

    MQTT Enabled

    Click MQTT Enabled to enable the MQTT service. The toggle button is green when the service is enabled.

    MQTT Spec

    Select the option that determines the format of the MQTT data and from where the data is sent. Options are:

    • MQTT on Device - No Formula Support: Raw data is sent. This is the default.

    • Digi Axess Single Value - Formula Support: A separate topic per value is sent, and includes only current data.

    • Digi Axess JSON - Formula Support: A single topic for all values is sent, and includes current and historical data.

    Send Sample Data to Digi Axess

    Enable Send Sample Data to Digi Axess if you want to send sample data to Digi Axess for further processing. This is disabled by default, and when it is disabled, no data is sent to Digi Axess.

    QoS

    Currently only one MQTT quality of service level is available.

    The 0 - at most once option is selected by default.
    Publish Retain Enable Publish Retain if you want to enable the retain flag on published messages. This is disabled by default.

    MQTT Version

    		Select the MQTT version that you want to use.

    MQTT Topic Prefix

    In the MQTT Topic Prefix field, enter the MQTT topic prefix to use. The following variables are supported: $Model, $LocationName, and $SerialNumber.

    The MQTT topic preview space previews what the topic will be when the variables are resolved and the postfix is added.

    MQTT Topic Preview

    		Previews what the topic will be when the variables defined in the MQTT Topic Prefix are resolved and the postfix is added.

  6. Click the green arrow at the top of the page. The MQTT Broker Configuration page displays.

  7. Configure the MQTT broker.

    Field Description

    MQTT Broker Host

    Enter MQTT the broker host to which data is sent.

    The MQTT broker host must be unique.

    MQTT Broker Port

    Enter the number of the MQTT Broker port to which data should be sent.

    Username

    Enter the user name to authenticate with the broker.

    Password

    Enter the password to authenticate with the broker.

    Click the eye icon next to the field to toggle the password display.

    TLS Enabled

    Enable TLS.

    TLS Cert Check

    Enables checking the broker identity with a certificate.

  8. Click Add. The MQTT configuration is saved. The MQTT Configuration page displays, and includes the new configuration.