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-12 20:06:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace Climate HVAC_MODE_* constants with HVACMode enum (#1295)

Browse Source
This commit is contained in:
Franck Nijhof 2022-04-20 05:17:46 +02:00 committed by GitHub
parent 5f84f5d612
commit a9f6c551a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,7 +26,7 @@ Properties should always only return information from memory and not do I/O (lik
| min_temp | int | `DEFAULT_MIN_TEMP` (value == 7) | Returns the minimum temperature. | | min_temp | int | `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 | string | `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`. |
| hvac_action | string | None | The current HVAC action (heating, cooling) | | hvac_action | string | None | The current HVAC action (heating, cooling) |
| hvac_modes | list | `NotImplementedError()` | List of available operation modes. See below. | | hvac_modes | list | `NotImplementedError()` | List of available operation modes. See below. |
| preset_mode | string | `NotImplementedError()` | The current active preset. Requires `SUPPORT_PRESET_MODE`. | | preset_mode | string | `NotImplementedError()` | The current active preset. Requires `SUPPORT_PRESET_MODE`. |
@ -40,17 +40,19 @@ Properties should always only return information from memory and not do I/O (lik
### HVAC modes ### HVAC modes
You are only allowed to use the built-in HVAC modes. If you want another mode, add a preset instead. You are only allowed to use the built-in HVAC modes, provided by the `HVACMode`
enum. If you want another mode, add a preset instead.
| Name | Description | | Name | Description |
| --------------------- | ------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------- |
| `HVAC_MODE_OFF` | The device is turned off. | | `HVACMode.OFF` | The device is turned off. |
| `HVAC_MODE_HEAT` | The device is set to heat to a target temperature. | | `HVACMode.HEAT` | The device is set to heat to a target temperature. |
| `HVAC_MODE_COOL` | The device is set to cool to a target temperature. | | `HVACMode.COOL` | The device is set to cool to a target temperature. |
| `HVAC_MODE_HEAT_COOL` | The device supports heating/cooling to a range | | `HVACMode.HEAT_COOL` | The device supports heating/cooling to a range |
| `HVAC_MODE_AUTO` | The device is set to a schedule, learned behavior, AI. | | `HVACMode.AUTO` | The device is set to a schedule, learned behavior, AI. |
| `HVAC_MODE_DRY` | The device is set to dry/humidity mode. | | `HVACMode.DRY` | The device is set to dry/humidity mode. |
| `HVAC_MODE_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. |
### HVAC Action ### HVAC Action