From a357654713a1d94d751cd6f4877f18f42782613e Mon Sep 17 00:00:00 2001 From: Jess Date: Thu, 7 Nov 2019 10:30:44 +0000 Subject: [PATCH] Add switches (on/off) for geniushub outlets (#11095) * Update docs for https://github.com/home-assistant/home-assistant/pull/28182 * initial improvements * Update geniushub.markdown * Update geniushub.markdown * Update geniushub.markdown --- source/_integrations/geniushub.markdown | 39 ++++++++++++++++++------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown index afea22c9b81..488351ed483 100644 --- a/source/_integrations/geniushub.markdown +++ b/source/_integrations/geniushub.markdown @@ -7,24 +7,32 @@ ha_category: - Water Heater - Sensor - Binary Sensor + - Switch ha_release: 0.92 ha_iot_class: Local Polling --- The `geniushub` integration links Home Assistant with your Genius Hub CH/DHW system, including its zones, devices, and issues. -It uses the [geniushub](https://pypi.org/project/geniushub-client/) client library, which provides data compatible with the v1 API that _may not_ necessarily match that of the official Web App. +It uses the [geniushub](https://pypi.org/project/geniushub-client/) client library, which provides data compatible with the v1 API that _may not_ exactly match that of the official Web App. ### Zones Each zone controlled by your Genius Hub will be exposed as either a: -- `Climate` entity, for **Radiator** and **Wet Underfloor** Zones, and -- `Water Heater` entity, for **Hot Water Temperature** Zones +- `Climate` entity, for **Radiator** and **Wet Underfloor** zones, and +- `Water Heater` entity, for **Hot Water Temperature** zones and +- `Switch` entity, for **On/Off** zones -Other zone types, such as **On/Off** zones, are not currently supported (although see `Binary Sensor`s, below). +**Group** zones are not supported. -Each entity derived from a GH zone will report back its mode, setpoint and current temperature; other properties are available via its attributes (see below). The zone's mode can be changed as below. +Currently, there is no support for altering zone schedules, although entities can be switched to/from geniushub modes that utilize schedules. + +There are limitations due to the differences between the Genius Hub and Home Assisatnt schemas (e.g. HA has no **Footprint** mode) - see below for more details. + +### Climate and Water Heater Entities + +Climate and Water Heater entities will report their current temperature, setpoint and mode; other properties (e.g. occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to: GH mode | HA Operation | HA Preset :---: | :---: | :---: @@ -33,18 +41,27 @@ GH mode | HA Operation | HA Preset **Override** | Heat | Boost **Footprint** | Heat | Activity +Note that `Boost` mode may + Note that **Footprint** mode is only available to **Radiator** zones that have room sensors. -Currently, there is no support for reading/altering zone schedules, although a zone can be switched to/from modes that utilize schedules. +### Switch Entities + +Switch entities will report back their state; other properties are available via their state attributes. Currently, HA switches do not have modes/presets, so the Home Assistant state will be reported as: + +- `On` for **Override** \ **On**, and +- `Off` otherwise (NB: the zone could still be 'on', e.g. with **Timer** mode) + +If you turn a Switch entity `Off` via HA, it will revert to **Timer** mode. ### Devices -Each Device controlled by your Genius hub will be exposed as either a: +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., Smart Plugs, DCRs) -Each such entity will report back its primary state and `assigned_zone`. If the Hub is directly polled using Option 1 (see below), then some additional attributes such as `last_comms` (last communications time) are also available. +Such entities will report back their primary state and `assigned_zone`. If the Hub is directly polled using Option 1 (see below), then some additional state attributes such as `last_comms` (last communications time) are also available. ### Issues @@ -89,7 +106,7 @@ This alert may be useful to see if the CH is being turned on whilst you're on a ## State Attributes -Many zone/device properties are available via each entity's state attributes. For example, in the case of **Radiator**-derived `Climate` entities (note 'status'): +Many zone/device properties are available via the corresponding entity's state attributes. For example, in the case of **Radiator**-derived `Climate` entities (note 'status'): ```json { @@ -148,9 +165,9 @@ This is the recommended option. - Requires your **username** & **password**, as used with [geniushub.co.uk/app](https://www.geniushub.co.uk/app). - 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). -- You have the option of specifying a MAC address. +- You have the option of specifying a MAC address (not recommended, see above). -The hub does not have to be in the same subnet as HA. +The hub does not have to be in the same subnet as your Home Assistant server. ### Option 2: hub token only