MELCloud API for Node.js - v17.7.0

Enumerations

DeviceType

Defined in: src/enums.ts:1

Enumeration Members

Enumeration Member	Value	Defined in
Ata	0	src/enums.ts:2
Atw	1	src/enums.ts:3
Erv	3	src/enums.ts:4

---

FanSpeed

Defined in: src/enums.ts:7

Enumeration Members

Enumeration Member	Value	Defined in
auto	0	src/enums.ts:8
fast	4	src/enums.ts:9
moderate	3	src/enums.ts:10
silent	255	src/enums.ts:11
slow	2	src/enums.ts:12
very_fast	5	src/enums.ts:13
very_slow	1	src/enums.ts:14

---

Horizontal

Defined in: src/enums.ts:17

Enumeration Members

Enumeration Member	Value	Defined in
auto	0	src/enums.ts:18
center	3	src/enums.ts:19
center_left	2	src/enums.ts:20
center_right	4	src/enums.ts:21
leftwards	1	src/enums.ts:22
rightwards	5	src/enums.ts:23
swing	12	src/enums.ts:24
wide	8	src/enums.ts:25

---

LabelType

Defined in: src/enums.ts:28

Enumeration Members

Enumeration Member	Value	Defined in
day_of_week	4	src/enums.ts:29
month	2	src/enums.ts:30
month_of_year	3	src/enums.ts:31
raw	1	src/enums.ts:32
time	0	src/enums.ts:33

---

Language

Defined in: src/enums.ts:36

Enumeration Members

Enumeration Member	Value	Defined in
bg	1	src/enums.ts:37
cs	2	src/enums.ts:38
da	3	src/enums.ts:39
de	4	src/enums.ts:40
el	22	src/enums.ts:41
en	0	src/enums.ts:42
es	6	src/enums.ts:43
et	5	src/enums.ts:44
fi	17	src/enums.ts:45
fr	7	src/enums.ts:46
hr	23	src/enums.ts:47
hu	11	src/enums.ts:48
hy	8	src/enums.ts:49
it	19	src/enums.ts:50
lt	10	src/enums.ts:51
lv	9	src/enums.ts:52
nl	12	src/enums.ts:53
no	13	src/enums.ts:54
pl	14	src/enums.ts:55
pt	15	src/enums.ts:56
ro	24	src/enums.ts:57
ru	16	src/enums.ts:58
sl	25	src/enums.ts:59
sq	26	src/enums.ts:60
sv	18	src/enums.ts:61
tr	21	src/enums.ts:62
uk	20	src/enums.ts:63

---

OperationMode

Defined in: src/enums.ts:66

Enumeration Members

Enumeration Member	Value	Defined in
auto	8	src/enums.ts:67
cool	3	src/enums.ts:68
dry	2	src/enums.ts:69
fan	7	src/enums.ts:70
heat	1	src/enums.ts:71

---

OperationModeState

Defined in: src/enums.ts:74

Enumeration Members

Enumeration Member	Value	Defined in
cooling	3	src/enums.ts:75
defrost	5	src/enums.ts:76
dhw	1	src/enums.ts:77
heating	2	src/enums.ts:78
idle	0	src/enums.ts:79
legionella	6	src/enums.ts:80

---

OperationModeZone

Defined in: src/enums.ts:83

Enumeration Members

Enumeration Member	Value	Defined in
curve	2	src/enums.ts:84
flow	1	src/enums.ts:85
flow_cool	4	src/enums.ts:86
room	0	src/enums.ts:87
room_cool	3	src/enums.ts:88

---

VentilationMode

Defined in: src/enums.ts:91

Enumeration Members

Enumeration Member	Value	Defined in
auto	2	src/enums.ts:92
bypass	1	src/enums.ts:93
recovery	0	src/enums.ts:94

---

Vertical

Defined in: src/enums.ts:97

Enumeration Members

Enumeration Member	Value	Defined in
auto	0	src/enums.ts:98
downwards	5	src/enums.ts:99
mid_high	2	src/enums.ts:100
mid_low	4	src/enums.ts:101
middle	3	src/enums.ts:102
swing	7	src/enums.ts:103
upwards	1	src/enums.ts:104

Classes

AreaModel<T>

Defined in: src/models/area.ts:15

Extends

• BaseModel

Type Parameters

Type Parameter
T extends number | null

Implements

• IAreaModel

Properties

Property	Modifier	Type	Inherited from	Defined in
buildingId	readonly	number	-	src/models/area.ts:27
floorId	readonly	null | number	-	src/models/area.ts:29
id	readonly	number	IAreaModel.id BaseModel.id	src/models/base.ts:4
name	readonly	string	IAreaModel.name BaseModel.name	src/models/base.ts:6

Accessors

building

Get Signature

get building(): undefined | IBuildingModel

Defined in: src/models/area.ts:42

Returns

undefined | IBuildingModel

Implementation of

IAreaModel.building

deviceIds

Get Signature

get deviceIds(): number[]

Defined in: src/models/area.ts:46

Returns

number[]

Implementation of

IAreaModel.deviceIds

devices

Get Signature

get devices(): IDeviceModelAny[]

Defined in: src/models/area.ts:50

Returns

IDeviceModelAny[]

Implementation of

IAreaModel.devices

floor

Get Signature

get floor(): undefined | null | IFloorModel

Defined in: src/models/area.ts:54

Returns

undefined | null | IFloorModel

Implementation of

IAreaModel.floor

Methods

getAll()

static getAll(): IAreaModel[]

Defined in: src/models/area.ts:60

Returns

IAreaModel[]

getByBuildingId()

static getByBuildingId(id: number): IAreaModel[]

Defined in: src/models/area.ts:64

Parameters

Parameter	Type
id	number

Returns

IAreaModel[]

getByFloorId()

static getByFloorId(id: number): IAreaModel[]

Defined in: src/models/area.ts:68

Parameters

Parameter	Type
id	number

Returns

IAreaModel[]

getById()

static getById(id: number): undefined | IAreaModel

Defined in: src/models/area.ts:72

Parameters

Parameter	Type
id	number

Returns

undefined | IAreaModel

getByName()

static getByName(name: string): undefined | IAreaModel

Defined in: src/models/area.ts:76

Parameters

Parameter	Type
name	string

Returns

undefined | IAreaModel

setModels()

static setModels(__namedParameters: {
  buildingModel: typeof BuildingModel;
  deviceModel: typeof DeviceModel;
  floorModel: typeof FloorModel;
 }): void

Defined in: src/models/area.ts:80

Parameters

Parameter	Type
__namedParameters	{ buildingModel: typeof BuildingModel; deviceModel: typeof DeviceModel; floorModel: typeof FloorModel; }
__namedParameters.buildingModel	typeof BuildingModel
__namedParameters.deviceModel	typeof DeviceModel
__namedParameters.floorModel	typeof FloorModel

Returns

void

sync()

static sync(areas: AreaDataAny[]): void

Defined in: src/models/area.ts:94

Parameters

Parameter	Type
areas	AreaDataAny[]

Returns

void

---

BuildingModel

Defined in: src/models/building.ts:15

Extends

• BaseModel

Implements

• IBuildingModel

Properties

Property	Modifier	Type	Inherited from	Defined in
data	readonly	ZoneSettings	-	src/models/building.ts:24
id	readonly	number	IBuildingModel.id BaseModel.id	src/models/base.ts:4
location	readonly	number	-	src/models/building.ts:26
name	readonly	string	IBuildingModel.name BaseModel.name	src/models/base.ts:6

Accessors

areaIds

Get Signature

get areaIds(): number[]

Defined in: src/models/building.ts:39

Returns

number[]

Implementation of

IBuildingModel.areaIds

areas

Get Signature

get areas(): IAreaModel[]

Defined in: src/models/building.ts:43

Returns

IAreaModel[]

Implementation of

IBuildingModel.areas

deviceIds

Get Signature

get deviceIds(): number[]

Defined in: src/models/building.ts:47

Returns

number[]

Implementation of

IBuildingModel.deviceIds

devices

Get Signature

get devices(): IDeviceModelAny[]

Defined in: src/models/building.ts:51

Returns

IDeviceModelAny[]

Implementation of

IBuildingModel.devices

floorIds

Get Signature

get floorIds(): number[]

Defined in: src/models/building.ts:55

Returns

number[]

Implementation of

IBuildingModel.floorIds

floors

Get Signature

get floors(): IFloorModel[]

Defined in: src/models/building.ts:59

Returns

IFloorModel[]

Implementation of

IBuildingModel.floors

Methods

getAll()

static getAll(): IBuildingModel[]

Defined in: src/models/building.ts:63

Returns

IBuildingModel[]

getById()

static getById(id: number): undefined | IBuildingModel

Defined in: src/models/building.ts:67

Parameters

Parameter	Type
id	number

Returns

undefined | IBuildingModel

getByName()

static getByName(name: string): undefined | IBuildingModel

Defined in: src/models/building.ts:71

Parameters

Parameter	Type
name	string

Returns

undefined | IBuildingModel

setModels()

static setModels(__namedParameters: {
  areaModel: typeof AreaModel;
  deviceModel: typeof DeviceModel;
  floorModel: typeof FloorModel;
 }): void

Defined in: src/models/building.ts:75

Parameters

Parameter	Type
__namedParameters	{ areaModel: typeof AreaModel; deviceModel: typeof DeviceModel; floorModel: typeof FloorModel; }
__namedParameters.areaModel	typeof AreaModel
__namedParameters.deviceModel	typeof DeviceModel
__namedParameters.floorModel	typeof FloorModel

Returns

void

sync()

static sync(buildings: BuildingData[]): void

Defined in: src/models/building.ts:89

Parameters

Parameter	Type
buildings	BuildingData[]

Returns

void

---

DeviceModel<T>

Defined in: src/models/device.ts:20

Extends

• BaseModel

Type Parameters

Type Parameter
T extends DeviceType

Implements

• IDeviceModel<T>

Constructors

new DeviceModel()

protected new DeviceModel<T>(__namedParameters: ListDevice<T>): DeviceModel<T>

Defined in: src/models/device.ts:42

Parameters

Parameter	Type
__namedParameters	ListDevice<T>

Returns

DeviceModel<T>

Overrides

BaseModel.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
areaId	readonly	null | number	null	-	src/models/device.ts:32
buildingId	readonly	number	undefined	-	src/models/device.ts:34
floorId	readonly	null | number	null	-	src/models/device.ts:36
id	readonly	number	undefined	IDeviceModel.id BaseModel.id	src/models/base.ts:4
name	readonly	string	undefined	IDeviceModel.name BaseModel.name	src/models/base.ts:6
type	readonly	T	undefined	-	src/models/device.ts:38

Accessors

area

Get Signature

get area(): undefined | null | IAreaModel

Defined in: src/models/device.ts:60

Returns

undefined | null | IAreaModel

Implementation of

IDeviceModel.area

building

Get Signature

get building(): undefined | BuildingModel

Defined in: src/models/device.ts:66

Returns

undefined | BuildingModel

Implementation of

IDeviceModel.building

data

Get Signature

get data(): ListDeviceData<T>

Defined in: src/models/device.ts:70

Returns

ListDeviceData<T>

Implementation of

IDeviceModel.data

floor

Get Signature

get floor(): undefined | null | IFloorModel

Defined in: src/models/device.ts:74

Returns

undefined | null | IFloorModel

Implementation of

IDeviceModel.floor

Methods

update()

update(data: Partial<ListDeviceData<T>>): void

Defined in: src/models/device.ts:135

Parameters

Parameter	Type
data	Partial<ListDeviceData<T>>

Returns

void

Implementation of

IDeviceModel.update

getAll()

static getAll(): IDeviceModelAny[]

Defined in: src/models/device.ts:80

Returns

IDeviceModelAny[]

getByAreaId()

static getByAreaId(id: number): IDeviceModelAny[]

Defined in: src/models/device.ts:84

Parameters

Parameter	Type
id	number

Returns

IDeviceModelAny[]

getByBuildingId()

static getByBuildingId(id: number): IDeviceModelAny[]

Defined in: src/models/device.ts:88

Parameters

Parameter	Type
id	number

Returns

IDeviceModelAny[]

getByFloorId()

static getByFloorId(id: number): IDeviceModelAny[]

Defined in: src/models/device.ts:92

Parameters

Parameter	Type
id	number

Returns

IDeviceModelAny[]

getById()

static getById(id: number): undefined | IDeviceModelAny

Defined in: src/models/device.ts:96

Parameters

Parameter	Type
id	number

Returns

undefined | IDeviceModelAny

getByName()

static getByName(name: string): undefined | IDeviceModelAny

Defined in: src/models/device.ts:100

Parameters

Parameter	Type
name	string

Returns

undefined | IDeviceModelAny

getByType()

static getByType<U>(type: U): IDeviceModel<U>[]

Defined in: src/models/device.ts:104

Type Parameters

Type Parameter
U extends DeviceType

Parameters

Parameter	Type
type	U

Returns

IDeviceModel<U>[]

setModels()

static setModels(__namedParameters: {
  areaModel: typeof AreaModel;
  buildingModel: typeof BuildingModel;
  floorModel: typeof FloorModel;
 }): void

Defined in: src/models/device.ts:111

Parameters

Parameter	Type
__namedParameters	{ areaModel: typeof AreaModel; buildingModel: typeof BuildingModel; floorModel: typeof FloorModel; }
__namedParameters.areaModel	typeof AreaModel
__namedParameters.buildingModel	typeof BuildingModel
__namedParameters.floorModel	typeof FloorModel

Returns

void

sync()

static sync(devices: readonly ListDeviceAny[]): void

Defined in: src/models/device.ts:125

Parameters

Parameter	Type
devices	readonly ListDeviceAny[]

Returns

void

---

FacadeManager

Defined in: src/facades/manager.ts:23

Implements

• IFacadeManager

Constructors

new FacadeManager()

new FacadeManager(api: IAPI): FacadeManager

Defined in: src/facades/manager.ts:28

Parameters

Parameter	Type
api	IAPI

Returns

FacadeManager

Methods

get()

Call Signature

get<T>(instance: IDeviceModel<T>): IDeviceFacade<T>

Defined in: src/facades/manager.ts:32

Type Parameters

Type Parameter
T extends DeviceType

Parameters

Parameter	Type
instance	IDeviceModel<T>

Returns

IDeviceFacade<T>

Implementation of

IFacadeManager.get

Call Signature

get(instance:
  | IFloorModel
  | IAreaModel): ISuperDeviceFacade

Defined in: src/facades/manager.ts:33

Parameters

Parameter	Type
instance	| IFloorModel | IAreaModel

Returns

ISuperDeviceFacade

Implementation of

IFacadeManager.get

Call Signature

get(instance: IBuildingModel): IBuildingFacade

Defined in: src/facades/manager.ts:34

Parameters

Parameter	Type
instance	IBuildingModel

Returns

IBuildingFacade

Implementation of

IFacadeManager.get

Call Signature

get(instance: IDeviceModelAny): IDeviceFacadeAny

Defined in: src/facades/manager.ts:35

Parameters

Parameter	Type
instance	IDeviceModelAny

Returns

IDeviceFacadeAny

Implementation of

IFacadeManager.get

Call Signature

get(instance: IModel): IFacade

Defined in: src/facades/manager.ts:36

Parameters

Parameter	Type
instance	IModel

Returns

IFacade

Implementation of

IFacadeManager.get

Call Signature

get(): null

Defined in: src/facades/manager.ts:37

Returns

null

Implementation of

IFacadeManager.get

Call Signature

get<T>(instance?: IDeviceModel<T>): null | IDeviceFacade<T>

Defined in: src/facades/manager.ts:38

Type Parameters

Type Parameter
T extends DeviceType

Parameters

Parameter	Type
instance?	IDeviceModel<T>

Returns

null | IDeviceFacade<T>

Implementation of

IFacadeManager.get

Call Signature

get(instance?:
  | IFloorModel
  | IAreaModel): null | ISuperDeviceFacade

Defined in: src/facades/manager.ts:41

Parameters

Parameter	Type
instance?	| IFloorModel | IAreaModel

Returns

null | ISuperDeviceFacade

Implementation of

IFacadeManager.get

Call Signature

get(instance?: IBuildingModel): null | IBuildingFacade

Defined in: src/facades/manager.ts:42

Parameters

Parameter	Type
instance?	IBuildingModel

Returns

null | IBuildingFacade

Implementation of

IFacadeManager.get

Call Signature

get(instance?: IDeviceModelAny): null | IDeviceFacadeAny

Defined in: src/facades/manager.ts:43

Parameters

Parameter	Type
instance?	IDeviceModelAny

Returns

null | IDeviceFacadeAny

Implementation of

IFacadeManager.get

---

FloorModel

Defined in: src/models/floor.ts:15

Extends

• BaseModel

Implements

• IFloorModel

Properties

Property	Modifier	Type	Inherited from	Defined in
buildingId	readonly	number	-	src/models/floor.ts:24
id	readonly	number	IFloorModel.id BaseModel.id	src/models/base.ts:4
name	readonly	string	IFloorModel.name BaseModel.name	src/models/base.ts:6

Accessors

areaIds

Get Signature

get areaIds(): number[]

Defined in: src/models/floor.ts:35

Returns

number[]

Implementation of

IFloorModel.areaIds

areas

Get Signature

get areas(): IAreaModel[]

Defined in: src/models/floor.ts:39

Returns

IAreaModel[]

Implementation of

IFloorModel.areas

building

Get Signature

get building(): undefined | IBuildingModel

Defined in: src/models/floor.ts:43

Returns

undefined | IBuildingModel

Implementation of

IFloorModel.building

deviceIds

Get Signature

get deviceIds(): number[]

Defined in: src/models/floor.ts:47

Returns

number[]

Implementation of

IFloorModel.deviceIds

devices

Get Signature

get devices(): IDeviceModelAny[]

Defined in: src/models/floor.ts:51

Returns

IDeviceModelAny[]

Implementation of

IFloorModel.devices

Methods

getAll()

static getAll(): IFloorModel[]

Defined in: src/models/floor.ts:55

Returns

IFloorModel[]

getByBuildingId()

static getByBuildingId(id: number): IFloorModel[]

Defined in: src/models/floor.ts:59

Parameters

Parameter	Type
id	number

Returns

IFloorModel[]

getById()

static getById(id: number): undefined | IFloorModel

Defined in: src/models/floor.ts:63

Parameters

Parameter	Type
id	number

Returns

undefined | IFloorModel

getByName()

static getByName(name: string): undefined | IFloorModel

Defined in: src/models/floor.ts:67

Parameters

Parameter	Type
name	string

Returns

undefined | IFloorModel

setModels()

static setModels(__namedParameters: {
  areaModel: typeof AreaModel;
  buildingModel: typeof BuildingModel;
  deviceModel: typeof DeviceModel;
 }): void

Defined in: src/models/floor.ts:71

Parameters

Parameter	Type
__namedParameters	{ areaModel: typeof AreaModel; buildingModel: typeof BuildingModel; deviceModel: typeof DeviceModel; }
__namedParameters.areaModel	typeof AreaModel
__namedParameters.buildingModel	typeof BuildingModel
__namedParameters.deviceModel	typeof DeviceModel

Returns

void

sync()

static sync(floors: FloorData[]): void

Defined in: src/models/floor.ts:85

Parameters

Parameter	Type
floors	FloorData[]

Returns

void

---

MELCloudAPI

Defined in: src/services/api.ts:147

Implements

• IAPI

Properties

Property	Modifier	Type	Defined in
onSync?	readonly	OnSyncFunction	src/services/api.ts:148
settingManager?	readonly	SettingManager	src/services/api.ts:150

Methods

authenticate()

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

Defined in: src/services/api.ts:232

Parameters

Parameter	Type
data?	LoginCredentials

Returns

Promise<boolean>

Implementation of

IAPI.authenticate

clearSync()

clearSync(): void

Defined in: src/services/api.ts:246

Returns

void

Implementation of

IAPI.clearSync

energy()

energy(__namedParameters: {
  postData: EnergyPostData;
 }): Promise<{
  data: EnergyData<DeviceType>;
}>

Defined in: src/services/api.ts:253

Parameters

Parameter	Type
__namedParameters	{ postData: EnergyPostData; }
__namedParameters.postData	EnergyPostData

Returns

Promise<{ data: EnergyData<DeviceType>; }>

Implementation of

IAPI.energy

errorLog()

errorLog(query: ErrorLogQuery, deviceIds: number[]): Promise<ErrorLog>

Defined in: src/services/api.ts:261

Parameters

Parameter	Type
query	ErrorLogQuery
deviceIds	number[]

Returns

Promise<ErrorLog>

Implementation of

IAPI.errorLog

errors()

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

Defined in: src/services/api.ts:293

Parameters

Parameter	Type
__namedParameters	{ postData: ErrorLogPostData; }
__namedParameters.postData	ErrorLogPostData

Returns

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

Implementation of

IAPI.errors

fetch()

fetch(): Promise<Building[]>

Defined in: src/services/api.ts:221

Returns

Promise<Building[]>

Implementation of

IAPI.fetch

frostProtection()

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

Defined in: src/services/api.ts:301

Parameters

Parameter	Type
__namedParameters	{ params: SettingsParams; }
__namedParameters.params	SettingsParams

Returns

Promise<{ data: FrostProtectionData; }>

Implementation of

IAPI.frostProtection

group()

group(__namedParameters: {
  postData: GetGroupPostData;
 }): Promise<{
  data: GetGroupData;
}>

Defined in: src/services/api.ts:311

Parameters

Parameter	Type
__namedParameters	{ postData: GetGroupPostData; }
__namedParameters.postData	GetGroupPostData

Returns

Promise<{ data: GetGroupData; }>

Implementation of

IAPI.group

holidayMode()

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

Defined in: src/services/api.ts:319

Parameters

Parameter	Type
__namedParameters	{ params: SettingsParams; }
__namedParameters.params	SettingsParams

Returns

Promise<{ data: HolidayModeData; }>

Implementation of

IAPI.holidayMode

hourlyTemperatures()

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

Defined in: src/services/api.ts:329

Parameters

Parameter	Type
__namedParameters	{ postData: { device: number; hour: HourNumbers; }; }
__namedParameters.postData	{ device: number; hour: HourNumbers; }
__namedParameters.postData.device	number
__namedParameters.postData.hour	HourNumbers

Returns

Promise<{ data: ReportData; }>

Implementation of

IAPI.hourlyTemperatures

internalTemperatures()

internalTemperatures(__namedParameters: {
  postData: ReportPostData;
 }): Promise<{
  data: ReportData;
}>

Defined in: src/services/api.ts:337

Parameters

Parameter	Type
__namedParameters	{ postData: ReportPostData; }
__namedParameters.postData	ReportPostData

Returns

Promise<{ data: ReportData; }>

Implementation of

IAPI.internalTemperatures

list()

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

Defined in: src/services/api.ts:345

Returns

Promise<{ data: Building[]; }>

Implementation of

IAPI.list

login()

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

Defined in: src/services/api.ts:349

Parameters

Parameter	Type
__namedParameters	{ postData: LoginPostData; }
__namedParameters.postData	LoginPostData

Returns

Promise<{ data: LoginData; }>

Implementation of

IAPI.login

operationModes()

operationModes(__namedParameters: {
  postData: ReportPostData;
 }): Promise<{
  data: OperationModeLogData;
}>

Defined in: src/services/api.ts:357

Parameters

Parameter	Type
__namedParameters	{ postData: ReportPostData; }
__namedParameters.postData	ReportPostData

Returns

Promise<{ data: OperationModeLogData; }>

Implementation of

IAPI.operationModes

setFrostProtection()

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

Defined in: src/services/api.ts:365

Parameters

Parameter	Type
__namedParameters	{ postData: FrostProtectionPostData; }
__namedParameters.postData	FrostProtectionPostData

Returns

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

Implementation of

IAPI.setFrostProtection

setGroup()

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

Defined in: src/services/api.ts:373

Parameters

Parameter	Type
__namedParameters	{ postData: SetGroupPostData; }
__namedParameters.postData	SetGroupPostData

Returns

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

Implementation of

IAPI.setGroup

setHolidayMode()

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

Defined in: src/services/api.ts:381

Parameters

Parameter	Type
__namedParameters	{ postData: HolidayModePostData; }
__namedParameters.postData	HolidayModePostData

Returns

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

Implementation of

IAPI.setHolidayMode

setLanguage()

setLanguage(__namedParameters: {
  postData: {
     language: Language;
    };
 }): Promise<{
  data: boolean;
}>

Defined in: src/services/api.ts:389

Parameters

Parameter	Type
__namedParameters	{ postData: { language: Language; }; }
__namedParameters.postData	{ language: Language; }
__namedParameters.postData.language	Language

Returns

Promise<{ data: boolean; }>

Implementation of

IAPI.setLanguage

setPower()

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

Defined in: src/services/api.ts:397

Parameters

Parameter	Type
__namedParameters	{ postData: SetPowerPostData; }
__namedParameters.postData	SetPowerPostData

Returns

Promise<{ data: boolean; }>

Implementation of

IAPI.setPower

setValues()

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

Defined in: src/services/api.ts:405

Type Parameters

Type Parameter
T extends DeviceType

Parameters

Parameter	Type
__namedParameters	{ postData: SetDevicePostData<T>; type: T; }
__namedParameters.postData	SetDevicePostData<T>
__namedParameters.type	T

Returns

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

Implementation of

IAPI.setValues

signal()

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

Defined in: src/services/api.ts:415

Parameters

Parameter	Type
__namedParameters	{ postData: { devices: number | number[]; hour: HourNumbers; }; }
__namedParameters.postData	{ devices: number | number[]; hour: HourNumbers; }
__namedParameters.postData.devices	number | number[]
__namedParameters.postData.hour	HourNumbers

Returns

Promise<{ data: ReportData; }>

Implementation of

IAPI.signal

temperatures()

temperatures(__namedParameters: {
  postData: TemperatureLogPostData;
 }): Promise<{
  data: ReportData;
}>

Defined in: src/services/api.ts:423

Parameters

Parameter	Type
__namedParameters	{ postData: TemperatureLogPostData; }
__namedParameters.postData	TemperatureLogPostData

Returns

Promise<{ data: ReportData; }>

Implementation of

IAPI.temperatures

tiles()

Call Signature

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

Defined in: src/services/api.ts:431

Parameters

Parameter	Type
__namedParameters	{ postData: TilesPostData<null>; }
__namedParameters.postData	TilesPostData<null>

Returns

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

Implementation of

IAPI.tiles

Call Signature

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

Defined in: src/services/api.ts:437

Type Parameters

Type Parameter
T extends DeviceType

Parameters

Parameter	Type
__namedParameters	{ postData: TilesPostData<T>; }
__namedParameters.postData	TilesPostData<T>

Returns

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

Implementation of

IAPI.tiles

updateLanguage()

updateLanguage(language: string): Promise<void>

Defined in: src/services/api.ts:451

Parameters

Parameter	Type
language	string

Returns

Promise<void>

Implementation of

IAPI.updateLanguage

values()

values(__namedParameters: {
  params: GetDeviceDataParams;
 }): Promise<{
  data: GetDeviceData<DeviceType>;
}>

Defined in: src/services/api.ts:462

Parameters

Parameter	Type
__namedParameters	{ params: GetDeviceDataParams; }
__namedParameters.params	GetDeviceDataParams

Returns

Promise<{ data: GetDeviceData<DeviceType>; }>

Implementation of

IAPI.values

create()

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

Defined in: src/services/api.ts:214

Parameters

Parameter	Type
config?	APIConfig

Returns

Promise<MELCloudAPI>

Interfaces

APIConfig

Defined in: src/services/interfaces.ts:55

Extends

• Partial<LoginCredentials>

Properties

Property	Modifier	Type	Inherited from	Defined in
autoSyncInterval?	public	null | number	-	src/services/interfaces.ts:56
language?	public	string	-	src/services/interfaces.ts:57
logger?	public	Logger	-	src/services/interfaces.ts:58
onSync?	public	OnSyncFunction	-	src/services/interfaces.ts:59
password?	readonly	string	Partial.password	src/types/common.ts:162
settingManager?	public	SettingManager	-	src/services/interfaces.ts:60
shouldVerifySSL?	public	boolean	-	src/services/interfaces.ts:61
timezone?	public	string	-	src/services/interfaces.ts:62
username?	readonly	string	Partial.username	src/types/common.ts:163

---

APISettings

Defined in: src/services/interfaces.ts:38

Properties

Property	Type	Defined in
contextKey?	null | string	src/services/interfaces.ts:39
expiry?	null | string	src/services/interfaces.ts:40
password?	null | string	src/services/interfaces.ts:41
username?	null | string	src/services/interfaces.ts:42

---

AreaData<T>

Defined in: src/types/common.ts:28

Extends

• FloorData

Type Parameters

Type Parameter
T extends number | null

Properties

Property	Modifier	Type	Inherited from	Defined in
BuildingId	readonly	number	FloorData.BuildingId	src/types/common.ts:80
FloorId	readonly	T	-	src/types/common.ts:29
ID	readonly	number	FloorData.ID	src/types/common.ts:81
Name	readonly	string	FloorData.Name	src/types/common.ts:82

---

BaseDevicePostData

Defined in: src/types/bases.ts:4

Properties

Property	Modifier	Type	Defined in
DeviceID	readonly	number	src/types/bases.ts:5
EffectiveFlags	readonly	number	src/types/bases.ts:6

---

BaseGetDeviceData

Defined in: src/types/bases.ts:9

Extends

• BaseSetDeviceData

Properties

Property	Modifier	Type	Overrides	Inherited from	Defined in
EffectiveFlags	readonly	0	BaseSetDeviceData.EffectiveFlags	-	src/types/bases.ts:10
LastCommunication	readonly	string	-	BaseSetDeviceData.LastCommunication	src/types/bases.ts:39
NextCommunication	readonly	string	-	BaseSetDeviceData.NextCommunication	src/types/bases.ts:40
Offline	readonly	boolean	-	BaseSetDeviceData.Offline	src/types/bases.ts:31
Power	readonly	boolean	-	BaseSetDeviceData.Power	src/types/bases.ts:35

---

Building

Defined in: src/types/common.ts:32

Extends

• BuildingData

Properties

Property	Modifier	Type	Inherited from	Defined in
FPDefined	readonly	boolean	BuildingData.FPDefined	src/types/common.ts:86
FPEnabled	readonly	boolean	BuildingData.FPEnabled	src/types/common.ts:87
FPMaxTemperature	readonly	number	BuildingData.FPMaxTemperature	src/types/common.ts:88
FPMinTemperature	readonly	number	BuildingData.FPMinTemperature	src/types/common.ts:89
HMDefined	readonly	boolean	BuildingData.HMDefined	src/types/common.ts:123
HMEnabled	readonly	boolean	BuildingData.HMEnabled	src/types/common.ts:124
HMEndDate	readonly	null | string	BuildingData.HMEndDate	src/types/common.ts:125
HMStartDate	readonly	null | string	BuildingData.HMStartDate	src/types/common.ts:126
ID	readonly	number	BuildingData.ID	src/types/common.ts:48
Location	readonly	number	BuildingData.Location	src/types/common.ts:49
Name	readonly	string	BuildingData.Name	src/types/common.ts:50
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[]; }[]; }	-	src/types/common.ts:33
Structure.Areas	readonly	readonly AreaData<null> & { Devices: readonly ListDeviceAny[]; }[]	-	src/types/common.ts:34
Structure.Devices	readonly	readonly ListDeviceAny[]	-	src/types/common.ts:37
Structure.Floors	readonly	readonly FloorData & { Areas: readonly AreaData<number> & { Devices: readonly ListDeviceAny[]; }[]; Devices: readonly ListDeviceAny[]; }[]	-	src/types/common.ts:38
TimeZone	readonly	number	BuildingData.TimeZone	src/types/common.ts:135

---

BuildingData

Defined in: src/types/common.ts:47

Extends

• ZoneSettings

Extended by

• Building

Properties

Property	Modifier	Type	Inherited from	Defined in
FPDefined	readonly	boolean	ZoneSettings.FPDefined	src/types/common.ts:86
FPEnabled	readonly	boolean	ZoneSettings.FPEnabled	src/types/common.ts:87
FPMaxTemperature	readonly	number	ZoneSettings.FPMaxTemperature	src/types/common.ts:88
FPMinTemperature	readonly	number	ZoneSettings.FPMinTemperature	src/types/common.ts:89
HMDefined	readonly	boolean	ZoneSettings.HMDefined	src/types/common.ts:123
HMEnabled	readonly	boolean	ZoneSettings.HMEnabled	src/types/common.ts:124
HMEndDate	readonly	null | string	ZoneSettings.HMEndDate	src/types/common.ts:125
HMStartDate	readonly	null | string	ZoneSettings.HMStartDate	src/types/common.ts:126
ID	readonly	number	-	src/types/common.ts:48
Location	readonly	number	-	src/types/common.ts:49
Name	readonly	string	-	src/types/common.ts:50
TimeZone	readonly	number	ZoneSettings.TimeZone	src/types/common.ts:135

---

EnergyDataAta

Defined in: src/types/ata.ts:17

Properties

Property	Modifier	Type	Defined in
Auto	readonly	readonly number[]	src/types/ata.ts:18
Cooling	readonly	readonly number[]	src/types/ata.ts:19
Dry	readonly	readonly number[]	src/types/ata.ts:20
Fan	readonly	readonly number[]	src/types/ata.ts:21
Heating	readonly	readonly number[]	src/types/ata.ts:22
Other	readonly	readonly number[]	src/types/ata.ts:23
TotalAutoConsumed	readonly	number	src/types/ata.ts:24
TotalCoolingConsumed	readonly	number	src/types/ata.ts:25
TotalDryConsumed	readonly	number	src/types/ata.ts:26
TotalFanConsumed	readonly	number	src/types/ata.ts:27
TotalHeatingConsumed	readonly	number	src/types/ata.ts:28
TotalOtherConsumed	readonly	number	src/types/ata.ts:29
UsageDisclaimerPercentages	readonly	string	src/types/ata.ts:30

---

EnergyDataAtw

Defined in: src/types/atw.ts:15

Properties

Property	Modifier	Type	Defined in
CoP	readonly	readonly number[]	src/types/atw.ts:16
TotalCoolingConsumed	readonly	number	src/types/atw.ts:17
TotalCoolingProduced	readonly	number	src/types/atw.ts:18
TotalHeatingConsumed	readonly	number	src/types/atw.ts:19
TotalHeatingProduced	readonly	number	src/types/atw.ts:20
TotalHotWaterConsumed	readonly	number	src/types/atw.ts:21
TotalHotWaterProduced	readonly	number	src/types/atw.ts:22

---

EnergyPostData

Defined in: src/types/common.ts:53

Properties

Property	Modifier	Type	Defined in
DeviceID	readonly	number	src/types/common.ts:54
FromDate	readonly	string	src/types/common.ts:55
ToDate	readonly	string	src/types/common.ts:56

---

ErrorDetails

Defined in: src/services/interfaces.ts:65

Properties

Property	Modifier	Type	Defined in
date	readonly	string	src/services/interfaces.ts:66
device	readonly	string	src/services/interfaces.ts:67
error	readonly	string	src/services/interfaces.ts:68

---

ErrorLog

Defined in: src/services/interfaces.ts:71

Properties

Property	Modifier	Type	Defined in
errors	readonly	ErrorDetails[]	src/services/interfaces.ts:72
fromDateHuman	readonly	string	src/services/interfaces.ts:73
nextFromDate	readonly	string	src/services/interfaces.ts:74
nextToDate	readonly	string	src/services/interfaces.ts:75

---

ErrorLogData

Defined in: src/types/common.ts:59

Properties

Property	Modifier	Type	Defined in
DeviceId	readonly	number	src/types/common.ts:60
EndDate	readonly	string	src/types/common.ts:61
ErrorMessage	readonly	null | string	src/types/common.ts:62
StartDate	readonly	string	src/types/common.ts:63

---

ErrorLogPostData

Defined in: src/types/common.ts:66

Properties

Property	Modifier	Type	Defined in
DeviceIDs	readonly	number | readonly number[]	src/types/common.ts:67
Duration?	readonly	number	src/types/common.ts:71
FromDate?	readonly	string	src/types/common.ts:68
ToDate?	readonly	string	src/types/common.ts:69

---

ErrorLogQuery

Defined in: src/services/interfaces.ts:78

Properties

Property	Type	Defined in
from?	string	src/services/interfaces.ts:79
limit?	string	src/services/interfaces.ts:80
offset?	string	src/services/interfaces.ts:81
to?	string	src/services/interfaces.ts:82

---

FailureData

Defined in: src/types/common.ts:74

Properties

Property	Modifier	Type	Defined in
AttributeErrors	readonly	Record<string, readonly string[]>	src/types/common.ts:75
Success	readonly	false	src/types/common.ts:76

---

FloorData

Defined in: src/types/common.ts:79

Extended by

• AreaData

Properties

Property	Modifier	Type	Defined in
BuildingId	readonly	number	src/types/common.ts:80
ID	readonly	number	src/types/common.ts:81
Name	readonly	string	src/types/common.ts:82

---

FrostProtectionData

Defined in: src/types/common.ts:85

Extended by

• ZoneSettings

Properties

Property	Modifier	Type	Defined in
FPDefined	readonly	boolean	src/types/common.ts:86
FPEnabled	readonly	boolean	src/types/common.ts:87
FPMaxTemperature	readonly	number	src/types/common.ts:88
FPMinTemperature	readonly	number	src/types/common.ts:89

---

FrostProtectionLocation

Defined in: src/types/common.ts:92

Extended by

• FrostProtectionPostData

Properties

Property	Modifier	Type	Defined in
AreaIds?	readonly	number | readonly number[]	src/types/common.ts:93
BuildingIds?	readonly	number | readonly number[]	src/types/common.ts:94
DeviceIds?	readonly	number | readonly number[]	src/types/common.ts:95
FloorIds?	readonly	number | readonly number[]	src/types/common.ts:96

---

FrostProtectionPostData

Defined in: src/types/common.ts:99

Extends

• FrostProtectionLocation

Properties

Property	Modifier	Type	Inherited from	Defined in
AreaIds?	readonly	number | readonly number[]	FrostProtectionLocation.AreaIds	src/types/common.ts:93
BuildingIds?	readonly	number | readonly number[]	FrostProtectionLocation.BuildingIds	src/types/common.ts:94
DeviceIds?	readonly	number | readonly number[]	FrostProtectionLocation.DeviceIds	src/types/common.ts:95
Enabled	readonly	boolean	-	src/types/common.ts:100
FloorIds?	readonly	number | readonly number[]	FrostProtectionLocation.FloorIds	src/types/common.ts:96
MaximumTemperature	readonly	number	-	src/types/common.ts:101
MinimumTemperature	readonly	number	-	src/types/common.ts:102

---

FrostProtectionQuery

Defined in: src/facades/interfaces.ts:27

Properties

Property	Type	Defined in
enabled?	boolean	src/facades/interfaces.ts:30
max	number	src/facades/interfaces.ts:28
min	number	src/facades/interfaces.ts:29

---

GetDeviceDataParams

Defined in: src/types/common.ts:105

Properties

Property	Modifier	Type	Defined in
buildingId	readonly	number	src/types/common.ts:106
id	readonly	number	src/types/common.ts:107

---

GetGroupData

Defined in: src/types/ata.ts:33

Properties

Property	Modifier	Type	Defined in
Data	readonly	{ Group: { Specification: Required<GetGroupPostData>; State: Required<GroupState>; }; }	src/types/ata.ts:34
Data.Group	readonly	{ Specification: Required<GetGroupPostData>; State: Required<GroupState>; }	src/types/ata.ts:35
Data.Group.Specification	readonly	Required<GetGroupPostData>	src/types/ata.ts:36
Data.Group.State	readonly	Required<GroupState>	src/types/ata.ts:37

---

GetGroupPostData

Defined in: src/types/ata.ts:42

Properties

Property	Modifier	Type	Defined in
AreaID?	readonly	null | number	src/types/ata.ts:43
BuildingID?	readonly	null | number	src/types/ata.ts:44
FloorID?	readonly	null | number	src/types/ata.ts:45

---

GroupState

Defined in: src/types/ata.ts:48

Properties

Property	Modifier	Type	Defined in
FanSpeed?	readonly	| null | auto | fast | moderate | slow | very_fast | very_slow	src/types/ata.ts:49
OperationMode?	readonly	null | OperationMode	src/types/ata.ts:50
Power?	readonly	null | boolean	src/types/ata.ts:51
SetTemperature?	readonly	null | number	src/types/ata.ts:52
VaneHorizontalDirection?	readonly	null | Horizontal	src/types/ata.ts:53
VaneHorizontalSwing?	readonly	null | boolean	src/types/ata.ts:54
VaneVerticalDirection?	readonly	null | Vertical	src/types/ata.ts:55
VaneVerticalSwing?	readonly	null | boolean	src/types/ata.ts:56

---

HMTimeZone

Defined in: src/types/common.ts:110

Extends

• HolidayModeLocation

Properties

Property	Modifier	Type	Inherited from	Defined in
Areas?	readonly	number | readonly number[]	HolidayModeLocation.Areas	src/types/common.ts:139
Buildings?	readonly	number | readonly number[]	HolidayModeLocation.Buildings	src/types/common.ts:140
Devices?	readonly	number | readonly number[]	HolidayModeLocation.Devices	src/types/common.ts:141
Floors?	readonly	number | readonly number[]	HolidayModeLocation.Floors	src/types/common.ts:142
TimeZone?	readonly	number	-	src/types/common.ts:111

---

HolidayModeData

Defined in: src/types/common.ts:114

Properties

Property	Modifier	Type	Defined in
EndDate	readonly	{ Day: number; Hour: number; Minute: number; Month: number; Second: number; Year: number; }	src/types/common.ts:115
EndDate.Day	readonly	number	src/types/common.ts:116
EndDate.Hour	readonly	number	src/types/common.ts:117
EndDate.Minute	readonly	number	src/types/common.ts:118
EndDate.Month	readonly	number	src/types/common.ts:119
EndDate.Second	readonly	number	src/types/common.ts:120
EndDate.Year	readonly	number	src/types/common.ts:121
HMDefined	readonly	boolean	src/types/common.ts:123
HMEnabled	readonly	boolean	src/types/common.ts:124
HMEndDate	readonly	null | string	src/types/common.ts:125
HMStartDate	readonly	null | string	src/types/common.ts:126
StartDate	readonly	{ Day: number; Hour: number; Minute: number; Month: number; Second: number; Year: number; }	src/types/common.ts:127
StartDate.Day	readonly	number	src/types/common.ts:128
StartDate.Hour	readonly	number	src/types/common.ts:129
StartDate.Minute	readonly	number	src/types/common.ts:130
StartDate.Month	readonly	number	src/types/common.ts:131
StartDate.Second	readonly	number	src/types/common.ts:132
StartDate.Year	readonly	number	src/types/common.ts:133
TimeZone	readonly	number	src/types/common.ts:135

---

HolidayModeLocation

Defined in: src/types/common.ts:138

Extended by

• HMTimeZone

Properties

Property	Modifier	Type	Defined in
Areas?	readonly	number | readonly number[]	src/types/common.ts:139
Buildings?	readonly	number | readonly number[]	src/types/common.ts:140
Devices?	readonly	number | readonly number[]	src/types/common.ts:141
Floors?	readonly	number | readonly number[]	src/types/common.ts:142

---

HolidayModePostData

Defined in: src/types/common.ts:145

Properties

Property	Modifier	Type	Defined in
Enabled	readonly	boolean	src/types/common.ts:146
EndDate	readonly	DateTimeComponents	src/types/common.ts:147
HMTimeZones	readonly	readonly HMTimeZone[]	src/types/common.ts:148
StartDate	readonly	DateTimeComponents	src/types/common.ts:149

---

HolidayModeQuery

Defined in: src/facades/interfaces.ts:33

Properties

Property	Type	Defined in
from?	string	src/facades/interfaces.ts:34
to?	string	src/facades/interfaces.ts:35

---

IAPI

Defined in: src/services/interfaces.ts:85

Properties

Property	Type	Defined in
authenticate	(data?: LoginCredentials) => Promise<boolean>	src/services/interfaces.ts:87
clearSync	() => void	src/services/interfaces.ts:88
energy	(__namedParameters: { postData: EnergyPostData; }) => Promise<{ data: EnergyData<DeviceType>; }>	src/services/interfaces.ts:172
errorLog	(query: ErrorLogQuery, deviceIds: number[]) => Promise<ErrorLog>	src/services/interfaces.ts:89
errors	(__namedParameters: { postData: ErrorLogPostData; }) => Promise<{ data: | FailureData | ErrorLogData[]; }>	src/services/interfaces.ts:93
fetch	() => Promise<Building[]>	src/services/interfaces.ts:90
frostProtection	(__namedParameters: { params: SettingsParams; }) => Promise<{ data: FrostProtectionData; }>	src/services/interfaces.ts:98
group	(__namedParameters: { postData: GetGroupPostData; }) => Promise<{ data: GetGroupData; }>	src/services/interfaces.ts:178
holidayMode	(__namedParameters: { params: SettingsParams; }) => Promise<{ data: HolidayModeData; }>	src/services/interfaces.ts:103
hourlyTemperatures	(__namedParameters: { postData: { device: number; hour: HourNumbers; }; }) => Promise<{ data: ReportData; }>	src/services/interfaces.ts:189
internalTemperatures	(__namedParameters: { postData: ReportPostData; }) => Promise<{ data: ReportData; }>	src/services/interfaces.ts:194
list	() => Promise<{ data: Building[]; }>	src/services/interfaces.ts:108
login	(__namedParameters: { postData: LoginPostData; }) => Promise<{ data: LoginData; }>	src/services/interfaces.ts:109
onSync?	OnSyncFunction	src/services/interfaces.ts:86
operationModes	(__namedParameters: { postData: ReportPostData; }) => Promise<{ data: OperationModeLogData; }>	src/services/interfaces.ts:114
setFrostProtection	(__namedParameters: { postData: FrostProtectionPostData; }) => Promise<{ data: | FailureData | SuccessData; }>	src/services/interfaces.ts:119
setGroup	(__namedParameters: { postData: SetGroupPostData; }) => Promise<{ data: | FailureData | SuccessData; }>	src/services/interfaces.ts:183
setHolidayMode	(__namedParameters: { postData: HolidayModePostData; }) => Promise<{ data: | FailureData | SuccessData; }>	src/services/interfaces.ts:124
setLanguage	(__namedParameters: { postData: { language: Language; }; }) => Promise<{ data: boolean; }>	src/services/interfaces.ts:129
setPower	(__namedParameters: { postData: SetPowerPostData; }) => Promise<{ data: boolean; }>	src/services/interfaces.ts:134
setValues	<T>(__namedParameters: { postData: SetDevicePostData<T>; type: T; }) => Promise<{ data: SetDeviceData<T>; }>	src/services/interfaces.ts:139
signal	(__namedParameters: { postData: { devices: number | number[]; hour: HourNumbers; }; }) => Promise<{ data: ReportData; }>	src/services/interfaces.ts:146
temperatures	(__namedParameters: { postData: TemperatureLogPostData; }) => Promise<{ data: ReportData; }>	src/services/interfaces.ts:151
tiles	(__namedParameters: { postData: TilesPostData<null>; }) => Promise<{ data: TilesData<null>; }> & <T>(__namedParameters: { postData: TilesPostData<T>; }) => Promise<{ data: TilesData<T>; }>	src/services/interfaces.ts:156
updateLanguage	(language: string) => Promise<void>	src/services/interfaces.ts:91
values	(__namedParameters: { params: GetDeviceDataParams; }) => Promise<{ data: GetDeviceData<DeviceType>; }>	src/services/interfaces.ts:166

---

IAreaModel

Defined in: src/models/interfaces.ts:24

Extends

• ISubFloorModel.ISuperDeviceModel

Properties

Property	Type	Inherited from	Defined in
building?	IBuildingModel	ISubFloorModel.building	src/models/interfaces.ts:6
buildingId	number	ISubFloorModel.buildingId	src/models/interfaces.ts:5
deviceIds	number[]	ISuperDeviceModel.deviceIds	src/models/interfaces.ts:20
devices	IDeviceModelAny[]	ISuperDeviceModel.devices	src/models/interfaces.ts:21
floor?	null | IFloorModel	ISubFloorModel.floor	src/models/interfaces.ts:11
floorId	null | number	ISubFloorModel.floorId	src/models/interfaces.ts:10
id	number	ISubFloorModel.id	src/models/interfaces.ts:52
name	string	ISubFloorModel.name	src/models/interfaces.ts:53

---

IBuildingFacade

Defined in: src/facades/interfaces.ts:38

Extends

• IBaseBuildingModel.ISuperDeviceFacade

Properties

Property	Type	Inherited from	Defined in
data	ZoneSettings	IBaseBuildingModel.data	src/models/interfaces.ts:27
devices	IDeviceModelAny[]	ISuperDeviceFacade.devices	src/facades/interfaces.ts:63
errors	(query: ErrorLogQuery) => Promise< | FailureData | ErrorLog>	ISuperDeviceFacade.errors	src/facades/interfaces.ts:64
fetch	() => Promise<ZoneSettings>	-	src/facades/interfaces.ts:41
frostProtection	() => Promise<FrostProtectionData>	ISuperDeviceFacade.frostProtection	src/facades/interfaces.ts:65
group	() => Promise<GroupState>	ISuperDeviceFacade.group	src/facades/interfaces.ts:85
holidayMode	() => Promise<HolidayModeData>	ISuperDeviceFacade.holidayMode	src/facades/interfaces.ts:66
id	number	ISuperDeviceFacade.id	src/models/interfaces.ts:52
name	string	ISuperDeviceFacade.name	src/models/interfaces.ts:53
onSync	(params?: { type: DeviceType; }) => Promise<void>	ISuperDeviceFacade.onSync	src/facades/interfaces.ts:67
setFrostProtection	(query: FrostProtectionQuery) => Promise< | FailureData | SuccessData>	ISuperDeviceFacade.setFrostProtection	src/facades/interfaces.ts:68
setGroup	(state: GroupState) => Promise< | FailureData | SuccessData>	ISuperDeviceFacade.setGroup	src/facades/interfaces.ts:86
setHolidayMode	(query: HolidayModeQuery) => Promise< | FailureData | SuccessData>	ISuperDeviceFacade.setHolidayMode	src/facades/interfaces.ts:71
setPower	(value?: boolean) => Promise<boolean>	ISuperDeviceFacade.setPower	src/facades/interfaces.ts:74
signal	(hour?: HourNumbers) => Promise<ReportChartLineOptions>	ISuperDeviceFacade.signal	src/facades/interfaces.ts:75
tiles	(select?: false) => Promise<TilesData<null>> & <T>(select: IDeviceModel<T>) => Promise<TilesData<T>>	ISuperDeviceFacade.tiles	src/facades/interfaces.ts:76

---

IBuildingModel

Defined in: src/models/interfaces.ts:35

Extends

• IBaseBuildingModel.ISuperAreaModel

Properties

Property	Type	Inherited from	Defined in
areaIds	number[]	ISuperAreaModel.areaIds	src/models/interfaces.ts:15
areas	IAreaModel[]	ISuperAreaModel.areas	src/models/interfaces.ts:16
data	ZoneSettings	IBaseBuildingModel.data	src/models/interfaces.ts:27
deviceIds	number[]	ISuperAreaModel.deviceIds	src/models/interfaces.ts:20
devices	IDeviceModelAny[]	ISuperAreaModel.devices	src/models/interfaces.ts:21
floorIds	number[]	-	src/models/interfaces.ts:36
floors	IFloorModel[]	-	src/models/interfaces.ts:37
id	number	ISuperAreaModel.id	src/models/interfaces.ts:52
location	number	-	src/models/interfaces.ts:38
name	string	ISuperAreaModel.name	src/models/interfaces.ts:53

---

IDeviceFacade<T>

Defined in: src/facades/interfaces.ts:44

Extends

• IBaseDeviceModel<T>.IFacade

Type Parameters

Type Parameter
T extends DeviceType

Properties

Property	Type	Overrides	Inherited from	Defined in
data	ListDeviceData<T>	-	IBaseDeviceModel.data	src/models/interfaces.ts:31
devices	IDeviceModelAny[]	-	IFacade.devices	src/facades/interfaces.ts:63
energy	(query: ReportQuery) => Promise<EnergyData<T>>	-	-	src/facades/interfaces.ts:56
errors	(query: ErrorLogQuery) => Promise< | FailureData | ErrorLog>	-	IFacade.errors	src/facades/interfaces.ts:64
fetch	() => Promise<ListDeviceData<T>>	-	-	src/facades/interfaces.ts:48
flags	Record<keyof UpdateDeviceData<T>, number>	-	-	src/facades/interfaces.ts:47
frostProtection	() => Promise<FrostProtectionData>	-	IFacade.frostProtection	src/facades/interfaces.ts:65
holidayMode	() => Promise<HolidayModeData>	-	IFacade.holidayMode	src/facades/interfaces.ts:66
hourlyTemperatures	(hour?: HourNumbers) => Promise<ReportChartLineOptions>	-	-	src/facades/interfaces.ts:58
id	number	-	IFacade.id	src/models/interfaces.ts:52
internalTemperatures	(query: ReportQuery) => Promise<ReportChartLineOptions>	-	-	src/facades/interfaces.ts:59
name	string	-	IFacade.name	src/models/interfaces.ts:53
onSync	(params?: { type: DeviceType; }) => Promise<void>	-	IFacade.onSync	src/facades/interfaces.ts:67
operationModes	(query: ReportQuery) => Promise<ReportChartPieOptions>	-	-	src/facades/interfaces.ts:49
setFrostProtection	(query: FrostProtectionQuery) => Promise< | FailureData | SuccessData>	-	IFacade.setFrostProtection	src/facades/interfaces.ts:68
setHolidayMode	(query: HolidayModeQuery) => Promise< | FailureData | SuccessData>	-	IFacade.setHolidayMode	src/facades/interfaces.ts:71
setPower	(value?: boolean) => Promise<boolean>	-	IFacade.setPower	src/facades/interfaces.ts:74
setValues	(data: UpdateDeviceData<T>) => Promise<SetDeviceData<T>>	-	-	src/facades/interfaces.ts:50
signal	(hour?: HourNumbers) => Promise<ReportChartLineOptions>	-	IFacade.signal	src/facades/interfaces.ts:75
temperatures	(query: ReportQuery) => Promise<ReportChartLineOptions>	-	-	src/facades/interfaces.ts:51
tiles	(select: true | IDeviceModel<T>) => Promise<TilesData<T>> & (select?: false) => Promise<TilesData<null>>	IFacade.tiles	-	src/facades/interfaces.ts:52
type	T	-	IBaseDeviceModel.type	src/models/interfaces.ts:32
values	() => Promise<GetDeviceData<T>>	-	-	src/facades/interfaces.ts:54

---

IDeviceModel<T>

Defined in: src/models/interfaces.ts:41

Extends

• IBaseDeviceModel<T>.ISubFloorModel

Type Parameters

Type Parameter
T extends DeviceType

Properties

Property	Type	Inherited from	Defined in
area?	null | IAreaModel	-	src/models/interfaces.ts:45
areaId	null | number	-	src/models/interfaces.ts:44
building?	IBuildingModel	ISubFloorModel.building	src/models/interfaces.ts:6
buildingId	number	ISubFloorModel.buildingId	src/models/interfaces.ts:5
data	ListDeviceData<T>	IBaseDeviceModel.data	src/models/interfaces.ts:31
floor?	null | IFloorModel	ISubFloorModel.floor	src/models/interfaces.ts:11
floorId	null | number	ISubFloorModel.floorId	src/models/interfaces.ts:10
id	number	ISubFloorModel.id	src/models/interfaces.ts:52
name	string	ISubFloorModel.name	src/models/interfaces.ts:53
type	T	IBaseDeviceModel.type	src/models/interfaces.ts:32
update	(data: Partial<ListDeviceData<T>>) => void	-	src/models/interfaces.ts:46

---

IFacade

Defined in: src/facades/interfaces.ts:62

Extends

• IModel

Extended by

• IDeviceFacade
• ISuperDeviceFacade

Properties

Property	Type	Inherited from	Defined in
devices	IDeviceModelAny[]	-	src/facades/interfaces.ts:63
errors	(query: ErrorLogQuery) => Promise< | FailureData | ErrorLog>	-	src/facades/interfaces.ts:64
frostProtection	() => Promise<FrostProtectionData>	-	src/facades/interfaces.ts:65
holidayMode	() => Promise<HolidayModeData>	-	src/facades/interfaces.ts:66
id	number	IModel.id	src/models/interfaces.ts:52
name	string	IModel.name	src/models/interfaces.ts:53
onSync	(params?: { type: DeviceType; }) => Promise<void>	-	src/facades/interfaces.ts:67
setFrostProtection	(query: FrostProtectionQuery) => Promise< | FailureData | SuccessData>	-	src/facades/interfaces.ts:68
setHolidayMode	(query: HolidayModeQuery) => Promise< | FailureData | SuccessData>	-	src/facades/interfaces.ts:71
setPower	(value?: boolean) => Promise<boolean>	-	src/facades/interfaces.ts:74
signal	(hour?: HourNumbers) => Promise<ReportChartLineOptions>	-	src/facades/interfaces.ts:75
tiles	(select?: false) => Promise<TilesData<null>> & <T>(select: IDeviceModel<T>) => Promise<TilesData<T>>	-	src/facades/interfaces.ts:76

---

IFacadeManager

Defined in: src/facades/interfaces.ts:80

Properties

Property	Type	Defined in
get	(instance?: IModel) => null | IFacade	src/facades/interfaces.ts:81

---

IFloorModel

Defined in: src/models/interfaces.ts:49

Extends

• ISubBuildingModel.ISuperAreaModel

Properties

Property	Type	Inherited from	Defined in
areaIds	number[]	ISuperAreaModel.areaIds	src/models/interfaces.ts:15
areas	IAreaModel[]	ISuperAreaModel.areas	src/models/interfaces.ts:16
building?	IBuildingModel	ISubBuildingModel.building	src/models/interfaces.ts:6
buildingId	number	ISubBuildingModel.buildingId	src/models/interfaces.ts:5
deviceIds	number[]	ISuperAreaModel.deviceIds	src/models/interfaces.ts:20
devices	IDeviceModelAny[]	ISuperAreaModel.devices	src/models/interfaces.ts:21
id	number	ISubBuildingModel.id	src/models/interfaces.ts:52
name	string	ISubBuildingModel.name	src/models/interfaces.ts:53

---

IModel

Defined in: src/models/interfaces.ts:51

Extended by

• IFacade

Properties

Property	Type	Defined in
id	number	src/models/interfaces.ts:52
name	string	src/models/interfaces.ts:53

---

ISuperDeviceFacade

Defined in: src/facades/interfaces.ts:84

Extends

• IFacade

Extended by

• IBuildingFacade

Properties

Property	Type	Inherited from	Defined in
devices	IDeviceModelAny[]	IFacade.devices	src/facades/interfaces.ts:63
errors	(query: ErrorLogQuery) => Promise< | FailureData | ErrorLog>	IFacade.errors	src/facades/interfaces.ts:64
frostProtection	() => Promise<FrostProtectionData>	IFacade.frostProtection	src/facades/interfaces.ts:65
group	() => Promise<GroupState>	-	src/facades/interfaces.ts:85
holidayMode	() => Promise<HolidayModeData>	IFacade.holidayMode	src/facades/interfaces.ts:66
id	number	IFacade.id	src/models/interfaces.ts:52
name	string	IFacade.name	src/models/interfaces.ts:53
onSync	(params?: { type: DeviceType; }) => Promise<void>	IFacade.onSync	src/facades/interfaces.ts:67
setFrostProtection	(query: FrostProtectionQuery) => Promise< | FailureData | SuccessData>	IFacade.setFrostProtection	src/facades/interfaces.ts:68
setGroup	(state: GroupState) => Promise< | FailureData | SuccessData>	-	src/facades/interfaces.ts:86
setHolidayMode	(query: HolidayModeQuery) => Promise< | FailureData | SuccessData>	IFacade.setHolidayMode	src/facades/interfaces.ts:71
setPower	(value?: boolean) => Promise<boolean>	IFacade.setPower	src/facades/interfaces.ts:74
signal	(hour?: HourNumbers) => Promise<ReportChartLineOptions>	IFacade.signal	src/facades/interfaces.ts:75
tiles	(select?: false) => Promise<TilesData<null>> & <T>(select: IDeviceModel<T>) => Promise<TilesData<T>>	IFacade.tiles	src/facades/interfaces.ts:76

---

ListDevice<T>

Defined in: src/types/common.ts:157

Extends

• BaseListDevice

Type Parameters

Type Parameter
T extends DeviceType

Properties

Property	Modifier	Type	Inherited from	Defined in
AreaID	readonly	null | number	BaseListDevice.AreaID	src/types/bases.ts:14
BuildingID	readonly	number	BaseListDevice.BuildingID	src/types/bases.ts:15
Device	readonly	ListDeviceData<T>	-	src/types/common.ts:158
DeviceID	readonly	number	BaseListDevice.DeviceID	src/types/bases.ts:16
DeviceName	readonly	string	BaseListDevice.DeviceName	src/types/bases.ts:17
FloorID	readonly	null | number	BaseListDevice.FloorID	src/types/bases.ts:18
Type	readonly	DeviceType	BaseListDevice.Type	src/types/bases.ts:19

---

ListDeviceDataAta

Defined in: src/types/ata.ts:59

Extends

• BaseListDeviceData.Omit<GetDeviceData<Ata>, | KeyofSetDeviceDataAtaNotInList | keyof DeviceDataNotInList>.SetDeviceDataAtaInList

Properties

Property	Modifier	Type	Inherited from	Defined in
ActualFanSpeed	readonly	number	-	src/types/ata.ts:66
DeviceType	readonly	Ata	Omit.DeviceType	src/types/ata.ts:80
EffectiveFlags	readonly	0	BaseListDeviceData.EffectiveFlags	src/types/bases.ts:10
FanSpeed	readonly	FanSpeed	SetDeviceDataAtaInList.FanSpeed	src/types/ata.ts:86
HasAutomaticFanSpeed	readonly	boolean	-	src/types/ata.ts:67
MaxTempAutomatic	readonly	number	-	src/types/ata.ts:68
MaxTempCoolDry	readonly	number	-	src/types/ata.ts:69
MaxTempHeat	readonly	number	-	src/types/ata.ts:70
MinTempAutomatic	readonly	number	-	src/types/ata.ts:71
MinTempCoolDry	readonly	number	-	src/types/ata.ts:72
MinTempHeat	readonly	number	-	src/types/ata.ts:73
NumberOfFanSpeeds	readonly	number	Omit.NumberOfFanSpeeds	src/types/ata.ts:81
Offline	readonly	boolean	BaseListDeviceData.Offline	src/types/bases.ts:31
OperationMode	readonly	OperationMode	Omit.OperationMode	src/types/ata.ts:97
OutdoorTemperature	readonly	number	-	src/types/ata.ts:74
Power	readonly	boolean	BaseListDeviceData.Power	src/types/bases.ts:35
RoomTemperature	readonly	number	Omit.RoomTemperature	src/types/ata.ts:82
SetTemperature	readonly	number	Omit.SetTemperature	src/types/ata.ts:99
VaneHorizontalDirection	readonly	Horizontal	SetDeviceDataAtaInList.VaneHorizontalDirection	src/types/ata.ts:87
VaneVerticalDirection	readonly	Vertical	SetDeviceDataAtaInList.VaneVerticalDirection	src/types/ata.ts:88
WifiSignalStrength	readonly	number	BaseListDeviceData.WifiSignalStrength	src/types/bases.ts:24

---

ListDeviceDataAtw

Defined in: src/types/atw.ts:25

Extends

• BaseListDeviceData.Omit<GetDeviceData<Atw>, keyof DeviceDataNotInList>

Properties

Property	Modifier	Type	Inherited from	Defined in
BoosterHeater1Status	readonly	boolean	-	src/types/atw.ts:28
BoosterHeater2PlusStatus	readonly	boolean	-	src/types/atw.ts:29
BoosterHeater2Status	readonly	boolean	-	src/types/atw.ts:30
CanCool	readonly	boolean	-	src/types/atw.ts:31
CondensingTemperature	readonly	number	-	src/types/atw.ts:32
CurrentEnergyConsumed	readonly	number	-	src/types/atw.ts:33
CurrentEnergyProduced	readonly	number	-	src/types/atw.ts:34
DefrostMode	readonly	number	-	src/types/atw.ts:35
DeviceType	readonly	Atw	Omit.DeviceType	src/types/atw.ts:65
EcoHotWater	readonly	boolean	-	src/types/atw.ts:36
EffectiveFlags	readonly	0	BaseListDeviceData.EffectiveFlags	src/types/bases.ts:10
FlowTemperature	readonly	number	-	src/types/atw.ts:37
FlowTemperatureZone1	readonly	number	-	src/types/atw.ts:38
FlowTemperatureZone2	readonly	number	-	src/types/atw.ts:39
ForcedHotWaterMode	readonly	boolean	Omit.ForcedHotWaterMode	src/types/atw.ts:94
HasZone2	readonly	boolean	-	src/types/atw.ts:40
HeatPumpFrequency	readonly	number	-	src/types/atw.ts:41
IdleZone1	readonly	boolean	Omit.IdleZone1	src/types/atw.ts:66
IdleZone2	readonly	boolean	Omit.IdleZone2	src/types/atw.ts:67
ImmersionHeaterStatus	readonly	boolean	-	src/types/atw.ts:42
LastLegionellaActivationTime	readonly	string	-	src/types/atw.ts:43
MaxTankTemperature	readonly	number	-	src/types/atw.ts:44
MixingTankWaterTemperature	readonly	number	-	src/types/atw.ts:45
Offline	readonly	boolean	BaseListDeviceData.Offline	src/types/bases.ts:31
OperationMode	readonly	OperationModeState	Omit.OperationMode	src/types/atw.ts:68
OperationModeZone1	readonly	OperationModeZone	Omit.OperationModeZone1	src/types/atw.ts:58
OperationModeZone2	readonly	OperationModeZone	Omit.OperationModeZone2	src/types/atw.ts:59
OutdoorTemperature	readonly	number	Omit.OutdoorTemperature	src/types/atw.ts:69
Power	readonly	boolean	BaseListDeviceData.Power	src/types/bases.ts:35
ProhibitCoolingZone1	readonly	boolean	Omit.ProhibitCoolingZone1	src/types/atw.ts:70
ProhibitCoolingZone2	readonly	boolean	Omit.ProhibitCoolingZone2	src/types/atw.ts:71
ProhibitHeatingZone1	readonly	boolean	Omit.ProhibitHeatingZone1	src/types/atw.ts:72
ProhibitHeatingZone2	readonly	boolean	Omit.ProhibitHeatingZone2	src/types/atw.ts:73
ProhibitHotWater	readonly	boolean	Omit.ProhibitHotWater	src/types/atw.ts:74
ReturnTemperature	readonly	number	-	src/types/atw.ts:46
ReturnTemperatureZone1	readonly	number	-	src/types/atw.ts:47
ReturnTemperatureZone2	readonly	number	-	src/types/atw.ts:48
RoomTemperatureZone1	readonly	number	Omit.RoomTemperatureZone1	src/types/atw.ts:75
RoomTemperatureZone2	readonly	number	Omit.RoomTemperatureZone2	src/types/atw.ts:76
SetCoolFlowTemperatureZone1	readonly	number	Omit.SetCoolFlowTemperatureZone1	src/types/atw.ts:81
SetCoolFlowTemperatureZone2	readonly	number	Omit.SetCoolFlowTemperatureZone2	src/types/atw.ts:82
SetHeatFlowTemperatureZone1	readonly	number	Omit.SetHeatFlowTemperatureZone1	src/types/atw.ts:83
SetHeatFlowTemperatureZone2	readonly	number	Omit.SetHeatFlowTemperatureZone2	src/types/atw.ts:84
SetTankWaterTemperature	readonly	number	Omit.SetTankWaterTemperature	src/types/atw.ts:85
SetTemperatureZone1	readonly	number	Omit.SetTemperatureZone1	src/types/atw.ts:86
SetTemperatureZone2	readonly	number	Omit.SetTemperatureZone2	src/types/atw.ts:87
TankWaterTemperature	readonly	number	Omit.TankWaterTemperature	src/types/atw.ts:77
TargetHCTemperatureZone1	readonly	number	-	src/types/atw.ts:49
TargetHCTemperatureZone2	readonly	number	-	src/types/atw.ts:50
WifiSignalStrength	readonly	number	BaseListDeviceData.WifiSignalStrength	src/types/bases.ts:24
Zone1InCoolMode	readonly	boolean	-	src/types/atw.ts:51
Zone1InHeatMode	readonly	boolean	-	src/types/atw.ts:52
Zone2InCoolMode	readonly	boolean	-	src/types/atw.ts:53
Zone2InHeatMode	readonly	boolean	-	src/types/atw.ts:54

---

ListDeviceDataErv

Defined in: src/types/erv.ts:11

Extends

• BaseListDeviceData.Omit<GetDeviceData<Erv>, keyof DeviceDataNotInList>

Properties

Property	Modifier	Type	Inherited from	Defined in
DeviceType	readonly	Erv	Omit.DeviceType	src/types/erv.ts:23
EffectiveFlags	readonly	0	BaseListDeviceData.EffectiveFlags	src/types/bases.ts:10
HasAutomaticFanSpeed	readonly	boolean	-	src/types/erv.ts:14
HasCO2Sensor	readonly	boolean	-	src/types/erv.ts:15
HasPM25Sensor	readonly	boolean	-	src/types/erv.ts:16
NumberOfFanSpeeds	readonly	number	Omit.NumberOfFanSpeeds	src/types/erv.ts:24
Offline	readonly	boolean	BaseListDeviceData.Offline	src/types/bases.ts:31
OutdoorTemperature	readonly	number	Omit.OutdoorTemperature	src/types/erv.ts:25
PM25Level	readonly	number	-	src/types/erv.ts:17
Power	readonly	boolean	BaseListDeviceData.Power	src/types/bases.ts:35
RoomCO2Level	readonly	number	Omit.RoomCO2Level	src/types/erv.ts:26
RoomTemperature	readonly	number	Omit.RoomTemperature	src/types/erv.ts:27
SetFanSpeed	readonly	| auto | fast | moderate | slow | very_fast | very_slow	Omit.SetFanSpeed	src/types/erv.ts:31
VentilationMode	readonly	VentilationMode	Omit.VentilationMode	src/types/erv.ts:32
WifiSignalStrength	readonly	number	BaseListDeviceData.WifiSignalStrength	src/types/bases.ts:24

---

Logger

Defined in: src/services/interfaces.ts:201

Properties

Property	Type	Defined in
error	(message?: any, ...optionalParams: any[]) => void	src/services/interfaces.ts:202
log	(message?: any, ...optionalParams: any[]) => void	src/services/interfaces.ts:203

---

LoginCredentials

Defined in: src/types/common.ts:161

Properties

Property	Modifier	Type	Defined in
password	readonly	string	src/types/common.ts:162
username	readonly	string	src/types/common.ts:163

---

LoginData

Defined in: src/types/common.ts:166

Properties

Property	Modifier	Type	Defined in
LoginData	readonly	| null | { ContextKey: string; Expiry: string; }	src/types/common.ts:167

---

LoginPostData

Defined in: src/types/common.ts:173

Properties

Property	Modifier	Type	Defined in
AppVersion	readonly	string	src/types/common.ts:174
Email	readonly	string	src/types/common.ts:175
Language?	readonly	number	src/types/common.ts:177
Password	readonly	string	src/types/common.ts:176
Persist?	readonly	boolean	src/types/common.ts:178

---

OperationModeZoneDataAtw

Defined in: src/types/atw.ts:57

Extended by

• UpdateDeviceDataAtw

Properties

Property	Modifier	Type	Defined in
OperationModeZone1?	readonly	OperationModeZone	src/types/atw.ts:58
OperationModeZone2?	readonly	OperationModeZone	src/types/atw.ts:59

---

ReportChartLineOptions

Defined in: src/facades/interfaces.ts:89

Extends

• ReportChartOptions

Properties

Property	Type	Inherited from	Defined in
from	string	ReportChartOptions.from	src/facades/interfaces.ts:98
labels	string[]	ReportChartOptions.labels	src/facades/interfaces.ts:99
series	{ data: (null | number)[]; name: string; }[]	-	src/facades/interfaces.ts:90
to	string	ReportChartOptions.to	src/facades/interfaces.ts:100
unit	string	-	src/facades/interfaces.ts:94

---

ReportChartPieOptions

Defined in: src/facades/interfaces.ts:103

Extends

• ReportChartOptions

Properties

Property	Type	Inherited from	Defined in
from	string	ReportChartOptions.from	src/facades/interfaces.ts:98
labels	string[]	ReportChartOptions.labels	src/facades/interfaces.ts:99
series	number[]	-	src/facades/interfaces.ts:104
to	string	ReportChartOptions.to	src/facades/interfaces.ts:100

---

ReportData

Defined in: src/types/common.ts:181

Properties

Property	Modifier	Type	Defined in
Data	readonly	readonly readonly (null | number)[][]	src/types/common.ts:182
FromDate	readonly	string	src/types/common.ts:183
Labels	readonly	readonly string[]	src/types/common.ts:184
LabelType	readonly	LabelType	src/types/common.ts:185
Points	readonly	number	src/types/common.ts:186
Series	readonly	number	src/types/common.ts:187
ToDate	readonly	string	src/types/common.ts:188

---

ReportPostData

Defined in: src/types/common.ts:191

Extended by

• TemperatureLogPostData

Properties

Property	Modifier	Type	Defined in
DeviceID	readonly	number	src/types/common.ts:192
Duration?	readonly	number	src/types/common.ts:195
FromDate	readonly	string	src/types/common.ts:193
ToDate	readonly	string	src/types/common.ts:194

---

ReportQuery

Defined in: src/facades/interfaces.ts:107

Properties

Property	Type	Defined in
from?	string	src/facades/interfaces.ts:108
to?	string	src/facades/interfaces.ts:109

---

SetDeviceDataAta

Defined in: src/types/ata.ts:77

Extends

• BaseSetDeviceData.Required<UpdateDeviceDataAta>

Properties

Property	Modifier	Type	Inherited from	Defined in
DeviceType	readonly	Ata	-	src/types/ata.ts:80
EffectiveFlags	readonly	number	BaseSetDeviceData.EffectiveFlags	src/types/bases.ts:30
LastCommunication	readonly	string	BaseSetDeviceData.LastCommunication	src/types/bases.ts:39
NextCommunication	readonly	string	BaseSetDeviceData.NextCommunication	src/types/bases.ts:40
NumberOfFanSpeeds	readonly	number	-	src/types/ata.ts:81
Offline	readonly	boolean	BaseSetDeviceData.Offline	src/types/bases.ts:31
OperationMode	readonly	OperationMode	Required.OperationMode	src/types/ata.ts:97
Power	readonly	boolean	BaseSetDeviceData.Power	src/types/bases.ts:35
RoomTemperature	readonly	number	-	src/types/ata.ts:82
SetFanSpeed	readonly	| auto | fast | moderate | slow | very_fast | very_slow	Required.SetFanSpeed	src/types/ata.ts:98
SetTemperature	readonly	number	Required.SetTemperature	src/types/ata.ts:99
VaneHorizontal	readonly	Horizontal	Required.VaneHorizontal	src/types/ata.ts:100
VaneVertical	readonly	Vertical	Required.VaneVertical	src/types/ata.ts:101

---

SetDeviceDataAtaInList

Defined in: src/types/ata.ts:85

Extended by

• ListDeviceDataAta

Properties

Property	Modifier	Type	Defined in
FanSpeed	readonly	FanSpeed	src/types/ata.ts:86
VaneHorizontalDirection	readonly	Horizontal	src/types/ata.ts:87
VaneVerticalDirection	readonly	Vertical	src/types/ata.ts:88

---

SetDeviceDataAtw

Defined in: src/types/atw.ts:62

Extends

• BaseSetDeviceData.Required<UpdateDeviceDataAtw>

Properties

Property	Modifier	Type	Inherited from	Defined in
DeviceType	readonly	Atw	-	src/types/atw.ts:65
EffectiveFlags	readonly	number	BaseSetDeviceData.EffectiveFlags	src/types/bases.ts:30
ForcedHotWaterMode	readonly	boolean	Required.ForcedHotWaterMode	src/types/atw.ts:94
IdleZone1	readonly	boolean	-	src/types/atw.ts:66
IdleZone2	readonly	boolean	-	src/types/atw.ts:67
LastCommunication	readonly	string	BaseSetDeviceData.LastCommunication	src/types/bases.ts:39
NextCommunication	readonly	string	BaseSetDeviceData.NextCommunication	src/types/bases.ts:40
Offline	readonly	boolean	BaseSetDeviceData.Offline	src/types/bases.ts:31
OperationMode	readonly	OperationModeState	-	src/types/atw.ts:68
OperationModeZone1	readonly	OperationModeZone	Required.OperationModeZone1	src/types/atw.ts:58
OperationModeZone2	readonly	OperationModeZone	Required.OperationModeZone2	src/types/atw.ts:59
OutdoorTemperature	readonly	number	-	src/types/atw.ts:69
Power	readonly	boolean	BaseSetDeviceData.Power	src/types/bases.ts:35
ProhibitCoolingZone1	readonly	boolean	-	src/types/atw.ts:70
ProhibitCoolingZone2	readonly	boolean	-	src/types/atw.ts:71
ProhibitHeatingZone1	readonly	boolean	-	src/types/atw.ts:72
ProhibitHeatingZone2	readonly	boolean	-	src/types/atw.ts:73
ProhibitHotWater	readonly	boolean	-	src/types/atw.ts:74
RoomTemperatureZone1	readonly	number	-	src/types/atw.ts:75
RoomTemperatureZone2	readonly	number	-	src/types/atw.ts:76
SetCoolFlowTemperatureZone1	readonly	number	Required.SetCoolFlowTemperatureZone1	src/types/atw.ts:81
SetCoolFlowTemperatureZone2	readonly	number	Required.SetCoolFlowTemperatureZone2	src/types/atw.ts:82
SetHeatFlowTemperatureZone1	readonly	number	Required.SetHeatFlowTemperatureZone1	src/types/atw.ts:83
SetHeatFlowTemperatureZone2	readonly	number	Required.SetHeatFlowTemperatureZone2	src/types/atw.ts:84
SetTankWaterTemperature	readonly	number	Required.SetTankWaterTemperature	src/types/atw.ts:85
SetTemperatureZone1	readonly	number	Required.SetTemperatureZone1	src/types/atw.ts:86
SetTemperatureZone2	readonly	number	Required.SetTemperatureZone2	src/types/atw.ts:87
TankWaterTemperature	readonly	number	-	src/types/atw.ts:77

---

SetDeviceDataErv

Defined in: src/types/erv.ts:20

Extends

• BaseSetDeviceData.Required<UpdateDeviceDataErv>

Properties

Property	Modifier	Type	Inherited from	Defined in
DeviceType	readonly	Erv	-	src/types/erv.ts:23
EffectiveFlags	readonly	number	BaseSetDeviceData.EffectiveFlags	src/types/bases.ts:30
LastCommunication	readonly	string	BaseSetDeviceData.LastCommunication	src/types/bases.ts:39
NextCommunication	readonly	string	BaseSetDeviceData.NextCommunication	src/types/bases.ts:40
NumberOfFanSpeeds	readonly	number	-	src/types/erv.ts:24
Offline	readonly	boolean	BaseSetDeviceData.Offline	src/types/bases.ts:31
OutdoorTemperature	readonly	number	-	src/types/erv.ts:25
Power	readonly	boolean	BaseSetDeviceData.Power	src/types/bases.ts:35
RoomCO2Level	readonly	number	-	src/types/erv.ts:26
RoomTemperature	readonly	number	-	src/types/erv.ts:27
SetFanSpeed	readonly	| auto | fast | moderate | slow | very_fast | very_slow	Required.SetFanSpeed	src/types/erv.ts:31
VentilationMode	readonly	VentilationMode	Required.VentilationMode	src/types/erv.ts:32

---

SetGroupPostData

Defined in: src/types/ata.ts:91

Properties

Property	Modifier	Type	Defined in
Specification	readonly	GetGroupPostData	src/types/ata.ts:92
State	readonly	GroupState	src/types/ata.ts:93

---

SetPowerPostData

Defined in: src/types/common.ts:198

Properties

Property	Modifier	Type	Defined in
DeviceIds	readonly	number | readonly number[]	src/types/common.ts:199
Power	readonly	boolean	src/types/common.ts:200

---

SettingManager

Defined in: src/services/interfaces.ts:206

Properties

Property	Type	Defined in
get	<T>(key: T) => APISettings[T]	src/services/interfaces.ts:207
set	<T>(key: T, value: APISettings[T]) => void	src/services/interfaces.ts:208

---

SettingsParams

Defined in: src/types/common.ts:203

Properties

Property	Modifier	Type	Defined in
id	readonly	number	src/types/common.ts:204
tableName	readonly	"Area" | "Building" | "DeviceLocation" | "Floor"	src/types/common.ts:205

---

SuccessData

Defined in: src/types/common.ts:208

Properties

Property	Modifier	Type	Defined in
AttributeErrors	readonly	null	src/types/common.ts:209
Success	readonly	true	src/types/common.ts:210

---

TemperatureDataAtw

Defined in: src/types/atw.ts:80

Extended by

• UpdateDeviceDataAtw

Properties

Property	Modifier	Type	Defined in
SetCoolFlowTemperatureZone1?	readonly	number	src/types/atw.ts:81
SetCoolFlowTemperatureZone2?	readonly	number	src/types/atw.ts:82
SetHeatFlowTemperatureZone1?	readonly	number	src/types/atw.ts:83
SetHeatFlowTemperatureZone2?	readonly	number	src/types/atw.ts:84
SetTankWaterTemperature?	readonly	number	src/types/atw.ts:85
SetTemperatureZone1?	readonly	number	src/types/atw.ts:86
SetTemperatureZone2?	readonly	number	src/types/atw.ts:87

---

TemperatureLogPostData

Defined in: src/types/common.ts:213

Extends

• ReportPostData

Properties

Property	Modifier	Type	Inherited from	Defined in
DeviceID	readonly	number	ReportPostData.DeviceID	src/types/common.ts:192
Duration?	readonly	number	ReportPostData.Duration	src/types/common.ts:195
FromDate	readonly	string	ReportPostData.FromDate	src/types/common.ts:193
Location?	readonly	number	-	src/types/common.ts:214
ToDate	readonly	string	ReportPostData.ToDate	src/types/common.ts:194

---

TilesData<T>

Defined in: src/types/common.ts:217

Type Parameters

Type Parameter
T extends DeviceType | null

Properties

Property	Modifier	Type	Defined in
SelectedDevice	readonly	T extends DeviceType ? GetDeviceData<T<T>> : null	src/types/common.ts:218
Tiles	readonly	readonly { Device: number; Offline: boolean; Power: boolean; RoomTemperature: number; RoomTemperature2: number; TankWaterTemperature: number; }[]	src/types/common.ts:219

---

UpdateDeviceDataAta

Defined in: src/types/ata.ts:96

Extends

• BaseUpdateDeviceData

Properties

Property	Modifier	Type	Inherited from	Defined in
OperationMode?	readonly	OperationMode	-	src/types/ata.ts:97
Power?	readonly	boolean	BaseUpdateDeviceData.Power	src/types/bases.ts:35
SetFanSpeed?	readonly	| auto | fast | moderate | slow | very_fast | very_slow	-	src/types/ata.ts:98
SetTemperature?	readonly	number	-	src/types/ata.ts:99
VaneHorizontal?	readonly	Horizontal	-	src/types/ata.ts:100
VaneVertical?	readonly	Vertical	-	src/types/ata.ts:101

---

UpdateDeviceDataAtw

Defined in: src/types/atw.ts:90

Extends

• BaseUpdateDeviceData.OperationModeZoneDataAtw.TemperatureDataAtw

Properties

Property	Modifier	Type	Inherited from	Defined in
ForcedHotWaterMode?	readonly	boolean	-	src/types/atw.ts:94
OperationModeZone1?	readonly	OperationModeZone	OperationModeZoneDataAtw.OperationModeZone1	src/types/atw.ts:58
OperationModeZone2?	readonly	OperationModeZone	OperationModeZoneDataAtw.OperationModeZone2	src/types/atw.ts:59
Power?	readonly	boolean	BaseUpdateDeviceData.Power	src/types/bases.ts:35
SetCoolFlowTemperatureZone1?	readonly	number	TemperatureDataAtw.SetCoolFlowTemperatureZone1	src/types/atw.ts:81
SetCoolFlowTemperatureZone2?	readonly	number	TemperatureDataAtw.SetCoolFlowTemperatureZone2	src/types/atw.ts:82
SetHeatFlowTemperatureZone1?	readonly	number	TemperatureDataAtw.SetHeatFlowTemperatureZone1	src/types/atw.ts:83
SetHeatFlowTemperatureZone2?	readonly	number	TemperatureDataAtw.SetHeatFlowTemperatureZone2	src/types/atw.ts:84
SetTankWaterTemperature?	readonly	number	TemperatureDataAtw.SetTankWaterTemperature	src/types/atw.ts:85
SetTemperatureZone1?	readonly	number	TemperatureDataAtw.SetTemperatureZone1	src/types/atw.ts:86
SetTemperatureZone2?	readonly	number	TemperatureDataAtw.SetTemperatureZone2	src/types/atw.ts:87

---

UpdateDeviceDataErv

Defined in: src/types/erv.ts:30

Extends

• BaseUpdateDeviceData

Properties

Property	Modifier	Type	Inherited from	Defined in
Power?	readonly	boolean	BaseUpdateDeviceData.Power	src/types/bases.ts:35
SetFanSpeed?	readonly	| auto | fast | moderate | slow | very_fast | very_slow	-	src/types/erv.ts:31
VentilationMode?	readonly	VentilationMode	-	src/types/erv.ts:32

---

ZoneSettings

Defined in: src/types/common.ts:229

Extends

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

Extended by

• BuildingData

Properties

Property	Modifier	Type	Inherited from	Defined in
FPDefined	readonly	boolean	FrostProtectionData.FPDefined	src/types/common.ts:86
FPEnabled	readonly	boolean	FrostProtectionData.FPEnabled	src/types/common.ts:87
FPMaxTemperature	readonly	number	FrostProtectionData.FPMaxTemperature	src/types/common.ts:88
FPMinTemperature	readonly	number	FrostProtectionData.FPMinTemperature	src/types/common.ts:89
HMDefined	readonly	boolean	Omit.HMDefined	src/types/common.ts:123
HMEnabled	readonly	boolean	Omit.HMEnabled	src/types/common.ts:124
HMEndDate	readonly	null | string	Omit.HMEndDate	src/types/common.ts:125
HMStartDate	readonly	null | string	Omit.HMStartDate	src/types/common.ts:126
TimeZone	readonly	number	Omit.TimeZone	src/types/common.ts:135

Type Aliases

AreaDataAny

type AreaDataAny = AreaData<null> | AreaData<number>

Defined in: src/types/common.ts:233

---

DateTimeComponents

type DateTimeComponents = {
  Day: number
  Hour: number
  Minute: number
  Month: number
  Second: number
  Year: number
} | null

Defined in: src/types/common.ts:235

---

EnergyData<T>

type EnergyData<T> =
  T extends Ata ? EnergyDataAta
  : T extends Atw ? EnergyDataAtw
  : never

Defined in: src/types/common.ts:244

Type Parameters

Type Parameter
T extends DeviceType

---

GetDeviceData<T>

type GetDeviceData<T> = BaseGetDeviceData & SetDeviceData<T>

Defined in: src/types/common.ts:249

Type Parameters

Type Parameter
T extends DeviceType

---

IDeviceFacadeAny

type IDeviceFacadeAny =
  | IDeviceFacade<Ata>
  | IDeviceFacade<Atw>
  | IDeviceFacade<Erv>

Defined in: src/facades/interfaces.ts:112

---

IDeviceModelAny

type IDeviceModelAny = IDeviceModel<Ata> | IDeviceModel<Atw> | IDeviceModel<Erv>

Defined in: src/models/interfaces.ts:56

---

KeyofSetDeviceDataAtaNotInList

type KeyofSetDeviceDataAtaNotInList =
  | 'SetFanSpeed'
  | 'VaneHorizontal'
  | 'VaneVertical'

Defined in: src/types/ata.ts:104

---

ListDeviceAny

type ListDeviceAny = ListDevice<Ata> | ListDevice<Atw> | ListDevice<Erv>

Defined in: src/types/common.ts:252

---

ListDeviceData<T>

type ListDeviceData<T> =
  T extends Ata ? ListDeviceDataAta
  : T extends Atw ? ListDeviceDataAtw
  : T extends Erv ? ListDeviceDataErv
  : never

Defined in: src/types/common.ts:257

Type Parameters

Type Parameter
T extends DeviceType

---

ListDeviceDataAny

type ListDeviceDataAny =
  | ListDeviceData<Ata>
  | ListDeviceData<Atw>
  | ListDeviceData<Erv>

Defined in: src/types/common.ts:263

---

OnSyncFunction()

type OnSyncFunction = (params?: {
  ids: number[]
  type: DeviceType
}) => Promise<void>

Defined in: src/services/interfaces.ts:211

Parameters

Parameter	Type
params?	{ ids: number[]; type: DeviceType; }
params.ids?	number[]
params.type?	DeviceType

Returns

Promise<void>

---

OperationModeLogData

type OperationModeLogData = {
  Key: string
  Value: number
}[]

Defined in: src/types/common.ts:268

Type declaration

Name	Type	Defined in
Key	string	src/types/common.ts:269
Value	number	src/types/common.ts:270

---

SetDeviceData<T>

type SetDeviceData<T> =
  T extends Ata ? SetDeviceDataAta
  : T extends Atw ? SetDeviceDataAtw
  : T extends Erv ? SetDeviceDataErv
  : never

Defined in: src/types/common.ts:273

Type Parameters

Type Parameter
T extends DeviceType

---

SetDevicePostData<T>

type SetDevicePostData<T> = BaseDevicePostData & Required<UpdateDeviceData<T>>

Defined in: src/types/common.ts:279

Type Parameters

Type Parameter
T extends DeviceType

---

TilesPostData<T>

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

Defined in: src/types/common.ts:282

Type declaration

Name	Type	Defined in
DeviceIDs	number | readonly number[]	src/types/common.ts:283

Type Parameters

Type Parameter
T extends DeviceType | null

---

UpdateDeviceData<T>

type UpdateDeviceData<T> =
  T extends Ata ? UpdateDeviceDataAta
  : T extends Atw ? UpdateDeviceDataAtw
  : T extends Erv ? UpdateDeviceDataErv
  : never

Defined in: src/types/common.ts:288

Type Parameters

Type Parameter
T extends DeviceType

---

ZoneAtw

type ZoneAtw = 'Zone1' | 'Zone2'

Defined in: src/types/atw.ts:97

Functions

fetchDevices()

function fetchDevices<T>(
  target: (...args: unknown[]) => Promise<T>,
  _context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
): (...args: unknown[]) => Promise<T>

Defined in: src/decorators/fetch-devices.ts:5

Type Parameters

Type Parameter
T extends | ZoneSettings | ListDeviceData<DeviceType>

Parameters

Parameter	Type
target	(...args: unknown[]) => Promise<T>
_context	ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>

Returns

Function

Parameters

Parameter	Type
...args	unknown[]

Returns

Promise<T>

---

syncDevices()

function syncDevices<T, U>(__namedParameters: {
  type: T
}): (
  target: (...args: any[]) => Promise<U>,
  _context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
) => (...args: unknown[]) => Promise<U>

Defined in: src/decorators/sync-devices.ts:14

Type Parameters

Type Parameter
T extends DeviceType
U extends | boolean | SetDeviceDataAtw | SetDeviceDataErv | FailureData | SuccessData | SetDeviceDataAta | GroupState | Building[] | BaseGetDeviceData & (SetDeviceDataAtw | SetDeviceDataErv | SetDeviceDataAta)

Parameters

Parameter	Type
__namedParameters	{ type: T; }
__namedParameters.type?	T

Returns

Function

Parameters

Parameter	Type
target	(...args: any[]) => Promise<U>
_context	ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>

Returns

Function

Parameters

Parameter	Type
...args	unknown[]

Returns

Promise<U>

---

updateDevice()

function updateDevice<T, U>(
  target: (...args: any[]) => Promise<U>,
  _context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
): (...args: unknown[]) => Promise<U>

Defined in: src/decorators/update-devices.ts:82

Type Parameters

Type Parameter
T extends DeviceType
U extends | SetDeviceDataAtw | SetDeviceDataErv | SetDeviceDataAta | BaseGetDeviceData & (SetDeviceDataAtw | SetDeviceDataErv | SetDeviceDataAta)

Parameters

Parameter	Type
target	(...args: any[]) => Promise<U>
_context	ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>

Returns

Function

Parameters

Parameter	Type
...args	unknown[]

Returns

Promise<U>

---

updateDevices()

function updateDevices<T>(__namedParameters: {
  type: DeviceType
}): (
  target: (...args: any[]) => Promise<T>,
  context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
) => (...args: unknown[]) => Promise<T>

Defined in: src/decorators/update-devices.ts:24

Type Parameters

Type Parameter
T extends | boolean | FailureData | SuccessData | GroupState

Parameters

Parameter	Type
__namedParameters	{ type: DeviceType; }
__namedParameters.type?	DeviceType

Returns

Function

Parameters

Parameter	Type
target	(...args: any[]) => Promise<T>
context	ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>

Returns

Function

Parameters

Parameter	Type
...args	unknown[]

Returns

Promise<T>