diff --git a/source/_components/climate.econet.markdown b/source/_components/water_heater.econet.markdown similarity index 60% rename from source/_components/climate.econet.markdown rename to source/_components/water_heater.econet.markdown index 704c6ebf0ee..5ac129c4c38 100644 --- a/source/_components/climate.econet.markdown +++ b/source/_components/water_heater.econet.markdown @@ -8,20 +8,22 @@ comments: false sharing: true footer: true logo: econet.png -ha_category: Climate +ha_category: Water heater ha_release: 0.61.0 ha_iot_class: "Cloud Polling" +redirect_from: /components/climate.econet/ --- -The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This component allows you to set the temperature, the operation mode, and enable vaction mode. +The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vaction mode. -To enable the `econet` water heater platform add the following to your config. +## {% linkable_title Configuration %} +To enable the `econet` water heater platform, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry -climate: +water_heater: - platform: econet username: YOUR_ECONET_EMAIL password: YOUR_ECONET_PASSWORD @@ -38,10 +40,9 @@ password: type: string {% endconfiguration %} +### {% linkable_title Service `econet.add_vacation` %} -### {% linkable_title Service `econet_add_vacation` %} - -You can use the service econet/add_vacation to create a new vacation for your EcoNet water heaters. +You can use the service `econet.add_vacation` to create a new vacation for your EcoNet water heaters. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -50,15 +51,17 @@ You can use the service econet/add_vacation to create a new vacation for your Ec | `end_date` | yes | this is a Unix timestamp for when the vaction should end.

-The Unix timestamps can be obtained from the input_datetime component. This will allow you to graphically set the start and end date. +The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.

-### {% linkable_title Service `econet_delete_vacation` %} +### {% linkable_title Service `econet.delete_vacation` %} -You can use the service econet/delete_vacation to remove all vactions from an EcoNet water heater. +You can use the service `econet.delete_vacation` to remove all vactions from an EcoNet water heater. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | The entity id of the water heater to remove the vaction from. - +

+Econet water heaters use to live under the `climate` platform prior to release 0.81. +

diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown new file mode 100644 index 00000000000..56917dcc57b --- /dev/null +++ b/source/_components/water_heater.markdown @@ -0,0 +1,120 @@ +--- +layout: page +title: "Water Heater" +description: "Instructions on how to setup water heater devices within Home Assistant." +date: 2018-10-10 19:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + + +The `water_heater` component is built for the controlling and monitoring of hot water heaters. + +To enable this component, pick one of the platforms, and add it to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +water_heater: + platform: demo +``` + +## {% linkable_title Services %} + +### {% linkable_title Water heater control services %} +Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode` + +

+Not all water heater services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**. +

+ +### {% linkable_title Service `water_heater.set_temperature` %} + +Set target temperature of water heater device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. +| `temperature` | no | New target temperature for water heater +| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly. + +#### {% linkable_title Automation example %} + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: water_heater.set_temperature + data: + entity_id: water_heater.demo + temperature: 24 + operation_mode: eco +``` + +### {% linkable_title Service `water_heater.set_operation_mode` %} + +Set operation mode for water heater device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. +| `operation_mode` | no | New value of operation mode + +#### {% linkable_title Automation example %} + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: water_heater.set_operation_mode + data: + entity_id: water_heater.demo + operation_mode: eco +``` + +### {% linkable_title Service `water_heater.turn_away_mode_on` %} + +Turn away mode on for water heater device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. + +#### {% linkable_title Automation example %} + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: water_heater.turn_away_mode_on + data: + entity_id: water_heater.demo +``` + +### {% linkable_title Service `water_heater.turn_away_mode_off` %} + +Trun away mode off for water heater device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. + +#### {% linkable_title Automation example %} + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: water_heater.turn_away_mode_off + data: + entity_id: water_heater.demo +``` \ No newline at end of file