mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Add documentation for integration of Vallox ventilation units (#9668)
* Add documentation for integration of Vallox ventilation units. * Address review comments #1. * Apply suggestions from code review Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Adapt to changed architecture of parent patch. * ✏️ Component -> Integration
This commit is contained in:
parent
727b1bb2a4
commit
e5b6d9cde9
108
source/_components/vallox.markdown
Normal file
108
source/_components/vallox.markdown
Normal file
@ -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
|
||||
---
|
||||
|
||||
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 %}
|
||||
|
||||
```yaml
|
||||
vallox:
|
||||
host: IP_ADDRESS
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
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. |
|
Loading…
x
Reference in New Issue
Block a user