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

    Interface BuildingFacade

    Facade for a building, providing access to all its devices and zone settings.

    interface BuildingFacade {
        api: APIAdapter;
        frostProtectionLocation: "BuildingIds";
        groupSpecificationKey: "BuildingID";
        holidayModeLocation: "Buildings";
        id: number;
        isFrostProtectionAtZoneLevel: boolean | null;
        isHolidayModeAtZoneLevel: boolean | null;
        registry: ModelRegistry;
        tableName: "Building";
        get data(): ZoneSettings;
        get devices(): DeviceModelAny[];
        get instance(): T;
        get model(): { getById: (id: number) => BuildingModel | undefined };
        get name(): string;
        fetch(): Promise<ZoneSettings>;
        getErrors(query: ErrorLogQuery): Promise<ErrorLog>;
        getFrostProtection(): Promise<FrostProtectionData>;
        getGroup(): Promise<GroupState>;
        getHolidayMode(): Promise<HolidayModeData>;
        getSignalStrength(hour?: HourNumbers): Promise<ReportChartLineOptions>;
        getTiles(device?: false): Promise<TilesData<null>>;
        getTiles<TDeviceType extends DeviceType>(
            device: DeviceModel<TDeviceType>,
        ): Promise<TilesData<TDeviceType>>;
        notifySync(__namedParameters?: { type?: DeviceType }): Promise<void>;
        setFrostProtection(
            __namedParameters: FrostProtectionQuery,
        ): Promise<FailureData | SuccessData>;
        setGroup(state: GroupState): Promise<FailureData | SuccessData>;
        setHolidayMode(
            __namedParameters?: HolidayModeQuery,
        ): Promise<FailureData | SuccessData>;
        setPower(isOn?: boolean): Promise<boolean>;
    }

    Hierarchy

    Index

    Properties

    api frostProtectionLocation groupSpecificationKey holidayModeLocation id isFrostProtectionAtZoneLevel isHolidayModeAtZoneLevel registry tableName

    Accessors

    data devices instance model name

    Methods

    fetch getErrors getFrostProtection getGroup getHolidayMode getSignalStrength getTiles notifySync setFrostProtection setGroup setHolidayMode setPower

    Properties

    api: APIAdapter
    frostProtectionLocation: "BuildingIds" = 'BuildingIds'
    groupSpecificationKey: "BuildingID" = 'BuildingID'
    holidayModeLocation: "Buildings" = 'Buildings'
    id: number
    isFrostProtectionAtZoneLevel: boolean | null = null
    isHolidayModeAtZoneLevel: boolean | null = null
    registry: ModelRegistry
    tableName: "Building" = 'Building'

    Accessors

    • get name(): string

      Returns string

    Methods

    • Trigger a sync callback for downstream consumers.

      Parameters

      Returns Promise<void>

    • Turn all devices in this facade on or off.

      Parameters

      • isOn: boolean = true

      Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods