Skip to content

OlivierZal/melcloud-api

Repository files navigation

MELCloud API for Node.js - v21.0.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:12
moderate 3 src/enums.ts:11
silent 255 src/enums.ts:14
slow 2 src/enums.ts:10
very_fast 5 src/enums.ts:13
very_slow 1 src/enums.ts:9

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:21
center_left 2 src/enums.ts:20
center_right 4 src/enums.ts:22
leftwards 1 src/enums.ts:19
rightwards 5 src/enums.ts:23
swing 12 src/enums.ts:25
wide 8 src/enums.ts:24

LabelType

Defined in: src/enums.ts:28

Enumeration Members

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

Language

Defined in: src/enums.ts:36

Enumeration Members

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

OperationMode

Defined in: src/enums.ts:67

Enumeration Members

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

OperationModeState

Defined in: src/enums.ts:75

Enumeration Members

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

OperationModeZone

Defined in: src/enums.ts:84

Enumeration Members

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

VentilationMode

Defined in: src/enums.ts:92

Enumeration Members

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

Vertical

Defined in: src/enums.ts:98

Enumeration Members

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

Classes

AreaModel

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

Extends

  • BaseModel

Type Parameters

Type Parameter
T extends number | null

Implements

Properties

Property Modifier Type Inherited from Defined in
buildingId readonly number - src/models/area.ts:27
floorId readonly number | null - 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(): IBuildingModel | undefined;

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

Returns

IBuildingModel | undefined

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(): IFloorModel | null | undefined;

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

Returns

IFloorModel | null | undefined

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): IAreaModel | undefined;

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

Parameters
Parameter Type
id number
Returns

IAreaModel | undefined

getByName()
static getByName(name: string): IAreaModel | undefined;

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

Parameters
Parameter Type
name string
Returns

IAreaModel | undefined

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

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): IBuildingModel | undefined;

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

Parameters
Parameter Type
id number
Returns

IBuildingModel | undefined

getByName()
static getByName(name: string): IBuildingModel | undefined;

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

Parameters
Parameter Type
name string
Returns

IBuildingModel | undefined

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

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

Extends

  • BaseModel

Type Parameters

Type Parameter
T extends DeviceType

Implements

Constructors

Constructor
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 number | null null - src/models/device.ts:32
buildingId readonly number undefined - src/models/device.ts:34
floorId readonly number | null 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(): IAreaModel | null | undefined;

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

Returns

IAreaModel | null | undefined

Implementation of

IDeviceModel.area

building
Get Signature
get building(): BuildingModel | undefined;

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

Returns

BuildingModel | undefined

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(): IFloorModel | null | undefined;

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

Returns

IFloorModel | null | undefined

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): IDeviceModelAny | undefined;

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

Parameters
Parameter Type
id number
Returns

IDeviceModelAny | undefined

getByName()
static getByName(name: string): IDeviceModelAny | undefined;

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

Parameters
Parameter Type
name string
Returns

IDeviceModelAny | undefined

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

Constructors

Constructor
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>): IDeviceFacade<T> | null;

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

Type Parameters
Type Parameter
T extends DeviceType
Parameters
Parameter Type
instance? IDeviceModel<T>
Returns

IDeviceFacade<T> | null

Implementation of
IFacadeManager.get
Call Signature
get(instance?: IFloorModel | IAreaModel): ISuperDeviceFacade | null;

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

Parameters
Parameter Type
instance? IFloorModel | IAreaModel
Returns

ISuperDeviceFacade | null

Implementation of
IFacadeManager.get
Call Signature
get(instance?: IBuildingModel): IBuildingFacade | null;

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

Parameters
Parameter Type
instance? IBuildingModel
Returns

IBuildingFacade | null

Implementation of
IFacadeManager.get
Call Signature
get(instance?: IDeviceModelAny): IDeviceFacadeAny | null;

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

Parameters
Parameter Type
instance? IDeviceModelAny
Returns

IDeviceFacadeAny | null

Implementation of
IFacadeManager.get

FloorModel

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

Extends

  • BaseModel

Implements

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(): IBuildingModel | undefined;

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

Returns

IBuildingModel | undefined

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): IFloorModel | undefined;

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

Parameters
Parameter Type
id number
Returns

IFloorModel | undefined

getByName()
static getByName(name: string): IFloorModel | undefined;

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

Parameters
Parameter Type
name string
Returns

IFloorModel | undefined

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:151

Implements

Properties

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

Methods

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

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

Parameters
Parameter Type
data? LoginCredentials
Returns

Promise<boolean>

Implementation of

IAPI.authenticate

clearSync()
clearSync(): void;

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

Returns

void

Implementation of

IAPI.clearSync

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

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

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:265

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:298

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:225

Returns

Promise<Building[]>

Implementation of

IAPI.fetch

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

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

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:316

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:324

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:334

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:342

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:350

Returns

Promise<{ data: Building[]; }>

Implementation of

IAPI.list

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

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

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:362

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:370

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:378

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:386

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:394

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:402

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:410

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:420

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:428

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:436

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:441

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:454

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:465

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:218

Parameters
Parameter Type
config? APIConfig
Returns

Promise<MELCloudAPI>

Interfaces

APIConfig

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

Extends

Properties

Property Modifier Type Inherited from Defined in
autoSyncInterval? readonly number | null - src/services/interfaces.ts:44
language? readonly string - src/services/interfaces.ts:45
logger? readonly Logger - src/services/interfaces.ts:46
onSync? readonly OnSyncFunction - src/services/interfaces.ts:47
password? readonly string LoginCredentials.password src/types/generic.ts:162
settingManager? readonly SettingManager - src/services/interfaces.ts:48
shouldVerifySSL? readonly boolean - src/services/interfaces.ts:49
timezone? readonly string - src/services/interfaces.ts:50
username? readonly string LoginCredentials.username src/types/generic.ts:163

APISettings

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

Properties

Property Modifier Type Defined in
contextKey? readonly string | null src/services/interfaces.ts:54
expiry? readonly string | null src/services/interfaces.ts:55
password? readonly string | null src/services/interfaces.ts:56
username? readonly string | null src/services/interfaces.ts:57

AreaData

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

Extends

Type Parameters

Type Parameter
T extends number | null

Properties

Property Modifier Type Inherited from Defined in
BuildingId readonly number FloorData.BuildingId src/types/generic.ts:80
FloorId readonly T - src/types/generic.ts:29
ID readonly number FloorData.ID src/types/generic.ts:81
Name readonly string FloorData.Name src/types/generic.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:40
NextCommunication readonly string - BaseSetDeviceData.NextCommunication src/types/bases.ts:41
Offline readonly boolean - BaseSetDeviceData.Offline src/types/bases.ts:32
Power readonly boolean - UpdateDeviceDataAta.Power src/types/bases.ts:36

Building

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

Extends

Properties

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

BuildingData

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

Extends

Extended by

Properties

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

Properties

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

ErrorDetails

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

Properties

Property Modifier Type Defined in
date readonly string src/services/interfaces.ts:61
device readonly string src/services/interfaces.ts:62
error readonly string src/services/interfaces.ts:63

ErrorLog

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

Properties

Property Modifier Type Defined in
errors readonly readonly ErrorDetails[] src/services/interfaces.ts:67
fromDateHuman readonly string src/services/interfaces.ts:68
nextFromDate readonly string src/services/interfaces.ts:69
nextToDate readonly string src/services/interfaces.ts:70

ErrorLogData

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

Properties

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

ErrorLogPostData

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

Properties

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

ErrorLogQuery

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

Properties

Property Modifier Type Defined in
from? readonly string src/services/interfaces.ts:74
limit? readonly string src/services/interfaces.ts:75
offset? readonly string src/services/interfaces.ts:76
to? readonly string src/services/interfaces.ts:77

FailureData

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

Properties

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

FloorData

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

Extended by

Properties

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

FrostProtectionData

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

Extended by

Properties

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

FrostProtectionLocation

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

Extended by

Properties

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

FrostProtectionPostData

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

Extends

Properties

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

FrostProtectionQuery

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

Properties

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

GetDeviceDataParams

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

Properties

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

GetGroupData

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

Properties

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

GetGroupPostData

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

Properties

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

GroupState

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

Properties

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

HMTimeZone

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

Extends

Properties

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

HolidayModeData

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

Properties

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

HolidayModeLocation

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

Extended by

Properties

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

HolidayModePostData

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

Properties

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

HolidayModeQuery

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

Properties

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

IAPI

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

Properties

Property Modifier Type Defined in
authenticate readonly (data?: LoginCredentials) => Promise<boolean> src/services/interfaces.ts:82
clearSync readonly () => void src/services/interfaces.ts:83
energy readonly (__namedParameters: { postData: EnergyPostData; }) => Promise<{ data: EnergyData<DeviceType>; }> src/services/interfaces.ts:170
errorLog readonly (query: ErrorLogQuery, deviceIds: number[]) => Promise<ErrorLog> src/services/interfaces.ts:84
errors readonly (__namedParameters: { postData: ErrorLogPostData; }) => Promise<{ data: FailureData | ErrorLogData[]; }> src/services/interfaces.ts:91
fetch readonly () => Promise<Building[]> src/services/interfaces.ts:88
frostProtection readonly (__namedParameters: { params: SettingsParams; }) => Promise<{ data: FrostProtectionData; }> src/services/interfaces.ts:96
group readonly (__namedParameters: { postData: GetGroupPostData; }) => Promise<{ data: GetGroupData; }> src/services/interfaces.ts:176
holidayMode readonly (__namedParameters: { params: SettingsParams; }) => Promise<{ data: HolidayModeData; }> src/services/interfaces.ts:101
hourlyTemperatures readonly (__namedParameters: { postData: { device: number; hour: HourNumbers; }; }) => Promise<{ data: ReportData; }> src/services/interfaces.ts:187
internalTemperatures readonly (__namedParameters: { postData: ReportPostData; }) => Promise<{ data: ReportData; }> src/services/interfaces.ts:192
list readonly () => Promise<{ data: Building[]; }> src/services/interfaces.ts:106
login readonly (__namedParameters: { postData: LoginPostData; }) => Promise<{ data: LoginData; }> src/services/interfaces.ts:107
onSync? readonly OnSyncFunction src/services/interfaces.ts:81
operationModes readonly (__namedParameters: { postData: ReportPostData; }) => Promise<{ data: OperationModeLogData; }> src/services/interfaces.ts:112
setFrostProtection readonly (__namedParameters: { postData: FrostProtectionPostData; }) => Promise<{ data: FailureData | SuccessData; }> src/services/interfaces.ts:117
setGroup readonly (__namedParameters: { postData: SetGroupPostData; }) => Promise<{ data: FailureData | SuccessData; }> src/services/interfaces.ts:181
setHolidayMode readonly (__namedParameters: { postData: HolidayModePostData; }) => Promise<{ data: FailureData | SuccessData; }> src/services/interfaces.ts:122
setLanguage readonly (__namedParameters: { postData: { language: Language; }; }) => Promise<{ data: boolean; }> src/services/interfaces.ts:127
setPower readonly (__namedParameters: { postData: SetPowerPostData; }) => Promise<{ data: boolean; }> src/services/interfaces.ts:132
setValues readonly <T>(__namedParameters: { postData: SetDevicePostData<T>; type: T; }) => Promise<{ data: SetDeviceData<T>; }> src/services/interfaces.ts:137
signal readonly (__namedParameters: { postData: { devices: number | number[]; hour: HourNumbers; }; }) => Promise<{ data: ReportData; }> src/services/interfaces.ts:144
temperatures readonly (__namedParameters: { postData: TemperatureLogPostData; }) => Promise<{ data: ReportData; }> src/services/interfaces.ts:149
tiles readonly (__namedParameters: { postData: TilesPostData<null>; }) => Promise<{ data: TilesData<null>; }> & <T>(__namedParameters: { postData: TilesPostData<T>; }) => Promise<{ data: TilesData<T>; }> src/services/interfaces.ts:154
updateLanguage readonly (language: string) => Promise<void> src/services/interfaces.ts:89
values readonly (__namedParameters: { params: GetDeviceDataParams; }) => Promise<{ data: GetDeviceData<DeviceType>; }> src/services/interfaces.ts:164

IAreaModel

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

Extends

  • ISubFloorModel.ISuperDeviceModel

Properties

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

IBuildingFacade

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

Extends

Properties

Property Modifier Type Inherited from Defined in
data readonly ZoneSettings IBaseBuildingModel.data src/models/interfaces.ts:27
devices readonly readonly IDeviceModelAny[] ISuperDeviceFacade.devices src/facades/interfaces.ts:67
errors readonly (query: ErrorLogQuery) => Promise<FailureData | ErrorLog> ISuperDeviceFacade.errors src/facades/interfaces.ts:68
fetch readonly () => Promise<ZoneSettings> - src/facades/interfaces.ts:40
frostProtection readonly () => Promise<FrostProtectionData> ISuperDeviceFacade.frostProtection src/facades/interfaces.ts:69
group readonly () => Promise<GroupState> ISuperDeviceFacade.group src/facades/interfaces.ts:89
holidayMode readonly () => Promise<HolidayModeData> ISuperDeviceFacade.holidayMode src/facades/interfaces.ts:70
id readonly number ISuperDeviceFacade.id src/models/interfaces.ts:51
name readonly string ISuperDeviceFacade.name src/models/interfaces.ts:52
onSync readonly (params?: { type?: DeviceType; }) => Promise<void> ISuperDeviceFacade.onSync src/facades/interfaces.ts:71
setFrostProtection readonly (query: FrostProtectionQuery) => Promise<FailureData | SuccessData> ISuperDeviceFacade.setFrostProtection src/facades/interfaces.ts:72
setGroup readonly (state: GroupState) => Promise<FailureData | SuccessData> ISuperDeviceFacade.setGroup src/facades/interfaces.ts:90
setHolidayMode readonly (query: HolidayModeQuery) => Promise<FailureData | SuccessData> ISuperDeviceFacade.setHolidayMode src/facades/interfaces.ts:75
setPower readonly (value?: boolean) => Promise<boolean> ISuperDeviceFacade.setPower src/facades/interfaces.ts:78
signal readonly (hour?: HourNumbers) => Promise<ReportChartLineOptions> ISuperDeviceFacade.signal src/facades/interfaces.ts:79
tiles readonly (select?: false) => Promise<TilesData<null>> & <T>(select: IDeviceModel<T>) => Promise<TilesData<T>> ISuperDeviceFacade.tiles src/facades/interfaces.ts:80

IBuildingModel

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

Extends

  • IBaseBuildingModel.ISuperAreaModel

Properties

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

IDeviceFacade

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

Extends

Type Parameters

Type Parameter
T extends DeviceType

Properties

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

IDeviceModel

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

Extends

  • IBaseDeviceModel<T>.ISubFloorModel

Type Parameters

Type Parameter
T extends DeviceType

Properties

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

IFacade

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

Extends

Extended by

Properties

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

IFacadeManager

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

Properties

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

IFloorModel

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

Extends

  • ISubBuildingModel.ISuperAreaModel

Properties

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

IModel

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

Extended by

Properties

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

ISuperDeviceFacade

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

Extends

Extended by

Properties

Property Modifier Type Inherited from Defined in
devices readonly readonly IDeviceModelAny[] IFacade.devices src/facades/interfaces.ts:67
errors readonly (query: ErrorLogQuery) => Promise<FailureData | ErrorLog> IFacade.errors src/facades/interfaces.ts:68
frostProtection readonly () => Promise<FrostProtectionData> IFacade.frostProtection src/facades/interfaces.ts:69
group readonly () => Promise<GroupState> - src/facades/interfaces.ts:89
holidayMode readonly () => Promise<HolidayModeData> IFacade.holidayMode src/facades/interfaces.ts:70
id readonly number IFacade.id src/models/interfaces.ts:51
name readonly string IFacade.name src/models/interfaces.ts:52
onSync readonly (params?: { type?: DeviceType; }) => Promise<void> IFacade.onSync src/facades/interfaces.ts:71
setFrostProtection readonly (query: FrostProtectionQuery) => Promise<FailureData | SuccessData> IFacade.setFrostProtection src/facades/interfaces.ts:72
setGroup readonly (state: GroupState) => Promise<FailureData | SuccessData> - src/facades/interfaces.ts:90
setHolidayMode readonly (query: HolidayModeQuery) => Promise<FailureData | SuccessData> IFacade.setHolidayMode src/facades/interfaces.ts:75
setPower readonly (value?: boolean) => Promise<boolean> IFacade.setPower src/facades/interfaces.ts:78
signal readonly (hour?: HourNumbers) => Promise<ReportChartLineOptions> IFacade.signal src/facades/interfaces.ts:79
tiles readonly (select?: false) => Promise<TilesData<null>> & <T>(select: IDeviceModel<T>) => Promise<TilesData<T>> IFacade.tiles src/facades/interfaces.ts:80

ListDevice

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

Extends

  • BaseListDevice

Type Parameters

Type Parameter
T extends DeviceType

Properties

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

Properties

Property Modifier Type Inherited from Defined in
ActualFanSpeed readonly number - src/types/ata.ts:67
DeviceType readonly Ata SetDeviceDataAta.DeviceType src/types/ata.ts:80
EffectiveFlags readonly 0 BaseGetDeviceData.EffectiveFlags src/types/bases.ts:10
FanSpeed readonly FanSpeed SetDeviceDataAtaInList.FanSpeed src/types/ata.ts:86
HasAutomaticFanSpeed readonly boolean - src/types/ata.ts:68
MaxTempAutomatic readonly number - src/types/ata.ts:69
MaxTempCoolDry readonly number - src/types/ata.ts:70
MaxTempHeat readonly number - src/types/ata.ts:71
MinTempAutomatic readonly number - src/types/ata.ts:72
MinTempCoolDry readonly number - src/types/ata.ts:73
MinTempHeat readonly number - src/types/ata.ts:74
NumberOfFanSpeeds readonly number SetDeviceDataAta.NumberOfFanSpeeds src/types/ata.ts:81
Offline readonly boolean BaseGetDeviceData.Offline src/types/bases.ts:32
OperationMode readonly OperationMode UpdateDeviceDataAta.OperationMode src/types/ata.ts:97
OutdoorTemperature readonly number - src/types/ata.ts:75
Power readonly boolean UpdateDeviceDataAta.Power src/types/bases.ts:36
RoomTemperature readonly number SetDeviceDataAta.RoomTemperature src/types/ata.ts:82
SetTemperature readonly number UpdateDeviceDataAta.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:26

ListDeviceDataAtw

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

Extends

Properties

Property Modifier Type Inherited from Defined in
BoosterHeater1Status readonly boolean - src/types/atw.ts:29
BoosterHeater2PlusStatus readonly boolean - src/types/atw.ts:30
BoosterHeater2Status readonly boolean - src/types/atw.ts:31
CanCool readonly boolean - src/types/atw.ts:32
CondensingTemperature readonly number - src/types/atw.ts:33
CurrentEnergyConsumed readonly number - src/types/atw.ts:34
CurrentEnergyProduced readonly number - src/types/atw.ts:35
DefrostMode readonly number - src/types/atw.ts:36
DeviceType readonly Atw SetDeviceDataAtw.DeviceType src/types/atw.ts:65
EcoHotWater readonly boolean - src/types/atw.ts:37
EffectiveFlags readonly 0 BaseGetDeviceData.EffectiveFlags src/types/bases.ts:10
FlowTemperature readonly number - src/types/atw.ts:38
FlowTemperatureZone1 readonly number - src/types/atw.ts:39
FlowTemperatureZone2 readonly number - src/types/atw.ts:40
ForcedHotWaterMode readonly boolean UpdateDeviceDataAtw.ForcedHotWaterMode src/types/atw.ts:92
HasZone2 readonly boolean - src/types/atw.ts:41
HeatPumpFrequency readonly number - src/types/atw.ts:42
IdleZone1 readonly boolean SetDeviceDataAtw.IdleZone1 src/types/atw.ts:66
IdleZone2 readonly boolean SetDeviceDataAtw.IdleZone2 src/types/atw.ts:67
ImmersionHeaterStatus readonly boolean - src/types/atw.ts:43
LastLegionellaActivationTime readonly string - src/types/atw.ts:44
MaxTankTemperature readonly number - src/types/atw.ts:45
MixingTankWaterTemperature readonly number - src/types/atw.ts:46
Offline readonly boolean BaseGetDeviceData.Offline src/types/bases.ts:32
OperationMode readonly OperationModeState SetDeviceDataAtw.OperationMode src/types/atw.ts:68
OperationModeZone1 readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone1 src/types/atw.ts:59
OperationModeZone2 readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone2 src/types/atw.ts:60
OutdoorTemperature readonly number SetDeviceDataAtw.OutdoorTemperature src/types/atw.ts:69
Power readonly boolean UpdateDeviceDataAta.Power src/types/bases.ts:36
ProhibitCoolingZone1 readonly boolean SetDeviceDataAtw.ProhibitCoolingZone1 src/types/atw.ts:70
ProhibitCoolingZone2 readonly boolean SetDeviceDataAtw.ProhibitCoolingZone2 src/types/atw.ts:71
ProhibitHeatingZone1 readonly boolean SetDeviceDataAtw.ProhibitHeatingZone1 src/types/atw.ts:72
ProhibitHeatingZone2 readonly boolean SetDeviceDataAtw.ProhibitHeatingZone2 src/types/atw.ts:73
ProhibitHotWater readonly boolean SetDeviceDataAtw.ProhibitHotWater src/types/atw.ts:74
ReturnTemperature readonly number - src/types/atw.ts:47
ReturnTemperatureZone1 readonly number - src/types/atw.ts:48
ReturnTemperatureZone2 readonly number - src/types/atw.ts:49
RoomTemperatureZone1 readonly number SetDeviceDataAtw.RoomTemperatureZone1 src/types/atw.ts:75
RoomTemperatureZone2 readonly number SetDeviceDataAtw.RoomTemperatureZone2 src/types/atw.ts:76
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
TankWaterTemperature readonly number SetDeviceDataAtw.TankWaterTemperature src/types/atw.ts:77
TargetHCTemperatureZone1 readonly number - src/types/atw.ts:50
TargetHCTemperatureZone2 readonly number - src/types/atw.ts:51
WifiSignalStrength readonly number BaseListDeviceData.WifiSignalStrength src/types/bases.ts:26
Zone1InCoolMode readonly boolean - src/types/atw.ts:52
Zone1InHeatMode readonly boolean - src/types/atw.ts:53
Zone2InCoolMode readonly boolean - src/types/atw.ts:54
Zone2InHeatMode readonly boolean - src/types/atw.ts:55

ListDeviceDataErv

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

Extends

Properties

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

Logger

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

Properties

Property Modifier Type Defined in
error readonly (...data: any[]) => void src/services/interfaces.ts:200
log readonly (...data: any[]) => void src/services/interfaces.ts:201

LoginCredentials

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

Properties

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

LoginData

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

Properties

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

LoginPostData

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

Properties

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

OperationModeZoneDataAtw

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

Extended by

Properties

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

ReportChartLineOptions

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

Extends

  • ReportChartOptions

Properties

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

ReportChartPieOptions

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

Extends

  • ReportChartOptions

Properties

Property Modifier Type Inherited from Defined in
from readonly string ReportChartOptions.from src/facades/interfaces.ts:102
labels readonly readonly string[] ReportChartOptions.labels src/facades/interfaces.ts:103
series readonly number[] - src/facades/interfaces.ts:108
to readonly string ReportChartOptions.to src/facades/interfaces.ts:104

ReportData

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

Properties

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

ReportPostData

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

Extended by

Properties

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

ReportQuery

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

Properties

Property Modifier Type Defined in
from? readonly string src/facades/interfaces.ts:112
to? readonly string src/facades/interfaces.ts:113

SetDeviceDataAta

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

Extends

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:31
LastCommunication readonly string BaseSetDeviceData.LastCommunication src/types/bases.ts:40
NextCommunication readonly string BaseSetDeviceData.NextCommunication src/types/bases.ts:41
NumberOfFanSpeeds readonly number - src/types/ata.ts:81
Offline readonly boolean BaseSetDeviceData.Offline src/types/bases.ts:32
OperationMode readonly OperationMode UpdateDeviceDataAta.OperationMode src/types/ata.ts:97
Power readonly boolean UpdateDeviceDataAta.Power src/types/bases.ts:36
RoomTemperature readonly number - src/types/ata.ts:82
SetFanSpeed readonly | auto | very_slow | slow | moderate | fast | very_fast UpdateDeviceDataAta.SetFanSpeed src/types/ata.ts:98
SetTemperature readonly number UpdateDeviceDataAta.SetTemperature src/types/ata.ts:99
VaneHorizontal readonly Horizontal UpdateDeviceDataAta.VaneHorizontal src/types/ata.ts:100
VaneVertical readonly Vertical UpdateDeviceDataAta.VaneVertical src/types/ata.ts:101

SetDeviceDataAtaInList

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

Extended by

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:63

Extends

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:31
ForcedHotWaterMode readonly boolean UpdateDeviceDataAtw.ForcedHotWaterMode src/types/atw.ts:92
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:40
NextCommunication readonly string BaseSetDeviceData.NextCommunication src/types/bases.ts:41
Offline readonly boolean BaseSetDeviceData.Offline src/types/bases.ts:32
OperationMode readonly OperationModeState - src/types/atw.ts:68
OperationModeZone1 readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone1 src/types/atw.ts:59
OperationModeZone2 readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone2 src/types/atw.ts:60
OutdoorTemperature readonly number - src/types/atw.ts:69
Power readonly boolean UpdateDeviceDataAta.Power src/types/bases.ts:36
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 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
TankWaterTemperature readonly number - src/types/atw.ts:77

SetDeviceDataErv

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

Extends

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:31
LastCommunication readonly string BaseSetDeviceData.LastCommunication src/types/bases.ts:40
NextCommunication readonly string BaseSetDeviceData.NextCommunication src/types/bases.ts:41
NumberOfFanSpeeds readonly number - src/types/erv.ts:24
Offline readonly boolean BaseSetDeviceData.Offline src/types/bases.ts:32
OutdoorTemperature readonly number - src/types/erv.ts:25
Power readonly boolean UpdateDeviceDataAta.Power src/types/bases.ts:36
RoomCO2Level readonly number - src/types/erv.ts:26
RoomTemperature readonly number - src/types/erv.ts:27
SetFanSpeed readonly | auto | very_slow | slow | moderate | fast | very_fast UpdateDeviceDataErv.SetFanSpeed src/types/erv.ts:31
VentilationMode readonly VentilationMode UpdateDeviceDataErv.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/generic.ts:198

Properties

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

SettingManager

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

Properties

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

SettingsParams

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

Properties

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

SuccessData

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

Properties

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

TemperatureDataAtw

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

Extended by

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/generic.ts:213

Extends

Properties

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

TilesData

Defined in: src/types/generic.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/generic.ts:218
Tiles readonly readonly { Device: number; Offline: boolean; Power: boolean; RoomTemperature: number; RoomTemperature2: number; TankWaterTemperature: number; }[] src/types/generic.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:36
SetFanSpeed? readonly | auto | very_slow | slow | moderate | fast | very_fast - 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

Properties

Property Modifier Type Inherited from Defined in
ForcedHotWaterMode? readonly boolean - src/types/atw.ts:92
OperationModeZone1? readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone1 src/types/atw.ts:59
OperationModeZone2? readonly OperationModeZone OperationModeZoneDataAtw.OperationModeZone2 src/types/atw.ts:60
Power? readonly boolean BaseUpdateDeviceData.Power src/types/bases.ts:36
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:36
SetFanSpeed? readonly | auto | very_slow | slow | moderate | fast | very_fast - src/types/erv.ts:31
VentilationMode? readonly VentilationMode - src/types/erv.ts:32

ZoneSettings

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

Extends

Extended by

Properties

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

Type Aliases

AreaDataAny

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

Defined in: src/types/generic.ts:232


DateTimeComponents

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

Defined in: src/types/generic.ts:234


EnergyData

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

Defined in: src/types/generic.ts:243

Type Parameters

Type Parameter
T extends DeviceType

GetDeviceData

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

Defined in: src/types/generic.ts:248

Type Parameters

Type Parameter
T extends DeviceType

IDeviceFacadeAny

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

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


IDeviceModelAny

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

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


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/generic.ts:251


ListDeviceData

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

Defined in: src/types/generic.ts:256

Type Parameters

Type Parameter
T extends DeviceType

ListDeviceDataAny

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

Defined in: src/types/generic.ts:262


OnSyncFunction()

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

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

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/generic.ts:267

Type Declaration

Name Type Defined in
Key string src/types/generic.ts:268
Value number src/types/generic.ts:269

SetDeviceData

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

Defined in: src/types/generic.ts:272

Type Parameters

Type Parameter
T extends DeviceType

SetDevicePostData

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

Defined in: src/types/generic.ts:278

Type Parameters

Type Parameter
T extends DeviceType

TilesPostData

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

Defined in: src/types/generic.ts:281

Type Declaration

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

Type Parameters

Type Parameter
T extends DeviceType | null

UpdateDeviceData

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

Defined in: src/types/generic.ts:287

Type Parameters

Type Parameter
T extends DeviceType

ZoneAtw

type ZoneAtw = 'Zone1' | 'Zone2'

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

Functions

fetchDevices()

function fetchDevices<T>(
  target: (...args: unknown[]) => Promise<T>,
  _context: ClassMethodDecoratorContext,
): (...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

Returns

(...args: unknown[]): Promise<T>;
Parameters
Parameter Type
...args unknown[]
Returns

Promise<T>


syncDevices()

function syncDevices<T, U>(__namedParameters: {
  type?: T
}): (
  target: (...args: any[]) => Promise<U>,
  _context: ClassMethodDecoratorContext,
) => (...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

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

Promise<U>


updateDevice()

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

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

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

Returns

(...args: unknown[]): Promise<U>;
Parameters
Parameter Type
...args unknown[]
Returns

Promise<U>


updateDevices()

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

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

Type Parameters

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

Parameters

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

Returns

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

Promise<T>

About

MELCloud API for Node.js

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •