olivierzal / ariston-api

Ariston API for Node.js

Ariston API for Node.js

Enumerations

Mode

Enumeration Members

Enumeration Member	Value	Defined in
auto	1	src/types.ts:7
manual	2	src/types.ts:8

---

OperationMode

Enumeration Members

Enumeration Member	Value	Defined in
auto	3	src/types.ts:15
comfort	1	src/types.ts:13
fast	2	src/types.ts:14
green	0	src/types.ts:12

---

Switch

Enumeration Members

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

---

WheType

Enumeration Members

Enumeration Member	Value	Defined in
lydos	3	src/types.ts:2
nuos	4	src/types.ts:3

Classes

default

Constructors

new default()

new default(config: {
  language: string;
  logger: Logger;
  settingManager: SettingManager;
 }): default

Parameters

Parameter	Type
config	object
config.language?	string
config.logger?	Logger
config.settingManager?	SettingManager

Returns

default

Defined in

src/lib/AristonAPI.ts:66

Methods

applyLogin()

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

Parameters

Parameter	Type
data?	LoginCredentials

Returns

Promise<boolean>

Defined in

src/lib/AristonAPI.ts:113

errors()

errors(id: string): Promise<{
  data: PlantHeader;
}>

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: PlantHeader; }>

Name	Type	Defined in
data	PlantHeader	src/lib/AristonAPI.ts:133

Defined in

src/lib/AristonAPI.ts:133

get()

get(id: string): Promise<{
  data: GetData<PlantSettings>;
}>

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: GetData<PlantSettings>; }>

Name	Type	Defined in
data	GetData<PlantSettings>	src/lib/AristonAPI.ts:138

Defined in

src/lib/AristonAPI.ts:137

list()

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

Returns

Promise<{ data: Plant[]; }>

Name	Type	Defined in
data	Plant[]	src/lib/AristonAPI.ts:146

Defined in

src/lib/AristonAPI.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/AristonAPI.ts:154

Defined in

src/lib/AristonAPI.ts:150

report()

report(id: string): Promise<{
  data: ReportData;
}>

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: ReportData; }>

Name	Type	Defined in
data	ReportData	src/lib/AristonAPI.ts:167

Defined in

src/lib/AristonAPI.ts:167

setData()

setData(id: string, postData: PostData): Promise<{
  data: GetData<null>;
}>

Parameters

Parameter	Type
id	string
postData	PostData

Returns

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

Name	Type	Defined in
data	GetData<null>	src/lib/AristonAPI.ts:174

Defined in

src/lib/AristonAPI.ts:171

setSettings()

setSettings(id: string, settings: PostSettings): Promise<{
  data: GetSettings;
}>

Parameters

Parameter	Type
id	string
settings	PostSettings

Returns

Promise<{ data: GetSettings; }>

Name	Type	Defined in
data	GetSettings	src/lib/AristonAPI.ts:184

Defined in

src/lib/AristonAPI.ts:181

Interfaces

APISettings

Properties

Property	Modifier	Type	Defined in
expires?	readonly	null | string	src/lib/AristonAPI.ts:28
password?	readonly	null | string	src/lib/AristonAPI.ts:29
username?	readonly	null | string	src/lib/AristonAPI.ts:30

---

BasePlantData

Extended by

• PostPlantData
• ViewModel

Properties

Property	Type	Defined in
boostOn?	boolean	src/types.ts:53
comfortTemp?	number	src/types.ts:54
holidayUntil?	null | string	src/types.ts:55
hpState?	number	src/types.ts:56
on?	boolean	src/types.ts:57
opMode?	OperationMode	src/types.ts:58

---

BasePostSettings<T>

Extended by

• BasePostSettingsWithOld

Type Parameters

Type Parameter
T

Properties

Property	Modifier	Type	Defined in
new	readonly	T	src/types.ts:95

---

BasePostSettingsWithOld<T>

Extends

• BasePostSettings<T>

Type Parameters

Type Parameter
T

Properties

Property	Modifier	Type	Inherited from	Defined in
new	readonly	T	BasePostSettings.new	src/types.ts:95
old	readonly	T	-	src/types.ts:99

---

Failure

Properties

Property	Modifier	Type	Defined in
message	readonly	string	src/types.ts:29
ok	readonly	false	src/types.ts:30

---

GetSettings

Properties

Property	Modifier	Type	Defined in
success	readonly	boolean	src/types.ts:110

---

HistogramData

Properties

Property	Modifier	Type	Defined in
items	readonly	readonly { x: string; y: number; }[]	src/types.ts:121
period	readonly	string	src/types.ts:122
series	readonly	"DhwHp" | "DhwResistor"	src/types.ts:123
tab	readonly	string	src/types.ts:124

---

Logger

Properties

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

---

LoginCredentials

Properties

Property	Modifier	Type	Defined in
password	readonly	string	src/types.ts:34
username	readonly	string	src/types.ts:35

---

LoginPostData

Properties

Property	Modifier	Type	Defined in
email	readonly	string	src/types.ts:39
password	readonly	string	src/types.ts:40
rememberMe	readonly	true	src/types.ts:41

---

Plant

Properties

Property	Modifier	Type	Defined in
gw	readonly	string	src/types.ts:47
name	readonly	string	src/types.ts:48
wheType	readonly	WheType	src/types.ts:49

---

PlantData

Extends

• Readonly<Required<PostPlantData>>

Properties

Property	Modifier	Type	Inherited from	Defined in
boostOn	readonly	boolean	Readonly.boostOn	src/types.ts:53
comfortTemp	readonly	number	Readonly.comfortTemp	src/types.ts:54
holidayUntil	readonly	null | string	Readonly.holidayUntil	src/types.ts:55
hpState	readonly	number	Readonly.hpState	src/types.ts:56
mode	readonly	Mode	Readonly.mode	src/types.ts:62
on	readonly	boolean	Readonly.on	src/types.ts:57
opMode	readonly	OperationMode	Readonly.opMode	src/types.ts:58
waterTemp	readonly	number	-	src/types.ts:75

---

PlantHeader

Properties

Property	Modifier	Type	Defined in
data	readonly	{ errorText: string; errorType: number; }	src/types.ts:114
data.errorText	readonly	string	src/types.ts:115
data.errorType	readonly	number	src/types.ts:116

---

PlantSettings

Properties

Property	Modifier	Type	Defined in
antilegionellaOnOff	readonly	boolean	src/types.ts:79
maxSetpointTemp	readonly	{ value: number; }	src/types.ts:80
maxSetpointTemp.value	public	number	src/types.ts:80
minSetpointTemp	readonly	{ value: number; }	src/types.ts:81
minSetpointTemp.value	public	number	src/types.ts:81
preHeatingOnOff	readonly	boolean	src/types.ts:82

---

PostData

Properties

Property	Modifier	Type	Defined in
plantData	readonly	PostPlantData	src/types.ts:70
viewModel	readonly	ViewModel	src/types.ts:71

---

PostPlantData

Extends

• BasePlantData

Properties

Property	Type	Inherited from	Defined in
boostOn?	boolean	BasePlantData.boostOn	src/types.ts:53
comfortTemp?	number	BasePlantData.comfortTemp	src/types.ts:54
holidayUntil?	null | string	BasePlantData.holidayUntil	src/types.ts:55
hpState?	number	BasePlantData.hpState	src/types.ts:56
mode?	Mode	-	src/types.ts:62
on?	boolean	BasePlantData.on	src/types.ts:57
opMode?	OperationMode	BasePlantData.opMode	src/types.ts:58

---

PostSettings

Properties

Property	Type	Defined in
SlpAntilegionellaOnOff?	BasePostSettingsWithOld<Switch>	src/types.ts:103
SlpMaxSetpointTemperature?	BasePostSettings<number>	src/types.ts:104
SlpMinSetpointTemperature?	BasePostSettings<number>	src/types.ts:105
SlpPreHeatingOnOff?	BasePostSettingsWithOld<Switch>	src/types.ts:106

---

ReportData

Properties

Property	Modifier	Type	Defined in
data	readonly	{ asKwhRaw: { histogramData: readonly HistogramData[]; }; }	src/types.ts:128
data.asKwhRaw	readonly	{ histogramData: readonly HistogramData[]; }	src/types.ts:129
data.asKwhRaw.histogramData	readonly	readonly HistogramData[]	src/types.ts:129

---

SettingManager

Properties

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

---

Success

Properties

Property	Modifier	Type	Defined in
message	readonly	null	src/types.ts:24
ok	readonly	true	src/types.ts:25

---

ViewModel

Extends

• BasePlantData

Properties

Property	Type	Inherited from	Defined in
boostOn?	boolean	BasePlantData.boostOn	src/types.ts:53
comfortTemp?	number	BasePlantData.comfortTemp	src/types.ts:54
holidayUntil?	null | string	BasePlantData.holidayUntil	src/types.ts:55
hpState?	number	BasePlantData.hpState	src/types.ts:56
on?	boolean	BasePlantData.on	src/types.ts:57
opMode?	OperationMode	BasePlantData.opMode	src/types.ts:58
plantMode?	Mode	-	src/types.ts:66

Type Aliases

GetData<T>

type GetData<T>: Failure | Success & {
  data: {
     plantData: PlantData;
     plantSettings: T;
    };
};

Type Parameters

Type Parameter
T extends PlantSettings | null

Defined in

src/types.ts:85

---

LoginData

type LoginData: Failure | Success;

Defined in

src/types.ts:44