Page History

...

Anchor
TransmittersTagSettings TransmittersTagSettings

Transmitters - Tag Settings

Image RemovedImage Added

• Name
  • Unique name for the Transmitter
• Enabled
  • Checkbox to enable/disable the Transmitter. Selected by default.
• Tag Provider
  
  • The name of the tag provider that Transmission will monitor.  By default this is the Ignition 'default' provider.
• Tag Path
  • Optional path to the root folder where the tag tree starts.
  • Transmitters also support a multi-tag path configuration. Reference the Transmitters with Multi-Tag Paths tutorial for configuration assistance.
• Tag Pacing Period
  
  • The buffer period for outgoing Transmission messages in milliseconds.  The default is 1000ms.  This means when a tag change event is detected 1000ms will elapse before an MQTT message is sent.  This allows additional tag change events to be buffered and put into the message and in turn reduce the number of generated MQTT messages.
• Set
  • The Set that the default MQTT Transmission client will connect to.
• Discovery Delay
  • An optional startup delay, in milliseconds, to wait before scanning for Tags to monitor. This is useful when Tags are dynamically created on initial startup, as is the case when using the MQTT Engine module.
• Aliased Tags
  • Checkbox to enable/disable using aliases for tag names when published data messages as tag values change in order to optimize payload size when publishing data. Not selected by default.
• Compression
  • The algorithm to use to compress payloads before they are published to the MQTT Server.  If 'NONE' is selected then compression is disabled.
• Convert UDTs
  • Checkbox to enable/disable converting UDT members to normal Tags before publishing. If enabled the Tags representing the UDT member will retain their member path prefixed by the UDT Instance name. Selected by default.
• Device level UDTs as Devices
  • Treat 'device level UDTs as Sparkplug devices'. Not selected by default and 'Convert UDTs' must be selected
• Publish UDT Definitions
  • Checkbox to enable/disable publishing UDT Definitions in BIRTH. Selected by default and not editable.
• Optimize UDTs
  • Checkbox to enable/disable optimizing UDT payload sizes in NDATA and DDATA payloads. Selected by default and not editable.
  Enable Birth Caching
  • Checkbox to enable/disable caching birth requests for faster rebirth request response. Not selected by default.

Anchor
TransmittersCommandSettings TransmittersCommandSettings

Transmitters - Command Settings

...

Anchor
FilesTagSettings FilesTagSettings

Files - Tag SettingsImage Removed

Image Added

• Tag Name
  • A friendly name for File Records which must be unique. Name is prepopulated 
• Tag Provider
  • The name of the tag provider (i.e. default)
• Tag Folder Path
  • The path to the tag folder under specified tag provider

Anchor
FilesFileSettings FilesFileSettings

Files - File SettingsImage Removed

Image Added

• Enable Auto-Publish
  • Checkbox to enable/disable auto publish of files. Not selected by default.
• File Scan Rate
  • The rate, in seconds, to scan the files directory specified in the 'Publish Files Path' tag for files to publish. Default is 60 seconds.
• File Scan Rate Time Unit
  • Time unit for 'File Scan Rate' parameter. Default is SECONDS
  • Options are: MILLISECONDS, SECONDS, MINUTES, HOURS and DAYS

Anchor
FilesSparkplugSettings FilesSparkplugSettings

Files - Sparkplug Settings

...