Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The first tab is a list of MQTT Servers that MQTT Engine should connect to.  By default, MQTT Engine is configured to connect to the MQTT Distributor based MQTT Server.  It is set up to connect to localhost, port 1883, using the default username/password pair of admin/changeme.  Out of the box MQTT Engine will work with MQTT Distributor and its default configuration.   The connection status of each server can be seen in the 'Status' column.  Clicking on the 'Create new MQTT Server' link will bring up the following form for adding a new MQTT Server setting.

Image Added

Additional or alternative MQTT Servers can be configured in MQTT Engine.  Often times more than one will be configured to handle fail-over or in redundant or geographically distributed systems.  The configuration options for servers are listed below.

  • Name - This is the friendly name of the MQTT Server used to easily identify it
  • URL - This is the URL of the MQTT server.  Its format is as follows: [protocol]://[location]:[port].  Each of these are shown below
    • protocol - Either tcp or ssl
    • location - The server location.  e.g. localhost, myserver.chariot.io, mydomain.com, etc
    • port - The port the MQTT Server is listening on.  Generally this is 1883 if using TCP or 8883 if using SSL
  • ServerType - This is the type of MQTT Server to connect to
    • Chariot - If connecting to a Cirrus Link Chariot on-premise or Chariot cloud based MQTT Server
    • MQTT_Distributor - If connecting to a Ignition MQTT Distributor server
    • Third_Party - If connecting to a third party 3.1.1 compliant MQTT Server
  • ClientID - 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
  • Username - The MQTT username to use in the MQTT connect packet.  This is required if the MQTT Server to connect to requires it
  • Password - The MQTT password to use in the MQTT connect packet.  This is required if the MQTT Server to connect to requires it
  • Certificates - The server certificates to use if required.  These are generally only required when connecting using TLS and the MQTT server does not have a genuine certificate issued by a trusted certificate authority.

Image RemovedThe connection status of each server can be seen in the 'Status' column.  Clicking Clicking on the 'Create new MQTT Server...' link will bring up the following form for adding to add a new MQTT Server setting.

Advanced

The second tab contains advanced settings which allows one to configure Application ID Filters and Cirrus Link Chariot Access Settings.  The Chariot access settings settings are used in conjunction with a Cirrus Link Chariot deployment and will be provided when purchasing Chariot Cloud services.

...

Custom namespaces are used to provide support for generic MQTT messages with string based payloads.  If a custom namespace is configured MQTT Engine will convert all messages received to tags.  The topic of each message will directly translate into the tag's path.  The payload of the message will be that tag's value.  Each   

Image Added

Each custom namespace has the following properties:

...

Note: if a Tag Name is not specified, care must be taken so that published messages do not end up overwriting previous tags. 

Image RemovedClicking on the 'Create new Custom Namespace...' link will bring up the following form to add a new Custom Namespace.

...