Client Tab

This document describes the settings for the connection to the MQTT server.

To create an MQTT source system, do the following:

  1. Create a source system of the type MQTT source system.

  2. Make the following settings on the Client tab:

    Settings for the MQTT Client

    Field

    Description

    Client ID

    ID that PCo uses to identify itself to the MQTT server. The client ID must be unique. Enter an ID with maximum 23 places. Numbers, lowercase letters, and uppercase letters are allowed.

    Alternatively, you can leave the Client ID field blank. When the connection to an MQTT server is established, a unique client ID is then generated automatically. This is important because there must always be a 1:1 relationship between the source system and the agent instance.

    Server URI

    You enter the URI of the MQTT server here. The URI schema can be built up as follows:

    • TCP connection (mqtt)

    • Secure Transport Layer Security (TLS) connection (mqtts)

      You can maintain security settings for the mqtts connection. (See also: Security Settings Tab.)

    • WebSocket (ws)

    • Secure WebSocket connection (wss)

      You can maintain security settings for the wss connection. (See also: Security Settings Tab.)

    User Name

    User name for the logon to the MQTT server

    Password

    Password for the logon to the MQTT server

    Response Timeout

    Indicates the period in which the MQTT server must send a response.

    Keep-Alive Interval

    Indicates the maximum time that is allowed to pass between two consecutive control packets that are sent by the PCo client. If there are no control packets that need to be sent, PCo sends a PINGREQ packet.

    If you set 0 here, no PINGREQ packets are sent.

    Clean Session if Connection Was Interrupted

    If you select the checkbox, any messages that have been missed during an interruption to the connection are not sent when the connection is restored.

    If you do not select the checkbox, and the connection is interrupted, the MQTT server sends all missed messages as soon as the connection has been restored.

  3. Choose Open the Client Configuration Wizard if you want to make all client and connection settings in one step.

  4. Choose Test Connection to test the connection to the MQTT server.

    PCo sends the CONNECT and DISCONNECT control packets to the MQTT server.