Class ESPRMNeoDeviceParam

constructor

• new ESPRMNeoDeviceParam(
      data: ESPRMNeoParamInterface & { deviceName: string; uiType?: string },
      nodeRef: WeakRef<ESPRMNeoNode>,
  ): ESPRMNeoDeviceParam

  Parameters

  • data: ESPRMNeoParamInterface & { deviceName: string; uiType?: string }
  • nodeRef: WeakRef<ESPRMNeoNode>

  Returns ESPRMNeoDeviceParam

Readonly_nodeRef

Optional Readonlybounds

ReadonlydataType

ReadonlydeviceName

Readonlyid

Readonlyproperties

Readonlytype

Optional ReadonlyuiType

Optional ReadonlyvalidStrings

Optionalvalue

getLatestTSData

• getLatestTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>

  Gets the most recent time-series sample for this param from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/latest.

  Parameters

  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options (only dataType override is used).

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to time-series data with at most one point in data (empty when the param has no samples yet).

getRawTSData

• getRawTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>

  Gets raw time-series samples for this param (newest first) from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/raw.

  Parameters

  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options; startTs (Unix ms) is required, endTs defaults to now. Paginate via pageSize/startKey or the result's fetchNext().

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to raw time-series data.

getTSData

• getTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>

  Gets aggregated time-series data for this param from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/aggregates.

  Query modes (all require options.window):

  • no date options: current (live) window
  • date: one completed historical window
  • startDate + endDate: paginated range of completed windows

  Parameters

  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options (window required; date or startDate/endDate for historical windows; paginate via pageSize/startKey or the result's fetchNext()).

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to time-series data with aggregates populated.

setValue

• setValue(value: any): Promise<ESPAPIResponse>

  Parameters

  • value: any

  Returns Promise<ESPAPIResponse>