Merge 20131e4779 into 0f972f1cc3

app/include/zmk/display/widgets/mods_status.h

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <lvgl.h>
+#include <zephyr/kernel.h>
+
+struct zmk_widget_mods_status {
+    sys_snode_t node;
+    lv_obj_t *obj;
+};
+
+int zmk_widget_mods_status_init(struct zmk_widget_mods_status *widget, lv_obj_t *parent);
+lv_obj_t *zmk_widget_mods_status_obj(struct zmk_widget_mods_status *widget);

app/src/display/status_screen.c

@@ -9,6 +9,7 @@
 #include <zmk/display/widgets/battery_status.h>
 #include <zmk/display/widgets/layer_status.h>
 #include <zmk/display/widgets/wpm_status.h>
+#include <zmk/display/widgets/mods_status.h>
 #include <zmk/display/status_screen.h>
 
 #include <zephyr/logging/log.h>
@@ -34,6 +35,10 @@ static struct zmk_widget_layer_status layer_status_widget;
 static struct zmk_widget_wpm_status wpm_status_widget;
 #endif
 
+#if IS_ENABLED(CONFIG_ZMK_WIDGET_MODS_STATUS)
+static struct zmk_widget_mods_status mods_status_widget;
+#endif
+
 lv_obj_t *zmk_display_status_screen() {
     lv_obj_t *screen;
     screen = lv_obj_create(NULL);
@@ -65,5 +70,12 @@ lv_obj_t *zmk_display_status_screen() {
     zmk_widget_wpm_status_init(&wpm_status_widget, screen);
     lv_obj_align(zmk_widget_wpm_status_obj(&wpm_status_widget), LV_ALIGN_BOTTOM_RIGHT, 0, 0);
 #endif
+
+#if IS_ENABLED(CONFIG_ZMK_WIDGET_MODS_STATUS)
+    zmk_widget_mods_status_init(&mods_status_widget, screen);
+    lv_obj_set_style_text_font(zmk_widget_mods_status_obj(&mods_status_widget),
+                               lv_theme_get_font_small(screen), LV_PART_MAIN);
+    lv_obj_align(zmk_widget_mods_status_obj(&mods_status_widget), LV_ALIGN_BOTTOM_RIGHT, 0, 0);
+#endif
     return screen;
 }

app/src/display/widgets/CMakeLists.txt

@@ -6,3 +6,4 @@ target_sources_ifdef(CONFIG_ZMK_WIDGET_OUTPUT_STATUS app PRIVATE output_status.c
 target_sources_ifdef(CONFIG_ZMK_WIDGET_PERIPHERAL_STATUS app PRIVATE peripheral_status.c)
 target_sources_ifdef(CONFIG_ZMK_WIDGET_LAYER_STATUS app PRIVATE layer_status.c)
 target_sources_ifdef(CONFIG_ZMK_WIDGET_WPM_STATUS app PRIVATE wpm_status.c)
+target_sources_ifdef(CONFIG_ZMK_WIDGET_MODS_STATUS app PRIVATE mods_status.c)

app/src/display/widgets/Kconfig

@@ -36,4 +36,17 @@ config ZMK_WIDGET_WPM_STATUS
     select LV_USE_LABEL
     select ZMK_WPM
 
+config ZMK_WIDGET_MODS_STATUS
+    bool "Widget for displaying active modifiers"
+    depends on !ZMK_SPLIT || ZMK_SPLIT_ROLE_CENTRAL
+    select LV_USE_LABEL
+
+if ZMK_WIDGET_MODS_STATUS
+
+config ZMK_WIDGET_MODS_STATUS_CHARACTERS
+    string "Characters to show for each modifier, corresponding to Control/Shift/Alt/GUI respectively"
+    default "CSAG"
+
+endif
+
 endmenu

app/src/display/widgets/mods_status.c

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
+
+#include <zmk/display.h>
+#include <zmk/display/widgets/mods_status.h>
+#include <zmk/events/keycode_state_changed.h>
+#include <zmk/event_manager.h>
+#include <zmk/endpoints.h>
+#include <zmk/hid.h>
+
+#define MOD_CHARS CONFIG_ZMK_WIDGET_MODS_STATUS_CHARACTERS
+#define MOD_CHARS_LEN (sizeof(MOD_CHARS) - 1)
+
+BUILD_ASSERT(MOD_CHARS_LEN == 4,
+             "ERROR: CONFIG_ZMK_WIDGET_MODS_STATUS_CHARACTERS should have exactly 4 characters");
+
+static sys_slist_t widgets = SYS_SLIST_STATIC_INIT(&widgets);
+
+struct mods_status_state {
+    uint8_t mods;
+};
+
+struct mods_status_state mods_status_get_state(const zmk_event_t *eh) {
+    return (struct mods_status_state){.mods = zmk_hid_get_explicit_mods()};
+};
+
+void set_mods_symbol(lv_obj_t *label, struct mods_status_state state) {
+    char text[5] = {};
+
+    LOG_DBG("mods changed to %i", state.mods);
+    if (state.mods & (MOD_LCTL | MOD_RCTL))
+        strncat(text, &MOD_CHARS[0], 1);
+    if (state.mods & (MOD_LSFT | MOD_RSFT))
+        strncat(text, &MOD_CHARS[1], 1);
+    if (state.mods & (MOD_LALT | MOD_RALT))
+        strncat(text, &MOD_CHARS[2], 1);
+    if (state.mods & (MOD_LGUI | MOD_RGUI))
+        strncat(text, &MOD_CHARS[3], 1);
+
+    lv_label_set_text(label, text);
+    lv_obj_align(label, LV_ALIGN_BOTTOM_RIGHT, -1, 0);
+}
+
+void mods_status_update_cb(struct mods_status_state state) {
+    struct zmk_widget_mods_status *widget;
+    SYS_SLIST_FOR_EACH_CONTAINER(&widgets, widget, node) { set_mods_symbol(widget->obj, state); }
+}
+
+ZMK_DISPLAY_WIDGET_LISTENER(widget_mods_status, struct mods_status_state, mods_status_update_cb,
+                            mods_status_get_state)
+ZMK_SUBSCRIPTION(widget_mods_status, zmk_keycode_state_changed);
+
+int zmk_widget_mods_status_init(struct zmk_widget_mods_status *widget, lv_obj_t *parent) {
+    widget->obj = lv_label_create(parent);
+    lv_obj_set_style_text_align(widget->obj, LV_TEXT_ALIGN_RIGHT, 0);
+
+    sys_slist_append(&widgets, &widget->node);
+
+    widget_mods_status_init();
+    return 0;
+}
+
+lv_obj_t *zmk_widget_mods_status_obj(struct zmk_widget_mods_status *widget) { return widget->obj; }

docs/docs/config/displays.md

@@ -14,15 +14,19 @@ 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                                             | Type   | Description                                                                               | Default |
-| -------------------------------------------------- | ---- | -------------------------------------------------------------- | ------- |
+| -------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------- | ------- |
-| `CONFIG_ZMK_DISPLAY`                               | bool | Enable support for displays                                    | n       |
+| `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_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_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`                 | 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_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_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_ZMK_WIDGET_WPM_STATUS`                     | bool   | Enable a widget to show words per minute                                                  | n       |
+| `CONFIG_ZMK_WIDGET_MODS_STATUS`                    | bool   | Enable a widget to show active modifiers                                                  | n       |
+| `CONFIG_ZMK_WIDGET_MODS_STATUS_CHARACTERS`         | string | Characters to show for each modifier, corresponding to Control/Shift/Alt/GUI respectively | "CSAG"  |
+
+Note that WPM and modifiers widgets are both shown on the bottom right of the display and hence can conflict with each other.
 
 Note that `CONFIG_ZMK_DISPLAY_INVERT` setting might not work as expected with custom status screens that utilize images.