Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for integration of Vallox ventilation units #9668

Merged
merged 5 commits into from Jun 28, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
108 changes: 108 additions & 0 deletions source/_components/vallox.markdown
@@ -0,0 +1,108 @@
---
layout: page
title: "Vallox Ventilation Units"
description: "Instructions on how to integrate Vallox ventilation units into Home Assistant."
date: 2019-06-19 20:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category:
- Fan
- Sensor
ha_release: 0.96
ha_iot_class: Local Polling
---
frenck marked this conversation as resolved.
Show resolved Hide resolved

The `vallox` integration lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units).

The **fan** platform of this integration allows you to either turn on/off the complete unit via the toggle switch or select a ventilation profile through the service `vallox/set_profile`. The four standard Vallox profiles are provided:

- `At Home`
- `Away`
- `Boost`
- `Fireplace`

Also, there is a **sensor** platform that exposes a number of relevant metrics like fan speed, various air temperatures and humidity.

### {% linkable_title Configuration %}
andre-richter marked this conversation as resolved.
Show resolved Hide resolved

```yaml
vallox:
host: IP_ADDRESS
```

{% configuration %}
klaasnicolaas marked this conversation as resolved.
Show resolved Hide resolved
host:
description: The IP or hostname of the ventilation unit in your home network.
required: true
type: string
name:
description: The name of this device as you want to see it in Home Assistant.
required: false
default: Vallox
type: string
{% endconfiguration %}

## {% linkable_title Profile Switching %}

For convenient switching of ventilation profiles in the GUI, consider using an [input_select](../input_select) hooked to an automation, for example:

{% raw %}
```yaml
input_select:
ventilation_profile:
name: Ventilation profile select
options:
- "Home"
- "Away"
- "Boost"
- "Fireplace"
icon: mdi:fan

automation:
- alias: Set Ventilation Profile
trigger:
platform: state
entity_id: input_select.ventilation_profile
action:
service: vallox.set_profile
data_template:
profile: "{{ states('input_select.ventilation_profile') }}"
```
{% endraw %}

## {% linkable_title Fan Services %}

### {% linkable_title Service `vallox.set_profile` %}

Set the ventilation profile.

| Service data attribute | Optional | Description |
|------------------------|----------|------------------------------------------------------|
| `profile` | no | Allowed values: `Home`, `Away`, `Boost`, `Fireplace` |

### {% linkable_title Service `vallox.set_profile_fan_speed_home` %}

Set the fan speed of the `Home` profile.

| Service data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |


### {% linkable_title Service `vallox.set_profile_fan_speed_away` %}

Set the fan speed of the `Away` profile.

| Service data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |

### {% linkable_title Service `vallox.set_profile_fan_speed_boost` %}

Set the fan speed of the `Boost` profile.

| Service data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |