

'Declaration<ExceptionContractAnnotationAttribute(True)> <CLSCompliantAttribute(True)> <TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)> <ValueControlAttribute("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.83.473.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=False, Export=True, PageId=10001)> <SerializableAttribute()> Public Class SparkplugPayloadSubscriptionArguments Inherits SparkplugSubscriptionArguments Implements LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.OperationModel.ComTypes._OperationArguments, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
'UsageDim instance As SparkplugPayloadSubscriptionArguments
[ExceptionContractAnnotation(true)] [CLSCompliant(true)] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.83.473.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=false, Export=true, PageId=10001)] [Serializable()] public class SparkplugPayloadSubscriptionArguments : SparkplugSubscriptionArguments, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.OperationModel.ComTypes._OperationArguments, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
[ExceptionContractAnnotation(true)] [CLSCompliant(true)] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.83.473.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=false, Export=true, PageId=10001)] [Serializable()] public ref class SparkplugPayloadSubscriptionArguments : public SparkplugSubscriptionArguments, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.OperationModel.ComTypes._OperationArguments, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
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.
// This example shows how to receive payload with only the metrics that actually contained in the message. // // 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 System.Collections.Generic; using OpcLabs.EasySparkplug; using OpcLabs.EasySparkplug.OperationModel; namespace SparkplugDocExamples.Consumer._EasySparkplugConsumer { class DeliverCompleteDataSet { public static void Main1() { // Note that the default port for the "mqtt" scheme is 1883. var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost"); // Instantiate the consumer object and hook events. var consumer = new EasySparkplugConsumer(); consumer.PayloadNotification += consumer_Main1_PayloadNotification; Console.WriteLine("Subscribing..."); consumer.SubscribePayload( new EasySparkplugPayloadSubscriptionArguments( hostDescriptor, new SparkplugEdgeNodeDescriptor("easyGroup", "easySparkplugDemo")) { // Specify that we do not want the component to fill in metrics that have not been sent in the message. DeliverCompleteDataSet = false }); Console.WriteLine("Processing notifications for 20 seconds..."); System.Threading.Thread.Sleep(20 * 1000); Console.WriteLine("Unsubscribing..."); consumer.UnsubscribeAllPayloads(); Console.WriteLine("Waiting for 5 seconds..."); System.Threading.Thread.Sleep(5 * 1000); Console.WriteLine("Finished."); } static void consumer_Main1_PayloadNotification(object sender, EasySparkplugPayloadNotificationEventArgs eventArgs) { // Handle different types of notifications. Console.WriteLine(); switch (eventArgs.NotificationType) { case SparkplugNotificationType.Connect: Console.WriteLine($"Connected to Sparkplug host, client ID: {eventArgs.ClientId}."); break; case SparkplugNotificationType.Disconnect: Console.WriteLine("Disconnected from Sparkplug host."); break; case SparkplugNotificationType.Data: case SparkplugNotificationType.Birth: Console.WriteLine("Received birth or data message from Sparkplug host."); // Display the metrics name and data for each metric delivered in the payload. foreach (KeyValuePair<string, SparkplugMetricElement> pair in eventArgs.Payload) Console.WriteLine($"{pair.Key}: {pair.Value.MetricData}"); break; case SparkplugNotificationType.Death: Console.WriteLine("Received death message from Sparkplug host."); break; } if (!eventArgs.Succeeded) Console.WriteLine($"*** Failure: {eventArgs.ErrorMessageBrief}"); } } }
' This example shows how to receive payload with only the metrics that actually contained in the message. ' ' 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 DeliverCompleteDataSet Public Shared Sub Main1() ' Note that the default port for the "mqtt" scheme is 1883. Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost") ' Instantiate the consumer object and hook events. Dim consumer = New EasySparkplugConsumer() AddHandler consumer.PayloadNotification, AddressOf consumer_Main1_PayloadNotification Console.WriteLine("Subscribing...") consumer.SubscribePayload( New EasySparkplugPayloadSubscriptionArguments( hostDescriptor, New SparkplugEdgeNodeDescriptor("easyGroup", "easySparkplugDemo")) _ With { _ _ ' Specify that we do not want the component to fill in metrics that have not been sent in the message. .DeliverCompleteDataSet = False} ) Console.WriteLine("Processing notifications for 20 seconds...") Threading.Thread.Sleep(20 * 1000) Console.WriteLine("Unsubscribing...") consumer.UnsubscribeAllPayloads() Console.WriteLine("Waiting for 5 seconds...") Threading.Thread.Sleep(5 * 1000) Console.WriteLine("Finished.") End Sub Private Shared Sub consumer_Main1_PayloadNotification(ByVal sender As Object, ByVal eventArgs As EasySparkplugPayloadNotificationEventArgs) ' Handle different types of notifications. Console.WriteLine() Select Case eventArgs.NotificationType Case SparkplugNotificationType.Connect Console.WriteLine($"Connected to Sparkplug host, client ID: {eventArgs.ClientId}.") Case SparkplugNotificationType.Disconnect Console.WriteLine("Disconnected from Sparkplug host.") Case SparkplugNotificationType.Data, SparkplugNotificationType.Birth Console.WriteLine("Received birth or data message from Sparkplug host.") ' Display the metrics name and data for each metric delivered in the payload. For Each pair As KeyValuePair(Of String, SparkplugMetricElement) In eventArgs.Payload Console.WriteLine($"{pair.Key}: {pair.Value.MetricData}") Next Case SparkplugNotificationType.Death Console.WriteLine("Received death message from Sparkplug host.") End Select If Not eventArgs.Succeeded Then Console.WriteLine($"*** Failure: {eventArgs.ErrorMessageBrief}") End If End Sub End Class End Namespace
System.Object
OpcLabs.BaseLib.Object2
OpcLabs.BaseLib.Info
OpcLabs.BaseLib.OperationModel.OperationArguments
OpcLabs.EasySparkplug.OperationModel.SparkplugArguments
OpcLabs.EasySparkplug.OperationModel.SparkplugSubscriptionArguments
OpcLabs.EasySparkplug.OperationModel.SparkplugPayloadSubscriptionArguments
OpcLabs.EasySparkplug.OperationModel.EasySparkplugPayloadSubscriptionArguments