Page History

...

The configuration options for each of the six tabs - General, Servers, Sets, Transmitters, Records and Files - are detailed below. 

Anchor
#General #General

General

...

Anchor
#Servers #Servers

Servers

The Servers tab has two parts - Settings and Certificates

Servers - Settings

This tab provides a list of the MQTT Servers that MQTT Transmission should connect to. By default, MQTT Transmission is configured to connect to the local MQTT Distributor based MQTT Server and is set up to connect to localhost, port 1883, using the default username/password.

Additional or alternative MQTT Servers can be configured in MQTT Transmission - often times more than one will be configured to handle fail-over in redundant or geographically distributed systems. Clicking on the 'Create new MQTT Server' link will bring up a form for adding a new MQTT Server setting. 

The connection status of each server can be seen in the 'Connected' column.Image Modified

The Settings available for an MQTT Server are: 

...

See this document for TLS configuration: Configuring Secure MQTT Communication

• CA Certification File
  • CA Certification file currently in use.
• Client Certification File
  • Client Certification file currently in use.
• Client Private Key File
  • Client Private Key file currently in use
• Change Password?
  • Check box to enable changing of the optional password.
• Password
  • Optional password associated with the certificate's private key.
• Hostname Verification
  • Enable TLS Hostname Verification. This is true by default.
• TLS ALPN Extensions
  
  • Optional TLS ALPN Extensions to use with this connection

Advanced Properties

• Client ID
  • Optional MQTT client ID to use.  If specified this will be used in the MQTT Engine connect packet when connecting to the server.  If left blank, a random client ID will be create of the form 'IgnitionTarget-xxxxxxxx-xxxx-xxxx'. Caution: MQTT Clients IDs must be unique and if two clients attempt to connect with the same client ID, one will be forcefully disconnected from the server to allow the other client to connect.
• Keep Alive
  • The MQTT client keep alive time (in seconds).
• Random Startup Delay
  • The Random Startup Delay in milliseconds of the form 'min-max' where min is the low end and max is the high end of the random range. e.g. '10-1000'. 
• Reconnect Delay
  • The clients reconnect delay in millisecond.
• Auto-reconnect RPC Client
  • Allow the RPC Client to auto connect and reconnect when publishing from Ignition Python scripts.
• Data Format Type
  • The format of the data to send. Default is Sparkplug_B_v1_0_Protobuf with JSON as an option.

Servers - Certificates

This tab provides a list of the certificate or private key files if loaded and available for TLS configuration.

Image Modified

Image ModifiedMain

• Certificate File Upload
  • Browse to the certificate file or private key to upload.
• Friendly Name
  • The friendly name of the certificate file or private key.
• File Description
  • The description of the certificate file or private key.

Anchor
#Sets #Sets

Sets

The Sets tab contains a list of server sets.  Each set represents a logical grouping of MQTT servers.  When a set is referenced by a Transmitter configuration, a single connection to one of the servers in the set will be maintained. The other servers will act as failover in the case that a connection with the first is lost.  Server sets cannot have common elements meaning that a single MQTT server cannot be in more than one set.

...