MELCloud & MELCloud Home API for Node.js - v23.3.3
    Preparing search index...

    Interface ZoneFacade

    Facade for zones (building, floor, area) that contain multiple ATA devices supporting group operations.

    interface ZoneFacade {
        devices: readonly DeviceModelAny[];
        getErrors: (query: ErrorLogQuery) => Promise<FailureData | ErrorLog>;
        getFrostProtection: () => Promise<FrostProtectionData>;
        getGroup: () => Promise<GroupState>;
        getHolidayMode: () => Promise<HolidayModeData>;
        getSignalStrength: (hour?: HourNumbers) => Promise<ReportChartLineOptions>;
        getTiles: (device?: false) => Promise<TilesData<null>> & <
            T extends DeviceType,
        >(
            device: DeviceModel<T>,
        ) => Promise<TilesData<T>>;
        id: number;
        name: string;
        notifySync: (params?: { type?: DeviceType }) => Promise<void>;
        setFrostProtection: (
            query: FrostProtectionQuery,
        ) => Promise<FailureData | SuccessData>;
        setGroup: (state: GroupState) => Promise<FailureData | SuccessData>;
        setHolidayMode: (
            query: HolidayModeQuery,
        ) => Promise<FailureData | SuccessData>;
        setPower: (value?: boolean) => Promise<boolean>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    devices getErrors getFrostProtection getGroup getHolidayMode getSignalStrength getTiles id name notifySync setFrostProtection setGroup setHolidayMode setPower

    Properties

    devices: readonly DeviceModelAny[]

    All devices managed by this facade.

    getErrors: (query: ErrorLogQuery) => Promise<FailureData | ErrorLog>

    Retrieve the error log for all devices in this facade.

    getFrostProtection: () => Promise<FrostProtectionData>

    Get the current frost protection settings.

    getGroup: () => Promise<GroupState>

    Get the current group state for all ATA devices.

    getHolidayMode: () => Promise<HolidayModeData>

    Get the current holiday mode settings.

    getSignalStrength: (hour?: HourNumbers) => Promise<ReportChartLineOptions>

    Fetch WiFi signal strength report as line chart data.

    getTiles: (device?: false) => Promise<TilesData<null>> & <T extends DeviceType>(
        device: DeviceModel<T>,
    ) => Promise<TilesData<T>>

    Fetch tile overview data, optionally selecting a specific device.

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

    Trigger a sync callback for downstream consumers.

    setFrostProtection: (
        query: FrostProtectionQuery,
    ) => Promise<FailureData | SuccessData>

    Update frost protection settings with temperature clamping.

    setGroup: (state: GroupState) => Promise<FailureData | SuccessData>

    Update the group state for all ATA devices.

    setHolidayMode: (query: HolidayModeQuery) => Promise<FailureData | SuccessData>

    Enable or disable holiday mode.

    setPower: (value?: boolean) => Promise<boolean>

    Turn all devices in this facade on or off.

    Settings

    Member Visibility

    On This Page

    Properties