Heatzy API for Node.js - v21.3.1
    Preparing search index...

    Class DeviceProFacade

    Facade for Pro products: single-register temperatures, humidity and reported-mode measures, open-window detection, and the presence derogation.

    Hierarchy (View Summary)

    Index
    id: string

    Wire did of the wrapped device.

    product: Product

    Product generation of the wrapped device.

    • get comfortTemperature(): number

      The comfort target temperature, clamped to the wire's accepted range.

      Returns number

      The setpoint in °C.

    • get currentMode(): Mode | null

      The mode the device is actually applying right now (wire cur_mode), which can differ from the commanded mode during a presence derogation.

      Returns Mode | null

      The reported mode, or null when the wire answers a value this SDK does not model (a code outside the six labels, null).

    • get currentSignal(): Mode | null

      The pilot-wire order the module is sending to the radiator right now (wire cur_signal, Pro only). The Pro regulates on its own sensor, so under one commanded mode it alternates between comfort and eco — this says which of them is on the wire.

      Returns Mode | null

      The order being sent, or null when the wire answers a value this SDK does not model, or none at all.

    • get currentTemperature(): number

      The measured ambient temperature.

      Returns number

      The reading in °C.

    • get derogationEndString(): string | null

      The running derogation's end, formatted for display in the configured locale — time-of-day for boost and presence, day + month + time for vacation. null when no derogation is running, when its code is one this SDK does not model, or when it was already running at first sight: the wire carries no start timestamp, so the end is only derived when a change is observed (see Device.derogationEndDate).

      Returns string | null

      The formatted end label, or null.

    • get derogationMode(): DerogationMode | null

      The running derogation mode.

      Returns DerogationMode | null

      The wire derog_mode value, or null for a code the wire allows but this SDK does not model (4 and 5 on the Pro and the Glow family).

    • get derogationTime(): number

      The derogation duration — minutes for boost, days for vacation.

      Returns number

      The wire derog_time value.

    • get ecoTemperature(): number

      The eco target temperature, clamped to the wire's accepted range.

      Returns number

      The setpoint in °C.

    • get exists(): boolean

      Whether the underlying device still exists in the registry. Non-throwing introspection: answers false instead of throwing EntityNotFoundError when the registry no longer holds the id. For consumers that keep a cached facade reference and want to detect staleness without a try/catch.

      Returns boolean

      true when the device is still resolvable.

    • get isDetectingOpenWindow(): boolean

      Whether the device has detected an open window and paused heating.

      Returns boolean

      true while open-window detection is triggered.

    • get isLocked(): boolean

      Whether the physical controls are locked.

      Returns boolean

      true when the child lock is on.

    • get isOn(): boolean

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

      Returns boolean

      true while any heating mode is active.

    • get isPresence(): boolean

      Whether a presence derogation is running and currently applying comfort.

      Returns boolean

      true during an active presence window.

    • get isTimer(): boolean

      Whether the on-device program timer is running.

      Returns boolean

      true when the timer is on.

    • get name(): string

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

      Returns string

      The wire dev_alias value.

    • get temperatureCompensation(): number

      The sensor calibration register. On the Pro it reads 0–100 in tenths of a degree centred on 50 (no change); the Glow family declares it over 0–255 with no documented scale, so the raw value is answered as is (TemperatureCompensation names the Pro's anchors).

      Returns number

      The wire com_temp value.

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

      Returns Promise<void>