Skip to content

Commit

Permalink
Adapt to changed architecture of parent patch.
Browse files Browse the repository at this point in the history
  • Loading branch information
andre-richter committed Jun 25, 2019
1 parent e20cd90 commit b33f530
Showing 1 changed file with 42 additions and 45 deletions.
87 changes: 42 additions & 45 deletions source/_components/vallox.markdown
Expand Up @@ -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:
Expand All @@ -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
```

0 comments on commit b33f530

Please sign in to comment.