DataPoint interface

Defines the data point properties.

Properties

capabilityId

The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.

dataPointConfiguration

Protocol-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.

dataSource

The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.

name

The name of the data point.

observabilityMode

An indication of how the data point should be mapped to OpenTelemetry.

Property Details

capabilityId

The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.

capabilityId?: string

Property Value

string

dataPointConfiguration

Protocol-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.

dataPointConfiguration?: string

Property Value

string

dataSource

The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.

dataSource: string

Property Value

string

name

The name of the data point.

name?: string

Property Value

string

observabilityMode

An indication of how the data point should be mapped to OpenTelemetry.

observabilityMode?: string

Property Value

string