Versions Compared

Key

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

Overview  

This page contains information about MQTT SparkplugB ExternalTags. MQTT SparkplugB ExternalTags allow you to dynamically connect to servers using the MQTT SparkplugB protocol at runtime. This allows the integration and visualization of data and other components of your application without the need to create local Tags. 

On this page:

Table of Contents
maxLevel3
minLevel2


Configuration

To configure this Protocol as a ExternalTags, go to Unified Namespace → ExternalTags and create a new provider for MQTT +SparkplugB - Message Queuing Telemetry Transport - Collector.

Image ModifiedImage Modified

The station syntax is :

...

Access Mode: Defines the mode of access for the MQTT connection. The options are Read, Write and ReadWrite.

Type: If the MQTTSpB will be a Publisher or a Collector.

TagProperties : Configurations related to specific tag properties.

TimePublishRate : The rate at which data is published. Default is 500ms, meaning data is sent every half-second.

StoreAndForward: Determines if messages should be stored locally when the connection to the broker is lost and forwarded when the connection is re-established.

PublishDBIRTHAfterNBIRTH : Configuration related to the MQTT SparkPlugB Birth message sequence.

UseParenthesesForArray : If set, array elements will be enclosed in parentheses. Useful for specific formatting requirements.

For the broker configuration:

  • BrokerURL: The URL or IP address of the MQTT broker. Default is localhost.

  • Port: The port number on which the MQTT broker is running. The default is 1883 for no encryption and 8883 for SSL/TLS security.

  • ClientID: A unique identifier for the MQTT client connecting to the broker (if required).

  • Username: Username credential for authenticating with the MQTT broker (if required).

  • Password: Password credential for authenticating with the MQTT broker (if required).

  • X509Certificate: If using certificate-based authentication, this is where the path of the X.509 certificate is specified.

  • CertificatePassword: The password to unlock the provided X.509 certificate (if it's password-protected).