@espressif/rainmaker-base-cdf
    Preparing search index...

    Class ESPRMDeviceParam

    Represents a parameter associated with a device or node, including its name, value, and metadata.

    Implements

    Index

    Constructors

    Properties

    bounds?: Record<string, any>

    Bounds for the parameter values.

    dataType: string

    The data type of the parameter.

    deviceName: string

    The name of the device to which this parameter belongs.

    name: string

    The name of the parameter.

    nodeRef: WeakRef<ESPRMNode>

    Reference to ESPRMNode.

    properties: string[]

    Additional properties related to the parameter.

    type: string

    The type of the parameter.

    uiType?: string

    The user interface type for the parameter.

    validStrings?: string[]

    The valid string values of the parameter.

    value?: any

    The value of the parameter.

    Methods

    • Retrieves raw time series data in a paginated format for this parameter. This method internally uses getTSData with raw aggregation.

      Parameters

      • request: ESPRawTSDataRequest

        The request parameters for fetching raw time series data

      Returns Promise<ESPSimpleTSDataResponse>

      A promise that resolves to a paginated response containing time series data points

    • Retrieves simple time series data in a paginated format for this parameter.

      Parameters

      • request: ESPSimpleTSDataRequest

        The request parameters for fetching time series data

      Returns Promise<ESPSimpleTSDataResponse>

      A promise that resolves to a paginated response containing time series data points

    • Retrieves time series data in a paginated format for this parameter.

      Parameters

      • request: ESPTSDataRequest

        The request parameters for fetching time series data

      Returns Promise<ESPSimpleTSDataResponse>

      A promise that resolves to a paginated response containing time series data points

    • Sets the value of the device parameter.

      Parameters

      • value: any

        The new value to set for the device parameter.

      Returns Promise<ESPAPIResponse>

      A promise that resolves to the success response from the API.