SparkplugDevice Class Methods

For a list of all members of this type, see SparkplugDevice members.

Public Methods

	Name	Description
	Add	Adds a Sparkplug metric to the edge node.
	Clone	Overridden.
	CreateIn	Creates and returns a device (with given device ID) in the specified edge node.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
	DataSourceConnectionFailure	Indicates that the data source connection for the edge node or device has failed.
	DataSourceConnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully established.
	DataSourceDisconnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully disconnected.
	Dispose	Overloaded. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	Equals	(Inherited from object)
	Freeze	Freezes the device, preventing it from being considered alive.
	GetEnumerator
	GetHashCode	Serves as the default hash function. (Inherited from object)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
	GetObjectData	Overridden.
	GetSchema	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	GetService	Overridden.
	GetType	Gets the System.Type of the current instance. (Inherited from object)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
	LockPublishing	Locks the publishing of metric data changes, so that they are not immediately published.
	PerformConnectDataSource	In manual data source connection mode, instructs the producer to connect to the data source.
	PerformDisconnectDataSource	In manual data source connection mode, instructs the producer to disconnect from the data source.
	PerformPoll	Performs the periodic polling of data from the data source, and publishes the data payload.
	PublishDataPayload	Publishes the specified data payload to the Sparkplug system (MQTT broker).
	ReadXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	Thaw	Thaws the device, allowing it to be considered alive again.
	ToString	Overridden.
	UnlockPublishing	Publishes any assembled metric data changes, and unlocks the publishing.
	ValueEquals	Overloaded. Defines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether `this` instance has the same value as a given other instance. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	WriteXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)

Top

Protected Methods

	Name	Description
	Finalize	(Inherited from System.ComponentModel.Component)
	MemberwiseClone	Overloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
	OnApplicationOnlineChanged	Raises the ApplicationOnlineChanged event.
	OnConnectDataSource	Raises the ConnectDataSource event.
	OnContextTypesChanged	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	OnDataSourceConditionChanged	Raises the DataSourceConditionChanged event.
	OnDisconnectDataSource	Raises the DisconnectDataSource event.
	OnIsAliveChanged	Raises the IsAliveChanged event.
	OnIsFrozenChanged	Raises the IsFrozenChanged event.
	OnMetricNotification	Raises the MetricNotification event.
	OnPayloadNotification	Raises the PayloadNotification event.
	OnPoll	Raises the Poll event.
	OnProducerOnlineChanged	Raises the ProducerOnlineChanged event.
	OnPublishingError	Raises the PublishingError event.
	OnRead	Raises the Read event.
	OnStarting	Raises the Starting event.
	OnStopped	Raises the Stopped event.
	OnSystemConnectionStateChanged	Raises the SystemConnectionStateChanged event.
	OnWrite	Raises the Write event.
	OnWriteError	Raises the WriteError event.
	ReadXmlElement	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	WriteXmlElement	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)

Top

Extension Methods

	Name	Description
	Clear	Removes all metrics from the device.
	ConnectDataSourceAction	Defines an action to be performed for connecting the edge node or device to a data source.
	DataSourceConnectionFailure	Overloaded. Indicates that the data source connection for the edge node or device has failed.
	DisconnectDataSourceAction	Defines an action to be performed for disconnecting the edge node or device from a data source.
	DisposableLockPublishing	Locks the publishing of metric data changes and returns an object that unlocks the publishing upon its disposal.
	GetMetric	Gets the Sparkplug metric with the specified metric name from the Sparkplug edge node or device.
	PerformRebirth	Performs a rebirth of the device.
	PollFunction	Defines a function that will be called when the producer is polled for data.
	ReadMetric	Reads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the Sparkplug data object.
	ReadMetricValue	Reads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the metric value.
	SetState<TNode>	Sets the arbitrary object associated with the node.
	SetState	Sets the arbitrary object associated with the device.
	WriteMetric	Writes Sparkplug data to a Sparkplug metric with the specified metric name.
	WriteMetricValue	Writes a value to a Sparkplug metric with the specified metric name.

Top

Reference

SparkplugDevice Class
OpcLabs.EasySparkplug Namespace