Class MELCloudAPI

Readonlylogger

Optional ReadonlyonSync

Optional ReadonlysettingManager

registry

• get registry(): ModelRegistry

  Central model registry containing all synced buildings, floors, areas, and devices.

  Returns ModelRegistry

[dispose]

• "[dispose]"(): void

  Dispose both sync and retry timers.

  Returns void

authenticate

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

  Authenticate with MELCloud using the provided or stored credentials.

  Parameters

  • Optionaldata: LoginCredentials

  Returns Promise<boolean>

clearSync

• clearSync(): void

  Cancel any pending automatic sync timer.

  Returns void

fetch

• fetch(): Promise<BuildingWithStructure[]>

  Fetch all buildings, sync the model registry, and schedule the next auto-sync.

  Returns Promise<BuildingWithStructure[]>

  The list of fetched buildings.

getEnergy

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

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

  Type Parameters

  • T extends DeviceType

  Parameters

  • __namedParameters: { postData: EnergyPostData }

  Returns Promise<{ data: EnergyData<T> }>

getErrorEntries

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

  Fetch raw error log entries from the API.

  Parameters

  • __namedParameters: { postData: ErrorLogPostData }

  Returns Promise<{ data: FailureData | ErrorLogData[] }>

getErrorLog

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

  Retrieve a parsed, paginated error log for the specified devices. Filters out entries with invalid dates or empty messages.

  Parameters

  • query: ErrorLogQuery

    The error log query parameters (date range, pagination).

  • deviceIds: number[] = ...

    Device IDs to fetch errors for; defaults to all devices.

  Returns Promise<ErrorLog>

  Parsed error log with pagination metadata.

getFrostProtection

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

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

  Parameters

  • __namedParameters: { params: SettingsParams }

  Returns Promise<{ data: FrostProtectionData }>

getGroup

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

  Fetch ATA device group state. ATA only.

  Parameters

  • __namedParameters: { postData: GetGroupPostData }

  Returns Promise<{ data: GetGroupData }>

getHolidayMode

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

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

  Parameters

  • __namedParameters: { params: SettingsParams }

  Returns Promise<{ data: HolidayModeData }>

getHourlyTemperatures

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

  Fetch hourly temperature report. ATW only.

  Parameters

  • __namedParameters: { postData: { device: number; hour: HourNumbers } }

  Returns Promise<{ data: ReportData }>

getInternalTemperatures

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

  Fetch internal temperature report. ATW only.

  Parameters

  • __namedParameters: { postData: ReportPostData }

  Returns Promise<{ data: ReportData }>

getOperationModes

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

  Fetch operation mode log data for charting.

  Parameters

  • __namedParameters: { postData: ReportPostData }

  Returns Promise<{ data: OperationModeLogData }>

getSignal

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

  Fetch WiFi signal strength report.

  Parameters

  • __namedParameters: { postData: { devices: number | number[]; hour: HourNumbers } }

  Returns Promise<{ data: ReportData }>

getTemperatures

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

  Fetch temperature log data.

  Parameters

  • __namedParameters: { postData: TemperatureLogPostData }

  Returns Promise<{ data: ReportData }>

getTiles

• getTiles(
      __namedParameters: { postData: TilesPostData<null> },
  ): Promise<{ data: TilesData<null> }>

  Fetch tile data for device overview.

  Parameters

  • __namedParameters: { postData: TilesPostData<null> }

  Returns Promise<{ data: TilesData<null> }>

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

  Type Parameters

  • T extends DeviceType

  Parameters

  • __namedParameters: { postData: TilesPostData<T> }

  Returns Promise<{ data: TilesData<T> }>

getValues

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

  Fetch current device data by device and building ID.

  Type Parameters

  • T extends DeviceType

  Parameters

  • __namedParameters: { params: GetDeviceDataParams }

  Returns Promise<{ data: GetDeviceData<T> }>

isAuthenticated

• isAuthenticated(): boolean

  Whether a user is currently authenticated (context key valid).

  Returns boolean

list

• list(): Promise<{ data: BuildingWithStructure[] }>

  List all buildings and their device hierarchy.

  Returns Promise<{ data: BuildingWithStructure[] }>

login

• login(
      __namedParameters: { postData: LoginPostData },
  ): Promise<{ data: LoginData }>

  Perform a login request against the MELCloud API.

  Parameters

  • __namedParameters: { postData: LoginPostData }

  Returns Promise<{ data: LoginData }>

setFrostProtection

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

  Update frost protection settings.

  Parameters

  • __namedParameters: { postData: FrostProtectionPostData }

  Returns Promise<{ data: FailureData | SuccessData }>

setGroup

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

  Update ATA device group state. ATA only.

  Parameters

  • __namedParameters: { postData: SetGroupPostData }

  Returns Promise<{ data: FailureData | SuccessData }>

setHolidayMode

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

  Update holiday mode settings.

  Parameters

  • __namedParameters: { postData: HolidayModePostData }

  Returns Promise<{ data: FailureData | SuccessData }>

setLanguage

• setLanguage(language: string): Promise<void>

  Update the user's language on the server if it differs from the current locale.

  Parameters

  • language: string

    The language code to set.

  Returns Promise<void>

setPower

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

  Turn devices on or off.

  Parameters

  • __namedParameters: { postData: SetPowerPostData }

  Returns Promise<{ data: boolean }>

setSyncInterval

• setSyncInterval(minutes: number | null): void

  Update the automatic sync interval and reschedule.

  Parameters

  • minutes: number | null

    Interval in minutes. Set to 0 or null to disable auto-sync.

  Returns void

setValues

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

  Send updated device values to the API.

  Type Parameters

  • T extends DeviceType

  Parameters

  • __namedParameters: { postData: SetDevicePostData<T>; type: T }

  Returns Promise<{ data: SetDeviceData<T> }>

Staticcreate

• create(config?: APIConfig): Promise<MELCloudAPI>

  Create and initialize a new API instance, performing an initial device sync.

  Parameters

  • Optionalconfig: APIConfig

    Optional configuration for the API client.

  Returns Promise<MELCloudAPI>

  The initialized API instance.