Class ESPRMNeoDevice

constructor

• new ESPRMNeoDevice(
      data: Omit<ESPRMNeoDeviceInterface, "params" | "primaryParam"> & {
          params?: {
              bounds?: Record<string, unknown>;
              dataType: string;
              deviceName?: string;
              id: string;
              properties?: string[];
              type?: string;
              uiType?: string;
              validStrings?: string[];
          }[];
          primary?: string;
      },
      nodeRef: WeakRef<ESPRMNeoNode>,
  ): ESPRMNeoDevice

  Parameters

  • data: Omit<ESPRMNeoDeviceInterface, "params" | "primaryParam"> & {
        params?: {
            bounds?: Record<string, unknown>;
            dataType: string;
            deviceName?: string;
            id: string;
            properties?: string[];
            type?: string;
            uiType?: string;
            validStrings?: string[];
        }[];
        primary?: string;
    }
  • nodeRef: WeakRef<ESPRMNeoNode>

  Returns ESPRMNeoDevice

Readonly_nodeRef

Optional Readonlyattributes

ReadonlydisplayName

Readonlyname

Readonlyparams

Optional ReadonlyprimaryParam

Readonlytype

getNode

• getNode(): undefined | ESPRMNeoNode

  Parent node, if the weak reference is still alive.

  Returns undefined | ESPRMNeoNode

getParams

• getParams(options?: GetDeviceParamsOptions): Promise<ESPRMNeoDeviceParam[]>

  Returns param values for this device.

  With cache: true (default), reads values from the local node-config cache when present and applies them onto ESPRMNeoDevice.params. With cache: false, fetches live values via the best available transport (local control first when reachable, otherwise MQTT) and updates each ESPRMNeoDeviceParam's value. Returns the same instances as ESPRMNeoDevice.params.

  Parameters

  • Optionaloptions: GetDeviceParamsOptions

    See GetDeviceParamsOptions. Defaults to { cache: true }.

  Returns Promise<ESPRMNeoDeviceParam[]>