Connectivity Software User's Guide and Reference
PublishEdgeNodePayload(IEasySparkplugConsumer,String,String,SparkplugPayload) Method
Example 



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > IEasySparkplugConsumerExtension Class > PublishEdgeNodePayload Method : PublishEdgeNodePayload(IEasySparkplugConsumer,String,String,SparkplugPayload) Method
The consumer object that will perform the operation.

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

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).

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).

The Sparkplug payload.

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

Publishes a payload for an edge node, specifying the group ID, edge node ID and the payload object.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub PublishEdgeNodePayload( _
   ByVal consumer As IEasySparkplugConsumer, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal payload As SparkplugPayload _
) 
'Usage
 
Dim consumer As IEasySparkplugConsumer
Dim groupId As String
Dim edgeNodeId As String
Dim payload As SparkplugPayload
 
IEasySparkplugConsumerExtension.PublishEdgeNodePayload(consumer, groupId, edgeNodeId, payload)
[Extension()]
public static void PublishEdgeNodePayload( 
   IEasySparkplugConsumer consumer,
   string groupId,
   string edgeNodeId,
   SparkplugPayload payload
)

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).

payload
The Sparkplug payload.

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

Exceptions
ExceptionDescription

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.

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
// This example shows how to publish a payload with multiple command metrics 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
{
    class PublishEdgeNodePayload
    {
        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();

            // Create the payload with multiple command metrics.
            var payload = new SparkplugPayload
            {
                { "Simple", new SparkplugMetricData(42) },
                { "Simple2", new SparkplugMetricData(43) }
            };
            
            Console.WriteLine("Publishing...");
            try
            {
                consumer.PublishEdgeNodePayload(hostDescriptor, "easyGroup", "easySparkplugDemo", payload);
            }
            catch (SparkplugException sparkplugException)
            {
                Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}");
                return;
            }

            Console.WriteLine("Finished.");
        }
    }
}
' This example shows how to publish a payload with multiple command metrics 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
    Class PublishEdgeNodePayload
        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()

            ' Create the payload with multiple command metrics.
            Dim payload = New SparkplugPayload From
            {
                {"Simple", New SparkplugMetricData(42)},
                {"Simple2", New SparkplugMetricData(43)}
            }

            Console.WriteLine("Publishing...")
            Try
                consumer.PublishEdgeNodePayload(hostDescriptor, "easyGroup", "easySparkplugDemo", payload)
            Catch sparkplugException As SparkplugException
                Console.WriteLine($"*** Failure: {sparkplugException.GetBaseException().Message}")
                Return
            End Try

            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

See Also