mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Added water heater doc and moved econet to water heater (#6676)
* Added water heater doc and moved econet to water heater * Fixed services and added redirect * Fix redirect and typos
This commit is contained in:
William Scanlon
Fabian Affolter
parent
e9c4c36f78
commit
5fed8d57cd
@ -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.
|
||||
|
||||
<p class='note'>
|
||||
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.
|
||||
</p>
|
||||
|
||||
### {% 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.
|
||||
|
||||
|
||||
<p class='note'>
|
||||
Econet water heaters use to live under the `climate` platform prior to release 0.81.
|
||||
</p>
|
||||
120
source/_components/water_heater.markdown
Normal file
120
source/_components/water_heater.markdown
Normal file
@ -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`
|
||||
|
||||
<p class='note'>
|
||||
Not all water heater services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services**.
|
||||
</p>
|
||||
|
||||
### {% 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
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user