Update Vallox documentation (#21671)

This commit is contained in:
Andre Richter 2022-02-17 21:36:31 +01:00 committed by GitHub
parent a059ffcdda
commit cc9ff69bc9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,20 +9,18 @@ ha_release: 0.96
ha_iot_class: Local Polling
ha_domain: vallox
ha_platforms:
- binary_sensor
- fan
- sensor
ha_codeowners:
- '@andre-richter'
- '@slovdahl'
- '@viiru-'
---
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`
The **fan** platform of this integration allows you to turn on/off the complete unit via the toggle switch and to select a ventilation profile.
Also, there is a **sensor** platform that exposes a number of relevant metrics like fan speed, various air temperatures and humidity.
@ -30,65 +28,17 @@ Also, there is a **sensor** platform that exposes a number of relevant metrics l
## Profile Switching
For convenient switching of ventilation profiles in the GUI, consider using an [input_select](../input_select) hooked to an automation, for example:
For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan entity to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
{% raw %}
The four standard Vallox profiles are supported:
```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:
profile: "{{ states('input_select.ventilation_profile') }}"
```
{% endraw %}
In order to also update the input select in case some external event changes the Vallox profile (web interface, mechanical switch, reboot, etc...) you can use the following automation:
{% raw %}
```yaml
automation:
- alias: "Update Vallox input_select"
description: Update input_select when external event changes the profile
trigger:
- entity_id: sensor.vallox_current_profile
platform: state
action:
- service: input_select.select_option
target:
entity_id: input_select.ventilation_profile
data:
option: "{{ states('sensor.vallox_current_profile') }}"
```
{% endraw %}
- `At Home`
- `Away`
- `Boost`
- `Fireplace`
## Fan Services
### Service `vallox.set_profile`
Set the ventilation profile.
| Service data attribute | Optional | Description |
|------------------------|----------|------------------------------------------------------|
| `profile` | no | Allowed values: `Home`, `Away`, `Boost`, `Fireplace` |
### Service `vallox.set_profile_fan_speed_home`
Set the fan speed of the `Home` profile.