SparkplugDevice Class

Represents a Sparkplug device (a device/sensor connected to the Sparkplug edge node).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExceptionContractAnnotationAttribute(True)>
<CLSCompliantAttribute(True)>
<TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
<DesignerCategoryAttribute("Component")>
<SerializableAttribute()>
Public Class SparkplugDevice 
   Inherits OpcLabs.BaseLib.Widgets.Widget
   Implements OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable, OpcLabs.BaseLib.ComponentModel.IStartableEvents, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, IEasySparkplugNotificationEvents, ISparkplugDevice, ISparkplugMetricEvents, ISparkplugProducer, ISparkplugProducerEvents, ISparkplugSystemConnectionMonitoring, System.Collections.Generic.IEnumerable(Of SparkplugMetric), System.Collections.IEnumerable, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

'Usage
 
Dim instance As SparkplugDevice

[ExceptionContractAnnotation(true)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[DesignerCategory("Component")]
[Serializable()]
public class SparkplugDevice : OpcLabs.BaseLib.Widgets.Widget, OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable, OpcLabs.BaseLib.ComponentModel.IStartableEvents, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, IEasySparkplugNotificationEvents, ISparkplugDevice, ISparkplugMetricEvents, ISparkplugProducer, ISparkplugProducerEvents, ISparkplugSystemConnectionMonitoring, System.Collections.Generic.IEnumerable<SparkplugMetric>, System.Collections.IEnumerable, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

[ExceptionContractAnnotation(true)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[DesignerCategory("Component")]
[Serializable()]
public ref class SparkplugDevice : public OpcLabs.BaseLib.Widgets.Widget, OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable, OpcLabs.BaseLib.ComponentModel.IStartableEvents, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, IEasySparkplugNotificationEvents, ISparkplugDevice, ISparkplugMetricEvents, ISparkplugProducer, ISparkplugProducerEvents, ISparkplugSystemConnectionMonitoring, System.Collections.Generic.IEnumerable<SparkplugMetric>, System.Collections.IEnumerable, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

Remarks

A Sparkplug device is typically a sensor, actuator, or other endpoint that communicates its data through a Sparkplug edge node. Devices do not connect directly to the MQTT broker; instead, they connect to an edge node, which aggregates and forwards their data using the Sparkplug protocol. The edge node manages the lifecycle, state, and data of its devices, ensuring reliable and structured communication with the broker.

Note that the presence of one or more devices in the Sparkplug edge node is optional. The edge node may have no devices, and only expose metric on the edge node itself.

The Sparkplug device ID is stored in the DeviceId property. The collection of Sparkplug metrics that this device publishes is contained in the Metrics property of the device. 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.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         OpcLabs.BaseLib.Widgets.Widget
            OpcLabs.EasySparkplug.SparkplugDevice

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

SparkplugDevice Members
OpcLabs.EasySparkplug Namespace

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.