MELCloud & MELCloud Home API for Node.js - v60.5.0
    Preparing search index...

    Interface ClassicDeviceAtwFacade

    Facade for Air-to-Water (ATW) devices with hot water and zone state access.

    interface ClassicDeviceAtwFacade {
        data: Readonly<ClassicListDeviceData<T>>;
        devices: readonly ClassicDeviceAny[];
        errorMessage: string | null;
        exists: boolean;
        fetch: () => Promise<Readonly<ClassicListDeviceDataAtw>>;
        flags: Record<keyof ClassicUpdateDeviceData<T>, number>;
        getEnergy: (query: ReportQuery) => Promise<Result<ClassicEnergyDataAtw>>;
        getEnergyReport: (
            query?: ReportQuery,
        ) => Promise<Result<ReportChartLineOptions>>;
        getErrorLog: (query: ErrorLogQuery) => Promise<Result<ClassicErrorLog>>;
        getFrostProtection: () => Promise<Result<ProtectionState | null>>;
        getHolidayMode: () => Promise<Result<HolidayModeState | null>>;
        getHourlyTemperatures: (
            hour?: Hour,
        ) => Promise<Result<ReportChartLineOptions>>;
        getInternalTemperatures: (
            query?: ReportQuery,
        ) => Promise<Result<ReportChartLineOptions>>;
        getOperationModes: (
            query?: ReportQuery,
        ) => Promise<Result<ReportChartPieOptions>>;
        getSignalStrength: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>;
        getTemperatures: (
            query?: ReportQuery,
        ) => Promise<Result<ReportChartLineOptions>>;
        getTiles: (
            device?: boolean | ClassicDeviceAny,
        ) => Promise<Result<ClassicTilesData>>;
        getValues: () => Promise<Result<ClassicGetDeviceData<1>>>;
        hotWater: ClassicHotWaterState;
        id: number;
        isAvailable: boolean;
        isInError: boolean;
        name: string;
        notifySync: (params?: { type?: ClassicDeviceType }) => Promise<void>;
        operationalState: HomeAtwOperationalState | null;
        power: boolean;
        rssi: number;
        type: 1;
        updateFrostProtection: (update: ProtectionUpdate) => Promise<void>;
        updateHolidayMode: (update: HolidayModeUpdate) => Promise<void>;
        updatePower: (value?: boolean) => Promise<void>;
        updateValues: (
            data: ClassicUpdateDeviceDataAtw,
        ) => Promise<ClassicSetDeviceDataAtw>;
        zone1: ClassicZoneState;
        zone2: ClassicZoneState | null;
    }

    Hierarchy (View Summary)

    Index
    data devices errorMessage exists fetch flags getEnergy getEnergyReport getErrorLog getFrostProtection getHolidayMode getHourlyTemperatures getInternalTemperatures getOperationModes getSignalStrength getTemperatures getTiles getValues hotWater id isAvailable isInError name notifySync operationalState power rssi type updateFrostProtection updateHolidayMode updatePower updateValues zone1 zone2
    data: Readonly<ClassicListDeviceData<T>>
    devices: readonly ClassicDeviceAny[]

    All devices managed by this facade.

    errorMessage: string | null

    The fault as MELCloud words it, in the account's language, when the dialect carries a text on the unit (Classic ErrorMessages); null on a dialect that only flags it (Home) and while there is no fault.

    exists: boolean

    Whether the underlying entity still exists in the registry. Non-throwing staleness check — see EntityNotFoundError for the throwing counterpart surfaced by other accessors.

    fetch: () => Promise<Readonly<ClassicListDeviceDataAtw>>

    Fetch the latest device data after syncing.

    flags: Record<keyof ClassicUpdateDeviceData<T>, number>

    Bitfield flags mapping each updatable property to its effective flag value.

    getEnergy: (query: ReportQuery) => Promise<Result<ClassicEnergyDataAtw>>

    Fetch energy consumption report. ATA and ATW only.

    getEnergyReport: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartLineOptions>>

    Fetch the energy report as line chart data (kWh buckets). ATA and ATW only: types without an energy report resolve an empty chart.

    getErrorLog: (query: ErrorLogQuery) => Promise<Result<ClassicErrorLog>>

    Retrieve the error log for all devices in this facade.

    getFrostProtection: () => Promise<Result<ProtectionState | null>>

    Get the current frost protection settings, null when never configured.

    getHolidayMode: () => Promise<Result<HolidayModeState | null>>

    Get the current holiday mode settings, null when never configured.

    getHourlyTemperatures: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>

    Fetch hourly temperature report. ATW only.

    getInternalTemperatures: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartLineOptions>>

    Fetch internal temperature report. ATW only.

    getOperationModes: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartPieOptions>>

    Fetch operation mode usage as pie chart data.

    getSignalStrength: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>

    Fetch WiFi signal strength report as line chart data.

    getTemperatures: (
        query?: ReportQuery,
    ) => Promise<Result<ReportChartLineOptions>>

    Fetch temperature history as line chart data.

    getTiles: (
        device?: boolean | ClassicDeviceAny,
    ) => Promise<Result<ClassicTilesData>>

    Fetch tile overview data, optionally selecting a specific device.

    getValues: () => Promise<Result<ClassicGetDeviceData<1>>>

    Fetch current device values from the Classic API; on success the registry model catches up with the answer.

    hotWater: ClassicHotWaterState

    Current hot water state.

    id: number
    isAvailable: boolean
    isInError: boolean

    true while the unit reports a fault of its own (Classic HasError, Home isInError).

    name: string
    notifySync: (params?: { type?: ClassicDeviceType }) => Promise<void>

    Trigger a sync callback for downstream consumers.

    operationalState: HomeAtwOperationalState | null

    Top-level derived operational state in the cross-dialect vocabulary, or null for an out-of-vocabulary wire number.

    power: boolean

    Whether the unit is powered on.

    rssi: number

    Last-reported Wi-Fi signal strength, in dBm.

    type: 1
    updateFrostProtection: (update: ProtectionUpdate) => Promise<void>

    Update frost protection settings with temperature clamping.

    updateHolidayMode: (update: HolidayModeUpdate) => Promise<void>

    Enable or disable holiday mode.

    updatePower: (value?: boolean) => Promise<void>

    Turn all devices in this facade on or off.

    updateValues: (
        data: ClassicUpdateDeviceDataAtw,
    ) => Promise<ClassicSetDeviceDataAtw>

    Send updated device values, clamping temperatures to valid ranges. A change set the synced state already holds is refused with NoChangesError, before any wire call.

    zone1: ClassicZoneState

    Current zone 1 state.

    zone2: ClassicZoneState | null

    Current zone 2 state, or null on a single-zone unit.

    Settings
    Member Visibility

    On This Page
    Properties