OpcLabs.EasySparkplug Namespace (OpcLabs.EasySparkplug)

This namespace contains classes that facilitate easy work with Sparkplug. It also contains the most important extension classes.

Classes

	Class	Description
	EasySparkplugConsumerCore	The core part of the EasySparkplugConsumer object.
	EasySparkplugEdgeNodeCore	The core part of the EasySparkplugEdgeNode object.
	EasySparkplugUriStrings	Contains URI strings used by EasySparkplugConsumerCore and EasySparkplugEdgeNodeCore.
	IEasySparkplugConsumerExtension	Contains extension methods to the IEasySparkplugConsumer interface.
	IEasySparkplugEdgeNodeExtension	Contains extension methods to the IEasySparkplugEdgeNode interface.
	ISparkplugDeviceExtension	Contains extension methods to the ISparkplugDevice interface.
	ISparkplugProducerExtension	Contains extension methods to the ISparkplugProducer interface.
	SparkplugBrokerDescriptor	Represents a descriptor for a broker in the Sparkplug system, including its connection information and custom properties.
	SparkplugConnectionDescriptor	Represents a descriptor for a connection in the Sparkplug system.
	SparkplugConnectionParameters	Parameters required to establish a connection to the Sparkplug system.
	SparkplugData	A class that stores the value in Sparkplug, together with the timestamp and the transient flag.
	SparkplugDevice	Represents a Sparkplug device (a device/sensor connected to the Sparkplug edge node).
	SparkplugDeviceCollection	A collection of Sparkplug device objects, keyed by their device ID.
	SparkplugDeviceDescriptor	Descriptor for a Sparkplug device.
	SparkplugDeviceExtension
	SparkplugEdgeNodeDescriptor	Descriptor for a Sparkplug edge node.
	SparkplugHostDescriptor	Descriptor for a Sparkplug host.
	SparkplugMetadata	Contains Sparkplug metadata. Metadata is used to describe different types of binary data.
	SparkplugMetric	Represents a Sparkplug metric, which is a data point in the Sparkplug system.
	SparkplugMetricCollection	A collection of Sparkplug metrics, keyed by the metric name.
	SparkplugMetricData	Contains data associated with a Sparkplug metric.
	SparkplugMetricElement	Represents a Sparkplug metric element, comprising the metric data and optional metadata.
	SparkplugMetricExtension	Contains extension methods to the SparkplugMetric class.
	SparkplugPayload	Represent a Sparkplug payload, which contains a collection of Sparkplug metrics, and additional data.
	SparkplugPayloadElementCollection	A collection of Sparkplug payload elements.
	SparkplugSystemDescriptor	Descriptor for a Sparkplug system.
	SparkplugTemplateDefinition	Contains definition of a Sparkplug template.
	StringSparkplugMetadataDictionary	A dictionary of Sparkplug template definitions, indexed by string keys (metric names).
	StringSparkplugMetricDataDictionary	A dictionary of Sparkplug metric data, indexed by string keys (metric names).
	StringSparkplugTemplateDefinitionDictionary	A dictionary of Sparkplug template definitions, indexed by string keys (template definition names).

Interfaces

	Interface	Description
	IEasySparkplugConsumer	Allows simple consumption of data from Sparkplug.
	IEasySparkplugEdgeNode	Represents an interface for a Sparkplug edge node, including management of the connection and interaction with the Sparkplug system. This interface provides properties and methods to configure and control the edge node and its devices.
	IEasySparkplugNotificationEvents	Defines notifications events shared by other Sparkplug interfaces.
	ISparkplugDevice	An interface representing a Sparkplug device.
	ISparkplugMetricEvents	Contains events raised by the Sparkplug metric.
	ISparkplugPayloadElementReadOnlyCollection	An interface for read-only collection of Sparkplug payload elements.
	ISparkplugProducer	Contains properties and methods provided by the Sparkplug producer (edge node or device).
	ISparkplugProducerEvents	Contains events raised by the Sparkplug producer (edge node or device).
	ISparkplugSystemConnectionMonitoring	Allows monitoring of the connection to the Sparkplug system.
	IStringSparkplugMetadataReadOnlyDictionary	An interface for read-only dictionary of Sparkplug template definitions, indexed by string keys (metric names).
	IStringSparkplugMetricDataReadOnlyDictionary	An interface for read-only dictionary of Sparkplug metric data, indexed by string keys (metric names).
	IStringSparkplugTemplateDefinitionReadOnlyDictionary	An interface for read-only dictionary of Sparkplug template definitions, indexed by string keys (template definition names).

Delegates

	Delegate	Description
	EasySparkplugMetricNotificationEventHandler	Represents the method that will handle an event raised for notifications related to subscribed Sparkplug metric.
	EasySparkplugPayloadNotificationEventHandler	Represents the method that will handle an event raised for notifications related to subscribed Sparkplug payload.
	SparkplugConnectionStateChangedEventHandler	Represents the method that will handle an event raised when the state of a connection to the Sparkplug system changed.
	SparkplugMetricReadEventHandler	Represents the method that will handle an event raised for obtaining the Sparkplug metric read data.
	SparkplugMetricWriteEventHandler	Represents the method that will handle an event raised for supplying the Sparkplug metric write data.
	SparkplugProducerErrorEventHandler	Represents the method that will handle an event raised when an error occurs in the Sparkplug producer.
	SparkplugProducerPollEventHandler	Represents the method that will handle an event raised to poll for data and return the Sparkplug payload.
	SparkplugProducerProcessedEventHandler	Represents the method that will handle an event raised when the data source connection for the edge node or device is requested to be established or disconnected.

Enumerations

	Enumeration	Description
	SparkplugComponentTypes	The types of components in the Sparkplug system.
	SparkplugDataSourceConnectionMode	Defines when and how the Sparkplug producer (edge node or device) connects and disconnects its data source.
	SparkplugDataType	Data types used in Sparkplug payloads.
	SparkplugMetricIdentificationMode	Defines how the Sparkplug metrics are identified in the Birth and Data messages.
	SparkplugVersions	The versions of the Sparkplug specification, and payload encoding schemes and their versions.

Remarks

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.

Reference

OpcLabs.EasySparkplug Assembly