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

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

The following tables list the members exposed by IEasySparkplugEdgeNode.

Public Properties
 NameDescription
PropertyApplicationOnlineDetermines whether the Primary Host Application is online. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyAutoConnectSystemDetermines whether the edge automatically maintains its connection to the Sparkplug system.  
PropertyBirthDeathSequenceNumberThe number of birth-death sequence of this edge node.  
PropertyConvertCommandDataDetermines 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)
PropertyDataSourceConditionContains the condition of the data source connection associated with the Sparkplug producer. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyDataSourceConnectionModeDetermines when and how the Sparkplug producer (edge node or device) connects and disconnects its data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyDevicesThe collection of Sparkplug devices in this edge node.  
PropertyEdgeNodeIdThe Sparkplug edge node ID of this edge node.  
PropertyGroupIdThe sparkplug group ID of this edge node.  
PropertyIsPublishingLockedDetermines whether the publishing is currently locked, i.e. metric data changes are not immediately published. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyIsStartedDetermines whether the component is currently started. (Inherited from OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable)
PropertyIsSystemConnectedIndicates whether the edge node is currently instructed to keep connection to the Sparkplug system.  
PropertyMetricIdentificationModeDefines how the Sparkplug metrics are identified in the Birth and Data messages. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyMetricsThe collection of Sparkplug metrics that this producer publishes. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyPrimaryHostIdThe host ID of the primary host application that this edge node is associated with.  
PropertyProducerOnlineDetermines whether this Sparkplug producer (edge node or device) is online. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyPublishingIntervalThe interval in milliseconds at which the Sparkplug producer (edge node or device) publishes its data. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyPublishLastDataOnlyDetermines whether the Sparkplug producer (edge node or device) publishes only the last data known. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
PropertyReportByExceptionDetermines 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)
PropertySystemConnectionParametersGets or sets the parameters required to establish a connection to the Sparkplug system.  
PropertySystemDescriptorThe descriptor of the Sparkplug system that this edge node is part of.  
Top
Public Methods
 NameDescription
MethodDataSourceConnectionFailureIndicates that the data source connection for the edge node or device has failed. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodDataSourceConnectionSuccessIndicates that the data source connection for the edge node or device has been successfully established. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodDataSourceDisconnectionSuccessIndicates that the data source connection for the edge node or device has been successfully disconnected. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable)
MethodGetServiceGets the service object of the specified type. (Inherited from System.IServiceProvider)
MethodLockPublishingLocks the publishing of metric data changes, so that they are not immediately published. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodPerformConnectDataSourceIn manual data source connection mode, instructs the producer to connect to the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodPerformConnectSystemInstructs the edge node to connect to the Sparkplug system.  
MethodPerformDisconnectDataSourceIn manual data source connection mode, instructs the producer to disconnect from the data source. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodPerformDisconnectSystemInstructs the edge node to disconnect from the Sparkplug system.  
MethodPerformPollPerforms the periodic polling of data from the data source, and publishes the data payload. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodPerformRebirthPerforms a rebirth of the edge node.  
MethodPublishDataPayloadPublishes the specified data payload to the Sparkplug system (MQTT broker). (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
MethodStartStarts the edge node, connecting it to the Sparkplug system if configured to do so.  
MethodStopStops the edge node, disconnecting it from the Sparkplug system if configured to do so and connected.  
MethodUnlockPublishingPublishes any assembled metric data changes, and unlocks the publishing. (Inherited from OpcLabs.EasySparkplug.ISparkplugProducer)
Top
Extension Methods
 NameDescription
Public Extension MethodAsStartedStarts the Sparkplug edge node if it is not started, and returns the same Sparkplug edge node.
Public Extension MethodAsStoppedStops the Sparkplug edge node if it is started, and returns the same Sparkplug edge node.
Public Extension MethodClearRemoves all devices and metrics from the Sparkplug edge node.
Public Extension MethodConnectDataSourceActionDefines an action to be performed for connecting the edge node or device to a data source.
Public Extension MethodDataSourceConnectionFailureOverloaded. Indicates that the data source connection for the edge node or device has failed.
Public Extension MethodDisconnectDataSourceActionDefines an action to be performed for disconnecting the edge node or device from a data source.
Public Extension MethodDisposableLockPublishingLocks the publishing of metric data changes and returns an object that unlocks the publishing upon its disposal.
Public Extension MethodGetDeviceGets the Sparkplug device with the specified device ID from the Sparkplug edge node.
Public Extension MethodGetMetricGets the Sparkplug metric with the specified metric name from the Sparkplug edge node or device.
Public Extension MethodPollFunctionDefines a function that will be called when the producer is polled for data.
Public Extension MethodReadMetricReads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the Sparkplug data object.
Public Extension MethodReadMetricValueReads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the metric value.
Public Extension MethodWriteMetricWrites Sparkplug data to a Sparkplug metric with the specified metric name.
Public Extension MethodWriteMetricValueWrites a value to a Sparkplug metric with the specified metric name.
Top
See Also

Reference

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