diff --git a/source/_components/binary_sensor.hydrawise.markdown b/source/_components/binary_sensor.hydrawise.markdown deleted file mode 100644 index 9ec42c031aa..00000000000 --- a/source/_components/binary_sensor.hydrawise.markdown +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -title: "Hunter Hydrawise Binary Sensor" -description: "Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant." -date: 2018-04-11 08:02 -sidebar: true -comments: false -sharing: true -footer: true -logo: hydrawise_logo.png -ha_category: Irrigation -ha_release: 0.71 -ha_iot_class: Cloud Polling ---- - -Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. - -## {% linkable_title Configuration %} - -Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: hydrawise -``` - -{% configuration %} -monitored_conditions: - description: The binary sensors that should be displayed on the frontend. - required: false - type: list - default: All binary sensors are enabled. - keys: - is_watering: - description: The binary sensor is `on` when the zone is actively watering. - rain_sensor: - description: Is `on` when the rain_sensor (if installed on the controller) is active (wet). - status: - description: This will indicate `on` when there is a connection to the Hydrawise cloud. It is not an indication of whether the irrigation controller hardware is online. -{% endconfiguration %} - -Finish the configuration by visiting the [Hydrawise sensor](/components/sensor.hydrawise/) and [Hydrawise switch](/components/switch.hydrawise/) documentation. diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index f864bee1a70..7020eda923c 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -8,13 +8,27 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Irrigation +ha_category: + - Irrigation + - Binary Sensor + - Sensor + - Switch ha_release: 0.71 ha_iot_class: Cloud Polling +redirect_from: + - /components/binary_sensor.hydrawise/ + - /components/sensor.hydrawise/ + - /components/switch.hydrawise/ --- The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Sensor](#sensor) +- [Switch](#switch) + ## {% linkable_title Configuration %} To enable it, add the following to your `configuration.yaml` file: @@ -39,4 +53,98 @@ scan_interval: To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/account) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`. -Finish the configuration by visiting the [Hydrawise binary sensor](/components/binary_sensor.hydrawise/), [Hydrawise sensor](/components/sensor.hydrawise/) and [Hydrawise switch](/components/switch.hydrawise/) documentation. +## {% linkable_title Binary Sensor %} + +Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: hydrawise +``` + +{% configuration %} +monitored_conditions: + description: The binary sensors that should be displayed on the frontend. + required: false + type: list + default: All binary sensors are enabled. + keys: + is_watering: + description: The binary sensor is `on` when the zone is actively watering. + rain_sensor: + description: Is `on` when the rain_sensor (if installed on the controller) is active (wet). + status: + description: This will indicate `on` when there is a connection to the Hydrawise cloud. It is not an indication of whether the irrigation controller hardware is online. +{% endconfiguration %} + +## {% linkable_title Sensor %} + +Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: hydrawise +``` + +{% configuration %} +monitored_conditions: + description: The sensors that should be displayed on the frontend. + required: false + type: list + default: All sensors are enabled. + keys: + watering_time: + description: The amount of time left if the zone is actively watering. Otherwise the time is 0. + next_cycle: + description: The day and time when the next scheduled automatic watering cycle will start. If the zone is suspended then the value will be `NS` to indicate Not Scheduled. + {% endconfiguration %} + +## {% linkable_title Switch %} + +Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: hydrawise +``` + +{% configuration %} +watering_minutes: + description: When manual watering is enabled this will determine the length of time in minutes that the irrigation zone will run. The allowed values are 5, 10, 15, 30, 45, or 60. + required: false + type: integer + default: 15 +monitored_conditions: + description: Selects the set of switches that should be enabled on the frontend. Also sets the length of time a zone will run under manual control. + required: false + type: list + default: All switches are enabled. + keys: + auto_watering: + description: Enables the Smart Watering features for this zone. + manual_watering: + description: Enables the manual watering control for this zone. +{% endconfiguration %} + +### {% linkable_title Switch Operation %} + +When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year. + +When `manual_watering` is `on` the zone will run for the amount of time set by `watering_minutes`. + +```yaml +# An example that enables all the switches, and sets the manual watering time to 20 minutes. +switch: + - platform: hydrawise + watering_minutes: 20 +``` + +```yaml +# An example that enables only the manual control switches. +switch: + - platform: hydrawise + monitored_conditions: manual_watering +``` \ No newline at end of file diff --git a/source/_components/sensor.hydrawise.markdown b/source/_components/sensor.hydrawise.markdown deleted file mode 100644 index 6268b188504..00000000000 --- a/source/_components/sensor.hydrawise.markdown +++ /dev/null @@ -1,42 +0,0 @@ ---- -layout: page -title: "Hunter Hydrawise Sensor" -description: "Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant." -date: 2018-04-11 08:02 -sidebar: true -comments: false -sharing: true -footer: true -logo: hydrawise_logo.png -ha_category: Irrigation -ha_release: 0.71 -ha_iot_class: Cloud Polling ---- - -Before setting up the [Hunter Hydrawise](https://hydrawise.com) sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. - -## {% linkable_title Configuration %} - -Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: hydrawise -``` - -{% configuration %} - -monitored_conditions: - description: The sensors that should be displayed on the frontend. - required: false - type: list - default: All sensors are enabled. - keys: - watering_time: - description: The amount of time left if the zone is actively watering. Otherwise the time is 0. - next_cycle: - description: The day and time when the next scheduled automatic watering cycle will start. If the zone is suspended then the value will be `NS` to indicate Not Scheduled. - {% endconfiguration %} - -Finish the configuration by visiting the [Hydrawise binary sensor](/components/binary_sensor.hydrawise/) and [Hydrawise switch](/components/switch.hydrawise/) documentation. diff --git a/source/_components/switch.hydrawise.markdown b/source/_components/switch.hydrawise.markdown deleted file mode 100644 index 2fc830e844c..00000000000 --- a/source/_components/switch.hydrawise.markdown +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: page -title: "Hunter Hydrawise Switch" -description: "Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant." -date: 2018-04-11 08:02 -sidebar: true -comments: false -sharing: true -footer: true -logo: hydrawise_logo.png -ha_category: Irrigation -ha_release: 0.71 -ha_iot_class: Cloud Polling ---- - -Before setting up the [Hunter Hydrawise](https://hydrawise.com) switches please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. - -## {% linkable_title Configuration %} - -Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -switch: - - platform: hydrawise -``` - -{% configuration %} -watering_minutes: - description: When manual watering is enabled this will determine the length of time in minutes that the irrigation zone will run. The allowed values are 5, 10, 15, 30, 45, or 60. - required: false - type: integer - default: 15 -monitored_conditions: - description: Selects the set of switches that should be enabled on the frontend. Also sets the length of time a zone will run under manual control. - required: false - type: list - default: All switches are enabled. - keys: - auto_watering: - description: Enables the Smart Watering features for this zone. - manual_watering: - description: Enables the manual watering control for this zone. -{% endconfiguration %} - -### {% linkable_title Switch Operation %} - -When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year. - -When `manual_watering` is `on` the zone will run for the amount of time set by `watering_minutes`. - -```yaml -# An example that enables all the switches, and sets the manual watering time to 20 minutes. -switch: - - platform: hydrawise - watering_minutes: 20 -``` - -```yaml -# An example that enables only the manual control switches. -switch: - - platform: hydrawise - monitored_conditions: manual_watering -``` - -Finish the configuration by visiting the [Hydrawise binary sensor](/components/binary_sensor.hydrawise) and [Hydrawise sensor](/components/sensor.hydrawise/) documentation.