Skip to content

Commit e8b42ea

Browse files
kbx81Manoel Amaro
authored andcommitted
[thermostat] Update doc to allow heat_cool_mode without an automation (esphome#5875)
Add documentation Fix Lint
1 parent 08ecffa commit e8b42ea

File tree

2 files changed

+41
-4
lines changed

2 files changed

+41
-4
lines changed

content/components/climate/thermostat.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,10 @@ indication of the current climate mode.
230230
its fan either immediately or, when `fan_only_cooling` is `true`, as needed based on the upper
231231
target temperature value).
232232

233-
- **heat_cool_mode** (*Optional*, [Action](/automations/actions#all-actions)): The action to call when
234-
the climate device is placed into "heat/cool" mode (it may both cool and heat as required).
233+
- **heat_cool_mode** (*Optional*, [Action](/automations/actions#all-actions) or boolean): The action to call when
234+
the climate device is placed into "heat/cool" mode (it may both cool and heat as required). If no action is desired,
235+
may be set to `true` to enable the mode without a related automation. Note that **both** `heat_action` **and**
236+
`cool_action` ([see above](#heating-and-cooling-actions)) must be defined to enable this mode.
235237

236238
- **auto_mode** (*Optional*, [Action](/automations/actions#all-actions)): The action to call when
237239
the climate device is placed into "auto" mode (it may both cool and heat as required). This mode is

content/components/lvgl/_index.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@ The following configuration variables apply to the main `lvgl` component, in ord
9292
- **touchscreen_id** (**Required**, [ID](/guides/configuration-types#id)): ID of a touchscreen configuration related to a display.
9393
- **long_press_time** (*Optional*, [Time](/guides/configuration-types#time)): For the touchscreen, delay after which the `on_long_pressed` [interaction trigger](/components/lvgl/widgets#lvgl-automation-triggers) will be called. Defaults to `400ms`.
9494
- **long_press_repeat_time** (*Optional*, [Time](/guides/configuration-types#time)): For the touchscreen, repeated interval after `long_press_time`, when `on_long_pressed_repeat` [interaction trigger](/components/lvgl/widgets#lvgl-automation-triggers) will be called. Defaults to `100ms`.
95+
- **groups** (*Optional*, list, string): All available groups for widgets, encoders and keypads. See the {{< docref "/components/lvgl/widgets" "common properties" >}} of the widgets for more information on groups.
9596
- **encoders** (*Optional*, list): A list of rotary encoders interacting with the LVGL widgets on the display.
96-
- **group** (*Optional*, string): A name for a group of widgets which will interact with the input device. See the {{< docref "/components/lvgl/widgets" "common properties" >}} of the widgets for more information on groups.
97+
- **group** (*Optional*, string): A name for a group of widgets which will interact with the input device. This **must** match one of the groups defined in the `groups` list. See the {{< docref "/components/lvgl/widgets" "common properties" >}} of the widgets for more information on groups.
9798
- **initial_focus** (*Optional*, [ID](/guides/configuration-types#id)): An optional ID for a widget to be given focus on startup (especially useful if there is only one focusable widget.)
9899
- **enter_button** (**Required**, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `ENTER` key.
99100
- **sensor** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/sensor/rotary_encoder" >}}; or a list with buttons for left/right interaction with the widgets:
@@ -102,7 +103,7 @@ The following configuration variables apply to the main `lvgl` component, in ord
102103
- **long_press_time** (*Optional*, [Time](/guides/configuration-types#time)): For the rotary encoder, delay after which the `on_long_pressed` [interaction trigger](/components/lvgl/widgets#lvgl-automation-triggers) will be called. Defaults to `400ms`. Can be disabled with `never`.
103104
- **long_press_repeat_time** (*Optional*, [Time](/guides/configuration-types#time)): For the rotary encoder, repeated interval after `long_press_time`, when `on_long_pressed_repeat` [interaction trigger](/components/lvgl/widgets#lvgl-automation-triggers) will be called. Defaults to `100ms`. Can be disabled with `never`.
104105
- **keypads** (*Optional*, list): A list of keypads interacting with the LVGL widgets on the display.
105-
- **group** (*Optional*, string): A name for a group of widgets which will interact with the input device. See the {{< docref "/components/lvgl/widgets" "common properties" >}} of the widgets for more information on groups.
106+
- **group** (*Optional*, string): A name for a group of widgets which will interact with the input device. This **must** match one of the groups defined in the `groups` list. See the {{< docref "/components/lvgl/widgets" "common properties" >}} of the widgets for more information on groups.
106107
- **up** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `UP` key.
107108
- **down** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `DOWN` key.
108109
- **right** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `RIGHT` key.
@@ -728,6 +729,40 @@ on_...:
728729
- lvgl.widget.focus: previous
729730
```
730731

732+
{{< anchor "lvgl-encoder-set-group-action" >}}
733+
734+
### `lvgl.encoder.set_group`
735+
736+
This [action](#actions-action) sets the group for an encoder. This is useful for organizing encoders into specific groups for focused input handling.
737+
738+
- **id** (**Required**): The ID of the encoder to be configured.
739+
- **group** (**Required**): The name of the group to assign the encoder to. This must match one of the groups defined in the `groups` list.
740+
741+
```yaml
742+
on_...:
743+
then:
744+
- lvgl.encoder.set_group:
745+
id: my_encoder
746+
group: encoder_group
747+
```
748+
749+
{{< anchor "lvgl-keypad-set-group-action" >}}
750+
751+
### `lvgl.keypad.set_group`
752+
753+
This [action](#actions-action) sets the group for a keypad. This is useful for organizing keypads into specific groups for focused input handling.
754+
755+
- **id** (**Required**): The ID of the keypad to be configured.
756+
- **group** (**Required**): The name of the group to assign the keypad to. This must match one of the groups defined in the `groups` list.
757+
758+
```yaml
759+
on_...:
760+
then:
761+
- lvgl.keypad.set_group:
762+
id: my_keypad
763+
group: keypad_group
764+
```
765+
731766
{{< anchor "lvgl-conditions" >}}
732767

733768
## Conditions

0 commit comments

Comments
 (0)