Skip to content

Replace Climate CURRENT_HVAC_* constants with HVACAction enum #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 1 commit into from
Apr 20, 2022
Merged

Replace Climate CURRENT_HVAC_* constants with HVACAction enum #1297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/core/entity/climate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ enum. If you want another mode, add a preset instead.

### HVAC Action

The HVAC action describes the _current_ action. This is different from the mode, because if a device is set to heat, and the target temperature is already achieved, the device will not be actively heating anymore.

| Name | Description |
| ------------------- | --------------------- |
| `CURRENT_HVAC_OFF` | Device is turned off. |
| `CURRENT_HVAC_HEAT` | Device is heating. |
| `CURRENT_HVAC_COOL` | Device is cooling. |
| `CURRENT_HVAC_DRY` | Device is drying. |
| `CURRENT_HVAC_IDLE` | Device is idle. |
The HVAC action describes the _current_ action. This is different from the mode, because if a device is set to heat, and the target temperature is already achieved, the device will not be actively heating anymore. It is only allowed to use the built-in HVAC actions, provided by the `HVACAction` enum.

| Name | Description |
| -------------------- | --------------------- |
| `HVACAction.OFF` | Device is turned off. |
| `HVACAction.HEATING` | Device is heating. |
| `HVACAction.COOLING` | Device is cooling. |
| `HVACAction.DRYING` | Device is drying. |
| `HVACAction.IDLE` | Device is idle. |

### Presets

Expand Down