MELCloud API for Node.js

Enumerations

DeviceType

Enumeration Members

Enumeration Member	Value
`Ata`	`0`
`Atw`	`1`
`Erv`	`3`

FanSpeed

Enumeration Members

Enumeration Member	Value
`auto`	`0`
`fast`	`4`
`moderate`	`3`
`silent`	`255`
`slow`	`2`
`very_fast`	`5`
`very_slow`	`1`

Horizontal

Enumeration Members

Enumeration Member	Value
`auto`	`0`
`center`	`3`
`center_left`	`2`
`center_right`	`4`
`leftwards`	`1`
`rightwards`	`5`
`swing`	`12`
`wide`	`8`

Language

Enumeration Members

Enumeration Member	Value
`bg`	`1`
`cs`	`2`
`da`	`3`
`de`	`4`
`el`	`22`
`en`	`0`
`es`	`6`
`et`	`5`
`fi`	`17`
`fr`	`7`
`hr`	`23`
`hu`	`11`
`hy`	`8`
`it`	`19`
`lt`	`10`
`lv`	`9`
`nl`	`12`
`no`	`13`
`pl`	`14`
`pt`	`15`
`ro`	`24`
`ru`	`16`
`sl`	`25`
`sq`	`26`
`sv`	`18`
`tr`	`21`
`uk`	`20`

OperationMode

Enumeration Members

Enumeration Member	Value
`auto`	`8`
`cool`	`3`
`dry`	`2`
`fan`	`7`
`heat`	`1`

OperationModeState

Enumeration Members

Enumeration Member	Value
`cooling`	`3`
`defrost`	`5`
`dhw`	`1`
`heating`	`2`
`idle`	`0`
`legionella`	`6`

OperationModeZone

Enumeration Members

Enumeration Member	Value
`curve`	`2`
`flow`	`1`
`flow_cool`	`4`
`room`	`0`
`room_cool`	`3`

VentilationMode

Enumeration Members

Enumeration Member	Value
`auto`	`2`
`bypass`	`1`
`recovery`	`0`

Vertical

Enumeration Members

Enumeration Member	Value
`auto`	`0`
`downwards`	`5`
`mid_high`	`2`
`mid_low`	`4`
`middle`	`3`
`swing`	`7`
`upwards`	`1`

Classes

default

Constructors

new default()

new default(config: {
  "language": string;
  "logger": Logger;
  "settingManager": SettingManager;
  "shouldVerifySSL": boolean;
 }): default

Parameters

Parameter	Type
`config`	`object`
`config.language`?	`string`
`config.logger`?	`Logger`
`config.settingManager`?	`SettingManager`
`config.shouldVerifySSL`?	`boolean`

Returns

default

Source

src/lib/MELCloudAPI.ts:81

Properties

Property	Modifier	Type
`language`	`readonly`	`Language`

Methods

applyLogin()

applyLogin(data?: LoginCredentials, onSuccess?: () => Promise<void>): Promise<boolean>

Parameters

Parameter	Type
`data`?	`LoginCredentials`
`onSuccess`?	() => `Promise`<`void`>

Returns

Promise<boolean>

Source

src/lib/MELCloudAPI.ts:144

errors()

errors(postData: ErrorLogPostData): Promise<{
  "data": FailureData | ErrorLogData[];
}>

Parameters

Parameter	Type
`postData`	`ErrorLogPostData`

Returns

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

Member	Type
`data`	`FailureData` \| `ErrorLogData`[]

Source

src/lib/MELCloudAPI.ts:173

get()

get<T>(id: number, buildingId: number): Promise<{
  "data": DeviceDataFromGet[T];
}>

Type parameters

Type parameter
`T` extends `"Ata"` \| `"Atw"` \| `"Erv"`

Parameters

Parameter	Type
`id`	`number`
`buildingId`	`number`

Returns

Promise<{ "data": DeviceDataFromGet[T]; }>

Member	Type
`data`	`DeviceDataFromGet`[`T`]

Source

src/lib/MELCloudAPI.ts:182

getFrostProtection()

getFrostProtection(id: number): Promise<{
  "data": FrostProtectionData;
}>

Parameters

Parameter	Type
`id`	`number`

Returns

Promise<{ "data": FrostProtectionData; }>

Member	Type
`data`	`FrostProtectionData`

Source

src/lib/MELCloudAPI.ts:191

getHolidayMode()

getHolidayMode(id: number): Promise<{
  "data": HolidayModeData;
}>

Parameters

Parameter	Type
`id`	`number`

Returns

Promise<{ "data": HolidayModeData; }>

Member	Type
`data`	`HolidayModeData`

Source

src/lib/MELCloudAPI.ts:199

list()

list(): Promise<{
  "data": Building[];
}>

Returns

Promise<{ "data": Building[]; }>

Member	Type
`data`	`Building`[]

Source

src/lib/MELCloudAPI.ts:205

login()

login(postData: LoginPostData): Promise<{
  "data": LoginData;
}>

Parameters

Parameter	Type
`postData`	`LoginPostData`

Returns

Promise<{ "data": LoginData; }>

Member	Type
`data`	`LoginData`

Source

src/lib/MELCloudAPI.ts:209

report()

report<T>(postData: ReportPostData): Promise<{
  "data": ReportData[T];
}>

Type parameters

Type parameter
`T` extends `"Ata"` \| `"Atw"` \| `"Erv"`

Parameters

Parameter	Type
`postData`	`ReportPostData`

Returns

Promise<{ "data": ReportData[T]; }>

Member	Type
`data`	`ReportData`[`T`]

Source

src/lib/MELCloudAPI.ts:220

set()

set<T>(heatPumpType: T, postData: PostData[T]): Promise<{
  "data": DeviceData[T];
}>

Type parameters

Type parameter
`T` extends `"Ata"` \| `"Atw"` \| `"Erv"`

Parameters

Parameter	Type
`heatPumpType`	`T`
`postData`	`PostData`[`T`]

Returns

Promise<{ "data": DeviceData[T]; }>

Member	Type
`data`	`DeviceData`[`T`]

Source

src/lib/MELCloudAPI.ts:226

updateFrostProtection()

updateFrostProtection(postData: FrostProtectionPostData): Promise<{
  "data": SuccessData | FailureData;
}>

Parameters

Parameter	Type
`postData`	`FrostProtectionPostData`

Returns

Promise<{ "data": SuccessData | FailureData; }>

Member	Type
`data`	`SuccessData` \| `FailureData`

Source

src/lib/MELCloudAPI.ts:233

updateHolidayMode()

updateHolidayMode(postData: HolidayModePostData): Promise<{
  "data": SuccessData | FailureData;
}>

Parameters

Parameter	Type
`postData`	`HolidayModePostData`

Returns

Promise<{ "data": SuccessData | FailureData; }>

Member	Type
`data`	`SuccessData` \| `FailureData`

Source

src/lib/MELCloudAPI.ts:242

Interfaces

APISettings

Properties

Property	Modifier	Type
`contextKey?`	`readonly`	`null` \| `string`
`expiry?`	`readonly`	`null` \| `string`
`password?`	`readonly`	`null` \| `string`
`username?`	`readonly`	`null` \| `string`

BaseDeviceData

Extended by

Properties

Property	Modifier	Type
`EffectiveFlags`	`public`	`number`
`Power?`	`readonly`	`boolean`

BaseDeviceDataFromList

Extended by

Properties

Property	Modifier	Type
`WifiSignalStrength`	`readonly`	`number`

BaseListDevice

Extended by

Properties

Property	Modifier	Type
`BuildingID`	`readonly`	`number`
`DeviceID`	`readonly`	`number`
`DeviceName`	`readonly`	`string`

BasePostData

Properties

Property	Modifier	Type
`DeviceID`	`readonly`	`number`
`HasPendingCommand`	`readonly`	`true`

BaseSuccessData

Extended by

Properties

Property	Modifier	Type
`AttributeErrors`	`readonly`	`null` \| `Record`<`string`, readonly `string`[]>
`Data`	`readonly`	`null`
`GlobalErrors`	`readonly`	`null`
`Success`	`readonly`	`boolean`

Building

Extends

BuildingData

Properties

Property	Modifier	Type	Inherited from
`FPEnabled`	`readonly`	`boolean`	`BuildingData`.`FPEnabled`
`FPMaxTemperature`	`readonly`	`number`	`BuildingData`.`FPMaxTemperature`
`FPMinTemperature`	`readonly`	`number`	`BuildingData`.`FPMinTemperature`
`HMEnabled`	`readonly`	`boolean`	`BuildingData`.`HMEnabled`
`HMEndDate`	`readonly`	`null` \| `string`	`BuildingData`.`HMEndDate`
`HMStartDate`	`readonly`	`null` \| `string`	`BuildingData`.`HMStartDate`
`ID`	`readonly`	`number`	-
`Name`	`readonly`	`string`	-
`Structure`	`readonly`	{ `"Areas"`: readonly { `"Devices"`: readonly `ListDeviceAny`[]; }[]; `"Devices"`: readonly `ListDeviceAny`[]; `"Floors"`: readonly { `"Areas"`: readonly { `"Devices"`: readonly `ListDeviceAny`[]; }[]; `"Devices"`: readonly `ListDeviceAny`[]; }[]; }	-
`Structure.Areas`	`readonly`	readonly { `"Devices"`: readonly `ListDeviceAny`[]; }[]	-
`Structure.Devices`	`public`	readonly `ListDeviceAny`[]	-
`Structure.Floors`	`public`	readonly { `"Areas"`: readonly { `"Devices"`: readonly `ListDeviceAny`[]; }[]; `"Devices"`: readonly `ListDeviceAny`[]; }[]	-
`TimeZone`	`public`	`number`	`BuildingData`.`TimeZone`

BuildingData

Extends

FrostProtectionData.Omit<HolidayModeData, "EndDate" | "StartDate">

Extended by

Building

Properties

Property	Modifier	Type	Inherited from
`FPEnabled`	`readonly`	`boolean`	`FrostProtectionData`.`FPEnabled`
`FPMaxTemperature`	`readonly`	`number`	`FrostProtectionData`.`FPMaxTemperature`
`FPMinTemperature`	`readonly`	`number`	`FrostProtectionData`.`FPMinTemperature`
`HMEnabled`	`readonly`	`boolean`	`Omit.HMEnabled`
`HMEndDate`	`readonly`	`null` \| `string`	`Omit.HMEndDate`
`HMStartDate`	`readonly`	`null` \| `string`	`Omit.HMStartDate`
`TimeZone`	`readonly`	`number`	`Omit.TimeZone`

DeviceData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`DeviceDataAta`
`Atw`	`readonly`	`DeviceDataAtw`
`Erv`	`readonly`	`DeviceDataErv`

DeviceDataAta

Extends

SetDeviceDataAta

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`SetDeviceDataAta`.`EffectiveFlags`
`OperationMode?`	`readonly`	`OperationMode`	`SetDeviceDataAta`.`OperationMode`
`Power?`	`readonly`	`boolean`	`SetDeviceDataAta`.`Power`
`RoomTemperature`	`readonly`	`number`	-
`SetFanSpeed?`	`readonly`	`FanSpeed`	`SetDeviceDataAta`.`SetFanSpeed`
`SetTemperature?`	`readonly`	`number`	`SetDeviceDataAta`.`SetTemperature`
`VaneHorizontal?`	`readonly`	`Horizontal`	`SetDeviceDataAta`.`VaneHorizontal`
`VaneVertical?`	`readonly`	`Vertical`	`SetDeviceDataAta`.`VaneVertical`

DeviceDataAtw

Extends

SetDeviceDataAtw

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`SetDeviceDataAtw`.`EffectiveFlags`
`ForcedHotWaterMode?`	`readonly`	`boolean`	`SetDeviceDataAtw`.`ForcedHotWaterMode`
`IdleZone1`	`readonly`	`boolean`	-
`IdleZone2`	`readonly`	`boolean`	-
`OperationMode`	`readonly`	`OperationModeState`	-
`OperationModeZone1?`	`readonly`	`OperationModeZone`	`SetDeviceDataAtw`.`OperationModeZone1`
`OperationModeZone2?`	`readonly`	`OperationModeZone`	`SetDeviceDataAtw`.`OperationModeZone2`
`OutdoorTemperature`	`readonly`	`number`	-
`Power?`	`readonly`	`boolean`	`SetDeviceDataAtw`.`Power`
`ProhibitCoolingZone1`	`readonly`	`boolean`	-
`ProhibitCoolingZone2`	`readonly`	`boolean`	-
`ProhibitHeatingZone1`	`readonly`	`boolean`	-
`ProhibitHeatingZone2`	`readonly`	`boolean`	-
`ProhibitHotWater`	`readonly`	`boolean`	-
`RoomTemperatureZone1`	`readonly`	`number`	-
`RoomTemperatureZone2`	`readonly`	`number`	-
`SetCoolFlowTemperatureZone1?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetCoolFlowTemperatureZone1`
`SetCoolFlowTemperatureZone2?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetCoolFlowTemperatureZone2`
`SetHeatFlowTemperatureZone1?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetHeatFlowTemperatureZone1`
`SetHeatFlowTemperatureZone2?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetHeatFlowTemperatureZone2`
`SetTankWaterTemperature?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetTankWaterTemperature`
`SetTemperatureZone1?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetTemperatureZone1`
`SetTemperatureZone2?`	`readonly`	`number`	`SetDeviceDataAtw`.`SetTemperatureZone2`
`TankWaterTemperature`	`readonly`	`number`	-

DeviceDataErv

Extends

SetDeviceDataErv

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`SetDeviceDataErv`.`EffectiveFlags`
`OutdoorTemperature`	`readonly`	`number`	-
`Power?`	`readonly`	`boolean`	`SetDeviceDataErv`.`Power`
`RoomCO2Level`	`readonly`	`number`	-
`RoomTemperature`	`readonly`	`number`	-
`SetFanSpeed?`	`readonly`	`number`	`SetDeviceDataErv`.`SetFanSpeed`
`VentilationMode?`	`readonly`	`VentilationMode`	`SetDeviceDataErv`.`VentilationMode`

DeviceDataFromGet

Properties

Property	Modifier	Type
`Ata`	`readonly`	`DeviceDataFromGetAta`
`Atw`	`readonly`	`DeviceDataFromGetAtw`
`Erv`	`readonly`	`DeviceDataFromGetErv`

DeviceDataFromListAta

Extends

BaseDeviceDataFromList.Omit<DeviceDataFromGetAta, "SetFanSpeed" | "VaneHorizontal" | "VaneVertical">

Properties

Property	Modifier	Type	Inherited from
`ActualFanSpeed`	`readonly`	`number`	-
`DeviceType`	`readonly`	`Ata`	-
`EffectiveFlags`	`public`	`0`	`Omit.EffectiveFlags`
`FanSpeed`	`readonly`	`FanSpeed`	-
`HasAutomaticFanSpeed`	`readonly`	`boolean`	-
`MaxTempAutomatic`	`readonly`	`number`	-
`MaxTempCoolDry`	`readonly`	`number`	-
`MaxTempHeat`	`readonly`	`number`	-
`MinTempAutomatic`	`readonly`	`number`	-
`MinTempCoolDry`	`readonly`	`number`	-
`MinTempHeat`	`readonly`	`number`	-
`NumberOfFanSpeeds`	`readonly`	`number`	-
`OperationMode?`	`readonly`	`OperationMode`	`Omit.OperationMode`
`OutdoorTemperature`	`readonly`	`number`	-
`Power?`	`readonly`	`boolean`	`Omit.Power`
`RoomTemperature`	`readonly`	`number`	`Omit.RoomTemperature`
`SetTemperature?`	`readonly`	`number`	`Omit.SetTemperature`
`VaneHorizontalDirection`	`readonly`	`Horizontal`	-
`VaneVerticalDirection`	`readonly`	`Vertical`	-
`WifiSignalStrength`	`readonly`	`number`	`BaseDeviceDataFromList`.`WifiSignalStrength`

DeviceDataFromListAtw

Extends

BaseDeviceDataFromList.DeviceDataFromGetAtw

Properties

Property	Modifier	Type	Inherited from
`BoosterHeater1Status`	`readonly`	`boolean`	-
`BoosterHeater2PlusStatus`	`readonly`	`boolean`	-
`BoosterHeater2Status`	`readonly`	`boolean`	-
`CanCool`	`readonly`	`boolean`	-
`CondensingTemperature`	`readonly`	`number`	-
`CurrentEnergyConsumed`	`readonly`	`number`	-
`CurrentEnergyProduced`	`readonly`	`number`	-
`DefrostMode`	`readonly`	`number`	-
`DeviceType`	`readonly`	`Atw`	-
`EcoHotWater`	`readonly`	`boolean`	-
`EffectiveFlags`	`public`	`0`	`DeviceDataFromGetAtw.EffectiveFlags`
`FlowTemperature`	`readonly`	`number`	-
`FlowTemperatureZone1`	`readonly`	`number`	-
`FlowTemperatureZone2`	`readonly`	`number`	-
`ForcedHotWaterMode?`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ForcedHotWaterMode`
`HasZone2`	`readonly`	`boolean`	-
`HeatPumpFrequency`	`readonly`	`number`	-
`IdleZone1`	`readonly`	`boolean`	`DeviceDataFromGetAtw.IdleZone1`
`IdleZone2`	`readonly`	`boolean`	`DeviceDataFromGetAtw.IdleZone2`
`ImmersionHeaterStatus`	`readonly`	`boolean`	-
`LastLegionellaActivationTime`	`readonly`	`string`	-
`MaxTankTemperature`	`readonly`	`number`	-
`MixingTankWaterTemperature`	`readonly`	`number`	-
`OperationMode`	`readonly`	`OperationModeState`	`DeviceDataFromGetAtw.OperationMode`
`OperationModeZone1?`	`readonly`	`OperationModeZone`	`DeviceDataFromGetAtw.OperationModeZone1`
`OperationModeZone2?`	`readonly`	`OperationModeZone`	`DeviceDataFromGetAtw.OperationModeZone2`
`OutdoorTemperature`	`readonly`	`number`	`DeviceDataFromGetAtw.OutdoorTemperature`
`Power?`	`readonly`	`boolean`	`DeviceDataFromGetAtw.Power`
`ProhibitCoolingZone1`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ProhibitCoolingZone1`
`ProhibitCoolingZone2`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ProhibitCoolingZone2`
`ProhibitHeatingZone1`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ProhibitHeatingZone1`
`ProhibitHeatingZone2`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ProhibitHeatingZone2`
`ProhibitHotWater`	`readonly`	`boolean`	`DeviceDataFromGetAtw.ProhibitHotWater`
`ReturnTemperature`	`readonly`	`number`	-
`ReturnTemperatureZone1`	`readonly`	`number`	-
`ReturnTemperatureZone2`	`readonly`	`number`	-
`RoomTemperatureZone1`	`readonly`	`number`	`DeviceDataFromGetAtw.RoomTemperatureZone1`
`RoomTemperatureZone2`	`readonly`	`number`	`DeviceDataFromGetAtw.RoomTemperatureZone2`
`SetCoolFlowTemperatureZone1?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetCoolFlowTemperatureZone1`
`SetCoolFlowTemperatureZone2?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetCoolFlowTemperatureZone2`
`SetHeatFlowTemperatureZone1?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetHeatFlowTemperatureZone1`
`SetHeatFlowTemperatureZone2?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetHeatFlowTemperatureZone2`
`SetTankWaterTemperature?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetTankWaterTemperature`
`SetTemperatureZone1?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetTemperatureZone1`
`SetTemperatureZone2?`	`readonly`	`number`	`DeviceDataFromGetAtw.SetTemperatureZone2`
`TankWaterTemperature`	`readonly`	`number`	`DeviceDataFromGetAtw.TankWaterTemperature`
`TargetHCTemperatureZone1`	`readonly`	`number`	-
`TargetHCTemperatureZone2`	`readonly`	`number`	-
`WifiSignalStrength`	`readonly`	`number`	`BaseDeviceDataFromList`.`WifiSignalStrength`
`Zone1InCoolMode`	`readonly`	`boolean`	-
`Zone1InHeatMode`	`readonly`	`boolean`	-
`Zone2InCoolMode`	`readonly`	`boolean`	-
`Zone2InHeatMode`	`readonly`	`boolean`	-

DeviceDataFromListErv

Extends

BaseDeviceDataFromList.DeviceDataFromGetErv

Properties

Property	Modifier	Type	Inherited from
`DeviceType`	`readonly`	`Erv`	-
`EffectiveFlags`	`public`	`0`	`DeviceDataFromGetErv.EffectiveFlags`
`HasAutomaticFanSpeed`	`readonly`	`boolean`	-
`HasCO2Sensor`	`readonly`	`boolean`	-
`HasPM25Sensor`	`readonly`	`boolean`	-
`NumberOfFanSpeeds`	`readonly`	`number`	-
`OutdoorTemperature`	`readonly`	`number`	`DeviceDataFromGetErv.OutdoorTemperature`
`PM25Level`	`readonly`	`number`	-
`Power?`	`readonly`	`boolean`	`DeviceDataFromGetErv.Power`
`RoomCO2Level`	`readonly`	`number`	`DeviceDataFromGetErv.RoomCO2Level`
`RoomTemperature`	`readonly`	`number`	`DeviceDataFromGetErv.RoomTemperature`
`SetFanSpeed?`	`readonly`	`number`	`DeviceDataFromGetErv.SetFanSpeed`
`VentilationMode?`	`readonly`	`VentilationMode`	`DeviceDataFromGetErv.VentilationMode`
`WifiSignalStrength`	`readonly`	`number`	`BaseDeviceDataFromList`.`WifiSignalStrength`

EffectiveFlags

Properties

Property	Modifier	Type
`Ata`	`readonly`	`Record`< \| `"OperationMode"` \| `"SetFanSpeed"` \| `"SetTemperature"` \| `"VaneHorizontal"` \| `"VaneVertical"` \| `"Power"`, `number`>
`Atw`	`readonly`	`Record`< \| `"Power"` \| `"ForcedHotWaterMode"` \| `"OperationModeZone1"` \| `"OperationModeZone2"` \| `"SetCoolFlowTemperatureZone1"` \| `"SetCoolFlowTemperatureZone2"` \| `"SetHeatFlowTemperatureZone1"` \| `"SetHeatFlowTemperatureZone2"` \| `"SetTankWaterTemperature"` \| `"SetTemperatureZone1"` \| `"SetTemperatureZone2"`, `number`>
`Erv`	`readonly`	`Record`<`"SetFanSpeed"` \| `"Power"` \| `"VentilationMode"`, `number`>

ErrorLogData

Properties

Property	Modifier	Type
`DeviceId`	`readonly`	`number`
`EndDate`	`readonly`	`string`
`ErrorMessage`	`readonly`	`null` \| `string`
`StartDate`	`readonly`	`string`

ErrorLogPostData

Properties

Property	Modifier	Type
`DeviceIDs`	`readonly`	readonly `string`[]
`FromDate`	`readonly`	`string`
`ToDate`	`readonly`	`string`

FailureData

Extends

BaseSuccessData

Properties

Property	Modifier	Type	Overrides	Inherited from
`AttributeErrors`	`readonly`	`Record`<`string`, readonly `string`[]>	`BaseSuccessData`.`AttributeErrors`	`BaseSuccessData`.`AttributeErrors`
`Data`	`readonly`	`null`	`BaseSuccessData`.`Data`	`BaseSuccessData`.`Data`
`GlobalErrors`	`readonly`	`null`	`BaseSuccessData`.`GlobalErrors`	`BaseSuccessData`.`GlobalErrors`
`Success`	`readonly`	`false`	`BaseSuccessData`.`Success`	`BaseSuccessData`.`Success`

FrostProtectionData

Extended by

BuildingData

Properties

Property	Modifier	Type
`FPEnabled`	`readonly`	`boolean`
`FPMaxTemperature`	`readonly`	`number`
`FPMinTemperature`	`readonly`	`number`

FrostProtectionPostData

Properties

Property	Modifier	Type
`AreaIds?`	`readonly`	readonly `number`[]
`BuildingIds?`	`readonly`	readonly `number`[]
`DeviceIds?`	`readonly`	readonly `number`[]
`Enabled`	`readonly`	`boolean`
`FloorIds?`	`readonly`	readonly `number`[]
`MaximumTemperature`	`readonly`	`number`
`MinimumTemperature`	`readonly`	`number`

HolidayModeData

Properties

Property	Modifier	Type
`EndDate`	`readonly`	{ `"Day"`: `number`; `"Hour"`: `number`; `"Minute"`: `number`; `"Month"`: `number`; `"Second"`: `number`; `"Year"`: `number`; }
`EndDate.Day`	`readonly`	`number`
`EndDate.Hour`	`readonly`	`number`
`EndDate.Minute`	`readonly`	`number`
`EndDate.Month`	`readonly`	`number`
`EndDate.Second`	`readonly`	`number`
`EndDate.Year`	`public`	`number`
`HMEnabled`	`public`	`boolean`
`HMEndDate`	`public`	`null` \| `string`
`HMStartDate`	`public`	`null` \| `string`
`StartDate`	`public`	{ `"Day"`: `number`; `"Hour"`: `number`; `"Minute"`: `number`; `"Month"`: `number`; `"Second"`: `number`; `"Year"`: `number`; }
`StartDate.Day`	`public`	`number`
`StartDate.Hour`	`public`	`number`
`StartDate.Minute`	`public`	`number`
`StartDate.Month`	`public`	`number`
`StartDate.Second`	`public`	`number`
`StartDate.Year`	`public`	`number`
`TimeZone`	`public`	`number`

HolidayModePostData

Properties

Property	Modifier	Type
`Enabled`	`readonly`	`boolean`
`EndDate`	`readonly`	`null` \| { `"Day"`: `number`; `"Hour"`: `number`; `"Minute"`: `number`; `"Month"`: `number`; `"Second"`: `number`; `"Year"`: `number`; }
`HMTimeZones`	`readonly`	readonly { `"Areas"`: readonly `number`[]; `"Buildings"`: readonly `number`[]; `"Devices"`: readonly `number`[]; `"Floors"`: readonly `number`[]; `"TimeZone"`: `number`; }[]
`StartDate`	`readonly`	`null` \| { `"Day"`: `number`; `"Hour"`: `number`; `"Minute"`: `number`; `"Month"`: `number`; `"Second"`: `number`; `"Year"`: `number`; }

ListDevice

Properties

Property	Modifier	Type
`Ata`	`readonly`	`ListDeviceAta`
`Atw`	`readonly`	`ListDeviceAtw`
`Erv`	`readonly`	`ListDeviceErv`

ListDeviceAta

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`DeviceDataFromListAta`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`

ListDeviceAtw

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`DeviceDataFromListAtw`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`

ListDeviceErv

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`DeviceDataFromListErv`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`

Logger

Properties

Property	Modifier	Type
`error`	`readonly`	(...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void`
`log`	`readonly`	(...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void`

LoginCredentials

Properties

Property	Modifier	Type
`password`	`readonly`	`string`
`username`	`readonly`	`string`

LoginData

Properties

Property	Modifier	Type
`LoginData`	`readonly`	`null` \| { `"ContextKey"`: `string`; `"Expiry"`: `string`; }

LoginPostData

Properties

Property	Modifier	Type
`AppVersion`	`readonly`	`string`
`Email`	`readonly`	`string`
`Language?`	`readonly`	`number`
`Password`	`readonly`	`string`
`Persist?`	`readonly`	`boolean`

PostData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`PostDataAta`
`Atw`	`readonly`	`PostDataAtw`
`Erv`	`readonly`	`PostDataErv`

ReportData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`ReportDataAta`
`Atw`	`readonly`	`ReportDataAtw`
`Erv`	`readonly`	`never`

ReportDataAta

Properties

Property	Modifier	Type
`Auto`	`readonly`	readonly `number`[]
`Cooling`	`readonly`	readonly `number`[]
`Dry`	`readonly`	readonly `number`[]
`Fan`	`readonly`	readonly `number`[]
`Heating`	`readonly`	readonly `number`[]
`Other`	`readonly`	readonly `number`[]
`TotalAutoConsumed`	`readonly`	`number`
`TotalCoolingConsumed`	`readonly`	`number`
`TotalDryConsumed`	`readonly`	`number`
`TotalFanConsumed`	`readonly`	`number`
`TotalHeatingConsumed`	`readonly`	`number`
`TotalOtherConsumed`	`readonly`	`number`
`UsageDisclaimerPercentages`	`readonly`	`string`

ReportDataAtw

Properties

Property	Modifier	Type
`CoP`	`readonly`	readonly `number`[]
`TotalCoolingConsumed`	`readonly`	`number`
`TotalCoolingProduced`	`readonly`	`number`
`TotalHeatingConsumed`	`readonly`	`number`
`TotalHeatingProduced`	`readonly`	`number`
`TotalHotWaterConsumed`	`readonly`	`number`
`TotalHotWaterProduced`	`readonly`	`number`

ReportPostData

Properties

Property	Modifier	Type
`DeviceID`	`readonly`	`number`
`FromDate`	`readonly`	`string`
`ToDate`	`readonly`	`string`
`UseCurrency`	`readonly`	`false`

SetDeviceData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`SetDeviceDataAta`
`Atw`	`readonly`	`SetDeviceDataAtw`
`Erv`	`readonly`	`SetDeviceDataErv`

SetDeviceDataAta

Extends

BaseDeviceData

Extended by

DeviceDataAta

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`BaseDeviceData`.`EffectiveFlags`
`OperationMode?`	`readonly`	`OperationMode`	-
`Power?`	`readonly`	`boolean`	`BaseDeviceData`.`Power`
`SetFanSpeed?`	`readonly`	`FanSpeed`	-
`SetTemperature?`	`readonly`	`number`	-
`VaneHorizontal?`	`readonly`	`Horizontal`	-
`VaneVertical?`	`readonly`	`Vertical`	-

SetDeviceDataAtw

Extends

BaseDeviceData

Extended by

DeviceDataAtw

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`BaseDeviceData`.`EffectiveFlags`
`ForcedHotWaterMode?`	`readonly`	`boolean`	-
`OperationModeZone1?`	`readonly`	`OperationModeZone`	-
`OperationModeZone2?`	`readonly`	`OperationModeZone`	-
`Power?`	`readonly`	`boolean`	`BaseDeviceData`.`Power`
`SetCoolFlowTemperatureZone1?`	`readonly`	`number`	-
`SetCoolFlowTemperatureZone2?`	`readonly`	`number`	-
`SetHeatFlowTemperatureZone1?`	`readonly`	`number`	-
`SetHeatFlowTemperatureZone2?`	`readonly`	`number`	-
`SetTankWaterTemperature?`	`readonly`	`number`	-
`SetTemperatureZone1?`	`readonly`	`number`	-
`SetTemperatureZone2?`	`readonly`	`number`	-

SetDeviceDataErv

Extends

BaseDeviceData

Extended by

DeviceDataErv

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`BaseDeviceData`.`EffectiveFlags`
`Power?`	`readonly`	`boolean`	`BaseDeviceData`.`Power`
`SetFanSpeed?`	`readonly`	`number`	-
`VentilationMode?`	`readonly`	`VentilationMode`	-

SettingManager

Properties

Property	Type
`get`	<`K`>(`key`: `K`) => `undefined` \| `null` \| `APISettings`[`K`]
`set`	<`K`>(`key`: `K`, `value`: `APISettings`[`K`]) => `void`

SuccessData

Extends

BaseSuccessData

Properties

Property	Modifier	Type	Overrides	Inherited from
`AttributeErrors`	`readonly`	`null`	`BaseSuccessData`.`AttributeErrors`	`BaseSuccessData`.`AttributeErrors`
`Data`	`readonly`	`null`	`BaseSuccessData`.`Data`	`BaseSuccessData`.`Data`
`GlobalErrors`	`readonly`	`null`	`BaseSuccessData`.`GlobalErrors`	`BaseSuccessData`.`GlobalErrors`
`Success`	`readonly`	`true`	`BaseSuccessData`.`Success`	`BaseSuccessData`.`Success`

Type Aliases

DeviceDataFromGetAta

type DeviceDataFromGetAta: DeviceDataAta & {
  "EffectiveFlags": typeof FLAG_UNCHANGED;
};

Type declaration

Member	Type
`EffectiveFlags`	typeof `FLAG_UNCHANGED`

Source

src/types.ts:135

DeviceDataFromGetAtw

type DeviceDataFromGetAtw: DeviceDataAtw & {
  "EffectiveFlags": typeof FLAG_UNCHANGED;
};

Type declaration

Member	Type
`EffectiveFlags`	typeof `FLAG_UNCHANGED`

Source

src/types.ts:203

DeviceDataFromGetErv

type DeviceDataFromGetErv: DeviceDataErv & {
  "EffectiveFlags": typeof FLAG_UNCHANGED;
};

Type declaration

Member	Type
`EffectiveFlags`	typeof `FLAG_UNCHANGED`

Source

src/types.ts:253

ListDeviceAny

type ListDeviceAny: ListDeviceAta | ListDeviceAtw | ListDeviceErv;

Source

src/types.ts:448

NonEffectiveFlagsKeyOf<T>

type NonEffectiveFlagsKeyOf<T>: Exclude<keyof T, "EffectiveFlags">;

Type parameters

Type parameter
`T`

Source

src/types.ts:3

NonEffectiveFlagsValueOf<T>

type NonEffectiveFlagsValueOf<T>: T[NonEffectiveFlagsKeyOf<T>];

Type parameters

Type parameter
`T`

Source

src/types.ts:4

PostDataAta

type PostDataAta: BasePostData & Readonly<SetDeviceDataAta>;

Source

src/types.ts:131

PostDataAtw

type PostDataAtw: BasePostData & Readonly<SetDeviceDataAtw>;

Source

src/types.ts:188

PostDataErv

type PostDataErv: BasePostData & Readonly<SetDeviceDataErv>;

Source

src/types.ts:247

Variables

FLAG_UNCHANGED

const FLAG_UNCHANGED: 0 = 0x0;

Source

src/types.ts:1

effectiveFlagsAta

const effectiveFlagsAta: Record<NonEffectiveFlagsKeyOf<SetDeviceDataAta>, number>;

Source

src/types.ts:120

effectiveFlagsAtw

const effectiveFlagsAtw: Record<NonEffectiveFlagsKeyOf<SetDeviceDataAtw>, number>;

Source

src/types.ts:172

effectiveFlagsErv

const effectiveFlagsErv: Record<NonEffectiveFlagsKeyOf<SetDeviceDataErv>, number>;

Source

src/types.ts:243

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
.github		.github
.vscode		.vscode
src		src
.gitignore		.gitignore
.markdownlint.jsonc		.markdownlint.jsonc
.prettierignore		.prettierignore
README.md		README.md
eslint.config.mjs		eslint.config.mjs
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
typedoc.config.mjs		typedoc.config.mjs

OlivierZal/melcloud-api

Folders and files

Latest commit

History

Repository files navigation

MELCloud API for Node.js

Enumerations

DeviceType

Enumeration Members

FanSpeed

Enumeration Members

Horizontal

Enumeration Members

Language

Enumeration Members

OperationMode

Enumeration Members

OperationModeState

Enumeration Members

OperationModeZone

Enumeration Members

VentilationMode

Enumeration Members

Vertical

Enumeration Members

Classes

default

Constructors

new default()

Parameters

Returns

Source

Properties

Methods

applyLogin()

Parameters

Returns

Source

errors()

Parameters

Returns

Source

get()

Type parameters

Parameters

Returns

Source

getFrostProtection()

Parameters

Returns

Source

getHolidayMode()

Parameters

Returns

Source

list()

Returns

Source

login()

Parameters

Returns

Source

report()

Type parameters

Parameters

Returns

Source

set()

Type parameters

Parameters

Returns

Source

updateFrostProtection()

Parameters

Returns

Source

updateHolidayMode()

Parameters

Returns

Source