Skip to main content

Niagara-Based Supervisors

note

All the following operations have been performed on IQVision version 4.14.

Create a new device and get certificates

Open the Settings menu in the Diologi chatbot and select New device (refer to the Connect Your Device section for detailed instructions). You will then be prompted to download a security certificate for your device.

tip

Keep this certificate in a secure place, or better yet, remove it after establishing the connection between Niagara and Diologi.

Upload the certificate to Niagara

  1. Open Platform in Niagara and double-click on Certificate Management.

  2. Select the User Key Store tab and click Import.

    1 - Certificate Management

  3. In the dialog window that opens, select the generated full-chain device certificate.

    2 - Certificate Management - importing certificate

  4. Enter an Alias for the certificate and an encryption password.

    3 - Certificate Management - Enter Alias

    4 - Certificate Management - enter the password

    tip

    Save the alias and remember the password. You will need them when setting up the MQTT driver configuration for the Station.

  5. Make sure the certificate has been successfully imported: it should appear in the table of certificates and have a green tick next to its Alias.

    5 - Certificate Management - certificated successfully added

Configure an MQTT Driver for communication

  1. In the Nav sidebar, open Station -> Config -> Drivers.

  2. If the Palette sidebar is not visible, go to the Window menu, select Sidebars, and then choose Palette.

    6 - Config - Open config and Palette

  3. In the Palette, click the Open icon, find abstractMQTTDriver, and click OK.

    7 - Palette - Select abstractMQTTDriver

  4. From the Palette, drag and drop AbstractMqttDriverNetwork to the Drivers folder in the Nav tree.

  5. Similarly, drag and drop AbstractMqttDevice from the Palette to AbstractMqttDriverNetwork.

  6. Then, drag and drop DefaultAuthenticator from the Palette to AbstractMqttDevice.

    8 - Config - drag-and-drop AbstractMqttNetworkDriver

    9 - Config - drag-and-drop AbstractMqttDevice

    10 - Config - drag-and-drop DefaultAuthenticator

Set up Connection Settings

To configure the connection, open the properties of DefaultAuthenticator in the Nav sidebar and set the following:

  • Broker Endpoint:
    mqtt.diologi.com
  • Client ID: Enter your Device ID here. You can find the Device ID in the chatbot Settings selecting your device from the list.
  • Broker Port:
    8883
  • Connection Type: Select Anonymous Over SSL.
  • Use TLS Client Auth: Set to True.
  • Certificate Alias and Password: Enter the Alias and password that were set when importing the certificate. The Alias can be found in Platform under the Upload the certificate to Niagara section.

Save the configuration.

11 - Config - Authenticator settings

info

If the password is lost, you will have to remove the certificate from the Certificate Manager and import it again with a new password.

To check that the connection with the Diologi server has been established, open the Property Sheet of AbstractMqttDevice. Ensure that Health Status shows Ok and Status Message shows Ping Success: Connected to Broker.

12 - Config - MqttDriver Properties - connected

tip

If the connection hasn’t been established automatically, right-click on AbstractMqttDevice, find Actions, and click Connect. After that, open Actions again and click Ping. This should force a connection request to the server.

Set up MQTT Points

  1. Open the Mqtt Client Driver Point Manager and click the Discover button.

  2. Select the points that you want to make available for use in Diologi Chatbot and click ADD.

    13 - Points - Discover and Add points

  3. In the Add window that opens, select the Type:

    • Publish: If you want to send data to Diologi chatbot for reading actual values.
    • Subscribe: If you want to change a value from Diologi.

    14 - Points - Set Topics

    info

    If you want to read and change the value of the same point, you will have to add it twice: once as a Publish Point and once as a Subscribe Point. The Topics for both should be identical.

  4. Set the Topic starting with the device ID.

    MQTT topics on your field device must exactly match the topics defined in the Excel file, including the device ID at the beginning.

    note

    The topic must not start or end with a slash (/). The slash should only be used to separate topic segments.

Once you have added all the points needed to be accessible from the Diologi chatbot in the Database, the configuration of Niagara is complete.

The next step is to configure these points on the Chatbot side, where you can set allowed ranges for changeable points, define their location in the menu structure, and add keywords for the AI so it can understand the correct context for those points. You will find detailed guidance on this in the Set Up MQTT Communication section.

Export MQTT points for Diologi

If you have many points to set up in Diologi, you may find the export function from Niagara to CSV format useful.

  1. Select all the MQTT points on the Database tab in Niagara.
  2. Right-click and select Export from the context menu.
  3. In the export window that opens, set Select Explorer to AX Table to CSV and choose Save to file.

16 - Points - Export points

17 - Points - Export points - select CSV format

  1. Open the generated CSV file and copy-paste the topics to the Points Configuration Template in Excel for uploading to the Diologi chatbot.

    17 - Points - Export points - select CSV format