ISparkplugDevice Interface Methods

Connectivity Software User's Guide and Reference

ISparkplugDevice Interface Methods

Collapse All

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

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

Public Methods

	Name	Description
	DataSourceConnectionFailure	Indicates that the data source connection for the edge node or device has failed. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	DataSourceConnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully established. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	DataSourceDisconnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully disconnected. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable)
	Freeze	Freezes the device, preventing it from being considered alive.
	GetService	Gets the service object of the specified type. (Inherited from System.IServiceProvider)
	LockPublishing	Locks the publishing of metric data changes, so that they are not immediately published. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	PerformConnectDataSource	In manual data source connection mode, instructs the producer to connect to the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	PerformDisconnectDataSource	In manual data source connection mode, instructs the producer to disconnect from the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	PerformPoll	Performs the periodic polling of data from the data source, and publishes the data payload. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	PublishDataPayload	Publishes the specified data payload to the Sparkplug system (MQTT broker). (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
	Thaw	Thaws the device, allowing it to be considered alive again.
	UnlockPublishing	Publishes any assembled metric data changes, and unlocks the publishing. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)

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.
	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.

See Also

Reference

ISparkplugDevice Interface
OpcLabs.EasySparkplug Namespace

Copyright © 2004-2025 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

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.