Page History

...

Anchor
NamespacesCustom NamespacesCustom

Namespaces Custom

Custom

...

Namespaces are used to provide support for generic, non Sparkplug compliant MQTT messages with string based payloads.

...

If a custom namespace is configured MQTT Engine will convert all messages received to tags

...

where the topic of each message will translate directly

...

to the tag's path

...

and the payload will be

...

the tag's value.  

MQTT Engine supports MQTT Engine String Replacement for both MQTT Topics and Payloads for character sequences that will become part of an Ignition tag path. 

Each custom namespace configuration has two parts - General andString Conversion. 

Anchor
NamespacesCustomGeneral NamespacesCustomGeneral

Namespaces Custom General

The configuration sections available are Main, Optional and Advanced.

Anchor

...

NamespacesCustomGeneralMain

...

NamespacesCustomGeneralMain

Namespaces Custom - General Main

Image RemovedImage Added

• Name
  • A friendly name of the namespace to easily identify it.
• Subscriptions
  • A comma separated list of subscriptions.

Anchor

...

NamespacesCustomGeneralOptional

...

NamespacesCustomGeneralOptional

Namespaces Custom - General Optional

• 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.
• Encoding Charset
  
  • The encoding format to use when not parsing as JSON.

Anchor

...

NamespacesCustomGeneralAdvanced

...

NamespacesCustomGeneralAdvanced

Namespaces Custom - General AdvancedImage Modified

• Writable Tags
  • Enables writes on tags created by the Custom Namespace. Note: This will only make the tags writable; it will not result in outgoing MQTT messages.

...

Anchor
NamespacesCustomStringConversion NamespacesCustomStringConversion

Namespaces Custom - String Conversion

There is one configuration section available Main Settings

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

Anchor
NamespacesCustomstringConversionMain NamespacesCustomstringConversionMain

Namespaces Custom - String Conversion Main Settings

Image Added

• 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
• Regex
  • 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.