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

    Interface ClassicBuildingFacade

    Facade for a MELCloud building, combining zone settings with super device operations.

    interface ClassicBuildingFacade {
        data: ClassicZoneSettings;
        devices: readonly ClassicDeviceAny[];
        exists: boolean;
        fetch: () => Promise<ClassicZoneSettings>;
        getErrorLog: (
            query: ClassicErrorLogQuery,
        ) => Promise<Result<ClassicErrorLog>>;
        getFrostProtection: () => Promise<Result<ProtectionState | null>>;
        getGroup: () => Promise<Result<ClassicGroupState>>;
        getHolidayMode: () => Promise<Result<HolidayModeState | null>>;
        getSignalStrength: (hour?: Hour) => Promise<Result<ReportChartLineOptions>>;
        getTiles: (device?: false) => Promise<Result<ClassicTilesData<null>>> & <
            T extends ClassicDeviceType,
        >(
            device: ClassicDevice<T>,
        ) => Promise<Result<ClassicTilesData<T>>>;
        id: number;
        name: string;
        notifySync: (params?: { type?: ClassicDeviceType }) => Promise<void>;
        updateFrostProtection: (update: ProtectionUpdate) => Promise<void>;
        updateGroupState: (state: ClassicGroupState) => Promise<void>;
        updateHolidayMode: (update: HolidayModeUpdate) => Promise<void>;
        updatePower: (value?: boolean) => Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    data devices exists fetch getErrorLog getFrostProtection getGroup getHolidayMode getSignalStrength getTiles id name notifySync updateFrostProtection updateGroupState updateHolidayMode updatePower
    data: ClassicZoneSettings
    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<ClassicZoneSettings>

    Fetch the latest building zone settings after syncing devices.

    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.

    getGroup: () => Promise<Result<ClassicGroupState>>

    Get the current group state for all ATA devices.

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

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

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

    Fetch WiFi signal strength report as line chart data.

    getTiles: (device?: false) => Promise<Result<ClassicTilesData<null>>> & <
        T extends ClassicDeviceType,
    >(
        device: ClassicDevice<T>,
    ) => Promise<Result<ClassicTilesData<T>>>

    Fetch tile overview data, optionally selecting a specific device.

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

    Trigger a sync callback for downstream consumers.

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

    Update frost protection settings with temperature clamping.

    updateGroupState: (state: ClassicGroupState) => Promise<void>

    Update the group state for all ATA devices.

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

    Enable or disable holiday mode.

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

    Turn all devices in this facade on or off.

    Settings
    Member Visibility

    On This Page
    Properties