Versions Compared

Key

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

...

  • 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
  • Server Type
    • 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
      • AWS_Greengrass - If connectiong to an AWS Greengrass Server.
        • Note: This server type should not be used whe using MQTT Transmission in conjunction with MQTT Engine.
  • Server Set
    • The Set that this server is a member of.
  • 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.

TLS Properties

  • 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.
    • CA certificate must always end in 'ca.pem'
    • If using client side certificates (i.e. a public/private keypair and CA cert), make sure the following naming conventions are followed.
      • Edge/Device certificate must end in 'cert.pem'
      • Edge/Device private key must end in 'private.key'
  • PasswordA password associated with the certificate's private key.The configuration for TLS changed between MQTT Transmission v3.4.6 and v3.4.7. See this document for TLS configuration: Configuring Secure MQTT Communication

Advanced Properties

  • Client ID
    • Optional MQTT client ID to use. If left blank, a random client ID will be create of the form 'MT-xxxxxxxx-xxxx-xxxx'.  This should almost always be left blank. Do not use this setting unless it is an absolute required that a specific client ID be used for connection to the MQTT server.
  • 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. This will provide a random delay in the startup and connection of the MQTT Client with the MQTT Server. This is useful in use cases where large numbers of clients might be reconnecting simultaneously to the MQTT Server. By introducing a randomized delay, the rate at which clients will connect will be spread out over a period of time, reducing the load on the server.
      • Example: 1000-5000

...