From 3c9c2e1082a91fdf8b592b38ac0610b4ff5131f2 Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Thu, 20 Jun 2019 18:57:53 +0200 Subject: [PATCH 1/5] Add documentation for integration of Vallox ventilation units. --- source/_components/vallox.markdown | 109 +++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 source/_components/vallox.markdown diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown new file mode 100644 index 000000000000..c4418f5598d6 --- /dev/null +++ b/source/_components/vallox.markdown @@ -0,0 +1,109 @@ +--- +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.95 +ha_iot_class: Local Polling +redirect_from: + - /components/fan.vallox/ + - /components/sensor.vallox/ +--- + +The `vallox` component 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 component's fan platform allows you to either turn on/off the complete unit via toggle switch, or select a ventilation profile from a dropdown menu and therefore indirectly the fan speed. 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 %} + +## Fan Services + +### {% linkable_title Service `fan.vallox_set_profile_fan_speed_home` %} + +Set the fan speed of the `Home` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | + + +### {% linkable_title Service `fan.vallox_set_profile_fan_speed_away` %} + +Set the fan speed of the `Away` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | + +### {% linkable_title Service `fan.vallox_set_profile_fan_speed_boost` %} + +Set the fan speed of the `Boost` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | + +## Sensors + +The following sensors are available: + +- `fan_speed` +- `temp_extract_air` +- `temp_exhaust_air` +- `temp_outdoor_air` +- `temp_supply_air` +- `humidity` +- `remaining_time_filter` + +To activate _all_ sensors, add `sensors:` to your configuration: + +```yaml +vallox: + host: IP_ADDRESS + sensors: +``` + +In case you only want a subset, provide a reduced list of your choice, e.g.: + +```yaml +vallox: + host: IP_ADDRESS + sensors: + - fan_speed + - temp_outdoor_air + - temp_supply_air +``` From 81cfa26d17a08f3c8d1535a1e4e52d9061ebb265 Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Thu, 20 Jun 2019 23:01:06 +0200 Subject: [PATCH 2/5] Address review comments #1. --- source/_components/vallox.markdown | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown index c4418f5598d6..e23d2c0cbc66 100644 --- a/source/_components/vallox.markdown +++ b/source/_components/vallox.markdown @@ -10,11 +10,8 @@ footer: true ha_category: - Fan - Sensor -ha_release: 0.95 +ha_release: 0.96 ha_iot_class: Local Polling -redirect_from: - - /components/fan.vallox/ - - /components/sensor.vallox/ --- The `vallox` component 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). @@ -45,9 +42,14 @@ name: required: false default: Vallox type: string +sensors: + description: Include sensor reports. Optionally, provide a list of specific sensors. + required: false + default: All sensors. + type: list {% endconfiguration %} -## Fan Services +## {% linkable_title Fan Services %} ### {% linkable_title Service `fan.vallox_set_profile_fan_speed_home` %} @@ -77,7 +79,7 @@ Set the fan speed of the `Boost` profile. | `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | -## Sensors +## {% linkable_title Sensors %} The following sensors are available: From e20cd90a995f66d379285dab6344987914652569 Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Fri, 21 Jun 2019 07:28:24 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-Authored-By: Franck Nijhof --- source/_components/vallox.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown index e23d2c0cbc66..41b2292bcdbd 100644 --- a/source/_components/vallox.markdown +++ b/source/_components/vallox.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `vallox` component 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 component's fan platform allows you to either turn on/off the complete unit via toggle switch, or select a ventilation profile from a dropdown menu and therefore indirectly the fan speed. The four standard Vallox profiles are provided: +The component's fan platform allows you to either turn on/off the complete unit via the toggle switch or select a ventilation profile from a dropdown menu and therefore indirectly the fan speed. The four standard Vallox profiles are provided: - `At Home` - `Away` @@ -25,7 +25,7 @@ The component's fan platform allows you to either turn on/off the complete unit Also, there is a sensor platform that exposes a number of relevant metrics like fan speed, various air temperatures and humidity. -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} ```yaml vallox: @@ -57,7 +57,7 @@ Set the fan speed of the `Home` profile. | Service data attribute | Optional | Description | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | @@ -67,7 +67,7 @@ Set the fan speed of the `Away` profile. | Service data attribute | Optional | Description | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | ### {% linkable_title Service `fan.vallox_set_profile_fan_speed_boost` %} @@ -76,7 +76,7 @@ Set the fan speed of the `Boost` profile. | Service data attribute | Optional | Description | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entitiy id of the fan, e.g.`fan.vallox`. | +| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | ## {% linkable_title Sensors %} From b33f53092841acd9eaec2081f414cf5d13fce23a Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Tue, 25 Jun 2019 14:20:57 +0200 Subject: [PATCH 4/5] Adapt to changed architecture of parent patch. --- source/_components/vallox.markdown | 87 +++++++++++++++--------------- 1 file changed, 42 insertions(+), 45 deletions(-) diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown index 41b2292bcdbd..c6c9ea33fb3d 100644 --- a/source/_components/vallox.markdown +++ b/source/_components/vallox.markdown @@ -16,16 +16,16 @@ ha_iot_class: Local Polling The `vallox` component 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 component's fan platform allows you to either turn on/off the complete unit via the toggle switch or select a ventilation profile from a dropdown menu and therefore indirectly the fan speed. The four standard Vallox profiles are provided: +The component's **fan** platform 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. +Also, there is a **sensor** platform that exposes a number of relevant metrics like fan speed, various air temperatures and humidity. -## {% linkable_title Configuration %} +### {% linkable_title Configuration %} ```yaml vallox: @@ -42,70 +42,67 @@ name: required: false default: Vallox type: string -sensors: - description: Include sensor reports. Optionally, provide a list of specific sensors. - required: false - default: All sensors. - type: list {% 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 `fan.vallox_set_profile_fan_speed_home` %} +### {% 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 | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | -### {% linkable_title Service `fan.vallox_set_profile_fan_speed_away` %} +### {% linkable_title Service `vallox.set_profile_fan_speed_away` %} Set the fan speed of the `Away` profile. | Service data attribute | Optional | Description | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | -### {% linkable_title Service `fan.vallox_set_profile_fan_speed_boost` %} +### {% linkable_title Service `vallox.set_profile_fan_speed_boost` %} Set the fan speed of the `Boost` profile. | Service data attribute | Optional | Description | |------------------------|----------|-------------------------------------------------| -| `entity_id` | no | Entity id of the fan, e.g., `fan.vallox`. | | `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | - -## {% linkable_title Sensors %} - -The following sensors are available: - -- `fan_speed` -- `temp_extract_air` -- `temp_exhaust_air` -- `temp_outdoor_air` -- `temp_supply_air` -- `humidity` -- `remaining_time_filter` - -To activate _all_ sensors, add `sensors:` to your configuration: - -```yaml -vallox: - host: IP_ADDRESS - sensors: -``` - -In case you only want a subset, provide a reduced list of your choice, e.g.: - -```yaml -vallox: - host: IP_ADDRESS - sensors: - - fan_speed - - temp_outdoor_air - - temp_supply_air -``` From 3d7e48b53587ddbcd8e7a08af51d0fa227cd5dce Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 28 Jun 2019 21:27:33 +0200 Subject: [PATCH 5/5] :pencil2: Component -> Integration --- source/_components/vallox.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown index c6c9ea33fb3d..08d229ea82a6 100644 --- a/source/_components/vallox.markdown +++ b/source/_components/vallox.markdown @@ -14,9 +14,9 @@ ha_release: 0.96 ha_iot_class: Local Polling --- -The `vallox` component 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 `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 component's **fan** platform 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: +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`