feat(display): Add config for display update period

Add `CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS` Kconfig to allow tweaking the period between display updates.
zmkfirmware · Feb 10, 2025 · dd6da9c · dd6da9c
1 parent 627e6db
commit dd6da9c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/app/src/display/Kconfig b/app/src/display/Kconfig
@@ -13,6 +13,10 @@ config ZMK_DISPLAY_BLANK_ON_IDLE
     bool "Blank display on idle"
     default y if SSD1306
 
+config ZMK_DISPLAY_TICK_PERIOD_MS
+    int "Period (in ms) between display task execution"
+    default 10
+
 if LV_USE_THEME_MONO
 
 config ZMK_DISPLAY_INVERT

diff --git a/app/src/display/main.c b/app/src/display/main.c
@@ -39,8 +39,6 @@ __attribute__((weak)) lv_obj_t *zmk_display_status_screen() { return NULL; }
 
 void display_tick_cb(struct k_work *work) { lv_task_handler(); }
 
-#define TICK_MS 10
-
 K_WORK_DEFINE(display_tick_work, display_tick_cb);
 
 #if IS_ENABLED(CONFIG_ZMK_DISPLAY_WORK_QUEUE_DEDICATED)
@@ -69,7 +67,8 @@ void unblank_display_cb(struct k_work *work) {
 #endif
     display_blanking_off(display);
 #if !IS_ENABLED(CONFIG_ARCH_POSIX)
-    k_timer_start(&display_timer, K_MSEC(TICK_MS), K_MSEC(TICK_MS));
+    k_timer_start(&display_timer, K_MSEC(CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS),
+                  K_MSEC(CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS));
 #endif // !IS_ENABLED(CONFIG_ARCH_POSIX)
 }
 

diff --git a/docs/docs/config/displays.md b/docs/docs/config/displays.md
@@ -14,15 +14,17 @@ Definition files:
 - [zmk/app/src/display/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/display/Kconfig)
 - [zmk/app/src/display/widgets/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/display/widgets/Kconfig)
 
-| Config                                             | Type | Description                                                    | Default |
-| -------------------------------------------------- | ---- | -------------------------------------------------------------- | ------- |
-| `CONFIG_ZMK_DISPLAY`                               | bool | Enable support for displays                                    | n       |
-| `CONFIG_ZMK_DISPLAY_INVERT`                        | bool | Invert display colors from black-on-white to white-on-black    | n       |
-| `CONFIG_ZMK_WIDGET_LAYER_STATUS`                   | bool | Enable a widget to show the highest, active layer              | y       |
-| `CONFIG_ZMK_WIDGET_BATTERY_STATUS`                 | bool | Enable a widget to show battery charge information             | y       |
-| `CONFIG_ZMK_WIDGET_BATTERY_STATUS_SHOW_PERCENTAGE` | bool | If battery widget is enabled, show percentage instead of icons | n       |
-| `CONFIG_ZMK_WIDGET_OUTPUT_STATUS`                  | bool | Enable a widget to show the current output (USB/BLE)           | y       |
-| `CONFIG_ZMK_WIDGET_WPM_STATUS`                     | bool | Enable a widget to show words per minute                       | n       |
+| Config                                             | Type | Description                                                    | Default      |
+| -------------------------------------------------- | ---- | -------------------------------------------------------------- | ------------ |
+| `CONFIG_ZMK_DISPLAY`                               | bool | Enable support for displays                                    | n            |
+| `CONFIG_ZMK_DISPLAY_BLANK_ON_IDLE`                 | bool | Blank display on idle                                          | y if SSD1306 |
+| `CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS`                | int  | Period (in ms) between display task execution                  | 10           |
+| `CONFIG_ZMK_DISPLAY_INVERT`                        | bool | Invert display colors from black-on-white to white-on-black    | n            |
+| `CONFIG_ZMK_WIDGET_LAYER_STATUS`                   | bool | Enable a widget to show the highest, active layer              | y            |
+| `CONFIG_ZMK_WIDGET_BATTERY_STATUS`                 | bool | Enable a widget to show battery charge information             | y            |
+| `CONFIG_ZMK_WIDGET_BATTERY_STATUS_SHOW_PERCENTAGE` | bool | If battery widget is enabled, show percentage instead of icons | n            |
+| `CONFIG_ZMK_WIDGET_OUTPUT_STATUS`                  | bool | Enable a widget to show the current output (USB/BLE)           | y            |
+| `CONFIG_ZMK_WIDGET_WPM_STATUS`                     | bool | Enable a widget to show words per minute                       | n            |
 
 Note that `CONFIG_ZMK_DISPLAY_INVERT` setting might not work as expected with custom status screens that utilize images.