PublishEdgeNodeMetric(IEasySparkplugConsumer,String,String,String,SparkplugMetricData) Method

Publishes a single metric for an edge node, specifying the group ID, edge node ID, metric name and metric data.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub PublishEdgeNodeMetric( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal metricName As String, _
   ByVal metricData As SparkplugMetricData _
)

'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim groupId As String
Dim edgeNodeId As String
Dim metricName As String
Dim metricData As SparkplugMetricData
 
IEasySparkplugConsumerExtension.PublishEdgeNodeMetric(consumer, groupId, edgeNodeId, metricName, metricData)

[Extension()]
public static void PublishEdgeNodeMetric( 
   IEasySparkplugConsumer consumer,
   string groupId,
   string edgeNodeId,
   string metricName,
   SparkplugMetricData metricData
)

[Extension()]
public:
static void PublishEdgeNodeMetric( 
   IEasySparkplugConsumer^ consumer,
   String^ groupId,
   String^ edgeNodeId,
   String^ metricName,
   SparkplugMetricData^ metricData
)

Parameters

consumer

The consumer object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

groupId

The Sparkplug group ID.

The value represents a Sparkplug group ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

The value of this parameter cannot be null (Nothing in Visual Basic).

edgeNodeId

The Sparkplug edge node ID.

The value represents a Sparkplug edge node ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

The value of this parameter cannot be null (Nothing in Visual Basic).

metricName

The name of the Sparkplug metric.

The value of this parameter cannot be null (Nothing in Visual Basic).

metricData

The Sparkplug metric data.

The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasySparkplug.OperationModel.SparkplugException	The Sparkplug operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasySparkplug.OperationModel.SparkplugException

The Sparkplug operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

CSharp
VB.NET

// This example shows how to publish a command with single metric for a given edge node.
//
// In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
//
// 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.Consumer._EasySparkplugConsumer
{
    partial class PublishEdgeNodeMetric
    {
        public static void Overload1()
        {
            // Note that the default port for the "mqtt" scheme is 1883.
            var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");

            // Instantiate the consumer object.
            var consumer = new EasySparkplugConsumer();

            Console.WriteLine("Publishing...");
            try
            {
                consumer.PublishEdgeNodeMetric(hostDescriptor, 
                    "easyGroup", "easySparkplugDemo", "Simple", 
                    new SparkplugMetricData(42));   // the command metric value
            }
            catch (SparkplugException sparkplugException)
            {
                Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}");
                return;
            }

            Console.WriteLine("Finished.");
        }
    }
}

' This example shows how to publish a command with single metric for a given edge node.
'
' In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
'
' 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.Consumer._EasySparkplugConsumer
Partial Class PublishEdgeNodeMetric
Public Shared Sub Overload1()
' Note that the default port for the "mqtt" scheme is 1883.
Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")

' Instantiate the consumer object.
Dim consumer = New EasySparkplugConsumer()

Console.WriteLine("Publishing...")
Try
consumer.PublishEdgeNodeMetric(hostDescriptor,
"easyGroup", "easySparkplugDemo", "Simple",
New SparkplugMetricData(42)) ' the command metric value
Catch sparkplugException As SparkplugException
Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}")
Return
End Try

Console.WriteLine("Finished.")
End Sub
End Class
End Namespace

CSharp
VB.NET

// This example shows how to send an ever-incrementing value to a Sparkplug metric.
//
// In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
//
// 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 OpcLabs.EasySparkplug;
using OpcLabs.EasySparkplug.OperationModel;
using System;
using System.Threading;

namespace SparkplugDocExamples.Consumer._EasySparkplugConsumer
{
    partial class PublishEdgeNodeMetric
    {
        public static void Incrementing()
        {
            // Note that the default port for the "mqtt" scheme is 1883.
            var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");

            // Instantiate the consumer object.
            var consumer = new EasySparkplugConsumer();

            //
            Console.WriteLine("Publishing... (press any key to stop)");
            int i = 0;

            do
            {
                Console.WriteLine($"@{DateTime.Now}: Publishing {i}");
                try
                {
                    consumer.PublishEdgeNodeMetric(hostDescriptor,
                        "easyGroup", "easySparkplugDemo", "Simple",
                        new SparkplugMetricData(i));   // the command metric value
                }
                catch (SparkplugException sparkplugException)
                {
                    Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}");
                    return;
                }
                i = unchecked((i + 1) & 0x7FFFFFFF);
                Thread.Sleep(2 * 1000);
            } while (!Console.KeyAvailable);

            Console.WriteLine("Finished.");
        }
    }
}

' This example shows how to send an ever-incrementing value to a Sparkplug metric.
'
' In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first.
'
' 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 System.Threading
Imports OpcLabs.EasySparkplug
Imports OpcLabs.EasySparkplug.OperationModel

Namespace Global.SparkplugDocExamples.Consumer._EasySparkplugConsumer
    Partial Class PublishEdgeNodeMetric
        Public Shared Sub Incrementing()
            ' Note that the default port for the "mqtt" scheme is 1883.
            Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")

            ' Instantiate the consumer object.
            Dim consumer = New EasySparkplugConsumer()

            ' 
            Console.WriteLine("Publishing... (press any key to stop)")
            Dim i = 0

            Do
                Console.WriteLine($"@{DateTime.Now}: Publishing {i}")
                Try
                    consumer.PublishEdgeNodeMetric(hostDescriptor,
                        "easyGroup", "easySparkplugDemo", "Simple",
                        New SparkplugMetricData(i)) ' the command metric value
                Catch sparkplugException As SparkplugException
                    Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}")
                    Return
                End Try
                i = CInt((CLng(i) + 1) And &H7FFFFFFF)
                Thread.Sleep(2 * 1000)
            Loop Until Console.KeyAvailable

            Console.WriteLine("Finished.")
        End Sub
    End Class
End Namespace

Requirements

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

Reference

IEasySparkplugConsumerExtension Class
IEasySparkplugConsumerExtension Members
Overload List
AutoStartStop Property
AutoGeneratedHostId Property

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.