@danielbayerlein/vallox-api
v1.0.1
Published
API for Vallox ventilation units
Downloads
112
Maintainers
Readme
vallox-api
API for Vallox ventilation units
Installation
# npm
npm install @danielbayerlein/vallox-api --save
# Yarn
yarn add @danielbayerlein/vallox-api
Usage
new Vallox(object{ip: string, port: int})
Returns the client instance.
import Vallox from '@danielbayerlein/vallox-api'
const client = new Vallox({ ip: '192.168.178.33', port: 80 })
.PROFILES
Returns an object with the profile mapping.
client.PROFILES
.getProfile()
Returns the current profile id.
await client.getProfile()
.fetchMetric(string)
Returns the value of the metric key.
await client.fetchMetric('A_CYC_FAN_SPEED')
.fetchMetrics(array[string])
Returns an array with the values if the metric keys.
await client.fetchMetrics([
'A_CYC_TEMP_EXHAUST_AIR',
'A_CYC_TEMP_OUTDOOR_AIR'
])
.setProfile(int, int)
Sets the profile.
// Permanently AWAY profile
await client.setProfile(client.PROFILES.AWAY)
// FIREPLACE mode for configured timeout
await client.setProfile(client.PROFILES.FIREPLACE)
// FIREPLACE mode for 30 min
await client.setProfile(client.PROFILES.FIREPLACE, 30)
.setValues(object{string: int})
Sets the value for the metric key.
await client.setValues({
'A_CYC_HOME_SPEED_SETTING': 60
})
Supported units
- ValloPlus 350 MV
- Please add your tested unit
Credits
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Copyright
Copyright (c) 2019-present Daniel Bayerlein. See LICENSE for details.