Skip to main content
Skip table of contents

Configuring MQTT Settings

This article provides information on how to configure and save a new connection to the MQTT broker.

Adding a New Connection

In the ZeroKey Dashboard, navigate to the Integration tab and click MQTT Settings. Then, click the + Add Connection button on the top right corner of the page.

image-20240527-180317.png

A window will then pop up, prompting you to enter the following details:

  1. Host (required):

    • Enter the hostname or IP address of the MQTT broker.

  2. Port (required):

    • Enter the port number in which the MQTT broker is listening. The default MQTT port is 1883. If you’re using TLS, which is encrypted traffic, the default port is 8883.

  3. Username (optional):

    • Enter your username if the MQTT broker requires authentication. If authentication is not required, leave it blank.

  4. Password (optional):

    • Enter the corresponding password.

  5. TLS (optional):

    • Select Yes if the connection is secured using TLS. Otherwise, select No.
      Note: If TLS is required, ensure to use the default port (1883) to successfully establish a connection.

  6. Topic (required):

    • Enter the MQTT topic that this connection will subscribe or publish messages to.

  7. Filter (required):

    • When setting up a new connection, you can define advanced message filtering rules to process only specific data based on the requirements. The filtering rules utilize selectors and matching criteria.

      1. Under Filter Template, you can select a predefined template to automatically configure filters based on the most used by other users. If you want to select one of the predefined templates, click the dropdown menu under Filter Template and select one of the predefined rules. If you prefer to set your own rules, select None.

      2. The Selector defines the criteria of the message that will be checked by the filter.

      3. The Type allows you to choose between string (the filter will look for a specific string within the data) and regex (the filter will apply regular statements to the message content to determine matches).

  8. Add Child:

    • This function allows the ability to add more filter criteria to the current filter.

  9. Add Filter:

    • This function allows the ability to add the defined filter to the connection settings.

  10. Add Topic:

    • This function allows the ability to add more topic fields to enable the connection to handle multiple topics at once.

After filling out the required fields, click the Submit button located on the bottom right corner.

image-20240527-173420.png

You will then see the connection added in the MQTT Settings tab.

image-20240527-173456.png

Connection Management Options

After successfully adding an MQTT connection, you can either edit or delete the entry.

Editing the Connection:

  • To adjust the current MQTT settings, click the pen icon located to the right, as shown below.

Deleting the Connection:

  • To delete the connection, click the bin icon – also shown below.

    • A confirmation prompt will pop up to ensure that removal is intentional. Click Cancel to abandon the deletion process and Confirm to permanently delete the connection.

image-20240527-174849.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.