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

    Interface HomeAPI

    MELCloud Home API contract.

    interface HomeAPI {
        authenticate: (data?: LoginCredentials) => Promise<boolean>;
        clearSync: () => void;
        getEnergy: (
            id: string,
            params: { from: string; interval: string; to: string },
        ) => Promise<HomeEnergyData | null>;
        getErrorLog: (id: string) => Promise<HomeErrorLogEntry[]>;
        getSignal: (
            id: string,
            params: { from: string; to: string },
        ) => Promise<HomeEnergyData | null>;
        getTemperatures: (
            id: string,
            params: { from: string; period: string; to: string },
        ) => Promise<HomeReportData[] | null>;
        getUser: () => Promise<HomeUser | null>;
        isAuthenticated: () => boolean;
        list: () => Promise<HomeBuilding[]>;
        registry: HomeDeviceRegistry;
        setSyncInterval: (minutes: number | null) => void;
        setValues: (id: string, values: HomeAtaValues) => Promise<boolean>;
        user: HomeUser | null;
    }

    Implemented by

    Index

    Properties

    authenticate clearSync getEnergy getErrorLog getSignal getTemperatures getUser isAuthenticated list registry setSyncInterval setValues user

    Properties

    authenticate: (data?: LoginCredentials) => Promise<boolean>

    Authenticate with MELCloud Home using the provided or stored credentials.

    clearSync: () => void

    Cancel any pending automatic sync.

    getEnergy: (
        id: string,
        params: { from: string; interval: string; to: string },
    ) => Promise<HomeEnergyData | null>

    Fetch energy consumption data for a device.

    getErrorLog: (id: string) => Promise<HomeErrorLogEntry[]>

    Fetch the error log for a device.

    getSignal: (
        id: string,
        params: { from: string; to: string },
    ) => Promise<HomeEnergyData | null>

    Fetch WiFi signal strength (RSSI) telemetry for a device.

    getTemperatures: (
        id: string,
        params: { from: string; period: string; to: string },
    ) => Promise<HomeReportData[] | null>

    Fetch temperature trend summary for a device.

    getUser: () => Promise<HomeUser | null>

    Fetch the current user's claims from the BFF. Returns null on failure.

    isAuthenticated: () => boolean

    Whether a user is currently authenticated (session cookie valid).

    list: () => Promise<HomeBuilding[]>

    Fetch all buildings and sync the device registry.

    registry: HomeDeviceRegistry

    Device registry with stable model references across syncs.

    setSyncInterval: (minutes: number | null) => void

    Update the automatic sync interval and reschedule. Set to 0 or null to disable.

    setValues: (id: string, values: HomeAtaValues) => Promise<boolean>

    Update device values and refresh device data via list().

    user: HomeUser | null

    The currently authenticated user, or null.

    Settings

    Member Visibility

    On This Page

    Properties