Skip to content

Replaced Optional with Required in Climate Integration #40334

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
merged 1 commit into from
Aug 9, 2025
+33 −33
Merged

Replaced Optional with Required in Climate Integration #40334

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
66 changes: 33 additions & 33 deletions source/_integrations/climate.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ Not all climate {% term actions %} may be available for your platform. You can

Turn auxiliary heater on/off for climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `aux_heat` | no | New value of auxiliary heater.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `aux_heat` | Yes | New value of auxiliary heater.

#### Automation example

Expand All @@ -69,10 +69,10 @@ Set preset mode for climate device. Away mode changes the target temperature per
reflecting a situation where the climate device is set to save energy. For example, this may be used to emulate a
"vacation mode."

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `preset_mode` | no | New value of preset mode.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `preset_mode` | Yes | New value of preset mode.

#### Automation example

Expand All @@ -93,13 +93,13 @@ automation:

Set target temperature of climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `temperature` | yes | New target temperature for climate device (commonly referred to as a *setpoint*). Do not use if `hvac_mode` is `heat_cool`.
| `target_temp_high` | yes | The highest temperature that the climate device will allow. Required if `hvac_mode` is `heat_cool`. Required together with `target_temp_low`.
| `target_temp_low` | yes | The lowest temperature that the climate device will allow. Required if `hvac_mode` is `heat_cool`. Required together with `target_temp_high`.
| `hvac_mode` | yes | HVAC mode to set the climate device to. This defaults to current HVAC mode if not set, or set incorrectly.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `temperature` | No | New target temperature for climate device (commonly referred to as a *setpoint*). Do not use if `hvac_mode` is `heat_cool`.
| `target_temp_high` | No | The highest temperature that the climate device will allow. Required if `hvac_mode` is `heat_cool`. Required together with `target_temp_low`.
| `target_temp_low` | No | The lowest temperature that the climate device will allow. Required if `hvac_mode` is `heat_cool`. Required together with `target_temp_high`.
| `hvac_mode` | No | HVAC mode to set the climate device to. This defaults to current HVAC mode if not set, or set incorrectly.

#### Automation examples

Expand Down Expand Up @@ -138,10 +138,10 @@ automation:

Set target humidity of climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `humidity` | no | New target humidity for climate device
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `humidity` | Yes | New target humidity for climate device

#### Automation example

Expand All @@ -162,10 +162,10 @@ automation:

Set fan operation for climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `fan_mode` | no | New value of fan mode
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `fan_mode` | Yes | New value of fan mode

#### Automation example

Expand All @@ -186,10 +186,10 @@ automation:

Set climate device's HVAC mode

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `hvac_mode` | no | New value of HVAC mode
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `hvac_mode` | Yes | New value of HVAC mode

#### Automation example

Expand All @@ -210,10 +210,10 @@ automation:

Set swing operation mode for climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `swing_mode` | no | New value of swing mode: `off`, `horizontal`, `vertical` or `both`.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `swing_mode` | Yes | New value of swing mode: `off`, `horizontal`, `vertical` or `both`.

#### Automation example

Expand All @@ -234,10 +234,10 @@ automation:

Set horizontal swing operation mode for climate device

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`. |
| `swing_horizontal_mode` | no | New value of horizontal swing mode. |
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`. |
| `swing_horizontal_mode` | Yes | New value of horizontal swing mode. |

#### Automation example

Expand All @@ -258,25 +258,25 @@ automation:

Turn climate device on. This is only supported if the climate device supports being turned off.

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.

### Action `climate.turn_off`

Turn climate device off. This is only supported if the climate device has the HVAC mode `off`.

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.

### Action `climate.toggle`

Toggle climate device. This is only supported if the climate device supports being turned on and off.

| Data attribute | Optional | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
| `entity_id` | No | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.

## Attributes

Expand Down