From 0ca086a84593efa2d264b17c2ea42e30d5b1ad5f Mon Sep 17 00:00:00 2001 From: darknao Date: Wed, 8 May 2024 02:07:54 +0200 Subject: [PATCH] underglow-layer: track layer changes with event & battery life optimization I tried using event instead of the 25ms underglow_tick to update the underglow on layer change only. That didn't improve the battery life much.... The second change is cutting off the led strip power if the underglow is not defined for a layer. Power is restored if a layer with rgb is activated, and cut off as soon as the layer is disabled. This, on the other hand, improves the battery life a lot, especially if you don't use rgb on your base layer. If you are using rgb on your base layer, setting CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_IDLE is highly recommended. --- app/CMakeLists.txt | 1 + .../events/split_peripheral_layer_changed.h | 16 +++++++++++++ app/include/zmk/rgb_underglow_layer.h | 4 ++-- .../events/split_peripheral_layer_changed.c | 10 ++++++++ app/src/rgb_underglow.c | 23 +++++++++++++++---- app/src/rgb_underglow_layer.c | 14 ++++------- app/src/split/bluetooth/central.c | 4 ++++ app/src/split/bluetooth/service.c | 5 +++- 8 files changed, 61 insertions(+), 16 deletions(-) create mode 100644 app/include/zmk/events/split_peripheral_layer_changed.h create mode 100644 app/src/events/split_peripheral_layer_changed.c diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index 3d78f066..f01db605 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -96,6 +96,7 @@ target_sources_ifdef(CONFIG_ZMK_BATTERY_REPORTING app PRIVATE src/battery.c) target_sources_ifdef(CONFIG_ZMK_HID_INDICATORS app PRIVATE src/events/hid_indicators_changed.c) target_sources_ifdef(CONFIG_ZMK_SPLIT app PRIVATE src/events/split_peripheral_status_changed.c) +target_sources_ifdef(CONFIG_ZMK_SPLIT app PRIVATE src/events/split_peripheral_layer_changed.c) add_subdirectory_ifdef(CONFIG_ZMK_SPLIT src/split) target_sources_ifdef(CONFIG_USB_DEVICE_STACK app PRIVATE src/usb.c) diff --git a/app/include/zmk/events/split_peripheral_layer_changed.h b/app/include/zmk/events/split_peripheral_layer_changed.h new file mode 100644 index 00000000..2445c164 --- /dev/null +++ b/app/include/zmk/events/split_peripheral_layer_changed.h @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2022 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#pragma once + +#include +#include + +struct zmk_split_peripheral_layer_changed { + uint32_t layers; +}; + +ZMK_EVENT_DECLARE(zmk_split_peripheral_layer_changed); diff --git a/app/include/zmk/rgb_underglow_layer.h b/app/include/zmk/rgb_underglow_layer.h index 032714eb..ad28f74f 100644 --- a/app/include/zmk/rgb_underglow_layer.h +++ b/app/include/zmk/rgb_underglow_layer.h @@ -14,5 +14,5 @@ (DT_FOREACH_CHILD(DT_INST(0, zmk_underglow_layer), ZMK_RGB_CHILD_LEN_PLUS_ONE) 0) const int zmk_rgbmap_id(uint8_t layer); -uint32_t *rgb_underglow_get_bindings(void); -uint8_t rgb_underglow_top_layer(void); \ No newline at end of file +uint32_t *rgb_underglow_get_bindings(uint8_t layer); +uint8_t rgb_underglow_top_layer_with_state(uint32_t state_to_test); \ No newline at end of file diff --git a/app/src/events/split_peripheral_layer_changed.c b/app/src/events/split_peripheral_layer_changed.c new file mode 100644 index 00000000..81f2ab8d --- /dev/null +++ b/app/src/events/split_peripheral_layer_changed.c @@ -0,0 +1,10 @@ +/* + * Copyright (c) 2022 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#include +#include + +ZMK_EVENT_IMPL(zmk_split_peripheral_layer_changed); \ No newline at end of file diff --git a/app/src/rgb_underglow.c b/app/src/rgb_underglow.c index 7fd0d0c3..981d21ae 100644 --- a/app/src/rgb_underglow.c +++ b/app/src/rgb_underglow.c @@ -34,6 +34,7 @@ #include #include #include +#include #if IS_ENABLED(CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING) #include @@ -467,15 +468,19 @@ static void zmk_rgb_underglow_apply_rgbmap(uint32_t rgbmap[], size_t rgbmap_len) } } -static void zmk_rgb_underglow_set_layer(void) { - uint32_t *rgbmap = rgb_underglow_get_bindings(); +static void zmk_rgb_underglow_set_layer(uint8_t layer) { + state.on = true; + uint32_t *rgbmap = rgb_underglow_get_bindings(layer); if (rgbmap != NULL) { zmk_rgb_underglow_apply_rgbmap(rgbmap, ZMK_KEYMAP_LEN); } else { for (int i = 0; i < STRIP_NUM_PIXELS; i++) { pixels[i] = (struct led_rgb){r : 0, g : 0, b : 0}; } + state.on = false; } + zmk_led_write_pixels(); + zmk_rgb_set_ext_power(); } static void zmk_rgb_underglow_tick(struct k_work *work) { @@ -493,7 +498,7 @@ static void zmk_rgb_underglow_tick(struct k_work *work) { zmk_rgb_underglow_effect_swirl(); break; case UNDERGLOW_EFFECT_LAYER_INDICATORS: - zmk_rgb_underglow_set_layer(); + //zmk_rgb_underglow_set_layer(); break; } @@ -503,7 +508,7 @@ static void zmk_rgb_underglow_tick(struct k_work *work) { K_WORK_DEFINE(underglow_tick_work, zmk_rgb_underglow_tick); static void zmk_rgb_underglow_tick_handler(struct k_timer *timer) { - if (!state.on) { + if (!state.on && state.current_effect == UNDERGLOW_EFFECT_LAYER_INDICATORS) { return; } @@ -860,6 +865,15 @@ static int rgb_underglow_event_listener(const zmk_event_t *eh) { if (as_zmk_activity_state_changed(eh)) { return rgb_underglow_auto_state(zmk_activity_get_state() == ZMK_ACTIVITY_ACTIVE); } + if (as_zmk_split_peripheral_layer_changed(eh)) { + const struct zmk_split_peripheral_layer_changed *ev = as_zmk_split_peripheral_layer_changed(eh); + LOG_DBG("zmk_split_peripheral_layer_changed: %08x", ev->layers); + + uint8_t layer = rgb_underglow_top_layer_with_state(ev->layers); + LOG_DBG("top layer: %d", layer); + zmk_rgb_underglow_set_layer(layer); + return 0; + } #endif #if IS_ENABLED(CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_USB) @@ -877,6 +891,7 @@ ZMK_LISTENER(rgb_underglow, rgb_underglow_event_listener); #if IS_ENABLED(CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_IDLE) ZMK_SUBSCRIPTION(rgb_underglow, zmk_activity_state_changed); +ZMK_SUBSCRIPTION(rgb_underglow, zmk_split_peripheral_layer_changed); #endif #if IS_ENABLED(CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_USB) diff --git a/app/src/rgb_underglow_layer.c b/app/src/rgb_underglow_layer.c index 21208b1f..28dfe26b 100644 --- a/app/src/rgb_underglow_layer.c +++ b/app/src/rgb_underglow_layer.c @@ -41,8 +41,7 @@ const int zmk_rgbmap_id(uint8_t layer) { return -1; } -uint32_t *rgb_underglow_get_bindings(void) { - uint8_t layer = rgb_underglow_top_layer(); +uint32_t *rgb_underglow_get_bindings(uint8_t layer) { int rgblayer = zmk_rgbmap_id(layer); if (rgblayer == -1){ return NULL; @@ -51,15 +50,12 @@ uint32_t *rgb_underglow_get_bindings(void) { } } -uint8_t rgb_underglow_top_layer(void) { +uint8_t rgb_underglow_top_layer_with_state(uint32_t state_to_test) { for (uint8_t layer = ZMK_KEYMAP_LAYERS_LEN - 1; layer > 0; layer--) { -#if IS_ENABLED(CONFIG_ZMK_SPLIT_ROLE_CENTRAL) - if (zmk_keymap_layer_active(layer)) { -#else - if (peripheral_layer_active(layer)) { -#endif + if ((state_to_test & (BIT(layer))) == (BIT(layer)) || layer == 0) { return layer; } } - return -1; + // return default layer (0) + return 0; } diff --git a/app/src/split/bluetooth/central.c b/app/src/split/bluetooth/central.c index 8addfa3f..6fdbcbd2 100644 --- a/app/src/split/bluetooth/central.c +++ b/app/src/split/bluetooth/central.c @@ -33,6 +33,7 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); #include #include #include +#include static int start_scanning(void); @@ -1175,6 +1176,9 @@ static void split_central_update_layers_callback(struct k_work *work) { LOG_ERR("Failed to send layers to peripheral (err %d)", err); } else { LOG_DBG("Sent Layers over to peripheral"); + raise_zmk_split_peripheral_layer_changed( + (struct zmk_split_peripheral_layer_changed){.layers = layers}); + } } } diff --git a/app/src/split/bluetooth/service.c b/app/src/split/bluetooth/service.c index b51cb88f..9f02a4ca 100644 --- a/app/src/split/bluetooth/service.c +++ b/app/src/split/bluetooth/service.c @@ -35,6 +35,7 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); #include #include +#include #if ZMK_KEYMAP_HAS_SENSORS static struct sensor_event last_sensor_event; @@ -144,7 +145,9 @@ static uint32_t layers = 0; static void split_svc_update_layers_callback(struct k_work *work) { LOG_DBG("Setting peripheral layers: %x", layers); - set_peripheral_layers_state(layers); + // set_peripheral_layers_state(layers); + raise_zmk_split_peripheral_layer_changed( + (struct zmk_split_peripheral_layer_changed){.layers = layers}); } static K_WORK_DEFINE(split_svc_update_layers_work, split_svc_update_layers_callback);