https://github.com/danielbayerlein/vallox-api

📚 API for Vallox ventilation units
https://github.com/danielbayerlein/vallox-api

api iot modbus vallox ventilation

Last synced: 3 months ago
JSON representation

📚 API for Vallox ventilation units

• Host: GitHub
• URL: https://github.com/danielbayerlein/vallox-api
• Owner: danielbayerlein
• License: mit
• Created: 2018-12-31T19:46:24.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T06:37:18.000Z (11 months ago)
• Last Synced: 2024-10-14T07:44:46.997Z (3 months ago)
• Topics: api, iot, modbus, vallox, ventilation
• Language: JavaScript
• Homepage:
• Size: 294 KB
• Stars: 14
• Watchers: 9
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# vallox-api

[![npm version](https://badge.fury.io/js/%40danielbayerlein%2Fvallox-api.svg)](https://badge.fury.io/js/%40danielbayerlein%2Fvallox-api)

[![Actions Status](https://github.com/danielbayerlein/vallox-api/workflows/CI/badge.svg)](https://github.com/danielbayerlein/vallox-api/actions)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=danielbayerlein/vallox-api)](https://dependabot.com)

API for [Vallox](https://www.vallox.com) ventilation units

## Installation

```bash

# 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.

```javascript

import Vallox from '@danielbayerlein/vallox-api'

const client = new Vallox({ ip: '192.168.178.33', port: 80 })

```

[Example](./examples/getProfile.js)

### `.PROFILES`

Returns an object with the profile mapping.

```javascript

client.PROFILES

```

[Example](./examples/getProfile.js)

### `.getProfile()`

Returns the current profile id.

```javascript

await client.getProfile()

```

[Example](./examples/getProfile.js)

### `.fetchMetric(string)`

Returns the value of the metric key.

```javascript

await client.fetchMetric('A_CYC_FAN_SPEED')

```

[Example](./examples/fetchMetric.js)

### `.fetchMetrics(array[string])`

Returns an array with the values if the metric keys.

```javascript

await client.fetchMetrics([

  'A_CYC_TEMP_EXHAUST_AIR',

  'A_CYC_TEMP_OUTDOOR_AIR'

])

```

[Example](./examples/fetchMetrics.js)

### `.setProfile(int, int)`

Sets the profile.

```javascript

// 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)

```

[Example](./examples/setProfile.js)

### `.setValues(object{string: int})`

Sets the value for the metric key.

```javascript

await client.setValues({

  'A_CYC_HOME_SPEED_SETTING': 60

})

```

[Example](./examples/setValues.js)

## Supported units

* ValloPlus 350 MV

* ValloPlus 240-E MV

* _Please add your tested unit_

## Credits

* [yozik04/vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api)

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new [Pull Request](../../pull/new/master)

## Copyright

Copyright (c) 2019-present Daniel Bayerlein. See [LICENSE](./LICENSE.md) for details.