diff --git a/source/_components/geniushub.markdown b/source/_components/geniushub.markdown index 00789f70031..23aa01aa395 100644 --- a/source/_components/geniushub.markdown +++ b/source/_components/geniushub.markdown @@ -11,17 +11,47 @@ logo: geniushub.png ha_category: - Climate - Water heater + - Sensor + - Binary sensor ha_release: 0.92 ha_iot_class: Local Polling --- -The `geniushub` integration links Home Assistant with your Genius Hub (the hub does not have to be in the same network as HA). +The `geniushub` integration links Home Assistant with your Genius Hub for controlling its Zones and Devices. Currently, there is no support for Zone schedules. -Currently only **Radiator** and **Hot Water Temperature** zones are supported. Within HA, each **Radiator** zone will appear as a `Climate` device, and each **Hot Water Temperature** zone will appear as a `WaterHeater` device. +It uses the [geniushub-client](https://pypi.org/project/geniushub-client/) library. -The device'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. +### {% linkable_title Zones %} -Other properties are available via the device's state attributes, which includes a JSON data structure called `status`. For example, in the case of **Radiator** zones/`Climate` devices: +Each Zone controlled by your Genius hub will be exposed as either a: + + - `Climate` entity, for **Radiator** Zones, and + - `Water Heater`, for **Hot Water Temperature** Zones + +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). + +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. + +### {% linkable_title Devices %} + +If the Hub is directly polled using the v3 API (see below), then each Device controlled by your Genius hub will be exposed as either a: + + - `Sensor` entity with a % battery, for any Device with a battery (e.g. a Genius Valve), or + - `Binary Sensor` entity with on/off state for any Device that is a switch (e.g. a Smart Plug) + +Each such entity will report back its primary state; in addition, `assigned_zone` and `last_comms` (last communications time) are available via the entity's attributes. + +### {% linkable_title Issues %} + +There are three `Sensor` entities that will indicate the number of **Errors**, **Warnings** and **Information** issues. + +Each such entity has a state attribute that will contain a list of any such issues. For example, `error_list`. + +### {% linkable_title State Attributes %} + +Other properties are available via each entity's state attributes. For example, in the case of **Radiator** Zones/`Climate` devices: ```json { @@ -35,7 +65,6 @@ Other properties are available via the device's state attributes, which includes } } } - ``` This data can be accessed in automations, etc. via a value template. For example: @@ -54,8 +83,6 @@ value_template: "{{ state_attr('climate.main_room', 'status').occupied }}" ``` {% endraw %} -Currently, there is no support for modifying schedules and neither do they appear in the state attributes. - ## {% linkable_title Configuration %} To add your Genius Hub into your Home Assistant installation, add one of the following to your `configuration.yaml` file.