Class Device

Readonlyprofile

point

• point(id: string): PointInfo

  Parameters

  • id: string

  Returns PointInfo

points

• points(): readonly PointInfo[]

  Metadata access (spec §32.1).

  Returns readonly PointInfo[]

readMeasurand

• readMeasurand(q: MeasurandQuery, opts?: TransportOpts): Promise<DecodedValue>

  Read a point by its semantic measurand tuple (spec §26.1).

  Parameters

  • q: MeasurandQuery
  • Optionalopts: TransportOpts

  Returns Promise<DecodedValue>

readPoint

• readPoint(id: string, opts?: TransportOpts): Promise<DecodedValue>

  Read and decode a single point by id.

  Parameters

  • id: string
  • Optionalopts: TransportOpts

  Returns Promise<DecodedValue>

readPoints

• readPoints(
      ids: readonly string[],
      opts?: TransportOpts,
  ): Promise<Map<string, DecodedValue>>

  Read several points; refs are resolved once per call.

  Parameters

  • ids: readonly string[]
  • Optionalopts: TransportOpts

  Returns Promise<Map<string, DecodedValue>>

runCommand

• runCommand(
      id: string,
      params?: Record<string, EncodableValue>,
      opts?: TransportOpts,
  ): Promise<Map<string, DecodedValue>>

  Execute a §11.7 command: params are the caller's inputs keyed by CommandParam.field; the returned map holds results keyed by CommandResult.field. Steps run strictly in declaration order; a poll step past its timeout_ms rejects with PollTimeoutError. Poll conditions and trigger writes use raw (pre-transform) register values.

  Parameters

  • id: string
  • params: Record<string, EncodableValue> = {}
  • Optionalopts: TransportOpts

  Returns Promise<Map<string, DecodedValue>>

writePoint

• writePoint(
      id: string,
      value: EncodableValue,
      opts?: TransportOpts,
  ): Promise<void>

  Encode and write a value, validating access mode and §11.4 constraints.

  Parameters

  • id: string
  • value: EncodableValue
  • Optionalopts: TransportOpts

  Returns Promise<void>

Staticcreate

• create(doc: ModDefDocument, deviceId: undefined | string, t: Transport): Device

  Bind a transport to the named device profile in doc (or the only one).

  Parameters

  • doc: ModDefDocument
  • deviceId: undefined | string
  • t: Transport

  Returns Device