MELCloud & MELCloud Home API for Node.js - v48.2.0
    Preparing search index...

    Interface ClassicDeviceFacade<T>

    Facade for an individual MELCloud device with type-safe data access and control.

    interface ClassicDeviceFacade<T extends ClassicDeviceType> {
        data: Readonly<ClassicListDeviceData<T>>;
        devices: readonly ClassicDeviceAny[];
        exists: boolean;
        fetch: () => Promise<Readonly<ClassicListDeviceData<T>>>;
        flags: Record<keyof ClassicUpdateDeviceData<T>, number>;
        getEnergy: (query: ReportQuery) => Promise<Result<ClassicEnergyData<T>>>;
        getEnergyReport: (
            query?: ReportQuery,
        ) => Promise<Result<ReportChartLineOptions>>;
        getErrorLog: (
            query: ClassicErrorLogQuery,
        ) => 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: true | ClassicDeviceAny,
        ) => Promise<Result<ClassicTilesData<T>>> & (
            device?: false,
        ) => Promise<Result<ClassicTilesData<null>>>;
        getValues: () => Promise<Result<ClassicGetDeviceData<T>>>;
        id: number;
        isAvailable: boolean;
        name: string;
        notifySync: (params?: { type?: ClassicDeviceType }) => Promise<void>;
        power: boolean;
        rssi: number;
        type: T;
        updateFrostProtection: (update: ProtectionUpdate) => Promise<void>;
        updateHolidayMode: (update: HolidayModeUpdate) => Promise<void>;
        updatePower: (value?: boolean) => Promise<void>;
        updateValues: (
            data: ClassicUpdateDeviceData<T>,
        ) => Promise<ClassicSetDeviceData<T>>;
    }

    Type Parameters

    • T extends ClassicDeviceType

      Device type discriminator narrowing device data, update payloads, and report shapes.

    Hierarchy (View Summary)

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

    All devices managed by this facade.

    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<ClassicListDeviceData<T>>>

    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<ClassicEnergyData<T>>>

    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: ClassicErrorLogQuery) => 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: true | ClassicDeviceAny,
    ) => Promise<Result<ClassicTilesData<T>>> & (
        device?: false,
    ) => Promise<Result<ClassicTilesData<null>>>

    Fetch tile overview data, optionally selecting a specific device.

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

    Fetch current device values from the Classic API.

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

    Trigger a sync callback for downstream consumers.

    power: boolean

    Whether the unit is powered on.

    rssi: number

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

    type: T
    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: ClassicUpdateDeviceData<T>,
    ) => Promise<ClassicSetDeviceData<T>>

    Send updated device values, clamping temperatures to valid ranges.

    Settings
    Member Visibility

    On This Page
    Properties