Heatzy API for Node.js - v9.0.0

Enumerations

DerogationMode

Enumeration Members

Enumeration Member	Value	Defined in
`boost`	`2`	enums.ts:4
`off`	`0`	enums.ts:2
`presence`	`3`	enums.ts:6
`vacation`	`1`	enums.ts:3

Mode

Defined in: enums.ts:9

Enumeration Members

Enumeration Member	Value	Defined in
`comfort`	`"cft"`	enums.ts:10
`comfortMinus1`	`"cft1"`	enums.ts:15
`comfortMinus2`	`"cft2"`	enums.ts:16
`eco`	`"eco"`	enums.ts:11
`frostProtection`	`"fro"`	enums.ts:12
`stop`	`"stop"`	enums.ts:13

Product

Defined in: enums.ts:19

Enumeration Members

Enumeration Member	Value	Defined in
`glow`	`5`	enums.ts:23
`pro`	`6`	enums.ts:24
`v1`	`1`	enums.ts:20
`v2`	`2`	enums.ts:21
`v4`	`4`	enums.ts:22

Switch

Defined in: enums.ts:27

Enumeration Members

Enumeration Member	Value	Defined in
`off`	`0`	enums.ts:28
`on`	`1`	enums.ts:29

TemperatureCompensation

Defined in: enums.ts:32

Enumeration Members

Enumeration Member	Value	Defined in
`minus5C`	`0`	enums.ts:33
`noChange`	`50`	enums.ts:34
`plus5C`	`100`	enums.ts:35

Classes

DeviceModel

Defined in: models/device.ts:13

Implements

IDeviceModel

Properties

Property	Modifier	Type	Defined in
`id`	`readonly`	`string`	models/device.ts:16
`name`	`readonly`	`string`	models/device.ts:18
`product`	`readonly`	`Product`	models/device.ts:20
`productKey`	`readonly`	`string`	models/device.ts:22
`productName`	`readonly`	`string`	models/device.ts:24

Accessors

data

Get Signature

get data(): Attributes;

Defined in: models/device.ts:43

Returns

Attributes

Implementation of

IDeviceModel.data

derogationEndDate

Get Signature

get derogationEndDate(): DateTime<boolean> | null;

Defined in: models/device.ts:47

Returns

DateTime<boolean> | null

Implementation of

IDeviceModel.derogationEndDate

previousMode

Get Signature

get previousMode(): PreviousMode;

Defined in: models/device.ts:53

Returns

PreviousMode

Implementation of

IDeviceModel.previousMode

Methods

update()

update(data: Partial<Attributes>): void;

Defined in: models/device.ts:112

Parameters

Parameter	Type
`data`	`Partial`<`Attributes`>

Returns

void

Implementation of

IDeviceModel.update

getAll()

static getAll(): DeviceModel[];

Defined in: models/device.ts:57

Returns

DeviceModel[]

getById()

static getById(id: string): DeviceModel | undefined;

Defined in: models/device.ts:61

Parameters

Parameter	Type
`id`	`string`

Returns

DeviceModel | undefined

getByName()

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

Defined in: models/device.ts:65

Parameters

Parameter	Type
`name`	`string`

Returns

DeviceModel | undefined

sync()

static sync(devices: readonly Device[], data: Record<string, Attributes>): void;

Defined in: models/device.ts:69

Parameters

Parameter	Type
`devices`	readonly `Device`[]
`data`	`Record`<`string`, `Attributes`>

Returns

void

FacadeManager

Defined in: facades/manager.ts:13

Implements

IFacadeManager

Constructors

Constructor

new FacadeManager(api: IAPI): FacadeManager;

Defined in: facades/manager.ts:18

Parameters

Parameter	Type
`api`	`IAPI`

Returns

FacadeManager

Properties

Property	Modifier	Type	Defined in
`api`	`readonly`	`IAPI`	facades/manager.ts:14

Methods

get()

Call Signature

get(): null;

Defined in: facades/manager.ts:22

Returns

null

Implementation of

IFacadeManager.get

Call Signature

get(instance: IDeviceModel): IDeviceFacadeAny;

Defined in: facades/manager.ts:23

Parameters

Parameter	Type
`instance`	`IDeviceModel`

Returns

IDeviceFacadeAny

Implementation of

IFacadeManager.get

HeatzyAPI

Defined in: services/api.ts:71

Implements

IAPI

Constructors

Constructor

new HeatzyAPI(config: APIConfig): HeatzyAPI;

Defined in: services/api.ts:86

Parameters

Parameter	Type
`config`	`APIConfig`

Returns

HeatzyAPI

Properties

Property	Modifier	Type	Defined in
`onSync?`	`readonly`	() => `Promise`<`void`>	services/api.ts:72
`settingManager?`	`readonly`	`SettingManager`	services/api.ts:74

Methods

authenticate()

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

Defined in: services/api.ts:147

Parameters

Parameter	Type
`data?`	`LoginPostData`

Returns

Promise<boolean>

Implementation of

IAPI.authenticate

bindings()

bindings(): Promise<{
  data: Bindings;
}>;

Defined in: services/api.ts:161

Returns

Promise<{ data: Bindings; }>

Implementation of

IAPI.bindings

clearSync()

clearSync(): void;

Defined in: services/api.ts:165

Returns

void

Implementation of

IAPI.clearSync

control()

control(__namedParameters: {
  id: string;
  postData: DevicePostDataAny;
}): Promise<{
  data: Data;
}>;

Defined in: services/api.ts:172

Parameters

Parameter	Type
`__namedParameters`	{ `id`: `string`; `postData`: `DevicePostDataAny`; }
`__namedParameters.id`	`string`
`__namedParameters.postData`	`DevicePostDataAny`

Returns

Promise<{ data: Data; }>

Implementation of

IAPI.control

deviceData()

deviceData(__namedParameters: {
  id: string;
}): Promise<{
  data: DeviceData;
}>;

Defined in: services/api.ts:182

Parameters

Parameter	Type
`__namedParameters`	{ `id`: `string`; }
`__namedParameters.id`	`string`

Returns

Promise<{ data: DeviceData; }>

Implementation of

IAPI.deviceData

fetch()

fetch(): Promise<readonly Device[]>;

Defined in: services/api.ts:132

Returns

Promise<readonly Device[]>

Implementation of

IAPI.fetch

login()

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

Defined in: services/api.ts:190

Parameters

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

Returns

Promise<{ data: LoginData; }>

Implementation of

IAPI.login

create()

static create(config: APIConfig): Promise<HeatzyAPI>;

Defined in: services/api.ts:125

Parameters

Parameter	Type
`config`	`APIConfig`

Returns

Promise<HeatzyAPI>

Interfaces

APIConfig

Defined in: services/interfaces.ts:18

Extends

Partial<LoginPostData>

Properties

Property	Modifier	Type	Inherited from	Defined in
`autoSyncInterval?`	`readonly`	`number` \| `null`	-	services/interfaces.ts:19
`language?`	`readonly`	`string`	-	services/interfaces.ts:20
`logger?`	`readonly`	`Logger`	-	services/interfaces.ts:21
`onSync?`	`readonly`	`OnSyncFunction`	-	services/interfaces.ts:22
`password?`	`readonly`	`string`	`LoginPostData`.`password`	types.ts:54
`settingManager?`	`readonly`	`SettingManager`	-	services/interfaces.ts:23
`shouldVerifySSL?`	`readonly`	`boolean`	-	services/interfaces.ts:24
`timezone?`	`readonly`	`string`	-	services/interfaces.ts:25
`username?`	`readonly`	`string`	`LoginPostData`.`username`	types.ts:55

APISettings

Defined in: services/interfaces.ts:28

Properties

Property	Modifier	Type	Defined in
`expireAt?`	`readonly`	`string` \| `null`	services/interfaces.ts:29
`password?`	`readonly`	`string` \| `null`	services/interfaces.ts:30
`token?`	`readonly`	`string` \| `null`	services/interfaces.ts:31
`username?`	`readonly`	`string` \| `null`	services/interfaces.ts:32

Attributes

Defined in: types.ts:9

Extends

PostAttributes

Properties

Property	Modifier	Type	Overrides	Inherited from	Defined in
`cft_temp?`	`readonly`	`number`	-	`PostAttributes`.`cft_temp`	types.ts:76
`cft_tempH?`	`readonly`	`number`	-	`PostAttributes`.`cft_tempH`	types.ts:69
`cft_tempL?`	`readonly`	`number`	-	`PostAttributes`.`cft_tempL`	types.ts:70
`com_temp?`	`readonly`	`TemperatureCompensation`	-	`PostAttributes`.`com_temp`	types.ts:67
`cur_humi?`	`readonly`	`number`	-	-	types.ts:15
`cur_mode?`	`readonly`	`Mode`	-	-	types.ts:16
`cur_temp?`	`readonly`	`number`	-	-	types.ts:17
`cur_tempH?`	`readonly`	`number`	-	-	types.ts:12
`cur_tempL?`	`readonly`	`number`	-	-	types.ts:13
`derog_mode?`	`readonly`	`DerogationMode`	-	`PostAttributes`.`derog_mode`	types.ts:61
`derog_time?`	`readonly`	`number`	-	`PostAttributes`.`derog_time`	types.ts:62
`eco_temp?`	`readonly`	`number`	-	`PostAttributes`.`eco_temp`	types.ts:77
`eco_tempH?`	`readonly`	`number`	-	`PostAttributes`.`eco_tempH`	types.ts:71
`eco_tempL?`	`readonly`	`number`	-	`PostAttributes`.`eco_tempL`	types.ts:72
`LOCK_C?`	`readonly`	`Switch`	-	`PostAttributes`.`LOCK_C`	types.ts:73
`lock_switch?`	`readonly`	`Switch`	-	`PostAttributes`.`lock_switch`	types.ts:65
`mode`	`readonly`	`Mode`	`PostAttributes`.`mode`	-	types.ts:10
`on_off?`	`readonly`	`Switch`	-	`PostAttributes`.`on_off`	types.ts:74
`timer_switch?`	`readonly`	`Switch`	-	`PostAttributes`.`timer_switch`	types.ts:63
`window_switch?`	`readonly`	`Switch`	-	`PostAttributes`.`window_switch`	types.ts:78

Bindings

Defined in: types.ts:20

Properties

Property	Modifier	Type	Defined in
`devices`	`readonly`	readonly `Device`[]	types.ts:21

Device

Defined in: types.ts:24

Properties

Property	Modifier	Type	Defined in
`dev_alias`	`readonly`	`string`	types.ts:25
`did`	`readonly`	`string`	types.ts:26
`product_key`	`readonly`	`string`	types.ts:27
`product_name`	`readonly`	`string`	types.ts:28

DeviceData

Defined in: types.ts:31

Properties

Property	Modifier	Type	Defined in
`attr`	`readonly`	`Attributes`	types.ts:32

DevicePostData

Defined in: types.ts:35

Properties

Property	Modifier	Type	Defined in
`attrs`	`readonly`	`PostAttributes`	types.ts:36

DeviceV1PostData

Defined in: types.ts:39

Properties

Property	Modifier	Type	Defined in
`raw`	`readonly`	[`1`, `1`, `number`]	types.ts:40

ErrorData

Defined in: types.ts:43

Properties

Property	Modifier	Type	Defined in
`detail_message`	`readonly`	`string` \| `null`	types.ts:44
`error_message`	`readonly`	`string` \| `null`	types.ts:45

IAPI

Defined in: services/interfaces.ts:35

Properties

Property	Modifier	Type	Defined in
`authenticate`	`readonly`	(`data?`: `LoginPostData`) => `Promise`<`boolean`>	services/interfaces.ts:37
`bindings`	`readonly`	() => `Promise`<{ `data`: `Bindings`; }>	services/interfaces.ts:38
`clearSync`	`readonly`	() => `void`	services/interfaces.ts:39
`control`	`readonly`	(`__namedParameters`: { `id`: `string`; `postData`: `DevicePostDataAny`; }) => `Promise`<{ `data`: `Data`; }>	services/interfaces.ts:40
`deviceData`	`readonly`	(`__namedParameters`: { `id`: `string`; }) => `Promise`<{ `data`: `DeviceData`; }>	services/interfaces.ts:47
`fetch`	`readonly`	() => `Promise`<readonly `Device`[]>	services/interfaces.ts:48
`login`	`readonly`	(`__namedParameters`: { `postData`: `LoginPostData`; }) => `Promise`<{ `data`: `LoginData`; }>	services/interfaces.ts:49
`onSync?`	`readonly`	`OnSyncFunction`	services/interfaces.ts:36

IDeviceFacade

Defined in: facades/interfaces.ts:13

Extends

IBaseDeviceModel

Extended by

IDeviceV2Facade

Properties

Property	Modifier	Type	Inherited from	Defined in
`derogationEndDate`	`readonly`	`DateTime`<`boolean`> \| `null`	`IBaseDeviceModel.derogationEndDate`	models/interfaces.ts:8
`id`	`readonly`	`string`	`IBaseDeviceModel.id`	models/interfaces.ts:9
`isOn`	`readonly`	`boolean`	-	facades/interfaces.ts:14
`mode`	`readonly`	`Mode`	-	facades/interfaces.ts:15
`name`	`readonly`	`string`	`IBaseDeviceModel.name`	models/interfaces.ts:10
`onSync`	`readonly`	() => `Promise`<`void`>	-	facades/interfaces.ts:16
`previousMode`	`readonly`	`PreviousMode`	`IBaseDeviceModel.previousMode`	models/interfaces.ts:11
`product`	`readonly`	`Product`	`IBaseDeviceModel.product`	models/interfaces.ts:12
`setValues`	`readonly`	(`data`: `PostAttributes`) => `Promise`<`Partial`<`Attributes`>>	-	facades/interfaces.ts:17
`update`	`readonly`	(`data`: `Partial`<`Attributes`>) => `void`	`IBaseDeviceModel.update`	models/interfaces.ts:13
`values`	`readonly`	() => `Promise`<`Attributes`>	-	facades/interfaces.ts:18

Properties

Property	Modifier	Type	Inherited from	Defined in
`comfortTemperature`	`readonly`	`number`	-	facades/interfaces.ts:22
`currentTemperature`	`readonly`	`number`	-	facades/interfaces.ts:23
`derogationEndDate`	`readonly`	`DateTime`<`boolean`> \| `null`	`IDeviceV2Facade`.`derogationEndDate`	facades/interfaces.ts:36
`derogationEndString`	`readonly`	`string` \| `null`	`IDeviceV2Facade`.`derogationEndString`	facades/interfaces.ts:37
`derogationMode`	`readonly`	`DerogationMode`	`IDeviceV2Facade`.`derogationMode`	facades/interfaces.ts:38
`derogationTime`	`readonly`	`number`	`IDeviceV2Facade`.`derogationTime`	facades/interfaces.ts:39
`ecoTemperature`	`readonly`	`number`	-	facades/interfaces.ts:24
`id`	`readonly`	`string`	`IDeviceV2Facade`.`id`	models/interfaces.ts:9
`isLocked`	`readonly`	`boolean`	`IDeviceV2Facade`.`isLocked`	facades/interfaces.ts:40
`isOn`	`readonly`	`boolean`	`IDeviceV2Facade`.`isOn`	facades/interfaces.ts:14
`isTimer`	`readonly`	`boolean`	`IDeviceV2Facade`.`isTimer`	facades/interfaces.ts:41
`mode`	`readonly`	`Mode`	`IDeviceV2Facade`.`mode`	facades/interfaces.ts:15
`name`	`readonly`	`string`	`IDeviceV2Facade`.`name`	models/interfaces.ts:10
`onSync`	`readonly`	() => `Promise`<`void`>	`IDeviceV2Facade`.`onSync`	facades/interfaces.ts:16
`previousMode`	`readonly`	`PreviousMode`	`IDeviceV2Facade`.`previousMode`	models/interfaces.ts:11
`product`	`readonly`	`Product`	`IDeviceV2Facade`.`product`	models/interfaces.ts:12
`setValues`	`readonly`	(`data`: `PostAttributes`) => `Promise`<`Partial`<`Attributes`>>	`IDeviceV2Facade`.`setValues`	facades/interfaces.ts:17
`temperatureCompensation`	`readonly`	`TemperatureCompensation`	-	facades/interfaces.ts:25
`update`	`readonly`	(`data`: `Partial`<`Attributes`>) => `void`	`IDeviceV2Facade`.`update`	models/interfaces.ts:13
`values`	`readonly`	() => `Promise`<`Attributes`>	`IDeviceV2Facade`.`values`	facades/interfaces.ts:18

IDeviceModel

Defined in: models/interfaces.ts:16

Extends

IBaseDeviceModel

Properties

Property	Modifier	Type	Inherited from	Defined in
`data`	`readonly`	`Attributes`	-	models/interfaces.ts:17
`derogationEndDate`	`readonly`	`DateTime`<`boolean`> \| `null`	`IBaseDeviceModel.derogationEndDate`	models/interfaces.ts:8
`id`	`readonly`	`string`	`IBaseDeviceModel.id`	models/interfaces.ts:9
`name`	`readonly`	`string`	`IBaseDeviceModel.name`	models/interfaces.ts:10
`previousMode`	`readonly`	`PreviousMode`	`IBaseDeviceModel.previousMode`	models/interfaces.ts:11
`product`	`readonly`	`Product`	`IBaseDeviceModel.product`	models/interfaces.ts:12
`productKey`	`readonly`	`string`	-	models/interfaces.ts:18
`productName`	`readonly`	`string`	-	models/interfaces.ts:19
`update`	`readonly`	(`data`: `Partial`<`Attributes`>) => `void`	`IBaseDeviceModel.update`	models/interfaces.ts:13

IDeviceProFacade

Defined in: facades/interfaces.ts:28

Extends

IDeviceGlowFacade

Properties

Property	Modifier	Type	Inherited from	Defined in
`comfortTemperature`	`readonly`	`number`	`IDeviceGlowFacade`.`comfortTemperature`	facades/interfaces.ts:22
`currentHumidity`	`readonly`	`number`	-	facades/interfaces.ts:29
`currentMode`	`readonly`	`Mode`	-	facades/interfaces.ts:30
`currentTemperature`	`readonly`	`number`	`IDeviceGlowFacade`.`currentTemperature`	facades/interfaces.ts:23
`derogationEndDate`	`readonly`	`DateTime`<`boolean`> \| `null`	`IDeviceGlowFacade`.`derogationEndDate`	facades/interfaces.ts:36
`derogationEndString`	`readonly`	`string` \| `null`	`IDeviceGlowFacade`.`derogationEndString`	facades/interfaces.ts:37
`derogationMode`	`readonly`	`DerogationMode`	`IDeviceGlowFacade`.`derogationMode`	facades/interfaces.ts:38
`derogationTime`	`readonly`	`number`	`IDeviceGlowFacade`.`derogationTime`	facades/interfaces.ts:39
`ecoTemperature`	`readonly`	`number`	`IDeviceGlowFacade`.`ecoTemperature`	facades/interfaces.ts:24
`id`	`readonly`	`string`	`IDeviceGlowFacade`.`id`	models/interfaces.ts:9
`isDetectingOpenWindow`	`readonly`	`boolean`	-	facades/interfaces.ts:31
`isLocked`	`readonly`	`boolean`	`IDeviceGlowFacade`.`isLocked`	facades/interfaces.ts:40
`isOn`	`readonly`	`boolean`	`IDeviceGlowFacade`.`isOn`	facades/interfaces.ts:14
`isPresence`	`readonly`	`boolean`	-	facades/interfaces.ts:32
`isTimer`	`readonly`	`boolean`	`IDeviceGlowFacade`.`isTimer`	facades/interfaces.ts:41
`mode`	`readonly`	`Mode`	`IDeviceGlowFacade`.`mode`	facades/interfaces.ts:15
`name`	`readonly`	`string`	`IDeviceGlowFacade`.`name`	models/interfaces.ts:10
`onSync`	`readonly`	() => `Promise`<`void`>	`IDeviceGlowFacade`.`onSync`	facades/interfaces.ts:16
`previousMode`	`readonly`	`PreviousMode`	`IDeviceGlowFacade`.`previousMode`	models/interfaces.ts:11
`product`	`readonly`	`Product`	`IDeviceGlowFacade`.`product`	models/interfaces.ts:12
`setValues`	`readonly`	(`data`: `PostAttributes`) => `Promise`<`Partial`<`Attributes`>>	`IDeviceGlowFacade`.`setValues`	facades/interfaces.ts:17
`temperatureCompensation`	`readonly`	`TemperatureCompensation`	`IDeviceGlowFacade`.`temperatureCompensation`	facades/interfaces.ts:25
`update`	`readonly`	(`data`: `Partial`<`Attributes`>) => `void`	`IDeviceGlowFacade`.`update`	models/interfaces.ts:13
`values`	`readonly`	() => `Promise`<`Attributes`>	`IDeviceGlowFacade`.`values`	facades/interfaces.ts:18

IDeviceV2Facade

Defined in: facades/interfaces.ts:35

Extends

IDeviceFacade

Extended by

IDeviceGlowFacade

Properties

Property	Modifier	Type	Overrides	Inherited from	Defined in
`derogationEndDate`	`readonly`	`DateTime`<`boolean`> \| `null`	`IDeviceFacade`.`derogationEndDate`	-	facades/interfaces.ts:36
`derogationEndString`	`readonly`	`string` \| `null`	-	-	facades/interfaces.ts:37
`derogationMode`	`readonly`	`DerogationMode`	-	-	facades/interfaces.ts:38
`derogationTime`	`readonly`	`number`	-	-	facades/interfaces.ts:39
`id`	`readonly`	`string`	-	`IDeviceFacade`.`id`	models/interfaces.ts:9
`isLocked`	`readonly`	`boolean`	-	-	facades/interfaces.ts:40
`isOn`	`readonly`	`boolean`	-	`IDeviceFacade`.`isOn`	facades/interfaces.ts:14
`isTimer`	`readonly`	`boolean`	-	-	facades/interfaces.ts:41
`mode`	`readonly`	`Mode`	-	`IDeviceFacade`.`mode`	facades/interfaces.ts:15
`name`	`readonly`	`string`	-	`IDeviceFacade`.`name`	models/interfaces.ts:10
`onSync`	`readonly`	() => `Promise`<`void`>	-	`IDeviceFacade`.`onSync`	facades/interfaces.ts:16
`previousMode`	`readonly`	`PreviousMode`	-	`IDeviceFacade`.`previousMode`	models/interfaces.ts:11
`product`	`readonly`	`Product`	-	`IDeviceFacade`.`product`	models/interfaces.ts:12
`setValues`	`readonly`	(`data`: `PostAttributes`) => `Promise`<`Partial`<`Attributes`>>	-	`IDeviceFacade`.`setValues`	facades/interfaces.ts:17
`update`	`readonly`	(`data`: `Partial`<`Attributes`>) => `void`	-	`IDeviceFacade`.`update`	models/interfaces.ts:13
`values`	`readonly`	() => `Promise`<`Attributes`>	-	`IDeviceFacade`.`values`	facades/interfaces.ts:18

IFacadeManager

Defined in: facades/interfaces.ts:44

Properties

Property	Modifier	Type	Defined in
`get`	`readonly`	(`instance?`: `IDeviceModel`) => `IDeviceFacade` \| `null`	facades/interfaces.ts:45

Logger

Defined in: services/interfaces.ts:56

Properties

Property	Modifier	Type	Defined in
`error`	`readonly`	(...`data`: `any`[]) => `void`	services/interfaces.ts:57
`log`	`readonly`	(...`data`: `any`[]) => `void`	services/interfaces.ts:58

LoginData

Defined in: types.ts:48

Properties

Property	Modifier	Type	Defined in
`expire_at`	`readonly`	`number`	types.ts:49
`token`	`readonly`	`string`	types.ts:50

LoginPostData

Defined in: types.ts:53

Properties

Property	Modifier	Type	Defined in
`password`	`readonly`	`string`	types.ts:54
`username`	`readonly`	`string`	types.ts:55

PostAttributes

Defined in: types.ts:58

Extended by

Attributes

Properties

Property	Modifier	Type	Defined in
`cft_temp?`	`readonly`	`number`	types.ts:76
`cft_tempH?`	`readonly`	`number`	types.ts:69
`cft_tempL?`	`readonly`	`number`	types.ts:70
`com_temp?`	`readonly`	`TemperatureCompensation`	types.ts:67
`derog_mode?`	`readonly`	`DerogationMode`	types.ts:61
`derog_time?`	`readonly`	`number`	types.ts:62
`eco_temp?`	`readonly`	`number`	types.ts:77
`eco_tempH?`	`readonly`	`number`	types.ts:71
`eco_tempL?`	`readonly`	`number`	types.ts:72
`LOCK_C?`	`readonly`	`Switch`	types.ts:73
`lock_switch?`	`readonly`	`Switch`	types.ts:65
`mode?`	`readonly`	`Mode`	types.ts:59
`on_off?`	`readonly`	`Switch`	types.ts:74
`timer_switch?`	`readonly`	`Switch`	types.ts:63
`window_switch?`	`readonly`	`Switch`	types.ts:78

SettingManager

Defined in: services/interfaces.ts:61

Properties

Property	Modifier	Type	Defined in
`get`	`readonly`	<`K`>(`key`: `K`) => `APISettings`[`K`]	services/interfaces.ts:62
`set`	`readonly`	<`K`>(`key`: `K`, `value`: `APISettings`[`K`]) => `void`	services/interfaces.ts:63

Type Aliases

Data

type Data = Record<string, never>

Defined in: types.ts:81

DevicePostDataAny

type DevicePostDataAny = DevicePostData | DeviceV1PostData

Defined in: types.ts:83

IDeviceFacadeAny

type IDeviceFacadeAny =
  | IDeviceFacade
  | IDeviceGlowFacade
  | IDeviceProFacade
  | IDeviceV2Facade

Defined in: facades/interfaces.ts:48

OnSyncFunction()

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

Defined in: services/interfaces.ts:69

Parameters

Parameter	Type
`params?`	{ `ids?`: `string`[]; }
`params.ids?`	`string`[]

Returns

Promise<void>

PreviousMode

type PreviousMode = Exclude<Mode, stop>

Defined in: models/interfaces.ts:22

Functions

getTargetTemperature()

function getTargetTemperature(
  product: Product,
  mode: comfort | eco,
  value: number,
): PostAttributes

Defined in: utils.ts:13

Parameters

Parameter	Type
`product`	`Product`
`mode`	`comfort` \| `eco`
`value`	`number`

Returns

PostAttributes

supportsGlow()

function supportsGlow(device: IDeviceFacadeAny): device is IDeviceGlowFacade

Defined in: facades/interfaces.ts:58

Parameters

Parameter	Type
`device`	`IDeviceFacadeAny`

Returns

device is IDeviceGlowFacade

supportsPro()

function supportsPro(device: IDeviceFacadeAny): device is IDeviceProFacade

Defined in: facades/interfaces.ts:62

Parameters

Parameter	Type
`device`	`IDeviceFacadeAny`

Returns

device is IDeviceProFacade

supportsV2()

function supportsV2(device: IDeviceFacadeAny): device is IDeviceV2Facade

Defined in: facades/interfaces.ts:54

Parameters

Parameter	Type
`device`	`IDeviceFacadeAny`

Returns

device is IDeviceV2Facade

syncDevices()

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

Defined in: decorators/sync-devices.ts:5

Type Parameters

Type Parameter
`T` extends readonly `Device`[] \| `Partial`<`Attributes`>

Parameters

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

Returns

(...args: unknown[]): Promise<T>;

Parameters

Parameter	Type
...`args`	`unknown`[]

Returns

Promise<T>

updateDevice()

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

Defined in: decorators/update-device.ts:4

Type Parameters

Type Parameter
`T` extends `Partial`<`Attributes`>

Parameters

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

Returns

(...args: unknown[]): Promise<T>;

Parameters

Parameter	Type
...`args`	`unknown`[]

Returns

Promise<T>

Name		Name	Last commit message	Last commit date
Latest commit History 1,569 Commits
.github		.github
.vscode		.vscode
docs		docs
eslint-utils		eslint-utils
src		src
.gitignore		.gitignore
.prettierignore		.prettierignore
README.md		README.md
eslint.config.js		eslint.config.js
package-lock.json		package-lock.json
package.json		package.json
prettier.config.js		prettier.config.js
tsconfig.json		tsconfig.json
typedoc.config.js		typedoc.config.js

OlivierZal/heatzy-api

Folders and files

Latest commit

History

Repository files navigation

Heatzy API for Node.js - v9.0.0

Enumerations

DerogationMode

Enumeration Members

Mode

Enumeration Members

Product

Enumeration Members

Switch

Enumeration Members

TemperatureCompensation

Enumeration Members

Classes

DeviceModel

Implements

Properties

Accessors

data

Get Signature

Returns

Implementation of

derogationEndDate

Get Signature

Returns

Implementation of

previousMode

Get Signature

Returns

Implementation of

Methods

update()

Parameters

Returns

Implementation of

getAll()

Returns

getById()

Parameters

Returns

getByName()

Parameters

Returns

sync()

Parameters

Returns

FacadeManager

Implements

Constructors

Constructor

Parameters

Returns

Properties

Methods

get()

Call Signature

Returns

Implementation of

Call Signature

Parameters

Returns

Implementation of

HeatzyAPI

Implements

Constructors

Constructor

Parameters

Returns

Properties

Methods

authenticate()

Parameters

Returns

Implementation of

bindings()

Returns