Configuration File Details; Configuration File Structure; Mqtt Server Settings - ProSoft Technology MVI69E-LDM-MQTT Quick Start Manual

MVI69E-LDM-MQTT ♦ MQ Telemetry Transport
CompactLogix® Platform
9

Configuration File Details

The configuration file is named
and move it to the module, or access it directly on the module over FTP (example:
WinSCP). The file is in the folder /psft/sample/mqtt.
Note that settings differ depending on which MQTT broker the MVI69E-LDM is connecting.
Some MQTT brokers accept any client ID, while some require it to follow specific rules. Also,
different brokers have different requirements on TLS client certificates.
The folder C:\Workspace\mqtt-ldm-sample-app-mvi69e\test-generic
houses an example configuration file and certificates for generic MQTT brokers.
The file config.json and certificate files included in the firmware by default pertain to a
generic MQTT broker, such as Eclipse Mosquitto™.
Note: After changing the configuration file, you must restart the mqtt-ldm-sample-app-mvi69e process.
9.1

Configuration File Structure

This section describes the elements of the configuration file.

9.1.1 MQTT Server Settings

These settings are used to connect to the MQTT broker:
Parameter
UserName and Password
Group ID
UUID
Client ID
Type
Host
WillTopic
WillMessage
PublishRetryInterval
MaxPublishRetries
PublishTopicPrefix
SubscribeTopicPrefix
MaxPublishInterval
PublishQOS
PublishRetain
ProSoft Technology, Inc.
config.json (in JSON format). Edit it manually on the PC
Description
Set according to configuration settings for Ignition MQTT Distributor user.
The group_id element of Sparkplug topic namespace.
(Optional) Universally Unique Identifier component of Sparkplug payload.
The edge_node_id element of topic namespace.
Type of the MQTT broker to connect to:
Generic: Any MQTT broker, such as open source broker Eclipse Mosquitto™.
SparkPlug: MQTT broker supporting Sparkplug-B protocol.
IP address of the MQTT broker.
WillTopic field of the MQTT connect request payload. It should follow the following
format: spBv1.0/<GroupId>/NDEATH/<ClientId>.
Example: spBv1.0/Prosoft MQTT LDM Gateways/NDEATH/MVI69E-1.
Will Message field of MQTT Connect request payload.
Message retransmit if no response is received within this time for Publish messages
sent to the MQTT broker.
Maximum number of retries to successfully send a Publish message.
Prefix added before tag-specific topic name, used to publish values for tags.
Example: If the tag-specific topic name is SteamSensor/Pressure, and option
PublishTopicPrefix is set to PSFT, then the final topic name on which tag value is
published would be PSFT/SteamSensor/Pressure.
Similar to PublishTopicPrefix but used on topic names for Subscribe requests.
Maximum time interval between publishing of values for each tag. The tag values are
read from the PLC with a scan rate specific for each tag. If the value is not changed,
then it is not published. If time elapsed since the latest publishing of a value for a tag
is greater than MaxPublishInterval, then it is published even if value is not changed.
Value of the QoS field in MQTT Publish messages. Can be 0 or 1.
Value of the RETAIN field of the MQTT Publish message. Can be 0 or 1.
Configuration File Details
Quick Start Guide
Page 43 of 54