Connectivity Software User's Guide and Reference
EasySparkplugEdgeNodeCore Class
Members  Example 



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace : EasySparkplugEdgeNodeCore Class
The core part of the EasySparkplugEdgeNode object.
Syntax
'Usage
 
Dim instance As EasySparkplugEdgeNodeCore
Remarks

In your code, you will actually use the EasySparkplugEdgeNode component, which inherits from EasySparkplugEdgeNodeCore. Many members of EasySparkplugEdgeNode are already declared in EasySparkplugEdgeNodeCore.

The Sparkplug edge node ID is stored in the EdgeNodeId property. The collection of Sparkplug metrics that this edge node publishes is contained in the ISparkplugProducer.Metrics property of the edge node. You can add or remove your metrics in this collection.

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Example
// This example shows how to use the IDisposable interface to automatically stop the Sparkplug edge node.
//
// You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
// program, to subscribe to the edge node data. 
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
// Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.

using System;
using OpcLabs.EasySparkplug;
using OpcLabs.EasySparkplug.OperationModel;

namespace SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode
{
    class Dispose
    {
        static public void Main1()
        {
            // Note that the default port for the "mqtt" scheme is 1883.
            var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");

            // Instantiate the edge node object.
            // The "using" statement ensures disposal of the resource it acquires.
            using (var edgeNode = new EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo"))
            {
                // Hook events.
                edgeNode.SystemConnectionStateChanged += edgeNode_Main1_SystemConnectionStateChanged;

                // Define a metric providing random integers.
                var random = new Random();
                edgeNode.Metrics.Add(new SparkplugMetric("MyMetric").ReadValueFunction(() => random.Next()));

                // Start the edge node.
                Console.WriteLine("The edge node is starting...");
                edgeNode.Start();

                Console.WriteLine("The edge node is started.");
                Console.WriteLine();

                // Let the user decide when to stop.
                Console.WriteLine("Press Enter to stop the edge node...");
                Console.ReadLine();

                // The IDisposable.Dispose call (automatically made at the end of the "using" statement) stops the
                // EasySparkplugEdgeNode if it is started.
                Console.WriteLine("The edge node is stopping...");
            }
            Console.WriteLine("The edge node is stopped.");
        }


        static void edgeNode_Main1_SystemConnectionStateChanged(
            object sender, 
            SparkplugConnectionStateChangedEventArgs eventArgs)
        {
            // Display the new connection state (such as when the connection to the broker succeeds or fails).
            Console.WriteLine($"{nameof(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}");
        }
    }
}
' This example shows how to use the IDisposable interface to automatically stop the Sparkplug edge node.
'
' You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
' program, to subscribe to the edge node data.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
' a commercial license in order to use Online Forums, and we reply to every post.

Imports OpcLabs.EasySparkplug
Imports OpcLabs.EasySparkplug.OperationModel

Namespace Global.SparkplugDocExamples.EdgeNode._EasySparkplugEdgeNode
    Class Dispose
        Public Shared Sub Main1()
            ' Note that the default port for the "mqtt" scheme is 1883.
            Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")

            ' Instantiate the edge node object.
            ' The "using" statement ensures disposal of the resource it acquires.
            Using edgeNode = New EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo")
                ' Hook events.
                AddHandler edgeNode.SystemConnectionStateChanged, AddressOf edgeNode_Main1_SystemConnectionStateChanged

                ' Define a metric providing random integers.
                Dim random = New Random()
                edgeNode.Metrics.Add(New SparkplugMetric("MyMetric").ReadValueFunction(Function() random.Next()))

                ' Start the edge node.
                Console.WriteLine("The edge node is starting...")
                edgeNode.Start()

                Console.WriteLine("The edge node is started.")
                Console.WriteLine()

                ' Let the user decide when to stop.
                Console.WriteLine("Press Enter to stop the edge node...")
                Console.ReadLine()

                ' The IDisposable.Dispose call (automatically made at the end of the "using" statement) stops the
                ' EasySparkplugEdgeNode if it is started.
                Console.WriteLine("The edge node is stopping...")
            End Using
            Console.WriteLine("The edge node is stopped.")
        End Sub

        Private Shared Sub edgeNode_Main1_SystemConnectionStateChanged(ByVal sender As Object, ByVal eventArgs As SparkplugConnectionStateChangedEventArgs)
            ' Display the new connection state (such as when the connection to the broker succeeds or fails).
            Console.WriteLine($"{NameOf(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}")
        End Sub
    End Class
End Namespace
Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         OpcLabs.BaseLib.Widgets.Widget
            OpcLabs.BaseLib.Widgets.NotifyingWidget
               OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore
                  OpcLabs.EasySparkplug.EasySparkplugEdgeNode

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also