mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
[climate] Migrate geniushub docs for climate-1.0 (#9818)
* initial commit * manual rebase * manual rebase * manual rebase 2 * add modes
This commit is contained in:
parent
451dd96e75
commit
8d87a621c9
@ -17,9 +17,11 @@ ha_release: 0.92
|
|||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The `geniushub` integration links Home Assistant with your Genius Hub for controlling its Zones and Devices, and visibility of any Issues. Currently, there is no support for Zone schedules.
|
The `geniushub` integration links Home Assistant with your Genius Hub CH/DHW system, including its Zones, Devices, and Issues.
|
||||||
|
|
||||||
It uses the [geniushub-client](https://pypi.org/project/geniushub-client/) library.
|
Currently, there is no support for Zone schedules.
|
||||||
|
|
||||||
|
It uses the [geniushub](https://pypi.org/project/geniushub-client/) client library.
|
||||||
|
|
||||||
### Zones
|
### Zones
|
||||||
|
|
||||||
@ -30,9 +32,16 @@ Each Zone controlled by your Genius hub will be exposed as either a:
|
|||||||
|
|
||||||
Other Zone types, such as **On / Off** Zones, are not currently supported.
|
Other Zone types, such as **On / Off** Zones, are not currently supported.
|
||||||
|
|
||||||
Each such entity will report back its mode, state, setpoint and current temperature; other properties are available via its attributes (see below).
|
Each such entity will report back its mode, state, setpoint and current temperature; other properties are available via its attributes (see below). The Zone's mode can changed as below.
|
||||||
|
|
||||||
In addition, the entity's mode and setpoint can be changed. The entity's `operating_mode` can be set to one of `off`, `timer`, `on` (i.e. **Override** mode) or `eco`. The `eco` mode is a proxy for the **Footprint** mode and so is only available to **Radiator** Zones that have room sensors.
|
GH mode | HA Operation | HA Preset
|
||||||
|
:---: | :---: | :---:
|
||||||
|
**Off** | Off | N/A
|
||||||
|
**Timer** | Heat | None
|
||||||
|
**Override** | Heat | Boost
|
||||||
|
**Footprint** | Heat | Activity
|
||||||
|
|
||||||
|
Note that **Footprint** mode is only available to **Radiator** Zones that have room sensors.
|
||||||
|
|
||||||
### Devices
|
### Devices
|
||||||
|
|
||||||
@ -102,7 +111,7 @@ value_template: "{{ state_attr('climate.main_room', 'status').occupied }}"
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To add your Genius Hub into your Home Assistant installation, add one of the following to your `configuration.yaml` file.
|
To set up this integration, add one of the following to your **configuration.yaml** file.
|
||||||
|
|
||||||
### Option 1: hub token only
|
### Option 1: hub token only
|
||||||
|
|
||||||
@ -122,6 +131,8 @@ geniushub:
|
|||||||
- uses the v3 API - unofficial, but there are additional features (e.g., battery levels)
|
- uses the v3 API - unofficial, but there are additional features (e.g., battery levels)
|
||||||
- polls the hub directly (so is faster, say ~1s response time)
|
- polls the hub directly (so is faster, say ~1s response time)
|
||||||
|
|
||||||
|
The hub does not have to be in the same network as HA.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry, directly polling the Hub
|
# Example configuration.yaml entry, directly polling the Hub
|
||||||
geniushub:
|
geniushub:
|
||||||
@ -130,8 +141,6 @@ geniushub:
|
|||||||
password: GENIUS_HUB_PASSWORD
|
password: GENIUS_HUB_PASSWORD
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that if a `host` is used instead of `token`, then the `username` and `password` are also required.
|
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
token:
|
token:
|
||||||
description: The Hub Token of the Genius Hub.
|
description: The Hub Token of the Genius Hub.
|
||||||
@ -150,3 +159,5 @@ password:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
Note that if a `host` is used instead of `token`, then the `username` and `password` are also required.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user