Heatzy API for Node.js

Enumerations

DerogMode

Enumeration Members

Enumeration Member	Value	Defined in
boost	2	src/types.ts:15
off	0	src/types.ts:13
vacation	1	src/types.ts:14

---

Mode

Enumeration Members

Enumeration Member	Value	Defined in
cft	0	src/types.ts:4
cft1	4	src/types.ts:8
cft2	5	src/types.ts:9
eco	1	src/types.ts:5
fro	2	src/types.ts:6
stop	3	src/types.ts:7

---

Switch

Enumeration Members

Enumeration Member	Value	Defined in
off	0	src/types.ts:19
on	1	src/types.ts:20

Classes

default

Constructors

new default()

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

Parameters

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

Returns

default

Defined in

src/lib/HeatzyAPI.ts:66

Methods

applyLogin()

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

Parameters

Parameter	Type
data?	LoginCredentials

Returns

Promise<boolean>

Defined in

src/lib/HeatzyAPI.ts:120

bindings()

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

Returns

Promise<{ data: Bindings; }>

Name	Type	Defined in
data	Bindings	src/lib/HeatzyAPI.ts:135

Defined in

src/lib/HeatzyAPI.ts:135

control()

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

Parameters

Parameter	Type
id	string
postData	DevicePostDataAny

Returns

Promise<{ data: Data; }>

Name	Type	Defined in
data	Data	src/lib/HeatzyAPI.ts:142

Defined in

src/lib/HeatzyAPI.ts:139

deviceData()

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

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: DeviceData; }>

Name	Type	Defined in
data	DeviceData	src/lib/HeatzyAPI.ts:146

Defined in

src/lib/HeatzyAPI.ts:146

login()

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

Parameters

Parameter	Type
__namedParameters	LoginPostData

Returns

Promise<{ data: LoginData; }>

Name	Type	Defined in
data	LoginData	src/lib/HeatzyAPI.ts:153

Defined in

src/lib/HeatzyAPI.ts:150

Interfaces

APISettings

Properties

Property	Modifier	Type	Defined in
expireAt?	readonly	null | number	src/lib/HeatzyAPI.ts:25
password?	readonly	null | string	src/lib/HeatzyAPI.ts:26
token?	readonly	null | string	src/lib/HeatzyAPI.ts:27
username?	readonly	null | string	src/lib/HeatzyAPI.ts:28

---

BaseAttrs

Properties

Property	Type	Defined in
cft_tempH?	number	src/types.ts:59
cft_tempL?	number	src/types.ts:60
derog_mode?	DerogMode	src/types.ts:61
derog_time?	number	src/types.ts:62
lock_switch?	Switch	src/types.ts:63
mode?	Mode	src/types.ts:64
timer_switch?	Switch	src/types.ts:65

---

Bindings

Properties

Property	Modifier	Type	Defined in
devices	readonly	readonly { dev_alias: string; did: string; product_key: string; product_name: string; }[]	src/types.ts:46

---

DeviceData

Properties

Property	Modifier	Type	Defined in
attr	readonly	never	src/types.ts:75

---

DevicePostData

Properties

Property	Modifier	Type	Defined in
attrs	readonly	BaseAttrs	src/types.ts:69

---

ErrorData

Properties

Property	Modifier	Type	Defined in
detail_message	readonly	null | string	src/types.ts:26
error_message	readonly	null | string	src/types.ts:27

---

FirstGenDevicePostData

Properties

Property	Modifier	Type	Defined in
raw	readonly	[1, 1, Mode]	src/types.ts:55

---

Logger

Properties

Property	Modifier	Type	Defined in
error	readonly	(...data: any[]) => void(message?: any, ...optionalParams: any[]) => void	src/lib/HeatzyAPI.ts:32
log	readonly	(...data: any[]) => void(message?: any, ...optionalParams: any[]) => void	src/lib/HeatzyAPI.ts:33

---

LoginCredentials

Properties

Property	Modifier	Type	Defined in
password	readonly	string	src/types.ts:31
username	readonly	string	src/types.ts:32

---

LoginData

Properties

Property	Modifier	Type	Defined in
expire_at	readonly	number	src/types.ts:41
token	readonly	string	src/types.ts:42

---

LoginPostData

Properties

Property	Modifier	Type	Defined in
password	readonly	string	src/types.ts:36
username	readonly	string	src/types.ts:37

---

SettingManager

Properties

Property	Type	Defined in
get	<K>(key: K) => undefined | null | APISettings[K]	src/lib/HeatzyAPI.ts:37
set	<K>(key: K, value: APISettings[K]) => void	src/lib/HeatzyAPI.ts:40

Type Aliases

Data

type Data: Record<string, never>;

Defined in

src/types.ts:23

---

DevicePostDataAny

type DevicePostDataAny: DevicePostData | FirstGenDevicePostData;

Defined in

src/types.ts:72

Variables

NUMBER_1

const NUMBER_1: 1 = 1;

Defined in

src/types.ts:1