diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index f1532ff16f5..31b2c6df5c0 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -9,6 +9,7 @@ ha_category: - Light - Sensor - Switch + - Water Heater ha_release: 0.59 ha_iot_class: Cloud Polling redirect_from: @@ -19,18 +20,22 @@ redirect_from: - /components/switch.hive/ --- -The `hive` integration is the main integration to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. +The `hive` integration is the main integration to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all Hive devices into Home Assistant, including support for multi-zone heating. This integration uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive integration in Home Assistant. -There is currently support for the following device types within Home Assistant: +There is currently support for the following services and platforms within Home Assistant: -- [Binary Sensor](#Binary-Sensor) -- [Climate](#Climate) -- [Light](#Light) -- [Sensor](#Sensor) -- [Switch](#Switch) -- [Water Heater](#Water-Heater) +- [Services](#services) + - [Service `hive.boost_heating`](#service-hiveboostheating) + - [Service `hive.boost_hot_water`](#service-hiveboosthotwater) +- [Platforms](#platforms) + - [Binary Sensor](#binary-sensor) + - [Climate](#climate) + - [Light](#light) + - [Sensor](#sensor) + - [Switch](#switch) + - [Water Heater](#water-heater) To add your Hive devices into your Home Assistant installation, add the following to your `configuration.yaml` file: @@ -57,7 +62,65 @@ scan_interval: default: 2 {% endconfiguration %} -## Binary Sensor +## Services + +### Service `hive.boost_heating` + +You can use the service `hive.boost_heating` to set your heating to boost for a period of time at a certain target temperature". + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------------------- | +| `entity_id` | no | String, Name of entity e.g., `climate.heating` | +| `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` | +| `temperature` | yes | String, The required target temperature e.g., `20.5` | + +Examples: + +```yaml +# Example script to boost heating, boost period and target temperature specified. +script: + boost_heating: + sequence: + - service: hive.boost_heating + data: + entity_id: "climate.heating" + time_period: "01:30:00" + temperature: "20.5" +``` + +### Service `hive.boost_hot_water` + +You can use the service `hive.boost_hot_water` to set your hot water to boost for a period of time. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------- | +| `entity_id` | no | String, Name of entity e.g., `water_heater.hot_water` | +| `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00`. | +| `on_off` | no | String, The mode to set the boost to on or odd e.g., `on` | + +Examples: + +```yaml +# Example script to boost hot water, boost period specified +script: + boost_hot_water: + sequence: + - service: "hive.boost_hot_water" + data: + entity_id: "water_heater.hot_water" + time_period: "01:30:00" + on_off: "on" +``` + +## Platforms + +