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

    Interface DeviceAtwFacade

    Facade for Air-to-Water (ATW) devices with per-zone temperature clamping and merged temperature reports.

    interface DeviceAtwFacade {
        api: APIAdapter;
        flags: {
            ForcedHotWaterMode: number;
            OperationModeZone1: number;
            OperationModeZone2: number;
            Power: number;
            SetCoolFlowTemperatureZone1: number;
            SetCoolFlowTemperatureZone2: number;
            SetHeatFlowTemperatureZone1: number;
            SetHeatFlowTemperatureZone2: number;
            SetTankWaterTemperature: number;
            SetTemperatureZone1: number;
            SetTemperatureZone2: number;
        };
        frostProtectionLocation: "DeviceIds";
        holidayModeLocation: "Devices";
        id: number;
        internalTemperaturesLegend: string[];
        isFrostProtectionAtZoneLevel: boolean
        | null;
        isHolidayModeAtZoneLevel: boolean | null;
        registry: ModelRegistry;
        tableName: "DeviceLocation";
        temperaturesLegend: string[];
        type: 1;
        get data(): ListDeviceData<T>;
        get device(): DeviceModel<T>;
        get devices(): DeviceModelAny[];
        get hotWater(): HotWaterState;
        get instance(): T;
        get model(): { getById: (id: number) => DeviceModelAny | undefined };
        get name(): string;
        get setData(): Required<UpdateDeviceData<T>>;
        get zone1(): ZoneState;
        fetch(): Promise<ListDeviceDataAtw>;
        getEnergy(query?: ReportQuery): Promise<EnergyDataAtw>;
        getErrors(query: ErrorLogQuery): Promise<ErrorLog>;
        getFrostProtection(): Promise<FrostProtectionData>;
        getHolidayMode(): Promise<HolidayModeData>;
        getHourlyTemperatures(hour?: HourNumbers): Promise<ReportChartLineOptions>;
        getInternalTemperatures(
            query?: ReportQuery,
            shouldUseExactRange?: boolean,
        ): Promise<ReportChartLineOptions>;
        getOperationModes(
            query?: ReportQuery,
            shouldUseExactRange?: boolean,
        ): Promise<ReportChartPieOptions>;
        getSignalStrength(hour?: HourNumbers): Promise<ReportChartLineOptions>;
        getTemperatures(
            query?: ReportQuery,
            shouldUseExactRange?: boolean,
        ): Promise<ReportChartLineOptions>;
        getTiles(device?: false): Promise<TilesData<null>>;
        getTiles(device: true | DeviceModelAny): Promise<TilesData<1>>;
        getValues(): Promise<GetDeviceData<1>>;
        getZoneState(zone: ZoneAtw): ZoneState;
        notifySync(__namedParameters?: { type?: DeviceType }): Promise<void>;
        prepareUpdateData(
            data: Partial<UpdateDeviceDataAtw>,
        ): Required<UpdateDeviceDataAtw>;
        setFrostProtection(
            __namedParameters: FrostProtectionQuery,
        ): Promise<FailureData | SuccessData>;
        setHolidayMode(
            __namedParameters?: HolidayModeQuery,
        ): Promise<FailureData | SuccessData>;
        setPower(isOn?: boolean): Promise<boolean>;
        setValues(data: Partial<UpdateDeviceData<T>>): Promise<SetDeviceDataAtw>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    api flags frostProtectionLocation holidayModeLocation id internalTemperaturesLegend isFrostProtectionAtZoneLevel isHolidayModeAtZoneLevel registry tableName temperaturesLegend type

    Accessors

    data device devices hotWater instance model name setData zone1

    Methods

    fetch getEnergy getErrors getFrostProtection getHolidayMode getHourlyTemperatures getInternalTemperatures getOperationModes getSignalStrength getTemperatures getTiles getValues getZoneState notifySync prepareUpdateData setFrostProtection setHolidayMode setPower setValues

    Properties

    api: APIAdapter
    flags: {
        ForcedHotWaterMode: number;
        OperationModeZone1: number;
        OperationModeZone2: number;
        Power: number;
        SetCoolFlowTemperatureZone1: number;
        SetCoolFlowTemperatureZone2: number;
        SetHeatFlowTemperatureZone1: number;
        SetHeatFlowTemperatureZone2: number;
        SetTankWaterTemperature: number;
        SetTemperatureZone1: number;
        SetTemperatureZone2: number;
    } = ...
    frostProtectionLocation: "DeviceIds" = 'DeviceIds'
    holidayModeLocation: "Devices" = 'Devices'
    id: number
    internalTemperaturesLegend: string[] = ...
    isFrostProtectionAtZoneLevel: boolean | null = null
    isHolidayModeAtZoneLevel: boolean | null = null
    registry: ModelRegistry
    tableName: "DeviceLocation" = 'DeviceLocation'
    temperaturesLegend: string[] = ...
    type: 1 = DeviceType.Atw

    Accessors

    • get instance(): T

      Returns T

    • 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