How To Articles > How to Transfer Data from Sparkplug B to MQTT

How to Transfer Data from Sparkplug B to MQTT

How to Transfer Data from Modbus to MQTT

Open Automation Software enables the transfer of data from Sparkplug B Edge of Network Nodes to MQTT brokers either locally or over a network. This tutorial provides a step-by-step guide on how to download and install OAS, configure an MQTT and a Sparkplug B driver, automate tag setup from the Sparkplug B EoN, and implement Data Route.

Step 1. Download and Install the Open Automation Software and Start the OAS Service

If you have not already done so, you will need to download and install the OAS platform. Fully functional trial versions of the software are available for Windows, Windows IoT Core, Linux, Raspberry Pi and Docker on our downloads page.

On Windows run the downloaded Setup.exe file to install one or more of the Open Automation Software features. Select the default Typical installation if you are not sure what features to use or the Custom installation if you want to save disk space on the target system. When prompted agree to the End User License Agreement to continue the installation.

For more detailed instructions and video tutorials, visit the installation guide for your system:
Windows Installation | Linux Installation | Raspberry Pi Installation | Dockers Installation

The OAS Service Control application will appear when the installation finishes on Windows. Use this application to start the 3 Services. Run the Configure OAS application on Windows and select Configure-Tags; if the first time running, the AdminCreate utility will run to create an Administrator login as shown in Step 1 of Getting Started – Security.

Step 2. Set Up Sparkplug B Host App to Access EoN Node Data.

Select Configure-Drivers.

Enter a meaningful Driver Interface Name that you will refer to this connection and define the properties.

Set the driver to Sparkplug B.

Enter the Host property to the IP Address of the of the host broker or just use localhost for a local broker.

Set the Port property of the host broker to connect to. The default port is 1883 or 8883 for SSL.

Note: The OAS MQTT Broker can be used to host data locally. To use another broker on the default ports on the same computer change the OAS MQTT Broker Port under Configure-Options-MQTT Broker.

Enter the User Name and Password if required.

Set the MQTT Protocol Version to V311 or V500.

Set the Client ID to a unique value, each driver interface must have a specific value different than all other clients connecting to the host.

Set the Mode to Host App for OAS to control the online state of each Edge of Node defined to the shared Host Application ID. Or set to Client App to access EoN Node data without controlling their state.

Set the Host ID to the specific value that the Edge of Nodes will be using as the Host Application ID.

Set the Sparkplug B Version to 2.2 or 3.0.

To automatically add tags for each Metric from the matching Group, Edge of Nodes, and Devices enable the property Add Client Tags Automatically.

When enabled optionally set the Filter Groups, Edge Nodes, and Devices that tags should be added from for each of their Metrics. Leave the Filter fields blank to include all Edge of Nodes publishing data to the broker.

Select the Add Driver button in the left part of the form to add the Driver Interface as an available selection when defining Tags in the next step.

You are now ready to add tags for specific Sparkplug B EoN Node Metric values.

Note: If the Driver Interface property Add Client Tags Automatically was enabled tags will be created for you, you can skip this step to add tags manually.

Select Configure-Tags.

Note: You can add organizational Groups as many levels deep as you prefer and add tags to groups. To do this first add a Group to Tags Group at the root level, then right click on the Group in the right window to add additional Groups or Tags.

Select Add Tag.

Change the Data Source Tag property to Sparkplug B.

Select the correct Driver Interface from the Driver Interface pull down list.

Specify the Client Group ID, Client Edge Node ID, Client Device ID, and Client Metric Name for the Edge of Node Metric value to read and write.

Select the Data Type of the Tag to match the data type of the Metric.

Select Apply Changes and the current value for the Metric should appear with Good Quality.

Select the Save button from the toolbar to save your configuration.

You can view the Getting Started with Sparkplug B Video to familiarize yourself with the above steps to setup OAS as a Sparkplug B Edge of Network Node and a Host Application

00:00 – Introduction
01:10 – Download OAS
01:46 – Quick Start
02:08 – Edge of Network Node
05:52 – EoN Tags
07:04 – Host Application
09:20 – SpB Client Tags
10:22 – Programatic Interface
10:59 – CSV Export / Import
12:27 – Multiple Metric Tags
13:46 – Modbus
16:10 – DCMD Metric Write
17:00 – Data Route
17:58 – Networking
18:17 – Save Configuration
18:56 – OAS Platform

Step 3. Configure Your MQTT Data Source

First, you will need to open the Configure OAS application from the program group Open Automation Software.

Select Configure >> License from the top menu and verify that MQTT is one of the available Drivers in the lower left of the form. The demo license will have this by default. If you do not see MQTT available, contact support@openautomationsoftware.com to update your license.

Select Configure >> Drivers from the top menu.

Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.

The Configure Drivers Screen will appear. Select MQTT from the Driver dropdown box.

Enter a meaningful Driver Interface Name that you will refer to this physical connection when defining Tags with a MQTT Data Source.

Enter the IP Address of the broker. The default port is 1883.

Enter the User Name and Password if required.

Set the Keep Alive Time. The default is 60 Seconds.

Set the Reconnect Time. The default 10 Seconds. If the connection to the broker is lost the Reconnect Time determines how long to wait before attempting to reconnect.

For more detailed instructions on configuring your MQTT data source, click here to see our Getting Started MQTT tutorial or watch the video tutorial below:

Step 4. Configure MQTT Tags

OAS provides multiple ways to add and define tags:

Manually add and define Tags using the Configure OAS application. …learn more…
CSV Import and Export …learn more…
Programatically …learn more…
One Click Allen Bradley …learn more…
One Click OPC …learn more…

To add a Tag manually:

In the OAS Configure Application, select Configure >> Tags from the top menu.

Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.

Click on the Add Tag button located at the top of the Tag browser on the left portion of the screen.

A dialog box will appear. Enter a name for your new tag and click ok.

A configuration screen will appear for your new tag. Select your data source type in in the Data Source dropdown box.

Specify the correct data type in the Data Type dropdown box.

Click Apply Changes at the bottom right of the window.

For more detailed instructions on configuring your tags, click here to see our Getting Started Tags tutorial.

Step 5. Configure the Target Tab of the Source Tags

Select one of your source tags.

Select it’s Target tab.

Enable Write to Target

Select the Target Type (Tag, OPC, Azure IoT, Azure IoT Edge, or MQTT) from the dropdown.

Select the destination for the value to be sent. If Tag is selected then select Browse and select the desired tag from the localhost system or optionally a remote system for transfer over a network.

Local: TagName.Value

Remote: \\192.168.0.1\TagName.Value

If OPC Item is selected select browse and select the OPC Server and Item

If Azure IoT is selected then select the Driver Interface.

If MQTT is selected then select the Driver Interface and Topic.

Enter the desired float value Deadband field. Enter 0 for no deadband.

If you want to specify a desired update frequency for the target check Write Continuously and enter the desired frequency. If Write Contentiously is unchecked the the target will be updated every time the source tag changes.