jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 07:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve water heater (#625)

Browse Source 
* Update Water Heater Entity documentation to match WaterHeaterEntity

* Remove IDE file

* Add target_temperature_high/low

* Fix typo

* Fix another typo

* Use temperature unit constants

* Fix default for NotImplementedError properties

* Update docs/core/entity/water-heater.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Update docs/core/entity/water-heater.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Update docs/core/entity/water-heater.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Andrew Marks 2020-08-27 15:02:23 -04:00 committed by GitHub
parent 063e3ffd48
commit ff3af64cd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/core/entity/water-heater.md
View File

@ -9,18 +9,23 @@ sidebar_label: Water Heater
Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data.
:::
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| min_temp | float | 110°F | The minimum temperature that can be set.
| max_temp | float | 140°F | The maximum temperature that can be set.
| temperature | float | none | The current temperature in °C or °F.
| operation_mode | string | none | The current operation mode.
| operation_list | list | none | List of possible operation modes.
| away_mode | string | none | The current status of away mode. (on, off)
| Name | Type | Default | Description
| --------------------- | ----------- | --------- | -----------
| `min_temp` | `float` | 110°F | The minimum temperature that can be set.
| `max_temp` | `float` | 140°F | The maximum temperature that can be set.
| `current_temperature` | `float` | `None` | The current temperature.
| `target_temperature` | `float` | `None` | The temperature we are trying to reach.
| `target_temperature_high` | `float` | `None` | Upper bound of the temperature we are trying to reach.
| `target_temperature_low` | `float` | `None` | Lower bound of the temperature we are trying to reach.
| `temperature_unit` | `str` | `NotImplementedError` | One of `TEMP_CELSIUS`, `TEMP_FAHRENHEIT`, or `TEMP_KELVIN`.
| `current_operation` | `string` | `None` | The current operation mode.
| `operation_list` | `List[str]` | `None` | List of possible operation modes.
| `supported_features` | `List[str]` | `NotImplementedError` | List of supported features.
| `is_away_mode_on` | `bool` | `None` | The current status of away mode.
The allowed operation modes are specified in the base component and implementations of the water_heater component cannot differ.
The allowed operation modes are the states specified in the base component and implementations of the water_heater component cannot differ.
Properties have to follow the units defined in the `unit_system`.
Properties have to follow the units defined in the `temperature_unit`.
## States
@ -34,6 +39,14 @@ Properties have to follow the units defined in the `unit_system`.
| `STATE_GAS` | Gas only mode, uses the most energy.
| `STATE_OFF` | The water heater is off.
## Supported Features
| Feature | Description
| ---------------------------- | -----------
| `SUPPORT_TARGET_TEMPERATURE` | Temperature can be set
| `SUPPORT_OPERATION_MODE` | Operation mode can be set
| `SUPPORT_AWAY_MODE` | Away mode can be set
## Methods
### `set_temperature` or `async_set_temperature`