Class ESPRMDevice

Represents a device with its associated attributes and parameters. Implements the ESPRMDeviceInterface.

Implements

ESPRMDeviceInterface

Index

Constructors

Properties

attributes? displayName name nodeRef params? primaryParam? type

Methods

getParams getPrimaryParam

Constructors

constructor

new ESPRMDevice(data: ESPRMDeviceInterface, nodeRef: ESPRMNode): ESPRMDevice
Creates an instance of ESPRMDevice.
Parameters
- data: ESPRMDeviceInterface
  An object containing the device details.
- nodeRef: ESPRMNode
Returns ESPRMDevice
- Defined in src/ESPRMDevice.ts:42

Properties

`Optional`attributes

attributes?: ESPRMAttribute[]

Optional attributes associated with the device.

displayName

displayName: string

The display name of the device.

name

name: string

The name of the device.

nodeRef

nodeRef: WeakRef<ESPRMNode>

Referance to ESPRMNode.

`Optional`params

params?: ESPRMDeviceParam[]

Optional parameters associated with the device.

`Optional`primaryParam

primaryParam?: ESPRMDeviceParam

The primary parameter of the device.

type

type: string

The type of the device.

Methods

getParams

getParams(): Promise<ESPRMDeviceParam[]>
Fetches the parameters for the current device.

Returns Promise<ESPRMDeviceParam[]>
A promise that resolves to an array of updated device parameters.
- Defined in src/methods/ESPRMDevice/GetParams.ts:23

getPrimaryParam

getPrimaryParam(): undefined | ESPRMDeviceParam
Gets the primary parameter for the current device.

The primary device parameter if it exists, undefined otherwise.

Returns undefined | ESPRMDeviceParam
- Defined in src/methods/ESPRMDevice/GetPrimaryParam.ts:21