Class DeviceFacade

constructor

• new DeviceFacade(api: HeatzyAPIAdapter, device: Device): DeviceFacade

  Builds the facade over a registry entity.

  Parameters

  • api: HeatzyAPIAdapter

    API surface the facade calls through.

  • device: Device

    Registry entity to wrap.

  Returns DeviceFacade

Readonlyid

Readonlyproduct

derogationEndDate

• get derogationEndDate(): Temporal.ZonedDateTime | null

  When the running derogation ends, or null when none is running.

  Returns Temporal.ZonedDateTime | null

  The derogation end date, or null.

isOn

• get isOn(): boolean

  Whether the device is heating (mode is not stop).

  Returns boolean

  true while any heating mode is active.

mode

• get mode(): Mode

  The current heating mode.

  Returns Mode

  The wire mode value.

name

• get name(): string

  The user-facing device name, tracking renames across syncs.

  Returns string

  The wire dev_alias value.

previousMode

• get previousMode(): PreviousMode

  The last non-stop mode — what "back on" restores to.

  Returns PreviousMode

  The previous heating mode.

notifySync

• notifySync(): Promise<void>

  Notify the API's onSyncComplete observer, scoped to this device. Invoked by the @syncDevices decorator after each decorated mutation or read.

  Returns Promise<void>

setValues

• setValues(attributes: PostAttributes): Promise<PostAttributes>

  Send a control payload, merge the echo into the in-memory model, and notify sync observers.

  Parameters

  • attributes: PostAttributes

    Writable attributes to apply.

  Returns Promise<PostAttributes>

  The echoed attribute payload.

update

• update(data: UndefinedTolerant<Attributes>): void

  Merge a partial attribute payload into the registry entity. Invoked by the @updateDevice decorator.

  Parameters

  • data: UndefinedTolerant<Attributes>

    Partial attribute payload to merge.

  Returns void

values

• values(): Promise<Attributes>

  Refresh a live attribute read into the in-memory model and notify sync observers.

  Returns Promise<Attributes>

  The fresh attribute payload.