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

    Interface APIAdapter

    Low-level API adapter exposing all MELCloud HTTP endpoints. Methods are grouped by supported device types.

    interface APIAdapter {
        fetch: () => Promise<BuildingWithStructure[]>;
        getEnergy: <T extends DeviceType>(
            __namedParameters: { postData: EnergyPostData },
        ) => Promise<{ data: EnergyData<T> }>;
        getErrorEntries: (
            __namedParameters: { postData: ErrorLogPostData },
        ) => Promise<{ data: FailureData | ErrorLogData[] }>;
        getErrorLog: (
            query: ErrorLogQuery,
            deviceIds: number[],
        ) => Promise<ErrorLog>;
        getFrostProtection: (
            __namedParameters: { params: SettingsParams },
        ) => Promise<{ data: FrostProtectionData }>;
        getGroup: (
            __namedParameters: { postData: GetGroupPostData },
        ) => Promise<{ data: GetGroupData }>;
        getHolidayMode: (
            __namedParameters: { params: SettingsParams },
        ) => Promise<{ data: HolidayModeData }>;
        getHourlyTemperatures: (
            __namedParameters: { postData: { device: number; hour: HourNumbers } },
        ) => Promise<{ data: ReportData }>;
        getInternalTemperatures: (
            __namedParameters: { postData: ReportPostData },
        ) => Promise<{ data: ReportData }>;
        getOperationModes: (
            __namedParameters: { postData: ReportPostData },
        ) => Promise<{ data: OperationModeLogData }>;
        getSignal: (
            __namedParameters: {
                postData: { devices: number | number[]; hour: HourNumbers };
            },
        ) => Promise<{ data: ReportData }>;
        getTemperatures: (
            __namedParameters: { postData: TemperatureLogPostData },
        ) => Promise<{ data: ReportData }>;
        getTiles: (
            __namedParameters: { postData: TilesPostData<null> },
        ) => Promise<{ data: TilesData<null> }> & <T extends DeviceType>(
            __namedParameters: { postData: TilesPostData<T> },
        ) => Promise<{ data: TilesData<T> }>;
        getValues: <T extends DeviceType>(
            __namedParameters: { params: GetDeviceDataParams },
        ) => Promise<{ data: GetDeviceData<T> }>;
        onSync?: OnSyncFunction;
        setFrostProtection: (
            __namedParameters: { postData: FrostProtectionPostData },
        ) => Promise<{ data: FailureData | SuccessData }>;
        setGroup: (
            __namedParameters: { postData: SetGroupPostData },
        ) => Promise<{ data: FailureData | SuccessData }>;
        setHolidayMode: (
            __namedParameters: { postData: HolidayModePostData },
        ) => Promise<{ data: FailureData | SuccessData }>;
        setPower: (
            __namedParameters: { postData: SetPowerPostData },
        ) => Promise<{ data: boolean }>;
        setValues: <T extends DeviceType>(
            __namedParameters: { postData: SetDevicePostData<T>; type: T },
        ) => Promise<{ data: SetDeviceData<T> }>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    fetch getEnergy getErrorEntries getErrorLog getFrostProtection getGroup getHolidayMode getHourlyTemperatures getInternalTemperatures getOperationModes getSignal getTemperatures getTiles getValues onSync? setFrostProtection setGroup setHolidayMode setPower setValues

    Properties

    fetch: () => Promise<BuildingWithStructure[]>

    Fetch all buildings and sync the model registry.

    getEnergy: <T extends DeviceType>(
        __namedParameters: { postData: EnergyPostData },
    ) => Promise<{ data: EnergyData<T> }>

    Fetch energy consumption report. Supported by ATA and ATW devices.

    getErrorEntries: (
        __namedParameters: { postData: ErrorLogPostData },
    ) => Promise<{ data: FailureData | ErrorLogData[] }>

    Fetch raw error log entries from the API.

    getErrorLog: (query: ErrorLogQuery, deviceIds: number[]) => Promise<ErrorLog>

    Retrieve a parsed and paginated error log for the given devices. Supported by all device types.

    getFrostProtection: (
        __namedParameters: { params: SettingsParams },
    ) => Promise<{ data: FrostProtectionData }>

    Get frost protection settings for a building, floor, area, or device.

    getGroup: (
        __namedParameters: { postData: GetGroupPostData },
    ) => Promise<{ data: GetGroupData }>

    Fetch ATA device group state. ATA only.

    getHolidayMode: (
        __namedParameters: { params: SettingsParams },
    ) => Promise<{ data: HolidayModeData }>

    Get holiday mode settings for a building, floor, area, or device.

    getHourlyTemperatures: (
        __namedParameters: { postData: { device: number; hour: HourNumbers } },
    ) => Promise<{ data: ReportData }>

    Fetch hourly temperature report. ATW only.

    getInternalTemperatures: (
        __namedParameters: { postData: ReportPostData },
    ) => Promise<{ data: ReportData }>

    Fetch internal temperature report. ATW only.

    getOperationModes: (
        __namedParameters: { postData: ReportPostData },
    ) => Promise<{ data: OperationModeLogData }>

    Fetch operation mode log data for charting.

    getSignal: (
        __namedParameters: {
            postData: { devices: number | number[]; hour: HourNumbers };
        },
    ) => Promise<{ data: ReportData }>

    Fetch WiFi signal strength report.

    getTemperatures: (
        __namedParameters: { postData: TemperatureLogPostData },
    ) => Promise<{ data: ReportData }>

    Fetch temperature log data.

    getTiles: (
        __namedParameters: { postData: TilesPostData<null> },
    ) => Promise<{ data: TilesData<null> }> & <T extends DeviceType>(
        __namedParameters: { postData: TilesPostData<T> },
    ) => Promise<{ data: TilesData<T> }>

    Fetch tile data for device overview.

    getValues: <T extends DeviceType>(
        __namedParameters: { params: GetDeviceDataParams },
    ) => Promise<{ data: GetDeviceData<T> }>

    Fetch current device data by device and building ID.

    onSync?: OnSyncFunction

    Callback invoked after sync operations.

    setFrostProtection: (
        __namedParameters: { postData: FrostProtectionPostData },
    ) => Promise<{ data: FailureData | SuccessData }>

    Update frost protection settings.

    setGroup: (
        __namedParameters: { postData: SetGroupPostData },
    ) => Promise<{ data: FailureData | SuccessData }>

    Update ATA device group state. ATA only.

    setHolidayMode: (
        __namedParameters: { postData: HolidayModePostData },
    ) => Promise<{ data: FailureData | SuccessData }>

    Update holiday mode settings.

    setPower: (
        __namedParameters: { postData: SetPowerPostData },
    ) => Promise<{ data: boolean }>

    Turn devices on or off.

    setValues: <T extends DeviceType>(
        __namedParameters: { postData: SetDevicePostData<T>; type: T },
    ) => Promise<{ data: SetDeviceData<T> }>

    Send updated device values to the API.

    Settings

    Member Visibility

    On This Page

    Properties