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

AreaFacade<T>

Type parameters

Type parameter
`T` extends `number` \| `null`

Implements

IAreaFacade

Constructors

new AreaFacade()

new AreaFacade<T>(api: default, id: number): AreaFacade<T>

Parameters

Parameter	Type
`api`	`default`
`id`	`number`

Returns

AreaFacade<T>

Source

src/facades/area.ts:21

Accessors

model

get model(): AreaModel<T>

Returns

AreaModel<T>

Source

src/facades/area.ts:26

Methods

getErrors()

getErrors(__namedParameters: {
  from: string;
  to: string;
}): Promise<FailureData | ErrorData[]>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

getFrostProtection()

getFrostProtection(): Promise<FrostProtectionData>

Returns

Promise<FrostProtectionData>

Implementation of

IAreaFacade.getFrostProtection

Source

src/facades/area.ts:52

getHolidayMode()

getHolidayMode(): Promise<HolidayModeData>

Returns

Promise<HolidayModeData>

Implementation of

IAreaFacade.getHolidayMode

Source

src/facades/area.ts:69

getTiles()

getTiles(): Promise<TilesData<null>>

Returns

Promise<TilesData<null>>

Implementation of

IAreaFacade.getTiles

Source

src/facades/area.ts:86

getWifiReport()

getWifiReport(hour: number): Promise<WifiData>

Parameters

Parameter	Type
`hour`	`number`

Returns

Promise<WifiData>

Implementation of

IAreaFacade.getWifiReport

Source

src/facades/area.ts:94

setAtaGroup()

setAtaGroup(postData: Omit<SetAtaGroupPostData, "Specification">): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`postData`	`Omit`<`SetAtaGroupPostData`, `"Specification"`>

Returns

Promise<SuccessData | FailureData>

Implementation of

IAreaFacade.setAtaGroup

Source

src/facades/area.ts:104

setFrostProtection()

setFrostProtection(__namedParameters: {
  enable: boolean;
  max: number;
  min: number;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.max`	`number`
`__namedParameters.min`	`number`

Returns

Promise<SuccessData | FailureData>

Implementation of

IAreaFacade.setFrostProtection

Source

src/facades/area.ts:114

setHolidayMode()

setHolidayMode(__namedParameters: {
  enable: boolean;
  from: string;
  to: string;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<SuccessData | FailureData>

Implementation of

IAreaFacade.setHolidayMode

Source

src/facades/area.ts:137

setPower()

setPower(enable: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`enable`	`boolean`	`true`

Returns

Promise<boolean>

Implementation of

IAreaFacade.setPower

Source

src/facades/area.ts:185

AreaModel<T>

Type parameters

Type parameter
`T` extends `number` \| `null`

Implements

IAreaModel

Properties

Property	Modifier	Type	Default value
`buildingId`	`readonly`	`number`	`undefined`
`floorId`	`readonly`	`null` \| `number`	`undefined`
`id`	`readonly`	`number`	`undefined`
`name`	`readonly`	`string`	`undefined`
`areas`	`readonly`	`Map`<`number`, `AreaModelAny`>	`...`

Accessors

building

get building(): null | BuildingModel

Returns

null | BuildingModel

Source

src/models/area.ts:35

deviceIds

get deviceIds(): number[]

Returns

number[]

Source

src/models/area.ts:39

devices

get devices(): DeviceModelAny[]

Returns

DeviceModelAny[]

Source

src/models/area.ts:43

floor

get floor(): null | FloorModel

Returns

null | FloorModel

Source

src/models/area.ts:47

Methods

getAll()

static getAll(): AreaModelAny[]

Returns

AreaModelAny[]

Source

src/models/area.ts:53

getByBuildingId()

static getByBuildingId(buildingId: number): AreaModelAny[]

Parameters

Parameter	Type
`buildingId`	`number`

Returns

AreaModelAny[]

Source

src/models/area.ts:57

getById()

static getById(id: number): undefined | AreaModelAny

Parameters

Parameter	Type
`id`	`number`

Returns

undefined | AreaModelAny

Source

src/models/area.ts:61

getByName()

static getByName(areaName: string): undefined | AreaModelAny

Parameters

Parameter	Type
`areaName`	`string`

Returns

undefined | AreaModelAny

Source

src/models/area.ts:65

upsert()

static upsert(data: AreaDataAny): void

Parameters

Parameter	Type
`data`	`AreaDataAny`

Returns

void

Source

src/models/area.ts:69

BuildingFacade

Implements

IBuildingFacade

Constructors

new BuildingFacade()

new BuildingFacade(api: default, id: number): BuildingFacade

Parameters

Parameter	Type
`api`	`default`
`id`	`number`

Returns

BuildingFacade

Source

src/facades/building.ts:22

Accessors

model

get model(): BuildingModel

Returns

BuildingModel

Source

src/facades/building.ts:27

Methods

fetch()

fetch(): Promise<BuildingSettings>

Returns

Promise<BuildingSettings>

Implementation of

IBuildingFacade.fetch

Source

src/facades/building.ts:35

getErrors()

getErrors(__namedParameters: {
  from: string;
  to: string;
}): Promise<FailureData | ErrorData[]>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<FailureData | ErrorData[]>

Implementation of

IBuildingFacade.getErrors

Source

src/facades/building.ts:40

getFrostProtection()

getFrostProtection(): Promise<FrostProtectionData>

Returns

Promise<FrostProtectionData>

Implementation of

IBuildingFacade.getFrostProtection

Source

src/facades/building.ts:58

getHolidayMode()

getHolidayMode(): Promise<HolidayModeData>

Returns

Promise<HolidayModeData>

Implementation of

IBuildingFacade.getHolidayMode

Source

src/facades/building.ts:75

getTiles()

getTiles(): Promise<TilesData<null>>

Returns

Promise<TilesData<null>>

Implementation of

IBuildingFacade.getTiles

Source

src/facades/building.ts:92

getWifiReport()

getWifiReport(hour: number): Promise<WifiData>

Parameters

Parameter	Type
`hour`	`number`

Returns

Promise<WifiData>

Implementation of

IBuildingFacade.getWifiReport

Source

src/facades/building.ts:100

setAtaGroup()

setAtaGroup(postData: Omit<SetAtaGroupPostData, "Specification">): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`postData`	`Omit`<`SetAtaGroupPostData`, `"Specification"`>

Returns

Promise<SuccessData | FailureData>

Implementation of

IBuildingFacade.setAtaGroup

Source

src/facades/building.ts:110

setFrostProtection()

setFrostProtection(__namedParameters: {
  enable: boolean;
  max: number;
  min: number;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.max`	`number`
`__namedParameters.min`	`number`

Returns

Promise<SuccessData | FailureData>

Implementation of

IBuildingFacade.setFrostProtection

Source

src/facades/building.ts:123

setHolidayMode()

setHolidayMode(__namedParameters: {
  enable: boolean;
  from: string;
  to: string;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<SuccessData | FailureData>

Implementation of

IBuildingFacade.setHolidayMode

Source

src/facades/building.ts:146

setPower()

setPower(enable: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`enable`	`boolean`	`true`

Returns

Promise<boolean>

Implementation of

IBuildingFacade.setPower

Source

src/facades/building.ts:194

BuildingModel

Implements

IBuildingModel

Properties

Property	Modifier	Type	Default value
`data`	`readonly`	`BuildingSettings`	`undefined`
`id`	`readonly`	`number`	`undefined`
`name`	`readonly`	`string`	`undefined`
`buildings`	`readonly`	`Map`<`number`, `BuildingModel`>	`...`

Accessors

deviceIds

get deviceIds(): number[]

Returns

number[]

Source

src/models/building.ts:19

devices

get devices(): DeviceModelAny[]

Returns

DeviceModelAny[]

Source

src/models/building.ts:23

Methods

getAll()

static getAll(): BuildingModel[]

Returns

BuildingModel[]

Source

src/models/building.ts:29

getById()

static getById(id: number): undefined | BuildingModel

Parameters

Parameter	Type
`id`	`number`

Returns

undefined | BuildingModel

Source

src/models/building.ts:33

getByName()

static getByName(buildingName: string): undefined | BuildingModel

Parameters

Parameter	Type
`buildingName`	`string`

Returns

undefined | BuildingModel

Source

src/models/building.ts:37

upsert()

static upsert(data: BuildingData): void

Parameters

Parameter	Type
`data`	`BuildingData`

Returns

void

Source

src/models/building.ts:41

DeviceFacade<T>

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType`

Implements

IDeviceFacade<T>

Constructors

new DeviceFacade()

new DeviceFacade<T>(api: default, id: number): DeviceFacade<T>

Parameters

Parameter	Type
`api`	`default`
`id`	`number`

Returns

DeviceFacade<T>

Source

src/facades/device.ts:28

Accessors

model

get model(): DeviceModel<T>

Returns

DeviceModel<T>

Source

src/facades/device.ts:33

Methods

fetch()

fetch(): Promise<ListDevice[T]["Device"]>

Returns

Promise<ListDevice[T]["Device"]>

Implementation of

IDeviceFacade.fetch

Source

src/facades/device.ts:41

get()

get(): Promise<GetDeviceData[T]>

Returns

Promise<GetDeviceData[T]>

Implementation of

IDeviceFacade.get

Source

src/facades/device.ts:46

getEnergyReport()

getEnergyReport(__namedParameters: {
  from: string;
  to: string;
}): Promise<EnergyData[T]>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<EnergyData[T]>

Implementation of

IDeviceFacade.getEnergyReport

Source

src/facades/device.ts:54

getErrors()

getErrors(__namedParameters: {
  from: string;
  to: string;
}): Promise<FailureData | ErrorData[]>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<FailureData | ErrorData[]>

Implementation of

IDeviceFacade.getErrors

Source

src/facades/device.ts:68

getFrostProtection()

getFrostProtection(): Promise<FrostProtectionData>

Returns

Promise<FrostProtectionData>

Implementation of

IDeviceFacade.getFrostProtection

Source

src/facades/device.ts:86

getHolidayMode()

getHolidayMode(): Promise<HolidayModeData>

Returns

Promise<HolidayModeData>

Implementation of

IDeviceFacade.getHolidayMode

Source

src/facades/device.ts:94

getTile()

getTile(select)

getTile(select?: false): Promise<TilesData<null>>

Parameters

Parameter	Type
`select`?	`false`

Returns

Promise<TilesData<null>>

Implementation of

IDeviceFacade.getTile

Source

src/facades/device.ts:102

getTile(select)

getTile(select: true): Promise<TilesData<T>>

Parameters

Parameter	Type
`select`	`true`

Returns

Promise<TilesData<T>>

Implementation of

IDeviceFacade.getTile

Source

src/facades/device.ts:103

getWifiReport()

getWifiReport(hour: number): Promise<WifiData>

Parameters

Parameter	Type
`hour`	`number`

Returns

Promise<WifiData>

Implementation of

IDeviceFacade.getWifiReport

Source

src/facades/device.ts:124

set()

set(postData: UpdateDeviceData[T]): Promise<SetDeviceData[T]>

Parameters

Parameter	Type
`postData`	`UpdateDeviceData`[`T`]

Returns

Promise<SetDeviceData[T]>

Implementation of

IDeviceFacade.set

Source

src/facades/device.ts:134

setFrostProtection()

setFrostProtection(__namedParameters: {
  enable: boolean;
  max: number;
  min: number;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.max`	`number`
`__namedParameters.min`	`number`

Returns

Promise<SuccessData | FailureData>

Implementation of

IDeviceFacade.setFrostProtection

Source

src/facades/device.ts:143

setHolidayMode()

setHolidayMode(__namedParameters: {
  enable: boolean;
  from: string;
  to: string;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<SuccessData | FailureData>

Implementation of

IDeviceFacade.setHolidayMode

Source

src/facades/device.ts:164

setPower()

setPower(enable: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`enable`	`boolean`	`true`

Returns

Promise<boolean>

Implementation of

IDeviceFacade.setPower

Source

src/facades/device.ts:208

DeviceModel<T>

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType`

Implements

IDeviceModel<T>

Properties

Property	Modifier	Type	Default value
`areaId`	`readonly`	`null` \| `number`	`null`
`buildingId`	`readonly`	`number`	`undefined`
`data`	`readonly`	`ListDevice`[`T`][`"Device"`]	`undefined`
`floorId`	`readonly`	`null` \| `number`	`null`
`id`	`readonly`	`number`	`undefined`
`name`	`readonly`	`string`	`undefined`
`type`	`readonly`	`T`	`undefined`
`devices`	`readonly`	`Map`<`number`, `DeviceModelAny`>	`...`

Accessors

area

get area(): null | AreaModelAny

Returns

null | AreaModelAny

Source

src/models/device.ts:52

building

get building(): null | BuildingModel

Returns

null | BuildingModel

Source

src/models/device.ts:56

floor

get floor(): null | FloorModel

Returns

null | FloorModel

Source

src/models/device.ts:60

Methods

getAll()

static getAll(): DeviceModelAny[]

Returns

DeviceModelAny[]

Source

src/models/device.ts:66

getByBuildingId()

static getByBuildingId(buildingId: number): DeviceModelAny[]

Parameters

Parameter	Type
`buildingId`	`number`

Returns

DeviceModelAny[]

Source

src/models/device.ts:70

getById()

static getById(id: number): undefined | DeviceModelAny

Parameters

Parameter	Type
`id`	`number`

Returns

undefined | DeviceModelAny

Source

src/models/device.ts:74

getByName()

static getByName(deviceName: string): undefined | DeviceModelAny

Parameters

Parameter	Type
`deviceName`	`string`

Returns

undefined | DeviceModelAny

Source

src/models/device.ts:78

getByType()

static getByType(deviceType: "Ata" | "Atw" | "Erv"): DeviceModelAny[]

Parameters

Parameter	Type
`deviceType`	`"Ata"` \| `"Atw"` \| `"Erv"`

Returns

DeviceModelAny[]

Source

src/models/device.ts:82

upsert()

static upsert(data: ListDeviceAny): void

Parameters

Parameter	Type
`data`	`ListDeviceAny`

Returns

void

Source

src/models/device.ts:88

upsertMany()

static upsertMany(dataList: readonly ListDeviceAny[]): void

Parameters

Parameter	Type
`dataList`	readonly `ListDeviceAny`[]

Returns

void

Source

src/models/device.ts:92

FloorFacade

Implements

IFloorFacade

Constructors

new FloorFacade()

new FloorFacade(api: default, id: number): FloorFacade

Parameters

Parameter	Type
`api`	`default`
`id`	`number`

Returns

FloorFacade

Source

src/facades/floor.ts:21

Accessors

model

get model(): FloorModel

Returns

FloorModel

Source

src/facades/floor.ts:26

Methods

getErrors()

getErrors(__namedParameters: {
  from: string;
  to: string;
}): Promise<FailureData | ErrorData[]>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<FailureData | ErrorData[]>

Implementation of

IFloorFacade.getErrors

Source

src/facades/floor.ts:34

getFrostProtection()

getFrostProtection(): Promise<FrostProtectionData>

Returns

Promise<FrostProtectionData>

Implementation of

IFloorFacade.getFrostProtection

Source

src/facades/floor.ts:52

getHolidayMode()

getHolidayMode(): Promise<HolidayModeData>

Returns

Promise<HolidayModeData>

Implementation of

IFloorFacade.getHolidayMode

Source

src/facades/floor.ts:69

getTiles()

getTiles(): Promise<TilesData<null>>

Returns

Promise<TilesData<null>>

Implementation of

IFloorFacade.getTiles

Source

src/facades/floor.ts:86

getWifiReport()

getWifiReport(hour: number): Promise<WifiData>

Parameters

Parameter	Type
`hour`	`number`

Returns

Promise<WifiData>

Implementation of

IFloorFacade.getWifiReport

Source

src/facades/floor.ts:94

setAtaGroup()

setAtaGroup(postData: Omit<SetAtaGroupPostData, "Specification">): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`postData`	`Omit`<`SetAtaGroupPostData`, `"Specification"`>

Returns

Promise<SuccessData | FailureData>

Implementation of

IFloorFacade.setAtaGroup

Source

src/facades/floor.ts:104

setFrostProtection()

setFrostProtection(__namedParameters: {
  enable: boolean;
  max: number;
  min: number;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.max`	`number`
`__namedParameters.min`	`number`

Returns

Promise<SuccessData | FailureData>

Implementation of

IFloorFacade.setFrostProtection

Source

src/facades/floor.ts:114

setHolidayMode()

setHolidayMode(__namedParameters: {
  enable: boolean;
  from: string;
  to: string;
}): Promise<SuccessData | FailureData>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.enable`?	`boolean`
`__namedParameters.from`	`string`
`__namedParameters.to`	`string`

Returns

Promise<SuccessData | FailureData>

Implementation of

IFloorFacade.setHolidayMode

Source

src/facades/floor.ts:137

setPower()

setPower(enable: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`enable`	`boolean`	`true`

Returns

Promise<boolean>

Implementation of

IFloorFacade.setPower

Source

src/facades/floor.ts:185

FloorModel

Implements

IFloorModel

Properties

Property	Modifier	Type	Default value
`buildingId`	`readonly`	`number`	`undefined`
`id`	`readonly`	`number`	`undefined`
`name`	`readonly`	`string`	`undefined`
`floors`	`readonly`	`Map`<`number`, `FloorModel`>	`...`

Accessors

areaIds

get areaIds(): number[]

Returns

number[]

Source

src/models/floor.ts:29

areas

get areas(): AreaModel<number>[]

Returns

AreaModel<number>[]

Source

src/models/floor.ts:33

building

get building(): null | BuildingModel

Returns

null | BuildingModel

Source

src/models/floor.ts:39

deviceIds

get deviceIds(): number[]

Returns

number[]

Source

src/models/floor.ts:43

devices

get devices(): DeviceModelAny[]

Returns

DeviceModelAny[]

Source

src/models/floor.ts:47

Methods

getAll()

static getAll(): FloorModel[]

Returns

FloorModel[]

Source

src/models/floor.ts:51

getByBuildingId()

static getByBuildingId(buildingId: number): FloorModel[]

Parameters

Parameter	Type
`buildingId`	`number`

Returns

FloorModel[]

Source

src/models/floor.ts:55

getById()

static getById(id: number): undefined | FloorModel

Parameters

Parameter	Type
`id`	`number`

Returns

undefined | FloorModel

Source

src/models/floor.ts:59

getByName()

static getByName(floorName: string): undefined | FloorModel

Parameters

Parameter	Type
`floorName`	`string`

Returns

undefined | FloorModel

Source

src/models/floor.ts:63

upsert()

static upsert(data: FloorData): void

Parameters

Parameter	Type
`data`	`FloorData`

Returns

void

Source

src/models/floor.ts:67

default

Implements

IMELCloudAPI

Constructors

new default()

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

Parameters

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

Returns

default

Source

src/services/api.ts:74

Properties

Property	Modifier	Type
`language`	`public`	`string`

Methods

applyLogin()

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

Parameters

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

Returns

Promise<boolean>

Implementation of

IMELCloudAPI.applyLogin

Source

src/services/api.ts:140

fetchDevices()

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

Returns

Promise<{ data: Building[]; }>

Member	Type
`data`	`Building`[]

Implementation of

IMELCloudAPI.fetchDevices

Source

src/services/api.ts:171

getDevice()

getDevice<T>(__namedParameters: {
  params: GetDeviceDataParams;
 }): Promise<{
  data: GetDeviceData[T];
}>

Type parameters

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.params`	`GetDeviceDataParams`

Returns

Promise<{ data: GetDeviceData[T]; }>

Member	Type
`data`	`GetDeviceData`[`T`]

Implementation of

IMELCloudAPI.getDevice

Source

src/services/api.ts:194

getEnergyReport()

getEnergyReport<T>(__namedParameters: {
  postData: EnergyPostData;
 }): Promise<{
  data: EnergyData[T];
}>

Type parameters

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`EnergyPostData`

Returns

Promise<{ data: EnergyData[T]; }>

Member	Type
`data`	`EnergyData`[`T`]

Implementation of

IMELCloudAPI.getEnergyReport

Source

src/services/api.ts:204

getErrors()

getErrors(__namedParameters: {
  postData: ErrorPostData;
 }): Promise<{
  data: FailureData | ErrorData[];
}>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`ErrorPostData`

Returns

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

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

Implementation of

IMELCloudAPI.getErrors

Source

src/services/api.ts:212

getFrostProtection()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.params`	`SettingsParams`

Returns

Promise<{ data: FrostProtectionData; }>

Member	Type
`data`	`FrostProtectionData`

Implementation of

IMELCloudAPI.getFrostProtection

Source

src/services/api.ts:223

getHolidayMode()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.params`	`SettingsParams`

Returns

Promise<{ data: HolidayModeData; }>

Member	Type
`data`	`HolidayModeData`

Implementation of

IMELCloudAPI.getHolidayMode

Source

src/services/api.ts:233

getTiles()

getTiles(__namedParameters)

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`TilesPostData`<`null`>

Returns

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

Member	Type
`data`	`TilesData`<`null`>

Implementation of

IMELCloudAPI.getTiles

Source

src/services/api.ts:243

getTiles(__namedParameters)

getTiles<T>(__namedParameters: {
  postData: TilesPostData<T>;
 }): Promise<{
  data: TilesData<T>;
}>

Type parameters

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`TilesPostData`<`T`>

Returns

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

Member	Type
`data`	`TilesData`<`T`>

Implementation of

IMELCloudAPI.getTiles

Source

src/services/api.ts:248

getWifiReport()

getWifiReport(__namedParameters: {
  postData: WifiPostData;
 }): Promise<{
  data: WifiData;
}>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`WifiPostData`

Returns

Promise<{ data: WifiData; }>

Member	Type
`data`	`WifiData`

Implementation of

IMELCloudAPI.getWifiReport

Source

src/services/api.ts:261

login()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`LoginPostData`

Returns

Promise<{ data: LoginData; }>

Member	Type
`data`	`LoginData`

Implementation of

IMELCloudAPI.login

Source

src/services/api.ts:269

setAtaGroup()

setAtaGroup(__namedParameters: {
  postData: SetAtaGroupPostData;
 }): Promise<{
  data: SuccessData | FailureData;
}>

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`SetAtaGroupPostData`

Returns

Promise<{ data: SuccessData | FailureData; }>

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

Implementation of

IMELCloudAPI.setAtaGroup

Source

src/services/api.ts:288

setDevice()

setDevice<T>(__namedParameters: {
  heatPumpType: T;
  postData: SetDevicePostData<T>;
 }): Promise<{
  data: SetDeviceData[T];
}>

Type parameters

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.heatPumpType`	`T`
`__namedParameters.postData`	`SetDevicePostData`<`T`>

Returns

Promise<{ data: SetDeviceData[T]; }>

Member	Type
`data`	`SetDeviceData`[`T`]

Implementation of

IMELCloudAPI.setDevice

Source

src/services/api.ts:303

setFrostProtection()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`FrostProtectionPostData`

Returns

Promise<{ data: SuccessData | FailureData; }>

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

Implementation of

IMELCloudAPI.setFrostProtection

Source

src/services/api.ts:316

setHolidayMode()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`HolidayModePostData`

Returns

Promise<{ data: SuccessData | FailureData; }>

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

Implementation of

IMELCloudAPI.setHolidayMode

Source

src/services/api.ts:327

setLanguage()

setLanguage(language: string): Promise<{
  data: boolean;
}>

Parameters

Parameter	Type
`language`	`string`

Returns

Promise<{ data: boolean; }>

Member	Type
`data`	`boolean`

Implementation of

IMELCloudAPI.setLanguage

Source

src/services/api.ts:338

setPower()

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

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.postData`	`SetPowerPostData`

Returns

Promise<{ data: boolean; }>

Member	Type
`data`	`boolean`

Implementation of

IMELCloudAPI.setPower

Source

src/services/api.ts:348

Interfaces

APISettings

Properties

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

AreaData<T>

Extends

FloorData

Type parameters

Type parameter
`T` extends `number` \| `null`

Properties

Property	Modifier	Type	Inherited from
`BuildingId`	`readonly`	`number`	`FloorData`.`BuildingId`
`FloorId`	`readonly`	`T`	-
`ID`	`readonly`	`number`	`FloorData`.`ID`
`Name`	`readonly`	`string`	`FloorData`.`Name`

BaseDevicePostData

Extended by

EnergyPostData

Properties

Property	Modifier	Type
`DeviceID`	`readonly`	`number`

BaseGetDeviceData

Extends

BaseSetDeviceData

Properties

Property	Modifier	Type	Overrides	Inherited from
`EffectiveFlags`	`readonly`	`0`	`BaseSetDeviceData`.`EffectiveFlags`	`BaseSetDeviceData`.`EffectiveFlags`
`LastCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`LastCommunication`	`BaseSetDeviceData`.`LastCommunication`
`NextCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`NextCommunication`	`BaseSetDeviceData`.`NextCommunication`
`Offline`	`readonly`	`boolean`	`BaseSetDeviceData`.`Offline`	`BaseSetDeviceData`.`Offline`
`Power`	`readonly`	`boolean`	`BaseSetDeviceData`.`Power`	`BaseSetDeviceData`.`Power`

BaseListDevice

Extended by

Properties

Property	Modifier	Type
`AreaID`	`readonly`	`null` \| `number`
`BuildingID`	`readonly`	`number`
`DeviceID`	`readonly`	`number`
`DeviceName`	`readonly`	`string`
`FloorID`	`readonly`	`null` \| `number`
`Type`	`readonly`	`DeviceType`

BaseListDeviceData

Extends

Omit<BaseGetDeviceData, keyof DeviceDataNotInList>

Extended by

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`readonly`	`0`	`Omit.EffectiveFlags`
`Offline`	`readonly`	`boolean`	`Omit.Offline`
`Power`	`readonly`	`boolean`	`Omit.Power`
`WifiSignalStrength`	`readonly`	`number`	-

BaseSetDeviceData

Extends

Required<Readonly<BaseUpdateDeviceData>>.DeviceDataNotInList

Extended by

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`readonly`	`number`	`Required.EffectiveFlags`
`LastCommunication`	`readonly`	`string`	`DeviceDataNotInList`.`LastCommunication`
`NextCommunication`	`readonly`	`string`	`DeviceDataNotInList`.`NextCommunication`
`Offline`	`readonly`	`boolean`	-
`Power`	`readonly`	`boolean`	`Required.Power`

BaseUpdateDeviceData

Extended by

Properties

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

Building

Extends

BuildingData

Properties

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

BuildingData

Extends

BuildingSettings

Extended by

Building

Properties

Property	Modifier	Type	Inherited from
`FPDefined`	`readonly`	`boolean`	`BuildingSettings`.`FPDefined`
`FPEnabled`	`readonly`	`boolean`	`BuildingSettings`.`FPEnabled`
`FPMaxTemperature`	`readonly`	`number`	`BuildingSettings`.`FPMaxTemperature`
`FPMinTemperature`	`readonly`	`number`	`BuildingSettings`.`FPMinTemperature`
`HMDefined`	`readonly`	`boolean`	`BuildingSettings`.`HMDefined`
`HMEnabled`	`readonly`	`boolean`	`BuildingSettings`.`HMEnabled`
`HMEndDate`	`readonly`	`null` \| `string`	`BuildingSettings`.`HMEndDate`
`HMStartDate`	`readonly`	`null` \| `string`	`BuildingSettings`.`HMStartDate`
`ID`	`readonly`	`number`	-
`Name`	`readonly`	`string`	-
`TimeZone`	`readonly`	`number`	`BuildingSettings`.`TimeZone`

BuildingSettings

Extends

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

Extended by

BuildingData

Properties

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

DateTimeComponents

Properties

Property	Modifier	Type
`Day`	`readonly`	`number`
`Hour`	`readonly`	`number`
`Minute`	`readonly`	`number`
`Month`	`readonly`	`number`
`Second`	`readonly`	`number`
`Year`	`readonly`	`number`

DeviceDataNotInList

Extended by

BaseSetDeviceData

Properties

Property	Modifier	Type
`LastCommunication`	`readonly`	`string`
`NextCommunication`	`readonly`	`string`

EffectiveFlags

Properties

Property	Modifier	Type
`Ata`	`readonly`	`Record`<`NonEffectiveFlagsKeyOf`<`UpdateDeviceDataAta`>, `number`>
`Atw`	`readonly`	`Record`<`NonEffectiveFlagsKeyOf`<`UpdateDeviceDataAtw`>, `number`>
`Erv`	`readonly`	`Record`<`NonEffectiveFlagsKeyOf`<`UpdateDeviceDataErv`>, `number`>

EnergyData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`EnergyDataAta`
`Atw`	`readonly`	`EnergyDataAtw`
`Erv`	`readonly`	`never`

EnergyDataAta

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`

EnergyDataAtw

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`

EnergyPostData

Extends

BaseDevicePostData

Properties

Property	Modifier	Type	Inherited from
`DeviceID`	`readonly`	`number`	`BaseDevicePostData`.`DeviceID`
`FromDate`	`readonly`	`string`	-
`ToDate`	`readonly`	`string`	-

ErrorData

Properties

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

ErrorPostData

Properties

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

FailureData

Properties

Property	Modifier	Type
`AttributeErrors`	`readonly`	`Record`<`string`, readonly `string`[]>
`Success`	`readonly`	`false`

FloorData

Extended by

AreaData

Properties

Property	Modifier	Type
`BuildingId`	`readonly`	`number`
`ID`	`readonly`	`number`
`Name`	`readonly`	`string`

FrostProtectionData

Extended by

BuildingSettings

Properties

Property	Modifier	Type
`FPDefined`	`readonly`	`boolean`
`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`

GetDeviceData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`GetDeviceDataAta`
`Atw`	`readonly`	`GetDeviceDataAtw`
`Erv`	`readonly`	`GetDeviceDataErv`

GetDeviceDataParams

Properties

Property	Modifier	Type
`buildingId`	`readonly`	`number`
`id`	`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`	`readonly`	`number`
`HMDefined`	`public`	`boolean`
`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` \| `DateTimeComponents`
`HMTimeZones`	`readonly`	readonly { `Areas`: readonly `number`[]; `Buildings`: readonly `number`[]; `Devices`: readonly `number`[]; `Floors`: readonly `number`[]; `TimeZone`: `number`; }[]
`StartDate`	`readonly`	`null` \| `DateTimeComponents`

IAreaFacade

Extends

IBaseFacade.IBaseSuperDeviceFacade

Properties

Property	Type	Inherited from
`getErrors`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`FailureData` \| `ErrorData`[]>	`IBaseFacade`.`getErrors`
`getFrostProtection`	() => `Promise`<`FrostProtectionData`>	`IBaseFacade`.`getFrostProtection`
`getHolidayMode`	() => `Promise`<`HolidayModeData`>	`IBaseFacade`.`getHolidayMode`
`getTiles`	() => `Promise`<`TilesData`<`null`>>	`IBaseSuperDeviceFacade`.`getTiles`
`getWifiReport`	(`hour`: `number`) => `Promise`<`WifiData`>	`IBaseFacade`.`getWifiReport`
`setAtaGroup`	(`postData`: `Omit`<`SetAtaGroupPostData`, `"Specification"`>) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseSuperDeviceFacade`.`setAtaGroup`
`setFrostProtection`	(`__namedParameters`: { `enable`: `boolean`; `max`: `number`; `min`: `number`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setFrostProtection`
`setHolidayMode`	(`__namedParameters`: { `enable`: `boolean`; `from`: `string`; `to`: `string`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setHolidayMode`
`setPower`	(`enable`?: `boolean`) => `Promise`<`boolean`>	`IBaseFacade`.`setPower`

IAreaModel

Extends

IBaseModel.IBaseSubBuildingModel.IBaseSubFloorModel.IBaseSuperDeviceModel

Properties

Property	Modifier	Type	Inherited from
`building`	`readonly`	`null` \| `BuildingModel`	`IBaseSubBuildingModel`.`building`
`buildingId`	`readonly`	`number`	`IBaseSubBuildingModel`.`buildingId`
`deviceIds`	`readonly`	`number`[]	`IBaseSuperDeviceModel`.`deviceIds`
`devices`	`readonly`	`DeviceModelAny`[]	`IBaseSuperDeviceModel`.`devices`
`floor`	`readonly`	`null` \| `FloorModel`	`IBaseSubFloorModel`.`floor`
`floorId`	`readonly`	`null` \| `number`	`IBaseSubFloorModel`.`floorId`
`id`	`readonly`	`number`	`IBaseModel`.`id`
`name`	`readonly`	`string`	`IBaseModel`.`name`

IBaseFacade

Extended by

Properties

Property	Type
`getErrors`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`FailureData` \| `ErrorData`[]>
`getFrostProtection`	() => `Promise`<`FrostProtectionData`>
`getHolidayMode`	() => `Promise`<`HolidayModeData`>
`getWifiReport`	(`hour`: `number`) => `Promise`<`WifiData`>
`setFrostProtection`	(`__namedParameters`: { `enable`: `boolean`; `max`: `number`; `min`: `number`; }) => `Promise`<`SuccessData` \| `FailureData`>
`setHolidayMode`	(`__namedParameters`: { `enable`: `boolean`; `from`: `string`; `to`: `string`; }) => `Promise`<`SuccessData` \| `FailureData`>
`setPower`	(`enable`?: `boolean`) => `Promise`<`boolean`>

IBaseModel

Extended by

Properties

Property	Modifier	Type
`id`	`readonly`	`number`
`name`	`readonly`	`string`

IBaseSubBuildingModel

Extended by

Properties

Property	Modifier	Type
`building`	`readonly`	`null` \| `BuildingModel`
`buildingId`	`readonly`	`number`

IBaseSubFloorModel

Extended by

Properties

Property	Modifier	Type
`floor`	`readonly`	`null` \| `FloorModel`
`floorId`	`readonly`	`null` \| `number`

IBaseSuperDeviceFacade

Extended by

Properties

Property	Type
`getTiles`	() => `Promise`<`TilesData`<`null`>>
`setAtaGroup`	(`postData`: `Omit`<`SetAtaGroupPostData`, `"Specification"`>) => `Promise`<`SuccessData` \| `FailureData`>

IBaseSuperDeviceModel

Extended by

Properties

Property	Modifier	Type
`deviceIds`	`readonly`	`number`[]
`devices`	`readonly`	`DeviceModelAny`[]

IBuildingFacade

Extends

IBaseFacade.IBaseSuperDeviceFacade

Properties

Property	Type	Inherited from
`fetch`	() => `Promise`<`BuildingSettings`>	-
`getErrors`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`FailureData` \| `ErrorData`[]>	`IBaseFacade`.`getErrors`
`getFrostProtection`	() => `Promise`<`FrostProtectionData`>	`IBaseFacade`.`getFrostProtection`
`getHolidayMode`	() => `Promise`<`HolidayModeData`>	`IBaseFacade`.`getHolidayMode`
`getTiles`	() => `Promise`<`TilesData`<`null`>>	`IBaseSuperDeviceFacade`.`getTiles`
`getWifiReport`	(`hour`: `number`) => `Promise`<`WifiData`>	`IBaseFacade`.`getWifiReport`
`setAtaGroup`	(`postData`: `Omit`<`SetAtaGroupPostData`, `"Specification"`>) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseSuperDeviceFacade`.`setAtaGroup`
`setFrostProtection`	(`__namedParameters`: { `enable`: `boolean`; `max`: `number`; `min`: `number`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setFrostProtection`
`setHolidayMode`	(`__namedParameters`: { `enable`: `boolean`; `from`: `string`; `to`: `string`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setHolidayMode`
`setPower`	(`enable`?: `boolean`) => `Promise`<`boolean`>	`IBaseFacade`.`setPower`

IBuildingModel

Extends

IBaseModel.IBaseSuperDeviceModel

Properties

Property	Modifier	Type	Inherited from
`data`	`readonly`	`BuildingSettings`	-
`deviceIds`	`readonly`	`number`[]	`IBaseSuperDeviceModel`.`deviceIds`
`devices`	`readonly`	`DeviceModelAny`[]	`IBaseSuperDeviceModel`.`devices`
`id`	`readonly`	`number`	`IBaseModel`.`id`
`name`	`readonly`	`string`	`IBaseModel`.`name`

IDeviceFacade<T>

Extends

IBaseFacade

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType`

Properties

Property	Type	Inherited from
`fetch`	() => `Promise`<`ListDevice`[`T`][`"Device"`]>	-
`get`	() => `Promise`<`GetDeviceData`[`T`]>	-
`getEnergyReport`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`EnergyData`[`T`]>	-
`getErrors`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`FailureData` \| `ErrorData`[]>	`IBaseFacade`.`getErrors`
`getFrostProtection`	() => `Promise`<`FrostProtectionData`>	`IBaseFacade`.`getFrostProtection`
`getHolidayMode`	() => `Promise`<`HolidayModeData`>	`IBaseFacade`.`getHolidayMode`
`getTile`	(`select`?: `false`) => `Promise`<`TilesData`<`null`>> & (`select`: `true`) => `Promise`<`TilesData`<`T`>>	-
`getWifiReport`	(`hour`: `number`) => `Promise`<`WifiData`>	`IBaseFacade`.`getWifiReport`
`set`	(`postData`: `UpdateDeviceData`[`T`]) => `Promise`<`SetDeviceData`[`T`]>	-
`setFrostProtection`	(`__namedParameters`: { `enable`: `boolean`; `max`: `number`; `min`: `number`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setFrostProtection`
`setHolidayMode`	(`__namedParameters`: { `enable`: `boolean`; `from`: `string`; `to`: `string`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setHolidayMode`
`setPower`	(`enable`?: `boolean`) => `Promise`<`boolean`>	`IBaseFacade`.`setPower`

IDeviceModel<T>

Extends

IBaseModel.IBaseSubBuildingModel.IBaseSubFloorModel

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType`

Properties

Property	Modifier	Type	Inherited from
`area`	`readonly`	`null` \| `AreaModelAny`	-
`areaId`	`readonly`	`null` \| `number`	-
`building`	`readonly`	`null` \| `BuildingModel`	`IBaseSubBuildingModel`.`building`
`buildingId`	`readonly`	`number`	`IBaseSubBuildingModel`.`buildingId`
`data`	`readonly`	`ListDevice`[`T`][`"Device"`]	-
`floor`	`readonly`	`null` \| `FloorModel`	`IBaseSubFloorModel`.`floor`
`floorId`	`readonly`	`null` \| `number`	`IBaseSubFloorModel`.`floorId`
`id`	`readonly`	`number`	`IBaseModel`.`id`
`name`	`readonly`	`string`	`IBaseModel`.`name`
`type`	`readonly`	`T`	-

IFloorFacade

Extends

IBaseFacade.IBaseSuperDeviceFacade

Properties

Property	Type	Inherited from
`getErrors`	(`__namedParameters`: { `from`: `string`; `to`: `string`; }) => `Promise`<`FailureData` \| `ErrorData`[]>	`IBaseFacade`.`getErrors`
`getFrostProtection`	() => `Promise`<`FrostProtectionData`>	`IBaseFacade`.`getFrostProtection`
`getHolidayMode`	() => `Promise`<`HolidayModeData`>	`IBaseFacade`.`getHolidayMode`
`getTiles`	() => `Promise`<`TilesData`<`null`>>	`IBaseSuperDeviceFacade`.`getTiles`
`getWifiReport`	(`hour`: `number`) => `Promise`<`WifiData`>	`IBaseFacade`.`getWifiReport`
`setAtaGroup`	(`postData`: `Omit`<`SetAtaGroupPostData`, `"Specification"`>) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseSuperDeviceFacade`.`setAtaGroup`
`setFrostProtection`	(`__namedParameters`: { `enable`: `boolean`; `max`: `number`; `min`: `number`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setFrostProtection`
`setHolidayMode`	(`__namedParameters`: { `enable`: `boolean`; `from`: `string`; `to`: `string`; }) => `Promise`<`SuccessData` \| `FailureData`>	`IBaseFacade`.`setHolidayMode`
`setPower`	(`enable`?: `boolean`) => `Promise`<`boolean`>	`IBaseFacade`.`setPower`

IFloorModel

Extends

IBaseModel.IBaseSubBuildingModel.IBaseSuperDeviceModel

Properties

Property	Modifier	Type	Inherited from
`areaIds`	`readonly`	`number`[]	-
`areas`	`readonly`	`AreaModel`<`number`>[]	-
`building`	`readonly`	`null` \| `BuildingModel`	`IBaseSubBuildingModel`.`building`
`buildingId`	`readonly`	`number`	`IBaseSubBuildingModel`.`buildingId`
`deviceIds`	`readonly`	`number`[]	`IBaseSuperDeviceModel`.`deviceIds`
`devices`	`readonly`	`DeviceModelAny`[]	`IBaseSuperDeviceModel`.`devices`
`id`	`readonly`	`number`	`IBaseModel`.`id`
`name`	`readonly`	`string`	`IBaseModel`.`name`

IMELCloudAPI

Properties

Property	Modifier	Type
`applyLogin`	`public`	(`data`?: `LoginCredentials`, `onSuccess`?: () => `Promise`<`void`>) => `Promise`<`boolean`>
`fetchDevices`	`public`	() => `Promise`<{ `data`: `Building`[]; }>
`getDevice`	`public`	<`T`>(`__namedParameters`: { `params`: `GetDeviceDataParams`; }) => `Promise`<{ `data`: `GetDeviceData`[`T`]; }>
`getEnergyReport`	`public`	<`T`>(`__namedParameters`: { `postData`: `EnergyPostData`; }) => `Promise`<{ `data`: `EnergyData`[`T`]; }>
`getErrors`	`public`	(`__namedParameters`: { `postData`: `ErrorPostData`; }) => `Promise`<{ `data`: `FailureData` \| `ErrorData`[]; }>
`getFrostProtection`	`public`	(`__namedParameters`: { `params`: `SettingsParams`; }) => `Promise`<{ `data`: `FrostProtectionData`; }>
`getHolidayMode`	`public`	(`__namedParameters`: { `params`: `SettingsParams`; }) => `Promise`<{ `data`: `HolidayModeData`; }>
`getTiles`	`public`	(`__namedParameters`: { `postData`: `TilesPostData`<`null`>; }) => `Promise`<{ `data`: `TilesData`<`null`>; }> & <`T`>(`__namedParameters`: { `postData`: `TilesPostData`<`T`>; }) => `Promise`<{ `data`: `TilesData`<`T`>; }>
`getWifiReport`	`public`	(`__namedParameters`: { `postData`: `WifiPostData`; }) => `Promise`<{ `data`: `WifiData`; }>
`language`	`readonly`	`string`
`login`	`public`	(`__namedParameters`: { `postData`: `LoginPostData`; }) => `Promise`<{ `data`: `LoginData`; }>
`setAtaGroup`	`public`	(`__namedParameters`: { `postData`: `SetAtaGroupPostData`; }) => `Promise`<{ `data`: `SuccessData` \| `FailureData`; }>
`setDevice`	`public`	<`T`>(`__namedParameters`: { `heatPumpType`: `T`; `postData`: `SetDevicePostData`<`T`>; }) => `Promise`<{ `data`: `SetDeviceData`[`T`]; }>
`setFrostProtection`	`public`	(`__namedParameters`: { `postData`: `FrostProtectionPostData`; }) => `Promise`<{ `data`: `SuccessData` \| `FailureData`; }>
`setHolidayMode`	`public`	(`__namedParameters`: { `postData`: `HolidayModePostData`; }) => `Promise`<{ `data`: `SuccessData` \| `FailureData`; }>
`setLanguage`	`public`	(`language`: `string`) => `Promise`<{ `data`: `boolean`; }>
`setPower`	`public`	(`__namedParameters`: { `postData`: `SetPowerPostData`; }) => `Promise`<{ `data`: `boolean`; }>

ListDevice

Properties

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

ListDeviceAta

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`AreaID`	`readonly`	`null` \| `number`	`BaseListDevice`.`AreaID`
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`ListDeviceDataAta`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`
`FloorID`	`readonly`	`null` \| `number`	`BaseListDevice`.`FloorID`
`Type`	`readonly`	`DeviceType`	`BaseListDevice`.`Type`

ListDeviceAtw

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`AreaID`	`readonly`	`null` \| `number`	`BaseListDevice`.`AreaID`
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`ListDeviceDataAtw`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`
`FloorID`	`readonly`	`null` \| `number`	`BaseListDevice`.`FloorID`
`Type`	`readonly`	`DeviceType`	`BaseListDevice`.`Type`

ListDeviceDataAta

Extends

BaseListDeviceData.Omit<GetDeviceDataAta, keyof DeviceDataNotInList | "SetFanSpeed" | "VaneHorizontal" | "VaneVertical">

Properties

Property	Modifier	Type	Inherited from
`ActualFanSpeed`	`readonly`	`number`	-
`DeviceType`	`readonly`	`Ata`	`Omit.DeviceType`
`EffectiveFlags`	`readonly`	`0`	`BaseListDeviceData`.`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`	`Omit.NumberOfFanSpeeds`
`Offline`	`readonly`	`boolean`	`BaseListDeviceData`.`Offline`
`OperationMode`	`readonly`	`OperationMode`	`Omit.OperationMode`
`OutdoorTemperature`	`readonly`	`number`	-
`Power`	`readonly`	`boolean`	`BaseListDeviceData`.`Power`
`RoomTemperature`	`readonly`	`number`	`Omit.RoomTemperature`
`SetTemperature`	`readonly`	`number`	`Omit.SetTemperature`
`VaneHorizontalDirection`	`readonly`	`Horizontal`	-
`VaneVerticalDirection`	`readonly`	`Vertical`	-
`WifiSignalStrength`	`readonly`	`number`	`BaseListDeviceData`.`WifiSignalStrength`

ListDeviceDataAtw

Extends

BaseListDeviceData.Omit<GetDeviceDataAtw, keyof DeviceDataNotInList>

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`	`Omit.DeviceType`
`EcoHotWater`	`readonly`	`boolean`	-
`EffectiveFlags`	`readonly`	`0`	`BaseListDeviceData`.`EffectiveFlags`
`FlowTemperature`	`readonly`	`number`	-
`FlowTemperatureZone1`	`readonly`	`number`	-
`FlowTemperatureZone2`	`readonly`	`number`	-
`ForcedHotWaterMode`	`readonly`	`boolean`	`Omit.ForcedHotWaterMode`
`HasZone2`	`readonly`	`boolean`	-
`HeatPumpFrequency`	`readonly`	`number`	-
`IdleZone1`	`readonly`	`boolean`	`Omit.IdleZone1`
`IdleZone2`	`readonly`	`boolean`	`Omit.IdleZone2`
`ImmersionHeaterStatus`	`readonly`	`boolean`	-
`LastLegionellaActivationTime`	`readonly`	`string`	-
`MaxTankTemperature`	`readonly`	`number`	-
`MixingTankWaterTemperature`	`readonly`	`number`	-
`Offline`	`readonly`	`boolean`	`BaseListDeviceData`.`Offline`
`OperationMode`	`readonly`	`OperationModeState`	`Omit.OperationMode`
`OperationModeZone1`	`readonly`	`OperationModeZone`	`Omit.OperationModeZone1`
`OperationModeZone2`	`readonly`	`OperationModeZone`	`Omit.OperationModeZone2`
`OutdoorTemperature`	`readonly`	`number`	`Omit.OutdoorTemperature`
`Power`	`readonly`	`boolean`	`BaseListDeviceData`.`Power`
`ProhibitCoolingZone1`	`readonly`	`boolean`	`Omit.ProhibitCoolingZone1`
`ProhibitCoolingZone2`	`readonly`	`boolean`	`Omit.ProhibitCoolingZone2`
`ProhibitHeatingZone1`	`readonly`	`boolean`	`Omit.ProhibitHeatingZone1`
`ProhibitHeatingZone2`	`readonly`	`boolean`	`Omit.ProhibitHeatingZone2`
`ProhibitHotWater`	`readonly`	`boolean`	`Omit.ProhibitHotWater`
`ReturnTemperature`	`readonly`	`number`	-
`ReturnTemperatureZone1`	`readonly`	`number`	-
`ReturnTemperatureZone2`	`readonly`	`number`	-
`RoomTemperatureZone1`	`readonly`	`number`	`Omit.RoomTemperatureZone1`
`RoomTemperatureZone2`	`readonly`	`number`	`Omit.RoomTemperatureZone2`
`SetCoolFlowTemperatureZone1`	`readonly`	`number`	`Omit.SetCoolFlowTemperatureZone1`
`SetCoolFlowTemperatureZone2`	`readonly`	`number`	`Omit.SetCoolFlowTemperatureZone2`
`SetHeatFlowTemperatureZone1`	`readonly`	`number`	`Omit.SetHeatFlowTemperatureZone1`
`SetHeatFlowTemperatureZone2`	`readonly`	`number`	`Omit.SetHeatFlowTemperatureZone2`
`SetTankWaterTemperature`	`readonly`	`number`	`Omit.SetTankWaterTemperature`
`SetTemperatureZone1`	`readonly`	`number`	`Omit.SetTemperatureZone1`
`SetTemperatureZone2`	`readonly`	`number`	`Omit.SetTemperatureZone2`
`TankWaterTemperature`	`readonly`	`number`	`Omit.TankWaterTemperature`
`TargetHCTemperatureZone1`	`readonly`	`number`	-
`TargetHCTemperatureZone2`	`readonly`	`number`	-
`WifiSignalStrength`	`readonly`	`number`	`BaseListDeviceData`.`WifiSignalStrength`
`Zone1InCoolMode`	`readonly`	`boolean`	-
`Zone1InHeatMode`	`readonly`	`boolean`	-
`Zone2InCoolMode`	`readonly`	`boolean`	-
`Zone2InHeatMode`	`readonly`	`boolean`	-

ListDeviceDataErv

Extends

BaseListDeviceData.Omit<GetDeviceDataErv, keyof DeviceDataNotInList>

Properties

Property	Modifier	Type	Inherited from
`DeviceType`	`readonly`	`Erv`	`Omit.DeviceType`
`EffectiveFlags`	`readonly`	`0`	`BaseListDeviceData`.`EffectiveFlags`
`HasAutomaticFanSpeed`	`readonly`	`boolean`	-
`HasCO2Sensor`	`readonly`	`boolean`	-
`HasPM25Sensor`	`readonly`	`boolean`	-
`NumberOfFanSpeeds`	`readonly`	`number`	`Omit.NumberOfFanSpeeds`
`Offline`	`readonly`	`boolean`	`BaseListDeviceData`.`Offline`
`OutdoorTemperature`	`readonly`	`number`	`Omit.OutdoorTemperature`
`PM25Level`	`readonly`	`number`	-
`Power`	`readonly`	`boolean`	`BaseListDeviceData`.`Power`
`RoomCO2Level`	`readonly`	`number`	`Omit.RoomCO2Level`
`RoomTemperature`	`readonly`	`number`	`Omit.RoomTemperature`
`SetFanSpeed`	`readonly`	\| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`	`Omit.SetFanSpeed`
`VentilationMode`	`readonly`	`VentilationMode`	`Omit.VentilationMode`
`WifiSignalStrength`	`readonly`	`number`	`BaseListDeviceData`.`WifiSignalStrength`

ListDeviceErv

Extends

BaseListDevice

Properties

Property	Modifier	Type	Inherited from
`AreaID`	`readonly`	`null` \| `number`	`BaseListDevice`.`AreaID`
`BuildingID`	`readonly`	`number`	`BaseListDevice`.`BuildingID`
`Device`	`readonly`	`ListDeviceDataErv`	-
`DeviceID`	`readonly`	`number`	`BaseListDevice`.`DeviceID`
`DeviceName`	`readonly`	`string`	`BaseListDevice`.`DeviceName`
`FloorID`	`readonly`	`null` \| `number`	`BaseListDevice`.`FloorID`
`Type`	`readonly`	`DeviceType`	`BaseListDevice`.`Type`

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`

SetAtaGroupPostData

Properties

Property	Modifier	Type
`Specification`	`readonly`	{ `AreaID`: `null`; `BuildingID`: `null`; `FloorID`: `number`; } \| { `AreaID`: `null`; `BuildingID`: `number`; `FloorID`: `null`; } \| { `AreaID`: `number`; `BuildingID`: `null`; `FloorID`: `null`; }
`State`	`readonly`	{ `FanSpeed`: \| `null` \| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`; `OperationMode`: `null` \| `OperationMode`; `Power`: `null` \| `boolean`; `SetTemperature`: `null` \| `number`; `VaneHorizontalDirection`: `null` \| `Horizontal`; `VaneHorizontalSwing`: `null` \| `boolean`; `VaneVerticalDirection`: `null` \| `Vertical`; `VaneVerticalSwing`: `null` \| `boolean`; }
`State.FanSpeed?`	`public`	\| `null` \| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`
`State.OperationMode?`	`public`	`null` \| `OperationMode`
`State.Power?`	`public`	`null` \| `boolean`
`State.SetTemperature?`	`public`	`null` \| `number`
`State.VaneHorizontalDirection?`	`public`	`null` \| `Horizontal`
`State.VaneHorizontalSwing?`	`public`	`null` \| `boolean`
`State.VaneVerticalDirection?`	`public`	`null` \| `Vertical`
`State.VaneVerticalSwing?`	`public`	`null` \| `boolean`

SetDeviceData

Properties

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

SetDeviceDataAta

Extends

BaseSetDeviceData.Required<Readonly<UpdateDeviceDataAta>>

Properties

Property	Modifier	Type	Inherited from
`DeviceType`	`readonly`	`Ata`	-
`EffectiveFlags`	`readonly`	`number`	`BaseSetDeviceData`.`EffectiveFlags`
`LastCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`LastCommunication`
`NextCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`NextCommunication`
`NumberOfFanSpeeds`	`readonly`	`number`	-
`Offline`	`readonly`	`boolean`	`BaseSetDeviceData`.`Offline`
`OperationMode`	`readonly`	`OperationMode`	`Required.OperationMode`
`Power`	`readonly`	`boolean`	`BaseSetDeviceData`.`Power`
`RoomTemperature`	`readonly`	`number`	-
`SetFanSpeed`	`readonly`	\| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`	`Required.SetFanSpeed`
`SetTemperature`	`readonly`	`number`	`Required.SetTemperature`
`VaneHorizontal`	`readonly`	`Horizontal`	`Required.VaneHorizontal`
`VaneVertical`	`readonly`	`Vertical`	`Required.VaneVertical`

SetDeviceDataAtw

Extends

BaseSetDeviceData.Required<Readonly<UpdateDeviceDataAtw>>

Properties

Property	Modifier	Type	Inherited from
`DeviceType`	`readonly`	`Atw`	-
`EffectiveFlags`	`readonly`	`number`	`BaseSetDeviceData`.`EffectiveFlags`
`ForcedHotWaterMode`	`readonly`	`boolean`	`Required.ForcedHotWaterMode`
`IdleZone1`	`readonly`	`boolean`	-
`IdleZone2`	`readonly`	`boolean`	-
`LastCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`LastCommunication`
`NextCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`NextCommunication`
`Offline`	`readonly`	`boolean`	`BaseSetDeviceData`.`Offline`
`OperationMode`	`readonly`	`OperationModeState`	-
`OperationModeZone1`	`readonly`	`OperationModeZone`	`Required.OperationModeZone1`
`OperationModeZone2`	`readonly`	`OperationModeZone`	`Required.OperationModeZone2`
`OutdoorTemperature`	`readonly`	`number`	-
`Power`	`readonly`	`boolean`	`BaseSetDeviceData`.`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`	`Required.SetCoolFlowTemperatureZone1`
`SetCoolFlowTemperatureZone2`	`readonly`	`number`	`Required.SetCoolFlowTemperatureZone2`
`SetHeatFlowTemperatureZone1`	`readonly`	`number`	`Required.SetHeatFlowTemperatureZone1`
`SetHeatFlowTemperatureZone2`	`readonly`	`number`	`Required.SetHeatFlowTemperatureZone2`
`SetTankWaterTemperature`	`readonly`	`number`	`Required.SetTankWaterTemperature`
`SetTemperatureZone1`	`readonly`	`number`	`Required.SetTemperatureZone1`
`SetTemperatureZone2`	`readonly`	`number`	`Required.SetTemperatureZone2`
`TankWaterTemperature`	`readonly`	`number`	-

SetDeviceDataErv

Extends

BaseSetDeviceData.Required<Readonly<UpdateDeviceDataErv>>

Properties

Property	Modifier	Type	Inherited from
`DeviceType`	`readonly`	`Erv`	-
`EffectiveFlags`	`readonly`	`number`	`BaseSetDeviceData`.`EffectiveFlags`
`LastCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`LastCommunication`
`NextCommunication`	`readonly`	`string`	`BaseSetDeviceData`.`NextCommunication`
`NumberOfFanSpeeds`	`readonly`	`number`	-
`Offline`	`readonly`	`boolean`	`BaseSetDeviceData`.`Offline`
`OutdoorTemperature`	`readonly`	`number`	-
`Power`	`readonly`	`boolean`	`BaseSetDeviceData`.`Power`
`RoomCO2Level`	`readonly`	`number`	-
`RoomTemperature`	`readonly`	`number`	-
`SetFanSpeed`	`readonly`	\| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`	`Required.SetFanSpeed`
`VentilationMode`	`readonly`	`VentilationMode`	`Required.VentilationMode`

SetPowerPostData

Properties

Property	Modifier	Type
`DeviceIds`	`readonly`	readonly `number`[]
`Power`	`readonly`	`boolean`

SettingManager

Properties

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

SettingsParams

Properties

Property	Modifier	Type
`id`	`readonly`	`number`
`tableName`	`readonly`	`"Area"` \| `"Building"` \| `"DeviceLocation"` \| `"Floor"`

SuccessData

Properties

Property	Modifier	Type
`AttributeErrors`	`readonly`	`null`
`Success`	`readonly`	`true`

TilesData<T>

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType` \| `null`

Properties

Property	Modifier	Type
`SelectedDevice`	`readonly`	`T` extends `"Ata"` \| `"Atw"` \| `"Erv"` ? `GetDeviceData`[`T`<`T`>] : `null`
`Tiles`	`readonly`	readonly { `Device`: `number`; `Offline`: `boolean`; `Power`: `boolean`; `RoomTemperature`: `number`; `RoomTemperature2`: `number`; `TankWaterTemperature`: `number`; }[]

UpdateDeviceData

Properties

Property	Modifier	Type
`Ata`	`readonly`	`UpdateDeviceDataAta`
`Atw`	`readonly`	`UpdateDeviceDataAtw`
`Erv`	`readonly`	`UpdateDeviceDataErv`

UpdateDeviceDataAta

Extends

BaseUpdateDeviceData

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`BaseUpdateDeviceData`.`EffectiveFlags`
`OperationMode?`	`readonly`	`OperationMode`	-
`Power?`	`readonly`	`boolean`	`BaseUpdateDeviceData`.`Power`
`SetFanSpeed?`	`readonly`	\| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`	-
`SetTemperature?`	`readonly`	`number`	-
`VaneHorizontal?`	`readonly`	`Horizontal`	-
`VaneVertical?`	`readonly`	`Vertical`	-

UpdateDeviceDataAtw

Extends

BaseUpdateDeviceData

Properties

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

UpdateDeviceDataErv

Extends

BaseUpdateDeviceData

Properties

Property	Modifier	Type	Inherited from
`EffectiveFlags`	`public`	`number`	`BaseUpdateDeviceData`.`EffectiveFlags`
`Power?`	`readonly`	`boolean`	`BaseUpdateDeviceData`.`Power`
`SetFanSpeed?`	`readonly`	\| `auto` \| `very_slow` \| `slow` \| `moderate` \| `fast` \| `very_fast`	-
`VentilationMode?`	`readonly`	`VentilationMode`	-

WifiData

Properties

Property	Modifier	Type
`Data`	`readonly`	(`null` \| `number`)[][]
`FromDate`	`readonly`	`string`
`Labels`	`readonly`	`string`[]
`ToDate`	`readonly`	`string`

WifiPostData

Properties

Property	Modifier	Type
`devices`	`readonly`	readonly `number`[]
`hour`	`readonly`	`number`

Type Aliases

AreaDataAny

type AreaDataAny: AreaData<number> | AreaData<null>;

Source

src/types/common.ts:216

AreaModelAny

type AreaModelAny: AreaModel<number> | AreaModel<null>;

Source

src/models/area.ts:10

DeviceModelAny

type DeviceModelAny: DeviceModel<"Ata"> | DeviceModel<"Atw"> | DeviceModel<"Erv">;

Source

src/models/device.ts:10

GetDeviceDataAta

type GetDeviceDataAta: BaseGetDeviceData & SetDeviceDataAta;

Source

src/types/ata.ts:69

GetDeviceDataAtw

type GetDeviceDataAtw: BaseGetDeviceData & SetDeviceDataAtw;

Source

src/types/atw.ts:76

GetDeviceDataErv

type GetDeviceDataErv: BaseGetDeviceData & SetDeviceDataErv;

Source

src/types/erv.ts:42

ListDeviceAny

type ListDeviceAny: ListDeviceAta | ListDeviceAtw | ListDeviceErv;

Source

src/types/common.ts:207

NonEffectiveFlagsKeyOf<T>

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

Type parameters

Type parameter
`T`

Source

src/types/bases.ts:19

NonEffectiveFlagsValueOf<T>

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

Type parameters

Type parameter
`T`

Source

src/types/bases.ts:21

SetDevicePostData<T>

type SetDevicePostData<T>: UpdateDeviceData[T] & BaseDevicePostData;

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType`

Source

src/types/common.ts:86

TilesPostData<T>

type TilesPostData<T>: T extends keyof typeof DeviceType ? {
  SelectedBuilding: number;
  SelectedDevice: number;
 } : {
  SelectedBuilding: null;
  SelectedDevice: null;
 } & {
  DeviceIDs: readonly number[];
};

Type declaration

Member	Type
`DeviceIDs`	readonly `number`[]

Type parameters

Type parameter
`T` extends keyof typeof `DeviceType` \| `null`

Source

src/types/common.ts:266

Variables

FLAG_UNCHANGED

const FLAG_UNCHANGED: 0 = 0x0

Source

src/types/bases.ts:1

effectiveFlagsAta

const effectiveFlagsAta: Record<
  NonEffectiveFlagsKeyOf<UpdateDeviceDataAta>,
  number
>

Source

src/types/ata.ts:49

effectiveFlagsAtw

const effectiveFlagsAtw: Record<
  NonEffectiveFlagsKeyOf<UpdateDeviceDataAtw>,
  number
>

Source

src/types/atw.ts:41

effectiveFlagsErv

const effectiveFlagsErv: Record<
  NonEffectiveFlagsKeyOf<UpdateDeviceDataErv>,
  number
>

Source

src/types/erv.ts:23

Name		Name	Last commit message	Last commit date
Latest commit History 48 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.base.json		tsconfig.base.json
tsconfig.checkjs.json		tsconfig.checkjs.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

AreaFacade<T>

Type parameters

Implements

Constructors

new AreaFacade()

Parameters

Returns

Source

Accessors

model

Returns

Source

Methods

getErrors()

Parameters

Returns

Implementation of

Source

getFrostProtection()

Returns

Implementation of

Source

getHolidayMode()

Returns

Implementation of

Source

getTiles()

Returns

Implementation of

Source

getWifiReport()

Parameters

Returns

Implementation of

Source

setAtaGroup()

Parameters

Returns

Implementation of

Source

setFrostProtection()

Parameters

Returns

Implementation of

Source

setHolidayMode()

Parameters

Returns

Implementation of

Source

setPower()

Parameters

Returns

Implementation of