Interface ESPRMNeoTSDataOptions

Options for time-series data queries.

Raw queries (getRawTSData): startTs is required (Unix ms; seconds are also accepted by the backend), endTs defaults to now. Aggregate queries (getTSData): window is required. Provide either no date (current live window), date (single completed window), or startDate + endDate (paginated range of completed windows).

interface ESPRMNeoTSDataOptions {
    dataType?: string;
    date?: string;
    endDate?: string;
    endTs?: number;
    key?: string;
    pageSize?: number;
    startDate?: string;
    startKey?: string;
    startTs?: number;
    window?: ESPRMNeoTSAggregationWindow;
}

Properties

dataType? date? endDate? endTs? key? pageSize? startDate? startKey? startTs? window?

Properties

OptionaldataType

dataType?: string

Overrides the param's data_type sent to the backend (rarely needed).

Optionaldate

date?: string

Single completed window: YYYY-MM-DD (or YYYY-MM-DDTHH for hourly).

OptionalendDate

endDate?: string

Range of completed windows: end date YYYY-MM-DD (with startDate).

OptionalendTs

endTs?: number

Range end, Unix timestamp in milliseconds (raw queries; defaults to now).

Optionalkey

key?: string

Overrides the backend param key entirely, skipping the node-config lookup. Required for data models the config lookup cannot resolve — e.g. Matter attributes, whose key is "0x<ep>.0x<cluster>.0x<attr>" in lowercase, unpadded hex — the exact format the firmware publishes. Must be paired with dataType, since a Matter node config carries no data types.

OptionalpageSize

pageSize?: number

Page size (backend default 20).

OptionalstartDate

startDate?: string

Range of completed windows: start date YYYY-MM-DD (with endDate).

OptionalstartKey

startKey?: string

Opaque pagination token from a previous result's nextKey.

OptionalstartTs

startTs?: number

Range start, Unix timestamp in milliseconds (raw queries; required).

Optionalwindow

window?: ESPRMNeoTSAggregationWindow

Aggregation window (aggregate queries; required).

Settings

Member Visibility

On This Page

Properties