Setup OAS as a Sparkplug B Edge of Network Node and also a Host Application.
OAS is can act as a Sparkplug B Edge of Network Node and Host Application.
If you would like OAS to act as an Edge of Network Node view the Getting Started Sparkplug B EoN Node setup guide.
You can view the Getting Started with Sparkplug B Video to familiarize yourself with the following steps to setup Sparkplug B communications.
The following guide are the steps to define OAS as a Sparkplug B Host Application to receive and update Edge Node Metric values. The interface can control the online state of each Edge of Node or just act as a client.
Start Configure OAS application from the program group Open Automation Software.
Select Configure-License and verify that MQTT is one of the available Drivers in the lower left of the form. If you do not see the MQTT driver available contact support@oasiot.com to update your license.
Note: You will need to be running Open Automation Software Version 19.0.0.53 or greater to support Sparkplug B communications. Use Configure-Options-System Status to check the version of the running OAS Engine. You can download the latest version at www.openautomationsoftware.com/downloads/open-automation-software/ or use the Update Version button under Configure-License to update to the latest version of OAS.
Select Configure-Drivers.
Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.
Note: Optionally select the Live Data Cloud node if you are hosting data over the Internet with a standard Internet connection.
Define the properties for the desired Sparkplug B host.
Enter a meaningful Driver Interface Name that you will refer to this physical connection when defining Tags with Sparkplug B source.
Set the Driver property 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.
Keep Alive Time – Default is 60 Seconds.
Reconnect Time – Default 1 Second. If the connection to the broker is lost the Reconnect Time determines how long to wait before attempting to reconnect.
To connect with Transport Layer Security enable the property SSL / TLS.
Specify the Private Key File and Certificate File to use.
Uncheck the property Create Certificate to specify a PFX Certificate File and PFX Certificate Password.
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.
Optionally define a secondary failover Host Broker if the primary Host Broker fails with the property Enable Failover.
If both the primary and secondary broker are offline the Return to Online settings determines the retry frequency.
View Driver Interface Failover for more information and and video demonstrating communications failover.
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.
Note: To enable a communication interface to Edge of Nodes, but not set the state of the Host ID set the mode to Client App.
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.
Note: If you need to define several Driver Interfaces you can use the CSV Export and CSV Import on the toolbar in the upper right together with Microsoft Excel. You can also programmatically define drivers using the .NET OASConfig assembly or OAS REST API.
Select Configure-Tags.
Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.
Note: Optionally select the Live Data Cloud node if you are hosting Allen Bradley data over the Internet with a standard Internet connection.
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 to Add a Tag.
Note: You can also 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.
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.
Note: The above tag was automatically created using the Sparkplug B Test Compliance Kit as an Edge of Node source.
To setup automated data transfer of any OAS Tag to and from the Sparkplug B Tags see Getting-Started – Data Route.
To define multiple tags use the CSV Export and CSV Import on the toolbar in the upper right together with Microsoft Excel.
Note: You can also programmatically define Tags using the free to use .NET OASConfig assembly or OAS REST API.
Select the Save button on the toolbar at the top.
View the following video for explanation of each parameter and how to enable Total for a tag:
When this feature is enabled the current value will be summed at the sample rate specified with each value multiplied by the total gain before addition to the total.
The Total feature will keep track of the following:
The following image shows how the points will appear for connection in a client.
The following configuration properties are used to enable and control the summation of values.
Enables the summation of the current value to update the Total variables.
When enabled totalizing is active at the specified sample rate.
When disabled totalizing is paused.
When enabled Active state is controlled by a Boolean tag value.
The rate at which the value * gain is added to the total in seconds.
The gain will be multiplied to the value before adding to the total.
Use a negative gain or value if you want the total to decrease on each sample.
When enabled the gain to multiply to value is controlled by Tag.
The value that the total will be initialized to when the total is reset.
When enabled the total is set to the Total Initial Value on the reset hour and minute.
When enabled the total is set to the Total Initial Value on the reset hour and minute on the first day of the month.
When enabled a Boolean tag transition from false to true will set the total to the Total Initial Value.
To retain the total values after a system restart go to Configure-Options-Retain Values and enable to retain Totals to a file.
You can optionally specify a save frequency in hours to save the live total values at a specified rate. If the save Frequency is left at 0 the totals are only saved when the runtime is stopped or an orderly system shutdown.
How to identify and resolve communications errors with data sources.
Below are some helpful troubleshooting steps to resolve connection errors with OPC UA server.
The Server Url under Configure-Drivers must be specified correctly to then browse for the available Security Profiles.
Refer to the OPC UA server vendors documentation for the correct endpoint of the server.
Once the Server Url is correctly set use the Browse button to select the Security Profile.
If the OPC UA Server’s authentication certificate is rejected it will be placed in C:\ProgramData\OpenAutomationSoftware\pki\rejected\certs on Windows or the pki\rejected\certs sub-directory where the OAS Engine is located on Linux. To resolve and move the OPC UA Server’s certificate file in the rejected\certs directory to trusted\certs.
Version 18.0.0.17 of OAS added the ability to self create a certificate for OPC UA Servers and Clients to authenticate against. Check the current version under Configure-System Status and if older than version 18.0.0.17 update the version of OAS if you are receiving a certificate authentication error under Configure-System Errors.
If the OPC UA Server requires a user name and password to validate the connection enable User Security under Configure-Drivers and specify the Username and Password that is required by the OPC UA Server.
Select Configure-System Errors and expand any OPC UA or Driver Interface error to see the details of the error.
The information provided can often help you determine the cause of communication failures.
The history of all systems errors can be found in the OAS Error Log specified under Configure-Options-System Logging.
You can enable the OPC UA transaction logging under Configure-Options-System Logging to track all interface calls to the OPC UA server.
Specify the location of where the communication logs will be saved with the property Transaction Log Path further down in System Logging.
There will be multiple files generated with the opc-ua within the file name and also the base OAS Transactions file.
The UA Expert program is a good test application to communicate to OPC UA server to verify the server can be interfaced with.
You can download UA Expert from https://filedownloads.openautomationsoftware.com/tools/uaexpert.zip.
Open Automation Software can be setup to transfer data from S7 Controllers to Kafka brokers. Use the following guide to setup data transfer from S7-200, S7-300, S7-400, S7-1200, and S7-1500 controllers to Kafka. This tutorial walks you through downloading and installing OAS, defining the Siemens S7 interface, creating data source tags, and publishing data to Kafka in a JSON format. The message topic to publish is automatically formatted to include tag id, value, quality, and timestamp. All JSON packet parameters are configurable to deliver the Kafka topic message in the desired format.
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
When the installation is finished the OAS Service Control application will appear. Use this application to start the 4 Services. If this is the first time installing the software it will automatically enter Runtime with an example Tag Configuration.
For more detailed instructions on configuring your Siemens data source, click here to see our Getting Started Siemens tutorial.
To add a Tag manually:
For more detailed instructions on configuring your tags, click here to see our Getting Started Tags tutorial.
Select Configure-Drivers.
Enter a meaningful Driver Interface Name that you will refer to this connection and define the properties.
Set the driver to Kafka. Set the Bootstrap Servers of the brokers you wish to publish to.
If sending data to the cloud set the appropriate Security Protocol.
When connecting with Confluent Cloud set the SASL Username with the provided API Key and the SASL Password with the Secret Key.
Enable Publish Selected Tags at the bottom of the Driver configuration.
Select to publish data continuously at a specified interval, based on event, or at a specific time of day.
If Event Driven browse for a local or remote OAS tag that will trigger the publish. Select a Boolean tag that will change state from false to true, true to false, or both. Or choose an Integer tag that trigger a publish anytime the value changes other than 0.
Specify the Publish Topic Id if choosing to Publish All Tags As One Topic.
When publishing as one topic to optimize communications with Kafka multiple messages are sent for each publish when the number of tag value changes exceeds the Max Tags Per Publish limit.
Specify the Tag Id, Value Id, an optional Quality Id, and Timestamp Id for each tag value that is sent.
When including the Timestamp Id also specify the timestamp format, use Custom to specify your own date and time format.
Specify local and remote OAS tag variables to include in each publish and specify the Id. Value is the current value from the data source or you can select any of the over 600 tag variables of each tag to publish.
Optionally use CSV Export and CSV Import buttons to set up additional tags to publish using Microsoft Excel.
When selecting remote tags use Basic Networking syntax or Live Data Cloud syntax in the tag path.
Select the Add Driver button in the lower part of the form to add the Driver Interface.
Data is now publishing to the Kafka broker.
Select the Save button from the toolbar to save your configuration.
You can view the Getting Started with Kafka Video to familiarize yourself with the following steps to setup OAS as a producer and consumer of Kafka.
Open Automation Software can be setup to transfer data from OPC UA servers to Kafka brokers. Use the following guide to setup data transfer from OPC UA servers to Kafka. This tutorial walks you through downloading and installing OAS, defining the OPC server interface and automated tag creation with the One Click OPC UA feature, and publishing data to Kafka in a JSON format. The message topic to publish is automatically formatted to include tag id, value, quality, and timestamp. All JSON packet parameters are configurable to deliver the Kafka topic message in the desired format.
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
When the installation is finished the OAS Service Control application will appear. Use this application to start the 4 Services. If this is the first time installing the software it will automatically enter Runtime with an example Tag Configuration.
For more detailed instructions on configuring your OPC DA data source, click here to see our Getting Started OPC UA tutorial.
To add a Tag manually:
For more detailed instructions on configuring your tags, click here to see our Getting Started Tags tutorial.
Select Configure-Drivers.
Enter a meaningful Driver Interface Name that you will refer to this connection and define the properties.
Set the driver to Kafka. Set the Bootstrap Servers of the brokers you wish to publish to.
If sending data to the cloud set the appropriate Security Protocol.
When connecting with Confluent Cloud set the SASL Username with the provided API Key and the SASL Password with the Secret Key.
Enable Publish Selected Tags at the bottom of the Driver configuration.
Select to publish data continuously at a specified interval, based on event, or at a specific time of day.
If Event Driven browse for a local or remote OAS tag that will trigger the publish. Select a Boolean tag that will change state from false to true, true to false, or both. Or choose an Integer tag that trigger a publish anytime the value changes other than 0.
Specify the Publish Topic Id if choosing to Publish All Tags As One Topic.
When publishing as one topic to optimize communications with Kafka multiple messages are sent for each publish when the number of tag value changes exceeds the Max Tags Per Publish limit.
Specify the Tag Id, Value Id, an optional Quality Id, and Timestamp Id for each tag value that is sent.
When including the Timestamp Id also specify the timestamp format, use Custom to specify your own date and time format.
Specify local and remote OAS tag variables to include in each publish and specify the Id. Value is the current value from the data source or you can select any of the over 600 tag variables of each tag to publish.
Optionally use CSV Export and CSV Import buttons to set up additional tags to publish using Microsoft Excel.
When selecting remote tags use Basic Networking syntax or Live Data Cloud syntax in the tag path.
Select the Add Driver button in the lower part of the form to add the Driver Interface.
Data is now publishing to the Kafka broker.
Select the Save button from the toolbar to save your configuration.
You can view the Getting Started with Kafka Video to familiarize yourself with the following steps to setup OAS as a producer and consumer of Kafka.
Open Automation Software can be setup to transfer data from classic OPC DA 2.xx and 3.0 OPC servers to Kafka brokers. Use the following guide to setup data transfer from OPC servers to Kafka. This tutorial walks you through downloading and installing OAS, defining the OPC server interface and automated tag creation with the One Click OPC feature, and publishing data to Kafka in a JSON format. The message topic to publish is automatically formatted to include tag id, value, quality, and timestamp. All JSON packet parameters are configurable to deliver the Kafka topic message in the desired format.
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
When the installation is finished the OAS Service Control application will appear. Use this application to start the 4 Services. If this is the first time installing the software it will automatically enter Runtime with an example Tag Configuration.
For more detailed instructions on Configuring OPC Server Tags, visit our Getting Started OPC tutorial or the One Click OPC tutorial or watch the video tutorial below:
Select Configure-Drivers.
Enter a meaningful Driver Interface Name that you will refer to this connection and define the properties.
Set the driver to Kafka. Set the Bootstrap Servers of the brokers you wish to publish to.
If sending data to the cloud set the appropriate Security Protocol.
When connecting with Confluent Cloud set the SASL Username with the provided API Key and the SASL Password with the Secret Key.
Enable Publish Selected Tags at the bottom of the Driver configuration.
Select to publish data continuously at a specified interval, based on event, or at a specific time of day.
If Event Driven browse for a local or remote OAS tag that will trigger the publish. Select a Boolean tag that will change state from false to true, true to false, or both. Or choose an Integer tag that trigger a publish anytime the value changes other than 0.
Specify the Publish Topic Id if choosing to Publish All Tags As One Topic.
When publishing as one topic to optimize communications with Kafka multiple messages are sent for each publish when the number of tag value changes exceeds the Max Tags Per Publish limit.
Specify the Tag Id, Value Id, an optional Quality Id, and Timestamp Id for each tag value that is sent.
When including the Timestamp Id also specify the timestamp format, use Custom to specify your own date and time format.
Specify local and remote OAS tag variables to include in each publish and specify the Id. Value is the current value from the data source or you can select any of the over 600 tag variables of each tag to publish.
Optionally use CSV Export and CSV Import buttons to set up additional tags to publish using Microsoft Excel.
When selecting remote tags use Basic Networking syntax or Live Data Cloud syntax in the tag path.
Select the Add Driver button in the lower part of the form to add the Driver Interface.
Data is now publishing to the Kafka broker.
Select the Save button from the toolbar to save your configuration.
You can view the Getting Started with Kafka Video to familiarize yourself with the following steps to setup OAS as a producer and consumer of Kafka.
Open Automation Software can be setup to transfer data from MTConnnect data streams to Kafka brokers. Use the following guide to setup data transfer from MTConnect to Kafka. This tutorial walks you through downloading and installing OAS, defining MTConnect interface with automated tag creation, and publishing data to Kafka in a JSON format. The message topic to publish is automatically formatted to include tag id, value, quality, and timestamp. All JSON packet parameters are configurable to deliver the Kafka topic message in the desired format.
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
When the installation is finished the OAS Service Control application will appear. Use this application to start the 4 Services. If this is the first time installing the software it will automatically enter Runtime with an example Tag Configuration.
For more detailed instructions on configuring your MTConnect data source, click here to see our Getting Started MTConnect tutorial or watch the video tutorial below:
Note: OAS can automate the tag creation under the driver interface for MTConnect.
To add a Tag manually:
For more detailed instructions on configuring your tags, click here to see our Getting Started Tags tutorial.
Select Configure-Drivers.
Enter a meaningful Driver Interface Name that you will refer to this connection and define the properties.
Set the driver to Kafka. Set the Bootstrap Servers of the brokers you wish to publish to.
If sending data to the cloud set the appropriate Security Protocol.
When connecting with Confluent Cloud set the SASL Username with the provided API Key and the SASL Password with the Secret Key.
Enable Publish Selected Tags at the bottom of the Driver configuration.
Select to publish data continuously at a specified interval, based on event, or at a specific time of day.
If Event Driven browse for a local or remote OAS tag that will trigger the publish. Select a Boolean tag that will change state from false to true, true to false, or both. Or choose an Integer tag that trigger a publish anytime the value changes other than 0.
Specify the Publish Topic Id if choosing to Publish All Tags As One Topic.
When publishing as one topic to optimize communications with Kafka multiple messages are sent for each publish when the number of tag value changes exceeds the Max Tags Per Publish limit.
Specify the Tag Id, Value Id, an optional Quality Id, and Timestamp Id for each tag value that is sent.
When including the Timestamp Id also specify the timestamp format, use Custom to specify your own date and time format.
Specify local and remote OAS tag variables to include in each publish and specify the Id. Value is the current value from the data source or you can select any of the over 600 tag variables of each tag to publish.
Optionally use CSV Export and CSV Import buttons to set up additional tags to publish using Microsoft Excel.
When selecting remote tags use Basic Networking syntax or Live Data Cloud syntax in the tag path.
Select the Add Driver button in the lower part of the form to add the Driver Interface.
Data is now publishing to the Kafka broker.
Select the Save button from the toolbar to save your configuration.
You can view the Getting Started with Kafka Video to familiarize yourself with the following steps to setup OAS as a producer and consumer of Kafka.
