You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/components/lvgl/_index.md
+37-2Lines changed: 37 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,8 +92,9 @@ The following configuration variables apply to the main `lvgl` component, in ord
92
92
- **touchscreen_id** (**Required**, [ID](/guides/configuration-types#id)): ID of a touchscreen configuration related to a display.
93
93
- **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`.
94
94
- **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.
95
96
- **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.
97
98
- **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.)
98
99
- **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.
99
100
- **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
102
103
- **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`.
103
104
- **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`.
104
105
- **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.
106
107
- **up** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `UP` key.
107
108
- **down** (*Optional*, [ID](/guides/configuration-types#id)): The ID of a {{< docref "/components/binary_sensor/index" "Binary Sensor" >}}, to be used as `DOWN` key.
108
109
- **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_...:
728
729
- lvgl.widget.focus: previous
729
730
```
730
731
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.
0 commit comments