Defined in: src/enums.ts:1
Enumeration Member | Value | Defined in |
---|---|---|
boost |
2 |
src/enums.ts:2 |
off |
0 |
src/enums.ts:3 |
presence |
3 |
src/enums.ts:6 |
vacation |
1 |
src/enums.ts:4 |
Defined in: src/enums.ts:9
Enumeration Member | Value | Defined in |
---|---|---|
cft |
"cft" |
src/enums.ts:10 |
cft1 |
"cft1" |
src/enums.ts:15 |
cft2 |
"cft2" |
src/enums.ts:16 |
eco |
"eco" |
src/enums.ts:11 |
fro |
"fro" |
src/enums.ts:12 |
stop |
"stop" |
src/enums.ts:13 |
Defined in: src/enums.ts:19
Enumeration Member | Value | Defined in |
---|---|---|
cft |
0 |
src/enums.ts:20 |
eco |
1 |
src/enums.ts:21 |
fro |
2 |
src/enums.ts:22 |
stop |
3 |
src/enums.ts:23 |
Defined in: src/models/interfaces.ts:6
Enumeration Member | Value | Defined in |
---|---|---|
glow |
5 |
src/models/interfaces.ts:7 |
pro |
6 |
src/models/interfaces.ts:8 |
v1 |
1 |
src/models/interfaces.ts:9 |
v2 |
2 |
src/models/interfaces.ts:10 |
v4 |
4 |
src/models/interfaces.ts:11 |
Defined in: src/enums.ts:26
Enumeration Member | Value | Defined in |
---|---|---|
off |
0 |
src/enums.ts:27 |
on |
1 |
src/enums.ts:28 |
Defined in: src/enums.ts:31
Enumeration Member | Value | Defined in |
---|---|---|
minus5C |
0 |
src/enums.ts:32 |
noChange |
50 |
src/enums.ts:33 |
plus5C |
100 |
src/enums.ts:34 |
Defined in: src/models/device.ts:14
Property | Modifier | Type | Defined in |
---|---|---|---|
id |
readonly |
string |
src/models/device.ts:17 |
name |
readonly |
string |
src/models/device.ts:19 |
product |
readonly |
Product |
src/models/device.ts:21 |
productKey |
readonly |
string |
src/models/device.ts:23 |
productName |
readonly |
string |
src/models/device.ts:25 |
get data(): Attrs
Defined in: src/models/device.ts:44
get derogationEndDate(): null | DateTime
Defined in: src/models/device.ts:48
null
| DateTime
IDeviceModel
.derogationEndDate
get previousMode(): PreviousMode
Defined in: src/models/device.ts:54
update(data: Partial<Attrs>): void
Defined in: src/models/device.ts:100
Parameter | Type |
---|---|
data |
Partial <Attrs > |
void
static getAll(): DeviceModel[]
Defined in: src/models/device.ts:58
static getById(id: string): undefined | DeviceModel
Defined in: src/models/device.ts:62
Parameter | Type |
---|---|
id |
string |
undefined
| DeviceModel
static getByName(name: string): undefined | DeviceModel
Defined in: src/models/device.ts:66
Parameter | Type |
---|---|
name |
string |
undefined
| DeviceModel
static sync(devices: readonly Device[], data: Record<string, Attrs>): void
Defined in: src/models/device.ts:70
Parameter | Type |
---|---|
devices |
readonly Device [] |
data |
Record <string , Attrs > |
void
Defined in: src/facades/manager.ts:12
new FacadeManager(api: IAPI): FacadeManager
Defined in: src/facades/manager.ts:17
Parameter | Type |
---|---|
api |
IAPI |
Property | Modifier | Type | Defined in |
---|---|---|---|
api |
readonly |
IAPI |
src/facades/manager.ts:13 |
get(): null
Defined in: src/facades/manager.ts:21
null
get(instance: IDeviceModel): IDeviceFacadeAny
Defined in: src/facades/manager.ts:22
Parameter | Type |
---|---|
instance |
IDeviceModel |
IFacadeManager.get
Defined in: src/services/api.ts:68
new HeatzyAPI(config: APIConfig): HeatzyAPI
Defined in: src/services/api.ts:83
Parameter | Type |
---|---|
config |
APIConfig |
Property | Modifier | Type | Defined in |
---|---|---|---|
onSync? |
readonly |
() => Promise <void > |
src/services/api.ts:69 |
settingManager? |
readonly |
SettingManager |
src/services/api.ts:71 |
authenticate(data?: LoginPostData): Promise<boolean>
Defined in: src/services/api.ts:144
Parameter | Type |
---|---|
data ? |
LoginPostData |
Promise
<boolean
>
bindings(): Promise<{
data: Bindings;
}>
Defined in: src/services/api.ts:158
Promise
<{
data
: Bindings
;
}>
clearSync(): void
Defined in: src/services/api.ts:162
void
control(__namedParameters: {
id: string;
postData: DevicePostDataAny;
}): Promise<{
data: Data;
}>
Defined in: src/services/api.ts:169
Parameter | Type |
---|---|
__namedParameters |
{ id : string ; postData : DevicePostDataAny ; } |
__namedParameters.id |
string |
__namedParameters.postData |
DevicePostDataAny |
Promise
<{
data
: Data
;
}>
deviceData(__namedParameters: {
id: string;
}): Promise<{
data: DeviceData;
}>
Defined in: src/services/api.ts:179
Parameter | Type |
---|---|
__namedParameters |
{ id : string ; } |
__namedParameters.id |
string |
Promise
<{
data
: DeviceData
;
}>
fetch(): Promise<readonly Device[]>
Defined in: src/services/api.ts:129
Promise
<readonly Device
[]>
login(__namedParameters: {
postData: LoginPostData;
}): Promise<{
data: LoginData;
}>
Defined in: src/services/api.ts:187
Parameter | Type |
---|---|
__namedParameters |
{ postData : LoginPostData ; } |
__namedParameters.postData |
LoginPostData |
Promise
<{
data
: LoginData
;
}>
static create(config: APIConfig): Promise<HeatzyAPI>
Defined in: src/services/api.ts:122
Parameter | Type |
---|---|
config |
APIConfig |
Promise
<HeatzyAPI
>
Defined in: src/services/interfaces.ts:28
Partial
<LoginPostData
>
Property | Modifier | Type | Inherited from | Defined in |
---|---|---|---|---|
autoSyncInterval? |
public |
null | number |
- | src/services/interfaces.ts:29 |
language? |
public |
string |
- | src/services/interfaces.ts:30 |
logger? |
public |
Logger |
- | src/services/interfaces.ts:31 |
onSync? |
public |
OnSyncFunction |
- | src/services/interfaces.ts:32 |
password? |
readonly |
string |
Partial.password |
src/types.ts:55 |
settingManager? |
public |
SettingManager |
- | src/services/interfaces.ts:33 |
shouldVerifySSL? |
public |
boolean |
- | src/services/interfaces.ts:34 |
timezone? |
public |
string |
- | src/services/interfaces.ts:35 |
username? |
readonly |
string |
Partial.username |
src/types.ts:56 |
Defined in: src/services/interfaces.ts:11
Property | Type | Defined in |
---|---|---|
expireAt? |
null | string |
src/services/interfaces.ts:12 |
password? |
null | string |
src/services/interfaces.ts:13 |
token? |
null | string |
src/services/interfaces.ts:14 |
username? |
null | string |
src/services/interfaces.ts:15 |
Defined in: src/types.ts:10
Defined in: src/types.ts:21
Property | Modifier | Type | Defined in |
---|---|---|---|
devices |
readonly |
readonly Device [] |
src/types.ts:22 |
Defined in: src/types.ts:25
Property | Modifier | Type | Defined in |
---|---|---|---|
dev_alias |
readonly |
string |
src/types.ts:26 |
did |
readonly |
string |
src/types.ts:27 |
product_key |
readonly |
string |
src/types.ts:28 |
product_name |
readonly |
string |
src/types.ts:29 |
Defined in: src/types.ts:32
Property | Modifier | Type | Defined in |
---|---|---|---|
attr |
readonly |
Attrs |
src/types.ts:33 |
Defined in: src/types.ts:36
Property | Modifier | Type | Defined in |
---|---|---|---|
attrs |
readonly |
PostAttrs |
src/types.ts:37 |
Defined in: src/types.ts:40
Property | Modifier | Type | Defined in |
---|---|---|---|
raw |
readonly |
[1 , 1 , ModeV1 ] |
src/types.ts:41 |
Defined in: src/types.ts:44
Property | Modifier | Type | Defined in |
---|---|---|---|
detail_message |
readonly |
null | string |
src/types.ts:45 |
error_message |
readonly |
null | string |
src/types.ts:46 |
Defined in: src/services/interfaces.ts:38
Property | Type | Defined in |
---|---|---|
authenticate |
(data ?: LoginPostData ) => Promise <boolean > |
src/services/interfaces.ts:40 |
bindings |
() => Promise <{ data : Bindings ; }> |
src/services/interfaces.ts:41 |
clearSync |
() => void |
src/services/interfaces.ts:42 |
control |
(__namedParameters : { id : string ; postData : DevicePostDataAny ; }) => Promise <{ data : Data ; }> |
src/services/interfaces.ts:43 |
deviceData |
(__namedParameters : { id : string ; }) => Promise <{ data : DeviceData ; }> |
src/services/interfaces.ts:50 |
fetch |
() => Promise <readonly Device []> |
src/services/interfaces.ts:51 |
login |
(__namedParameters : { postData : LoginPostData ; }) => Promise <{ data : LoginData ; }> |
src/services/interfaces.ts:52 |
onSync? |
OnSyncFunction |
src/services/interfaces.ts:39 |
Defined in: src/facades/interfaces.ts:12
IBaseDeviceModel
Property | Type | Inherited from | Defined in |
---|---|---|---|
derogationEndDate |
null | DateTime |
IBaseDeviceModel.derogationEndDate |
src/models/interfaces.ts:15 |
id |
string |
IBaseDeviceModel.id |
src/models/interfaces.ts:16 |
isOn |
boolean |
- | src/facades/interfaces.ts:13 |
mode |
Mode |
- | src/facades/interfaces.ts:14 |
name |
string |
IBaseDeviceModel.name |
src/models/interfaces.ts:17 |
onSync |
() => Promise <void > |
- | src/facades/interfaces.ts:15 |
previousMode |
PreviousMode |
IBaseDeviceModel.previousMode |
src/models/interfaces.ts:18 |
product |
Product |
IBaseDeviceModel.product |
src/models/interfaces.ts:19 |
setValues |
(data : PostAttrs ) => Promise <Partial <Attrs >> |
- | src/facades/interfaces.ts:16 |
update |
(data : Partial <Attrs >) => void |
IBaseDeviceModel.update |
src/models/interfaces.ts:20 |
values |
() => Promise <Attrs > |
- | src/facades/interfaces.ts:17 |
Defined in: src/facades/interfaces.ts:20
Defined in: src/models/interfaces.ts:23
IBaseDeviceModel
Property | Type | Inherited from | Defined in |
---|---|---|---|
data |
Attrs |
- | src/models/interfaces.ts:24 |
derogationEndDate |
null | DateTime |
IBaseDeviceModel.derogationEndDate |
src/models/interfaces.ts:15 |
id |
string |
IBaseDeviceModel.id |
src/models/interfaces.ts:16 |
name |
string |
IBaseDeviceModel.name |
src/models/interfaces.ts:17 |
previousMode |
PreviousMode |
IBaseDeviceModel.previousMode |
src/models/interfaces.ts:18 |
product |
Product |
IBaseDeviceModel.product |
src/models/interfaces.ts:19 |
productKey |
string |
- | src/models/interfaces.ts:25 |
productName |
string |
- | src/models/interfaces.ts:26 |
update |
(data : Partial <Attrs >) => void |
IBaseDeviceModel.update |
src/models/interfaces.ts:20 |
Defined in: src/facades/interfaces.ts:27
Defined in: src/facades/interfaces.ts:34
Defined in: src/facades/interfaces.ts:43
Property | Type | Defined in |
---|---|---|
get |
(instance ?: IDeviceModel ) => null | IDeviceFacade |
src/facades/interfaces.ts:44 |
Defined in: src/services/interfaces.ts:59
Property | Type | Defined in |
---|---|---|
error |
(message ?: any , ...optionalParams : any []) => void |
src/services/interfaces.ts:60 |
log |
(message ?: any , ...optionalParams : any []) => void |
src/services/interfaces.ts:61 |
Defined in: src/types.ts:49
Property | Modifier | Type | Defined in |
---|---|---|---|
expire_at |
readonly |
number |
src/types.ts:50 |
token |
readonly |
string |
src/types.ts:51 |
Defined in: src/types.ts:54
Property | Modifier | Type | Defined in |
---|---|---|---|
password |
readonly |
string |
src/types.ts:55 |
username |
readonly |
string |
src/types.ts:56 |
Defined in: src/types.ts:59
Property | Modifier | Type | Defined in |
---|---|---|---|
cft_temp? |
readonly |
number |
src/types.ts:77 |
cft_tempH? |
readonly |
number |
src/types.ts:70 |
cft_tempL? |
readonly |
number |
src/types.ts:71 |
com_temp? |
readonly |
TemperatureCompensation |
src/types.ts:68 |
derog_mode? |
readonly |
DerogationMode |
src/types.ts:62 |
derog_time? |
readonly |
number |
src/types.ts:63 |
eco_temp? |
readonly |
number |
src/types.ts:78 |
eco_tempH? |
readonly |
number |
src/types.ts:72 |
eco_tempL? |
readonly |
number |
src/types.ts:73 |
lock_c? |
readonly |
Switch |
src/types.ts:74 |
lock_switch? |
readonly |
Switch |
src/types.ts:66 |
mode? |
readonly |
Mode |
src/types.ts:60 |
on_off? |
readonly |
Switch |
src/types.ts:75 |
timer_switch? |
readonly |
Switch |
src/types.ts:64 |
window_switch? |
readonly |
Switch |
src/types.ts:79 |
Defined in: src/services/interfaces.ts:64
Property | Type | Defined in |
---|---|---|
get |
<K >(key : K ) => APISettings [K ] |
src/services/interfaces.ts:65 |
set |
<K >(key : K , value : APISettings [K ]) => void |
src/services/interfaces.ts:66 |
type Data = Record<string, never>
Defined in: src/types.ts:82
type DevicePostDataAny = DevicePostData | DeviceV1PostData
Defined in: src/types.ts:84
type IDeviceFacadeAny =
| IDeviceFacade
| IDeviceGlowFacade
| IDeviceProFacade
| IDeviceV2Facade
Defined in: src/facades/interfaces.ts:47
type OnSyncFunction = (params?: { ids: string[] }) => Promise<void>
Defined in: src/services/interfaces.ts:69
Parameter | Type |
---|---|
params ? |
{ ids : string []; } |
params.ids ? |
string [] |
Promise
<void
>
type PreviousMode = Exclude<Mode, stop>
Defined in: src/models/interfaces.ts:29
const UNIT: 1 = 1
Defined in: src/constants.ts:3
function getTargetTemperature(
product: Product,
temperature: 'cft_temp' | 'eco_temp',
value: number,
): PostAttrs
Defined in: src/utils.ts:8
Parameter | Type |
---|---|
product |
Product |
temperature |
"cft_temp" | "eco_temp" |
value |
number |
function supportsGlow(device: IDeviceFacadeAny): device is IDeviceGlowFacade
Defined in: src/facades/interfaces.ts:57
Parameter | Type |
---|---|
device |
IDeviceFacadeAny |
device is IDeviceGlowFacade
function supportsPro(device: IDeviceFacadeAny): device is IDeviceProFacade
Defined in: src/facades/interfaces.ts:61
Parameter | Type |
---|---|
device |
IDeviceFacadeAny |
device is IDeviceProFacade
function supportsV2(device: IDeviceFacadeAny): device is IDeviceV2Facade
Defined in: src/facades/interfaces.ts:53
Parameter | Type |
---|---|
device |
IDeviceFacadeAny |
device is IDeviceV2Facade
function syncDevices<T>(
target: (...args: any[]) => Promise<T>,
_context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
): (...args: unknown[]) => Promise<T>
Defined in: src/decorators/sync-devices.ts:5
Type Parameter |
---|
T extends | readonly Device [] | Partial <Attrs > |
Parameter | Type |
---|---|
target |
(...args : any []) => Promise <T > |
_context |
ClassMethodDecoratorContext <(this : unknown , ...args : any ) => any > |
Function
Parameter | Type |
---|---|
...args |
unknown [] |
Promise
<T
>
function updateDevice<T>(
target: (...args: any[]) => Promise<T>,
_context: ClassMethodDecoratorContext<(this: unknown, ...args: any) => any>,
): (...args: unknown[]) => Promise<T>
Defined in: src/decorators/update-device.ts:4
Type Parameter |
---|
T extends Partial <Attrs > |
Parameter | Type |
---|---|
target |
(...args : any []) => Promise <T > |
_context |
ClassMethodDecoratorContext <(this : unknown , ...args : any ) => any > |
Function
Parameter | Type |
---|---|
...args |
unknown [] |
Promise
<T
>