Versions Compared

Old Version 2

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version Current

changes.mady.by.user Gill Houghton

Saved on

Key

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

...

Anchor
NamespacesDefaultGeneralNonSparkplugB
NamespacesDefaultGeneralNonSparkplugB
Namespaces Default Non Sparkplug B - General

Image RemovedImage Added

  • Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Whether or not the namespace is enabled. 
    • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.

Anchor
NamespacesDefaultGeneralSparkplugB
NamespacesDefaultGeneralSparkplugB
Namespaces Default Sparkplug B - General

Image RemovedImage Added


  • Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Whether or not the namespace is enabled. 
    • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.
  • Description
    • Description of the namespace
  • Default Tags Enabled
    • Included in release 4.0.23 and newer
    • Enable MQTT Engine tags in the 'Edge Nodes' folder prefixed by the Sparkplug IDs
  • UNS Tags Enabled
      Included in release 4.0.23 and newer
    • Enable MQTT Engine tags in a specified folder using the metric path as the tag path
  • UNS Folder Prefix
    • Included in release 4.0.23 and newer
    • The MQTT Engine folder prefix to use for UNS tags

...

From release 4.0.26, a specific Server Set(s) can be associated with the Namespace

Image RemovedImage Added

  • Server Set
    • A dropdown list of the existing sets configured under MQTT Engine Settings > Sets

...

Namespace filters allows you to specify Group or Group/EdgeNode combinations which will be included in the MQTT Engine subscriptions for this specific namespace. From MQTT Engine 4.0.16 and newer, it also Also allows for the filters to be applied to specific MQTT Servers.Image Removed

Image Added

  • Filter Name
    • Name of the filter
  • Description
    • Description of the filter
  • Group ID
    • The Group ID to be included in the
    Group ID
    • The Group ID to be included in the MQTT Engine subscriptions for this specific namespace. 
  • Edge Node ID
    • Edge Node ID to be included in the MQTT Engine subscriptions for this specific namespace.
  • MQTT Server List
    • A comma separated list of MQTT Server names to apply the filter to. If left blank, it will apply to all MQTT Servers

...

Anchor
NamespacesDefaultFiles
NamespacesDefaultFiles
Namespaces Default - FilesImage Removed

...

Image Added

  • Ignore Files
    • Default: Unchecked.
    • If checked, all published files will be ignored
  • File Host Type
    • Default: ACTIVE. Host will send message ACKs back to MQTT Transmission acting as an Active Host
    • Options are ACTIVE and PASSIVE

Image Removed

  • LocationBase File Directory
    • The directory to store files when 'Ignore Files' is unchecked
  • Add Topic Tokens
    • Default: Checked. If selected, appends the Group ID, Edge Node Id and device ID to the Base File Directory when storing files
  • File Storing Policy
    • The file policy for storing incoming files. Options are REPLACE_EXISTING_FILE and KEEP_EXISTING_FILE
    • Default: REPLACE_EXISTING_FILE
  • File Attributes Policy
    • The policy for handling basic file attributes such as CreationTime, LastModifiedTime and LastAccessTime of incoming files. Options are IGNORE, APPEND_TO_FILENAME, UPDATE_FILE_ATTRIBUTES and APPEND_AND_UPDATE
    • Default is IGNORE


Anchor
NamespacesDefaultStringConversion
NamespacesDefaultStringConversion
Namespaces Default - String Conversion

...

Image Added

  • Converter Name
    • Unique identifier for converter
  • Order Index
    • The order index which specifies the order in which to execute the replacement
  • Source StringPattern
    • Free form field for the source string or regular expression (regex) in the MQTT Topic or payload to be replaced
  • Replacement StringPattern
    • Free form field for the replacement string that will be used to replace the source string in Ignition tags
  • Regex
    • If checked, the source string will be treated as a 'regular expression'
    • If unchecked, the source string is an exact character string to match and replace
    • Default: unchecked

...

The configuration sections available are Main, Optional and Advanced.

Anchor
NamespacesCustomGeneralMain
NamespacesCustomGeneralMain
Namespaces Custom - General

...

Image Added

  • Namespace Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Enable this namespace
  • Description
    • Description for this namespace
  • MQTT TopicsSubscriptions
    • A comma separated list of MQTT subscriptions and supports both the multi-level (#) and single level (+) wild card characters.

    • (+) is a a single level wildcard that matches any name for a specific topic level. This can be used instead of specifying a name for any topic level in the topic filter.

    • (#) is a multi level wildcard that can only be used at the end of the topic filter as the last level and matches any topic whose first levels are the same as the topic levels specified at the left-hand side of the # symbol.

Warning

Check your MQTT Topic subscriptions to verify if they contain valid Ignition tag path or tag name characters. View the Ignition Understand Tag Naming document for details on the tag name rules.

While MQTT and Sparkplug both support characters such as . & % =, Ignition does not support these as valid characters in a tag path or tag name and as a result, it may be necessary to tell MQTT Engine to replace certain characters or strings of characters with something else so the tag path and tag names can be properly created in Ignition. Reference the MQTT Engine String Replacement HowTo for additional details on how to use this configuration.

...

  • Use QOS 1
    • Enable Quality of Service 1 (at least once delivery)
  • Root

Image Removed

Image Removed

  • Root Tag Folder
    • A name of a folder where all tags will be stored.  If configured, this folder will be the base folder where all tag paths will start.
  • Tag Name
    • A tag name to be used for all tags.  If not configured, the last token in the topic will represent the tag.
  • JSON Payload
    • Optional flag to indicate that the content of the string based payload is a JSON object.
  • Character Encoding Charset
    • The encoding format to use when not parsing as JSON.

...

  • Create Writable Tags
    • Enables writes on tags created by the Custom Namespace.
    • This will only make the tags writable and does not result in outgoing MQTT messages. Review this tutorial for writing back to an Edge device from a custom namespace tag.
    Numbers as Floats (added 4.0.28)
    • Treat all numbers as decimal numbers when creating tags. 


Anchor
NamespaceCustomSets
NamespaceCustomSets
Namespaces Custom - Sets

From release 4.0.26 a specific Server Set(s) can be associated with the NamespaceImage RemovedImage Added

  • Server Set
    • A dropdown list of the existing sets configured under MQTT Engine Settings > Sets

...

Reference the MQTT Engine String Replacement HowTo for additional details on how to use this configuration.

Anchor
NamespacesCustomstringConversionMain
NamespacesCustomstringConversionMain
Namespaces Custom - String Conversion

...

Image Added

  • Converter Name
    • Unique identifier for namespace converter

...

  • Order Index
    • The order index which specifies the order in which to execute the replacement
  • Source String
    • The source string or regular expression (regex) in the MQTT topic or payload to be replaced
  • Replacement String
    • The replacement string that will be used to replace the source string in the Ignition tags
  • Use Regular ExpressionsRegex
    • Checkbox to determine the source string format. If selected, source string is a 'regular expression'. If deselected, source string is an exact character string to match and replace.

...