Skip to content
ariston-api / 1.0.0

ariston-api 1.0.0

Install from the command line:
Learn more about npm packages
$ npm install @olivierzal/ariston-api@1.0.0
Install via package.json:
"@olivierzal/ariston-api": "1.0.0"

About this version

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(settingManager: SettingManager, logger: Logger): default
Parameters
Parameter Type Default value
settingManager SettingManager undefined
logger Logger console
Returns

default

Source

src/lib/AristonAPI.ts:57

Methods

applyLogin()
applyLogin(data?: LoginCredentials): Promise<boolean>
Parameters
Parameter Type
data? LoginCredentials
Returns

Promise<boolean>

Source

src/lib/AristonAPI.ts:69

login()
login(postData: LoginPostData): Promise<{
  "data": LoginData;
}>
Parameters
Parameter Type
postData LoginPostData
Returns

Promise<{ "data": LoginData; }>

Member Type
data LoginData
Source

src/lib/AristonAPI.ts:88

plantData()
plantData(id: string, postData?: PostData): Promise<{
  "data": GetData;
}>
Parameters
Parameter Type
id string
postData? PostData
Returns

Promise<{ "data": GetData; }>

Member Type
data GetData
Source

src/lib/AristonAPI.ts:97

plantMetering()
plantMetering(id: string): Promise<{
  "data": ReportData;
}>
Parameters
Parameter Type
id string
Returns

Promise<{ "data": ReportData; }>

Member Type
data ReportData
Source

src/lib/AristonAPI.ts:111

plantSettings()
plantSettings(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:115

plants()
plants(): Promise<{
  "data": Plant[];
}>
Returns

Promise<{ "data": Plant[]; }>

Member Type
data Plant[]
Source

src/lib/AristonAPI.ts:125

Interfaces

APISettings

Properties

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

BaseData

Extended by

Properties

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

BasePostSettings<T>

Extended by

Type parameters

Type parameter
T

Properties

Property Modifier Type
new readonly T

BasePostSettingsWithOld<T>

Extends

Type parameters

Type parameter
T

Properties

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

GetData

Properties

Property Modifier Type
data readonly { "plantData": Readonly<Required<PostPlantData>> & { "procReqTemp": number; "waterTemp": number; }; "plantSettings": { "antilegionellaOnOff": boolean; "maxSetpointTemp": { "value": number; }; "minSetpointTemp": { "value": number; }; "preHeatingOnOff": boolean; }; "viewModel": Readonly<Required<ViewModel>>; }
data.plantData public Readonly<Required<PostPlantData>> & { "procReqTemp": number; "waterTemp": number; }
data.plantSettings? public { "antilegionellaOnOff": boolean; "maxSetpointTemp": { "value": number; }; "minSetpointTemp": { "value": number; }; "preHeatingOnOff": boolean; }
data.plantSettings.antilegionellaOnOff public boolean
data.plantSettings.maxSetpointTemp public { "value": number; }
data.plantSettings.maxSetpointTemp.value public number
data.plantSettings.minSetpointTemp public { "value": number; }
data.plantSettings.minSetpointTemp.value public number
data.plantSettings.preHeatingOnOff public boolean
data.viewModel public Readonly<Required<ViewModel>>

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

LoginData

Properties

Property Modifier Type
ok readonly boolean

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

PostData

Properties

Property Modifier Type
plantData readonly PostPlantData
viewModel readonly ViewModel

PostPlantData

Extends

Properties

Property Type Inherited from
boostOn? boolean BaseData.boostOn
comfortTemp? number BaseData.comfortTemp
holidayUntil? null | string BaseData.holidayUntil
mode? Mode -
on? boolean BaseData.on
opMode? OperationMode BaseData.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

ViewModel

Extends

Properties

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

Details

Assets

  • ariston-api-1.0.0.tgz

Download activity

  • Total downloads 8
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all