Ariston API for Node.js

Enumerations

Mode

Enumeration Members

Enumeration Member	Value
auto	1
manual	2

---

OperationMode

Enumeration Members

Enumeration Member	Value
auto	3
comfort	1
fast	2
green	0

---

Switch

Enumeration Members

Enumeration Member	Value
off	0
on	1

---

WheType

Enumeration Members

Enumeration Member	Value
lydos	3
nuos	4

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

Source

src/lib/AristonAPI.ts:66

Methods

applyLogin()

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

Parameters

Parameter	Type
data?	LoginCredentials

Returns

Promise<boolean>

Source

src/lib/AristonAPI.ts:113

errors()

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

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: PlantHeader; }>

Member	Type
data	PlantHeader

Source

src/lib/AristonAPI.ts:133

get()

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

Parameters

Parameter	Type
id	string

Returns

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

Member	Type
data	GetData<PlantSettings>

Source

src/lib/AristonAPI.ts:137

list()

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

Returns

Promise<{ data: Plant[]; }>

Member	Type
data	Plant[]

Source

src/lib/AristonAPI.ts:146

login()

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

Parameters

Parameter	Type
__namedParameters	LoginPostData

Returns

Promise<{ data: LoginData; }>

Member	Type
data	LoginData

Source

src/lib/AristonAPI.ts:150

report()

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

Parameters

Parameter	Type
id	string

Returns

Promise<{ data: ReportData; }>

Member	Type
data	ReportData

Source

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>; }>

Member	Type
data	GetData<null>

Source

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; }>

Member	Type
data	GetSettings

Source

src/lib/AristonAPI.ts:181

Interfaces

APISettings

Properties

Property	Modifier	Type
expires?	readonly	null | string
password?	readonly	null | string
username?	readonly	null | string

---

BasePlantData

Extended by

• PostPlantData
• ViewModel

Properties

Property	Type
boostOn?	boolean
comfortTemp?	number
holidayUntil?	null | string
hpState?	number
on?	boolean
opMode?	OperationMode

---

BasePostSettings<T>

Extended by

• BasePostSettingsWithOld

Type parameters

Type parameter
T

Properties

Property	Modifier	Type
new	readonly	T

---

BasePostSettingsWithOld<T>

Extends

• BasePostSettings<T>

Type parameters

Type parameter
T

Properties

Property	Modifier	Type	Inherited from
new	readonly	T	BasePostSettings.new
old	readonly	T	-

---

Failure

Properties

Property	Modifier	Type
message	readonly	string
ok	readonly	false

---

GetSettings

Properties

Property	Modifier	Type
success	readonly	boolean

---

HistogramData

Properties

Property	Modifier	Type
items	readonly	readonly { x: string; y: number; }[]
period	readonly	string
series	readonly	"DhwHp" | "DhwResistor"
tab	readonly	string

---

Logger

Properties

Property	Modifier	Type
error	readonly	(...data: any[]) => void(message?: any, ...optionalParams: any[]) => void
log	readonly	(...data: any[]) => void(message?: any, ...optionalParams: any[]) => void

---

LoginCredentials

Properties

Property	Modifier	Type
password	readonly	string
username	readonly	string

---

LoginPostData

Properties

Property	Modifier	Type
email	readonly	string
password	readonly	string
rememberMe	readonly	true

---

Plant

Properties

Property	Modifier	Type
gw	readonly	string
name	readonly	string
wheType	readonly	WheType

---

PlantData

Extends

• Readonly<Required<PostPlantData>>

Properties

Property	Modifier	Type	Inherited from
boostOn	readonly	boolean	Readonly.boostOn
comfortTemp	readonly	number	Readonly.comfortTemp
holidayUntil	readonly	null | string	Readonly.holidayUntil
hpState	readonly	number	Readonly.hpState
mode	readonly	Mode	Readonly.mode
on	readonly	boolean	Readonly.on
opMode	readonly	OperationMode	Readonly.opMode
waterTemp	readonly	number	-

---

PlantHeader

Properties

Property	Modifier	Type
data	readonly	{ errorText: string; errorType: number; }
data.errorText	public	string
data.errorType	public	number

---

PlantSettings

Properties

Property	Modifier	Type
antilegionellaOnOff	readonly	boolean
maxSetpointTemp	readonly	{ value: number; }
maxSetpointTemp.value	readonly	number
minSetpointTemp	readonly	{ value: number; }
minSetpointTemp.value	public	number
preHeatingOnOff	public	boolean

---

PostData

Properties

Property	Modifier	Type
plantData	readonly	PostPlantData
viewModel	readonly	ViewModel

---

PostPlantData

Extends

• BasePlantData

Properties

Property	Type	Inherited from
boostOn?	boolean	BasePlantData.boostOn
comfortTemp?	number	BasePlantData.comfortTemp
holidayUntil?	null | string	BasePlantData.holidayUntil
hpState?	number	BasePlantData.hpState
mode?	Mode	-
on?	boolean	BasePlantData.on
opMode?	OperationMode	BasePlantData.opMode

---

PostSettings

Properties

Property	Type
SlpAntilegionellaOnOff?	BasePostSettingsWithOld<Switch>
SlpMaxSetpointTemperature?	BasePostSettings<number>
SlpMinSetpointTemperature?	BasePostSettings<number>
SlpPreHeatingOnOff?	BasePostSettingsWithOld<Switch>

---

ReportData

Properties

Property	Modifier	Type
data	readonly	{ asKwhRaw: { histogramData: readonly HistogramData[]; }; }
data.asKwhRaw	public	{ histogramData: readonly HistogramData[]; }
data.asKwhRaw.histogramData	public	readonly HistogramData[]

---

SettingManager

Properties

Property	Type
get	<K>(key: K) => undefined | null | APISettings[K]
set	<K>(key: K, value: APISettings[K]) => void

---

Success

Properties

Property	Modifier	Type
message	readonly	null
ok	readonly	true

---

ViewModel

Extends

• BasePlantData

Properties

Property	Type	Inherited from
boostOn?	boolean	BasePlantData.boostOn
comfortTemp?	number	BasePlantData.comfortTemp
holidayUntil?	null | string	BasePlantData.holidayUntil
hpState?	number	BasePlantData.hpState
on?	boolean	BasePlantData.on
opMode?	OperationMode	BasePlantData.opMode
plantMode?	Mode	-

Type Aliases

GetData<T>

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

Type parameters

Type parameter
T extends PlantSettings | null

Source

src/types.ts:85

---

LoginData

type LoginData: Failure | Success;

Source

src/types.ts:44