Add MQTT Client

Configure an MQTT client node to enable connection with MQTT Broker.
  1. In Project view, right-click
    MQTT
    , and select
    New
    MQTT Client
    .
  2. In , configure the
    MQTT Client
     settings:
    Broker address
    The address of the broker to connect to.
    Port
    Communication port number.
    ClientID
    The Client identifier that is unique on the server.
    SSL/TLS Enabled
    Enabling secure connection between FT Optix MQTT Client and MQTT Broker. If enabled, MQTTS protocol is used.
    Validate broker certificate
    Activates or deactivates validation process of MQTT broker certificate. During the SSL certificate verification process, the
    FactoryTalk Optix
     MQTT client checks the digital signature of the broker certificate to ensure that it has been issued by a trusted certificate authority (CA). The client also verifies that the certificate has not expired.
    CA certificate file
    A Certificate Authority certificate that has signed the server certificate on the MQTT Broker. It is required when SSL/TLS is activated to establish secure connection with the broker. It must be located in the directory:
    \FactoryTalk Optix\Projects\ProjectName\ProjectFiles\PKI\Own\Certs
    Client certificate file
    FactoryTalk Optix
     MQTT Client certificate. A client certificate identifies the client just like the server certificate identifies the server. If this property stays empty only broker certificate is user for authentication. It must be located in the directory:
    \FactoryTalk Optix\Projects\ProjectName\ProjectFiles\PKI\Own\Certs
    Client private key file
    FactoryTalk Optix
     MQTT Client private key. It must be located in the directory:
    \FactoryTalk Optix\Projects\ProjectName\ProjectFiles\PKI\Own\Certs
    User Identity type
    Specify user when accessing the MQTT Broker:
    • Anonymous
       - No logon is required, access the server as an anonymous user
    • Username/Password
       - Specify a username and password combination for logon.
      Username
       and
      Password
       must match the username and password configured for MQTT Broker.
    Will message enabled
    When set to
    True
    , will message is delivered to broker.
    Will message provides information about unexpectedly offline clients, allowing follow-up action.
    The client must send at least one message or a ping to broker every 60 seconds. If nothing is received in 90 seconds, the broker disconnects the client and shares Will Message to all subscribers.
    If the TCP connection is suddenly closed, for example by shutting down the application in the Task Manager, the broker detects this disconnection immediately. It then publishes the Will Message to the specified topic.
    Will topic
    Defines will topic where the will message is stored on client disconnection. It is mandatory if you enable will message.
    Will message
    Defines the payload of the will message which is sent to the will topic on client disconnection.
    Will QoS
    Quality of Service (QoS), defines the guarantee of delivery for a specific message:
    0
     - At most once (loss of messages is possible).
    1
     - At least once (ensures message delivery whti possible duplicate messages).
    2
     - Exactly once (ensures message delivery without duplication).
    Will retain
    When set to
    True
    , retains will message after it is read.
    Will delay interval
    Determines how long the server delays the publication of the will message after the network connection closes, measured in seconds.
In
Project view
, in the
MQTT
 folder, the
MQTT Client
 object appears.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal