Class MELCloudHomeAPI

Readonlylogger

Optional ReadonlyonSync

Optional ReadonlysettingManager

context

• get context(): HomeContext | null

  Returns HomeContext | null

registry

• get registry(): HomeDeviceRegistry

  Device registry with stable model references across syncs.

  Returns HomeDeviceRegistry

user

• get user(): HomeUser | null

  The currently authenticated user, or null.

  Returns HomeUser | null

[dispose]

• "[dispose]"(): void

  Returns void

authenticate

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

  Authenticate with MELCloud Home using the provided or stored credentials.

  Parameters

  • Optionaldata: LoginCredentials

  Returns Promise<boolean>

clearSync

• clearSync(): void

  Cancel any pending automatic sync.

  Returns void

getEnergy

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

  Fetch energy consumption data for a device.

  Parameters

  • id: string
  • params: { from: string; interval: string; to: string }

  Returns Promise<HomeEnergyData | null>

getErrorLog

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

  Fetch the error log for a device.

  Parameters

  • id: string

  Returns Promise<HomeErrorLogEntry[]>

getSignal

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

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

  Parameters

  • id: string
  • params: { from: string; to: string }

  Returns Promise<HomeEnergyData | null>

getTemperatures

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

  Fetch temperature trend summary for a device.

  Parameters

  • id: string
  • params: { from: string; period: string; to: string }

  Returns Promise<HomeReportData[] | null>

getUser

• getUser(): Promise<HomeUser | null>

  Fetch the current user's claims from the BFF. Returns null if the request fails (401, network error, etc.) and clears the stored user state.

  Returns Promise<HomeUser | null>

  The user or null.

isAuthenticated

• isAuthenticated(): boolean

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

  Returns boolean

list

• list(): Promise<HomeBuilding[]>

  Fetch all buildings (owned + guest), sync the device registry, and schedule the next auto-sync.

  Returns Promise<HomeBuilding[]>

  All buildings or an empty array on failure.

setSyncInterval

• setSyncInterval(minutes: number | null): void

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

  Parameters

  • minutes: number | null

  Returns void

setValues

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

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

  Parameters

  • id: string
  • values: HomeAtaValues

  Returns Promise<boolean>

Staticcreate

• create(config?: HomeAPIConfig): Promise<MELCloudHomeAPI>

  Create and initialize a MELCloud Home API instance. Authenticates and fetches the current user if credentials are provided.

  Parameters

  • Optionalconfig: HomeAPIConfig

    Optional configuration.

  Returns Promise<MELCloudHomeAPI>

  The initialized API instance.