| Name | Description | |
|---|---|---|
 | EasySparkplugEdgeNode Constructor | Overloaded. |
Connectivity Software User's Guide and Reference
EasySparkplugEdgeNode Class Members
The following tables list the members exposed by EasySparkplugEdgeNode.
| Name | Description | |
|---|---|---|
| EasySparkplugEdgeNode Constructor | Overloaded. |
| Name | Description | |
|---|---|---|
 | ApplicationOnline | Determines whether the Primary Host Application is online. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| AutoConnectSystem | Determines whether the edge automatically maintains its connection to the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| BirthDeathSequenceNumber | The number of birth-death sequence of this edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Container | (Inherited from System.ComponentModel.Component) |
| ConvertCommandData | Determines whether an attempt will be made to convert the data in the incoming command to the type of the metric. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| CustomReference | Can be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| DataSourceCondition | Contains the condition of the data source connection associated with the Sparkplug producer. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| DataSourceConnectionMode | Determines when and how the Sparkplug producer (edge node or device) connects and disconnects its data source. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Devices | The collection of Sparkplug devices in this edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| EdgeNodeId | The Sparkplug edge node ID of this edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| EffectiveEdgeNodeId | The edge node ID effectively used by the edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| GroupId | The sparkplug group ID of this edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| IsPublishingLocked | Determines whether the publishing is currently locked, i.e. metric data changes are not immediately published. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| IsStarted | Determines whether the component is currently started. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| IsSystemConnected | Indicates whether the edge node is currently instructed to keep connection to the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| LicenseInfo | Provides dictionary of license data fields and their values. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| MetricIdentificationMode | Defines how the Sparkplug metrics are identified in the Birth and Data messages. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Metrics | The collection of Sparkplug metrics that this producer publishes. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| NotificationQueueCapacity | Capacity of the notification queue. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| NotificationQueueIdleTimeToSleep | The idle time before the internal thread executing the queued notifications is stopped (in milliseconds). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| PrimaryHostId | The host ID of the primary host application that this edge node is associated with. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| ProducerOnline | Determines whether this Sparkplug producer (edge node or device) is online. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PublishingInterval | The interval in milliseconds at which the Sparkplug producer (edge node or device) publishes its data. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PublishLastDataOnly | Determines whether the Sparkplug producer (edge node or device) publishes only the last data known. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| QueueNotifications | Determines whether the component will deliver all notifications in a queued manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| ReportByException | Determines whether your code will report any changed data to the producer, or whether the producer will poll for data changes. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
 | SharedInstance | A shared instance of the edge node object. |
| Site | (Inherited from System.ComponentModel.Component) |
| SynchronizationContext | Contains synchronization context used by the object when performing asynchronous operations (including event notifications). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| SystemConnectionParameters | Gets or sets the parameters required to establish a connection to the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| SystemDescriptor | The descriptor of the Sparkplug system that this edge node is part of. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Name | Description | |
|---|---|---|
 | CanRaiseEvents | (Inherited from System.ComponentModel.Component) |
| DesignMode | (Inherited from System.ComponentModel.Component) |
| Events | (Inherited from System.ComponentModel.Component) |
| IsDisposed | Determines whether the object has been disposed. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| ServiceContainer | The service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
 | Add | Adds a Sparkplug metric to the edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Clone | Overridden. |
| 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. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| DataSourceConnectionSuccess | Indicates that the data source connection for the edge node or device has been successfully established. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| DataSourceDisconnectionSuccess | Indicates that the data source connection for the edge node or device has been successfully disconnected. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Dispose | Overloaded. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Equals | (Inherited from object) |
| GetEnumerator | (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| 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 | (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| GetSchema | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| GetService | (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| 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. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformConnectDataSource | In manual data source connection mode, instructs the producer to connect to the data source. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformConnectSystem | Instructs the edge node to connect to the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformDisconnectDataSource | In manual data source connection mode, instructs the producer to disconnect from the data source. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformDisconnectSystem | Instructs the edge node to disconnect from the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformPoll | Performs the periodic polling of data from the data source, and publishes the data payload. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PerformRebirth | Performs a rebirth of the edge node. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PublishDataPayload | Publishes the specified data payload to the Sparkplug system (MQTT broker). (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| ReadXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Start | Starts the edge node, connecting it to the Sparkplug system if configured to do so. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Stop | Stops the edge node, disconnecting it from the Sparkplug system if configured to do so and connected. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| ToString | (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| UnlockPublishing | Publishes any assembled metric data changes, and unlocks the publishing. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| 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.NotifyingWidget) |
| WriteXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
 | AsStarted | Starts the Sparkplug edge node if it is not started, and returns the same Sparkplug edge node. |
| AsStopped | Stops the Sparkplug edge node if it is started, and returns the same Sparkplug edge node. |
| Clear | Removes all devices and metrics from the Sparkplug edge node. |
| 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. |
| GetDevice | Gets the Sparkplug device with the specified device ID from the Sparkplug edge node. |
| GetMetric | Gets the Sparkplug metric with the specified metric name from the Sparkplug edge node or 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. |
| 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. |
| Name | Description | |
|---|---|---|
 | ApplicationOnlineChanged | Raised when the online status of the configured primary host application has changed. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| ConnectDataSource | Raised when the data source connection for the edge node or device is requested to be established. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| DataSourceConditionChanged | Raised when the connected condition of the data source for the edge node or device has changed. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| DisconnectDataSource | Raised when the data source connection for the edge node or device is requested to be disconnected. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Disposed | (Inherited from System.ComponentModel.Component) |
| MetricNotification | Raised for notifications related to subscribed Sparkplug metric. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PayloadNotification | Raised for notifications related to subscribed Sparkplug payload. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Poll | Raised to poll for data and return the Sparkplug payload. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| ProducerOnlineChanged | Raised when the Sparkplug producer's online status changes. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| PublishingError | Raised when a publishing error occurs in the Sparkplug producer. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Read | Raised for obtaining the Sparkplug metric read data. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Starting | Raised when the component is starting. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Stopped | Raised when the component has stopped. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| SystemConnectionStateChanged | Raised when the state of a connection to the Sparkplug system changed. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| Write | Raised for supplying the Sparkplug metric write data. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
| WriteError | Raised when a write error occurs in the Sparkplug metric. (Inherited from OpcLabs.EasySparkplug.EasySparkplugEdgeNodeCore) |
