Add MQTT Broker

Add MQTT Broker

Configure an MQTT Broker to handle communication between Subscribers and Publishers.
  1. In , right-click
    MQTT
    , and select
    New
    MQTT Broker
    .
  2. In , configure the
    MQTT Broker
     settings:
    Listener port
    The port number to listen on is required. If this variable is used and no port provided, the default listener is not started.
    The default for 
    FactoryTalk Optix
     is a single listener with one common configuration.
    Max connections
    The maximum number of allowed client connections, expressed as an integer, up to 25.
    Max in-flight messages
    The maximum number of Quality of Service (QoS) 1 and 2 messages in-flight per client. This number includes messages that are partway through handshakes and retried. Setting this value to 0 results in no upper limit for these messages. Setting the value to 1 ensures in-order delivery of QoS 1 and 2 messages.
    Max QoS
    The maximum QoS supported. Clients publishing at a QoS higher than the maximum will be disconnected.
    Max queued messages
    The maximum number of QoS 1 and 2 messages in queue per client, not including messages that are currently in-flight (being processed by the broker). Setting a maximum number (greater than 0) of queued messages is recommended.
    Message size limit
    The maximum message size that the broker allows. Received messages exceeding this size will not be accepted by the broker. If you set this value to 0, all valid MQTT messages are accepted without a size limit. However, MQTT imposes an actual maximum size of 268435455 bytes.
    Retain available
    Set to
    false
     to disable retained message support. If a client publishes a message with the retain bit set, it will be disconnected if the support is disabled.
    Anonymous authentication
    When set to
    False
    , user-password authentication is required. If set to
    True
    , no user-password authentication is required.
    Require client certificate
    By default a TLS-enabled listener operate like a HTTPS-enabled Web server: the server uses a certificate signed by a Certificate Authority (CA), and the client verifies if it is a trusted certificate. The overall aim is encryption of the network traffic. Ifyou set
    require_certificate
     to true, the client must provide a valid certificate to connect to the network. This allows access to the broker to be controlled outside of the mechanisms provided by MQTT.
    CA certificate file
    Defines the path to a file containing the CA certificates. These certificates are trusted when checking incoming client certificates. For CA chain, the
    cpath
     is assumed to be hardcoded as
    \ProjectFiles\PKI\Own\Certs
    Broker certificate file
    Path to the PEM encoded server certificate.
    Broker private key file
    Path to the PEM encoded keyfile.
In
Project view
, in the
MQTT
 folder, the configured MQTT broker object appears.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.