Skip to content

Commit ba23115

Browse files
dannytsangdannytsang
authored
Replaced Optional with Required in Climate Integration (#40334)
1 parent 3a000cb commit ba23115

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

‎source/_integrations/climate.markdown

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ Not all climate {% term actions %} may be available for your platform. You can
4343

4444
Turn auxiliary heater on/off for climate device
4545

46-
| Data attribute | Optional | Description |
46+
| Data attribute | Required | Description |
4747
| ---------------------- | -------- | ----------- |
48-
| `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`.
49-
| `aux_heat` | no | New value of auxiliary heater.
48+
| `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`.
49+
| `aux_heat` | Yes | New value of auxiliary heater.
5050

5151
#### Automation example
5252

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

72-
| Data attribute | Optional | Description |
72+
| Data attribute | Required | Description |
7373
| ---------------------- | -------- | ----------- |
74-
| `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`.
75-
| `preset_mode` | no | New value of preset mode.
74+
| `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`.
75+
| `preset_mode` | Yes | New value of preset mode.
7676

7777
#### Automation example
7878

@@ -93,13 +93,13 @@ automation:
9393

9494
Set target temperature of climate device
9595

96-
| Data attribute | Optional | Description |
96+
| Data attribute | Required | Description |
9797
| ---------------------- | -------- | ----------- |
98-
| `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`.
99-
| `temperature` | yes | New target temperature for climate device (commonly referred to as a *setpoint*). Do not use if `hvac_mode` is `heat_cool`.
100-
| `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`.
101-
| `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`.
102-
| `hvac_mode` | yes | HVAC mode to set the climate device to. This defaults to current HVAC mode if not set, or set incorrectly.
98+
| `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`.
99+
| `temperature` | No | New target temperature for climate device (commonly referred to as a *setpoint*). Do not use if `hvac_mode` is `heat_cool`.
100+
| `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`.
101+
| `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`.
102+
| `hvac_mode` | No | HVAC mode to set the climate device to. This defaults to current HVAC mode if not set, or set incorrectly.
103103

104104
#### Automation examples
105105

@@ -138,10 +138,10 @@ automation:
138138

139139
Set target humidity of climate device
140140

141-
| Data attribute | Optional | Description |
141+
| Data attribute | Required | Description |
142142
| ---------------------- | -------- | ----------- |
143-
| `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`.
144-
| `humidity` | no | New target humidity for climate device
143+
| `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`.
144+
| `humidity` | Yes | New target humidity for climate device
145145

146146
#### Automation example
147147

@@ -162,10 +162,10 @@ automation:
162162

163163
Set fan operation for climate device
164164

165-
| Data attribute | Optional | Description |
165+
| Data attribute | Required | Description |
166166
| ---------------------- | -------- | ----------- |
167-
| `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`.
168-
| `fan_mode` | no | New value of fan mode
167+
| `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`.
168+
| `fan_mode` | Yes | New value of fan mode
169169

170170
#### Automation example
171171

@@ -186,10 +186,10 @@ automation:
186186

187187
Set climate device's HVAC mode
188188

189-
| Data attribute | Optional | Description |
189+
| Data attribute | Required | Description |
190190
| ---------------------- | -------- | ----------- |
191-
| `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`.
192-
| `hvac_mode` | no | New value of HVAC mode
191+
| `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`.
192+
| `hvac_mode` | Yes | New value of HVAC mode
193193

194194
#### Automation example
195195

@@ -210,10 +210,10 @@ automation:
210210

211211
Set swing operation mode for climate device
212212

213-
| Data attribute | Optional | Description |
213+
| Data attribute | Required | Description |
214214
| ---------------------- | -------- | ----------- |
215-
| `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`.
216-
| `swing_mode` | no | New value of swing mode: `off`, `horizontal`, `vertical` or `both`.
215+
| `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`.
216+
| `swing_mode` | Yes | New value of swing mode: `off`, `horizontal`, `vertical` or `both`.
217217

218218
#### Automation example
219219

@@ -234,10 +234,10 @@ automation:
234234

235235
Set horizontal swing operation mode for climate device
236236

237-
| Data attribute | Optional | Description |
237+
| Data attribute | Required | Description |
238238
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
239-
| `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`. |
240-
| `swing_horizontal_mode` | no | New value of horizontal swing mode. |
239+
| `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`. |
240+
| `swing_horizontal_mode` | Yes | New value of horizontal swing mode. |
241241

242242
#### Automation example
243243

@@ -258,25 +258,25 @@ automation:
258258

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

261-
| Data attribute | Optional | Description |
261+
| Data attribute | Required | Description |
262262
| ---------------------- | -------- | ----------- |
263-
| `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`.
263+
| `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`.
264264

265265
### Action `climate.turn_off`
266266

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

269-
| Data attribute | Optional | Description |
269+
| Data attribute | Required | Description |
270270
| ---------------------- | -------- | ----------- |
271-
| `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`.
271+
| `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`.
272272

273273
### Action `climate.toggle`
274274

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

277-
| Data attribute | Optional | Description |
277+
| Data attribute | Required | Description |
278278
| ---------------------- | -------- | ----------- |
279-
| `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`.
279+
| `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`.
280280

281281
## Attributes
282282

0 commit comments

Comments
 (0)