Class ESPCDFDeviceParam

Represents a device parameter entity with operations

Implements

ESPCDFDeviceParamInterface

Index

Constructors

Properties

_raw bounds? dataType? deviceName? events name operations properties? type? uiType? value?

Methods

dispose getRawTSData? getSimpleTSData? getTSData? setValue subscribe

Constructors

constructor

new ESPCDFDeviceParam(paramData: ESPCDFDeviceParamInterface): ESPCDFDeviceParam
Parameters
- paramData: ESPCDFDeviceParamInterface
Returns ESPCDFDeviceParam
- Defined in src/entities/ESPCDFDeviceParam.ts:39

Properties

_raw

_raw: any

`Optional`bounds

bounds?: Record<string, any>

`Optional`dataType

dataType?: string

`Optional`deviceName

deviceName?: string

`Readonly`events

events: ESPCDFOperationEventEmitter<ESPCDFDeviceParam, "setValue">

name

name: string

operations

operations: ESPCDFDeviceParamOperation

`Optional`properties

properties?: string[]

`Optional`type

type?: string

`Optional`uiType

uiType?: string

`Optional`value

value?: any

Methods

dispose

dispose(): void
Remove all listeners and clean up

Returns void
- Defined in src/entities/ESPCDFDeviceParam.ts:77

`Optional`getRawTSData

getRawTSData?(request: ESPCDFTSDataRequest): Promise<ESPCDFSimpleTSDataResponse>
Parameters
- request: ESPCDFTSDataRequest
Returns Promise<ESPCDFSimpleTSDataResponse>
- Defined in src/entities/ESPCDFDeviceParam.ts:138

`Optional`getSimpleTSData

getSimpleTSData?(
request: ESPCDFSimpleTSDataRequest,
): Promise<ESPCDFSimpleTSDataResponse>
Parameters
- request: ESPCDFSimpleTSDataRequest
Returns Promise<ESPCDFSimpleTSDataResponse>
- Defined in src/entities/ESPCDFDeviceParam.ts:132

`Optional`getTSData

getTSData?(request: ESPCDFTSDataRequest): Promise<ESPCDFSimpleTSDataResponse>
Parameters
- request: ESPCDFTSDataRequest
Returns Promise<ESPCDFSimpleTSDataResponse>
- Defined in src/entities/ESPCDFDeviceParam.ts:144

setValue

setValue(value: any): Promise<any>
Set the value of this parameter
Parameters
- value: any
Returns Promise<any>
- Defined in src/entities/ESPCDFDeviceParam.ts:125

subscribe(
listener: ESPCDFOperationListener<ESPCDFDeviceParam, "setValue">,
): () => void
Subscribe to all operation events
Parameters
- listener: ESPCDFOperationListener<ESPCDFDeviceParam, "setValue">
  The callback function to register
Returns () => void
Unsubscribe function
- Defined in src/entities/ESPCDFDeviceParam.ts:65