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-14 12:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes to climate entity documentation (#1366)

Browse Source
This commit is contained in:
Brandon Rothweiler 2022-06-14 07:44:41 -04:00 committed by GitHub
parent 95ac9ab58d
commit 17742eaf49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/core/entity/climate.md
View File

@ -22,8 +22,8 @@ Properties should always only return information from memory and not do I/O (lik
| target_temperature_low | float | None | The lower bound target temperature | | target_temperature_low | float | None | The lower bound target temperature |
| target_temperature_step | float | None | The supported step size a target temperature can be increased/decreased | | target_temperature_step | float | None | The supported step size a target temperature can be increased/decreased |
| target_humidity | float | None | The target humidity the device is trying to reach. Requires `SUPPORT_TARGET_HUMIDITY`. | | target_humidity | float | None | The target humidity the device is trying to reach. Requires `SUPPORT_TARGET_HUMIDITY`. |
| max_temp | int | `DEFAULT_MAX_TEMP` (value == 35) | Returns the maximum temperature. | | max_temp | float | `DEFAULT_MAX_TEMP` (value == 35) | Returns the maximum temperature. |
| min_temp | int | `DEFAULT_MIN_TEMP` (value == 7) | Returns the minimum temperature. | | min_temp | float | `DEFAULT_MIN_TEMP` (value == 7) | Returns the minimum temperature. |
| max_humidity | int | `DEFAULT_MAX_HUMIDITY` (value == 99) | Returns the maximum humidity. Requires `SUPPORT_TARGET_HUMIDITY`. | | max_humidity | int | `DEFAULT_MAX_HUMIDITY` (value == 99) | Returns the maximum humidity. Requires `SUPPORT_TARGET_HUMIDITY`. |
| min_humidity | int | `DEFAULT_MIN_HUMIDITY` (value == 30) | Returns the minimum humidity. Requires `SUPPORT_TARGET_HUMIDITY`. | | min_humidity | int | `DEFAULT_MIN_HUMIDITY` (value == 30) | Returns the minimum humidity. Requires `SUPPORT_TARGET_HUMIDITY`. |
| hvac_mode | HVACMode | `NotImplementedError()` | The current operation (e.g. heat, cool, idle). Used to determine `state`. | | hvac_mode | HVACMode | `NotImplementedError()` | The current operation (e.g. heat, cool, idle). Used to determine `state`. |
@ -49,7 +49,7 @@ enum. If you want another mode, add a preset instead.
| `HVACMode.OFF` | The device is turned off. | | `HVACMode.OFF` | The device is turned off. |
| `HVACMode.HEAT` | The device is set to heat to a target temperature. | | `HVACMode.HEAT` | The device is set to heat to a target temperature. |
| `HVACMode.COOL` | The device is set to cool to a target temperature. | | `HVACMode.COOL` | The device is set to cool to a target temperature. |
| `HVACMode.HEAT_COOL` | The device supports heating/cooling to a range | | `HVACMode.HEAT_COOL` | The device is set to heat/cool to a target temperature range. |
| `HVACMode.AUTO` | The device is set to a schedule, learned behavior, AI. | | `HVACMode.AUTO` | The device is set to a schedule, learned behavior, AI. |
| `HVACMode.DRY` | The device is set to dry/humidity mode. | | `HVACMode.DRY` | The device is set to dry/humidity mode. |
| `HVACMode.FAN_ONLY` | The device only has the fan on. No heating or cooling taking place. | | `HVACMode.FAN_ONLY` | The device only has the fan on. No heating or cooling taking place. |
@ -126,7 +126,7 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Set hvac mode ### Set HVAC mode
```python ```python
class MyClimateEntity(ClimateEntity): class MyClimateEntity(ClimateEntity):