Connectivity Software User's Guide and Reference
ISparkplugDevice Interface Members
Properties  Methods  Events

OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace : ISparkplugDevice Interface

The following tables list the members exposed by ISparkplugDevice.

Public Properties
 NameDescription
 PropertyDetermines whether the Primary Host Application is online. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines whether an attempt will be made to convert the data in the incoming command to the type of the metric. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyContains the condition of the data source connection associated with the Sparkplug producer. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines when and how the Sparkplug producer (edge node or device) connects and disconnects its data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyContains device ID of this Sparkplug device.  
 PropertyContains reference to the edge node that this device belongs to.  
 PropertyDetermines whether this device is currently alive.  
 PropertyDetermines whether this device is currently frozen.  
 PropertyDetermines whether the publishing is currently locked, i.e. metric data changes are not immediately published. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines whether the component is currently started. (Inherited from OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable)
 PropertyDefines how the Sparkplug metrics are identified in the Birth and Data messages. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyThe collection of Sparkplug metrics that this producer publishes. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines whether this Sparkplug producer (edge node or device) is online. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyThe interval in milliseconds at which the Sparkplug producer (edge node or device) publishes its data. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines whether the Sparkplug producer (edge node or device) publishes only the last data known. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 PropertyDetermines whether your code will report any changed data to the producer, or whether the producer will poll for data changes. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
Top
Public Methods
 NameDescription
 MethodIndicates that the data source connection for the edge node or device has failed. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodIndicates that the data source connection for the edge node or device has been successfully established. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodIndicates that the data source connection for the edge node or device has been successfully disconnected. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable)
 MethodFreezes the device, preventing it from being considered alive.  
 MethodGets the service object of the specified type. (Inherited from System.IServiceProvider)
 MethodLocks the publishing of metric data changes, so that they are not immediately published. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodIn manual data source connection mode, instructs the producer to connect to the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodIn manual data source connection mode, instructs the producer to disconnect from the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodPerforms the periodic polling of data from the data source, and publishes the data payload. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodPublishes the specified data payload to the Sparkplug system (MQTT broker). (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
 MethodThaws the device, allowing it to be considered alive again.  
 MethodPublishes any assembled metric data changes, and unlocks the publishing. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
Top
Extension Methods
 NameDescription
Public Extension MethodRemoves all metrics from the device.
Public Extension MethodDefines an action to be performed for connecting the edge node or device to a data source.
Public Extension MethodOverloaded. Indicates that the data source connection for the edge node or device has failed.
Public Extension MethodDefines an action to be performed for disconnecting the edge node or device from a data source.
Public Extension MethodLocks the publishing of metric data changes and returns an object that unlocks the publishing upon its disposal.
Public Extension MethodGets the Sparkplug metric with the specified metric name from the Sparkplug edge node or device.
Public Extension MethodPerforms a rebirth of the device.
Public Extension MethodDefines a function that will be called when the producer is polled for data.
Public Extension MethodReads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the Sparkplug data object.
Public Extension MethodReads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the metric value.
Public Extension MethodWrites Sparkplug data to a Sparkplug metric with the specified metric name.
Public Extension MethodWrites a value to a Sparkplug metric with the specified metric name.
Top
Public Events
 NameDescription
 EventRaised when the alive status of this device has changed.  
 EventRaised when the frozen status of this device has changed.  
Top
See Also

Reference

ISparkplugDevice Interface
OpcLabs.EasySparkplug Namespace