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

      MELCloud & MELCloud Home API for Node.js - v23.3.3

      Classes

      AreaModel

      Area model representing a zone within a building or floor.

      BuildingModel

      Building model holding zone settings and geographic location.

      DeviceModel

      Concrete device model holding mutable device data that can be partially updated after API calls.

      FacadeManager

      Lazily creates and caches facade instances using a WeakMap keyed by model reference. Ensures each model instance maps to exactly one facade throughout its lifetime.

      FloorModel

      Floor model representing a level within a building.

      HomeDeviceAtaFacade

      Facade for a MELCloud Home ATA device. Provides typed access to device settings and temperature clamping per operation mode before sending values to the API.

      HomeDeviceModel

      Mutable wrapper around a HomeDevice, preserving object identity across syncs.

      HomeDeviceRegistry

      Lightweight device registry for the Home API. Maintains stable model references across syncs using upsert + prune.

      HomeFacadeManager

      Lazily creates and caches Home device facade instances using a WeakMap keyed by model reference. Mirrors the classic FacadeManager pattern.

      MELCloudAPI

      Main MELCloud API client. Handles authentication, device syncing, and all API endpoint calls. Uses a private constructor — create instances via MELCloudAPI.create.

      MELCloudHomeAPI

      MELCloud Home API client. Authenticates via headless OIDC login through a double-federated flow: BFF → IdentityServer → AWS Cognito.

      ModelRegistry

      Central in-memory registry of all MELCloud models (buildings, floors, areas, devices). Synced from the API response and queryable by ID or parent relationship.

      Interfaces

      API

      Full MELCloud API contract including authentication and device listing.

      APIAdapter

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

      APIConfig

      Configuration options for creating a MELCloud API instance.

      APISettings

      Persistent settings managed by the API for session authentication.

      AreaData
      AreaZone
      BaseAPIConfig

      Common configuration shared by all API clients.

      BaseDevicePostData
      BaseGetDeviceData
      BuildingData
      BuildingFacade

      Facade for a building, providing access to all its devices and zone settings.

      BuildingWithStructure
      BuildingZone
      DeviceAtwFacade

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

      DeviceAtwHasZone2Facade

      Extended ATW facade for units with two zones. Automatically couples zone operation modes so that cooling and room/flow modes stay consistent between zones.

      DeviceFacade

      Facade for an individual MELCloud device with type-safe data access and control.

      DeviceZone
      EnergyDataAta
      EnergyDataAtw
      EnergyPostData
      ErrorDetails

      A single error entry from the device error log.

      ErrorLog

      Parsed error log with pagination support.

      ErrorLogData
      ErrorLogPostData
      ErrorLogQuery

      Query parameters for paginating the error log.

      Facade

      Base facade contract shared by all facade types (building, floor, area, device).

      FailureData
      FloorData
      FloorZone
      FrostProtectionData
      FrostProtectionLocation
      FrostProtectionPostData
      FrostProtectionQuery

      Parameters for configuring frost protection temperature bounds.

      GetDeviceDataParams
      GetGroupData
      GetGroupPostData
      GroupState
      HolidayModeData
      HolidayModeLocation
      HolidayModePostData
      HolidayModeQuery

      Parameters for enabling or disabling holiday mode.

      HolidayModeTimeZone
      HomeAPI

      MELCloud Home API contract.

      HomeAPIConfig

      Configuration options for the MELCloud Home API.

      HomeAtaValues
      HomeBuilding
      HomeClaim
      HomeContext
      HomeDevice
      HomeDeviceCapabilities
      HomeDeviceSetting
      HomeEnergyData
      HomeEnergyMeasure
      HomeEnergyPoint
      HomeErrorLogEntry
      HomeReportData
      HomeReportDataset
      HomeReportPoint
      HomeUser
      HotWaterState

      ATW hot water state derived from device data.

      ListDevice
      ListDeviceDataAta

      ATA properties that use different names in list responses vs set requests (e.g., FanSpeed in list, SetFanSpeed in set).

      ListDeviceDataAtw
      ListDeviceDataErv
      Logger

      Logger interface for API call tracing.

      LoginCredentials
      LoginData
      LoginPostData
      OperationModeZoneDataAtw
      ReportChartLineOptions

      Line chart data with named series and a measurement unit.

      ReportChartPieOptions

      Pie chart data with labeled segments.

      ReportData
      ReportPostData
      ReportQuery

      Date range query for report endpoints.

      SetDeviceDataAta
      SetDeviceDataAtaInList

      ATA properties that use different names in list responses vs set requests (e.g., FanSpeed in list, SetFanSpeed in set).

      SetDeviceDataAtw
      SetDeviceDataErv
      SetGroupPostData
      SetPowerPostData
      SettingManager

      External storage adapter for persisting API session settings.

      SettingsParams
      SuccessData
      TemperatureDataAtw
      TemperatureLogPostData
      TilesData
      UpdateDeviceDataAta
      UpdateDeviceDataAtw
      UpdateDeviceDataErv
      ZoneFacade

      Facade for zones (building, floor, area) that contain multiple ATA devices supporting group operations.

      ZoneSettings
      ZoneState

      Type Aliases

      AreaDataAny
      DateTimeComponents
      DeviceFacadeAny

      Union of all device facade types.

      DeviceModelAny

      Union of all device model types.

      DeviceType

      MELCloud device type identifiers.

      EnergyData
      FanSpeed

      Fan speed levels for ATA and ERV devices.

      GetDeviceData
      HomeDeviceType

      MELCloud Home API device type identifiers, matching context response keys.

      HomeFanSpeed
      HomeHorizontal
      HomeOperationMode
      HomeVertical
      Horizontal

      Horizontal vane positions for ATA devices.

      KeyOfSetDeviceDataAtaNotInList

      Set-request property names that have no direct counterpart in list responses (they map to SetDeviceDataAtaInList names instead).

      LabelType

      Report axis label formatting types.

      Language

      MELCloud supported language codes.

      ListDeviceAny
      ListDeviceData
      ListDeviceDataAny
      Model

      Base type for all model classes.

      NonSilentFanSpeed

      Fan speed values excluding silent, used in set/update commands.

      OnSyncFunction

      Callback invoked after sync operations, with optional device IDs and type filter.

      OperationMode

      ATA device operation modes.

      OperationModeLogData
      OperationModeState

      ATW device real-time operation state.

      OperationModeStateHotWater

      ATW hot water derived operational state.

      OperationModeStateZone

      ATW zone derived operational state.

      OperationModeZone

      ATW zone operation modes controlling temperature regulation strategy.

      SetDeviceData
      SetDevicePostData
      Temperature

      ATA set-temperature limits (universal across all ATA models).

      TilesPostData
      UpdateDeviceData
      VentilationMode

      ERV ventilation modes.

      Vertical

      Vertical vane positions for ATA devices.

      Zone
      ZoneAtw

      ATW zone state derived from device data.

      Variables

      coolModes

      Pre-built sets of ATA operation modes that support cooling or heating.

      DeviceType

      MELCloud device type identifiers.

      FanSpeed

      Fan speed levels for ATA and ERV devices.

      fanSpeedFromClassic
      fanSpeedToClassic
      FLAG_UNCHANGED

      Effective flags value indicating no specific fields were changed; all data should be included.

      heatModes
      HomeDeviceType

      MELCloud Home API device type identifiers, matching context response keys.

      homeDeviceTypeFromClassic
      homeDeviceTypeToClassic
      Horizontal

      Horizontal vane positions for ATA devices.

      horizontalFromClassic
      horizontalToClassic
      LabelType

      Report axis label formatting types.

      Language

      MELCloud supported language codes.

      OPERATION_MODE_MIXED

      Synthetic operation mode for buildings with devices in different modes. Not a real API value — used at the application layer for mixed-state display.

      OperationMode

      ATA device operation modes.

      operationModeFromClassic
      OperationModeState

      ATW device real-time operation state.

      OperationModeStateHotWater

      ATW hot water derived operational state.

      OperationModeStateZone

      ATW zone derived operational state.

      operationModeToClassic
      OperationModeZone

      ATW zone operation modes controlling temperature regulation strategy.

      Temperature

      ATA set-temperature limits (universal across all ATA models).

      VentilationMode

      ERV ventilation modes.

      Vertical

      Vertical vane positions for ATA devices.

      verticalFromClassic
      verticalToClassic

      Functions

      authenticate
      fetchDevices

      Method decorator that triggers an API fetch before executing the decorated method.

      hasZone2

      Type guard that narrows an ATW facade to the zone 2 variant. Allows consumers to safely access zone2 without type assertions.

      isAtaFacade

      Type guard that narrows a device facade to the ATA variant.

      isAtwFacade

      Type guard that narrows a device facade to the ATW variant. Allows consumers to safely access hotWater and zone1 without type assertions.

      isDeviceOfType

      Type guard that narrows a DeviceModelAny to a specific DeviceModel variant. Overloads ensure the predicate type is always assignable to the union member.

      isErvFacade

      Type guard that narrows a device facade to the ERV variant.

      syncDevices

      Method decorator factory that invokes the sync callback after the decorated method completes. Works with any class that exposes notifySync (facades) or onSync (API services).

      updateDevice

      Method decorator that converts API response data back to list format and updates the device model, using effective flags to determine which fields changed.

      updateDevices

      Method decorator factory that propagates data changes to device models after the decorated method completes. Supports filtering by device type and handles the special SetPower method name for power state updates.