Add options CONFIG_ZMK_BLE_INDICATOR_AUTO_OFF and CONFIG_ZMK_HANDLE_BLE_DISCONNECTION

app/CMakeLists.txt

@@ -37,6 +37,8 @@ target_sources(app PRIVATE src/behaviors/behavior_reset.c)
 target_sources_ifdef(CONFIG_ZMK_EXT_POWER app PRIVATE src/behaviors/behavior_ext_power.c)
 if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
   target_sources(app PRIVATE src/hid.c)
+  target_sources_ifdef(CONFIG_ZMK_USB app PRIVATE src/usb_hid.c)
+
   target_sources(app PRIVATE src/behaviors/behavior_key_press.c)
   target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_KEY_TOGGLE app PRIVATE src/behaviors/behavior_key_toggle.c)
   target_sources(app PRIVATE src/behaviors/behavior_hold_tap.c)
@@ -65,6 +67,7 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
   target_sources(app PRIVATE src/events/layer_state_changed.c)
   target_sources(app PRIVATE src/events/modifiers_state_changed.c)
   target_sources(app PRIVATE src/events/keycode_state_changed.c)
+  target_sources(app PRIVATE src/hid_indicators.c)
 
   if (CONFIG_ZMK_BLE)
     target_sources(app PRIVATE src/events/ble_active_profile_changed.c)
@@ -80,11 +83,12 @@ target_sources_ifdef(CONFIG_ZMK_BACKLIGHT app PRIVATE src/behaviors/behavior_bac
 target_sources_ifdef(CONFIG_ZMK_BATTERY_REPORTING app PRIVATE src/events/battery_state_changed.c)
 target_sources_ifdef(CONFIG_ZMK_BATTERY_REPORTING app PRIVATE src/battery.c)
 
+target_sources(app PRIVATE src/events/hid_indicators_changed.c)
+
 target_sources_ifdef(CONFIG_ZMK_SPLIT app PRIVATE src/events/split_peripheral_status_changed.c)
 add_subdirectory(src/split)
 
 target_sources_ifdef(CONFIG_USB_DEVICE_STACK app PRIVATE src/usb.c)
-target_sources_ifdef(CONFIG_ZMK_USB app PRIVATE src/usb_hid.c)
 target_sources_ifdef(CONFIG_ZMK_RGB_UNDERGLOW app PRIVATE src/rgb_underglow.c)
 target_sources_ifdef(CONFIG_ZMK_BACKLIGHT app PRIVATE src/backlight.c)
 target_sources(app PRIVATE src/workqueue.c)

app/Kconfig

@@ -168,6 +168,14 @@ config ZMK_BLE_PASSKEY_ENTRY
     default n
     select RING_BUFFER
 
+config ZMK_HANDLE_BLE_DISCONNECTION
+    bool "Experimental: Respect user disconnection request from computer"
+    default n
+
+config ZMK_BLE_INDICATOR_AUTO_OFF
+    bool "Experimental: automatically turn off BLE indicator"
+    default n
+
 config BT_PERIPHERAL_PREF_MIN_INT
     default 6
 
@@ -222,6 +230,11 @@ config ZMK_RGB_UNDERGLOW_BRT_MAX
     range ZMK_RGB_UNDERGLOW_BRT_MIN 100
     default 100
 
+config ZMK_RGB_UNDERGLOW_BRT_SCALE
+    int "RGB underglow brightness scale factor in percent"
+    range 0 100
+    default 1
+
 config ZMK_RGB_UNDERGLOW_HUE_STEP
     int "RGB underglow hue step in degrees"
     range 0 359
@@ -259,7 +272,7 @@ config ZMK_RGB_UNDERGLOW_SPD_START
 
 config ZMK_RGB_UNDERGLOW_EFF_START
     int "RGB underglow start effect int value related to the effect enum list"
-    range 0 3
+    range 0 5
     default 0
 
 config ZMK_RGB_UNDERGLOW_ON_START
@@ -290,7 +303,12 @@ config ZMK_BACKLIGHT_BRT_STEP
 config ZMK_BACKLIGHT_BRT_START
     int "Default brightness in percent"
     range 1 100
-    default 40
+    default 100
+
+config ZMK_BACKLIGHT_BRT_SCALE
+    int "Default brightness in percent"
+    range 0 100
+    default 25
 
 config ZMK_BACKLIGHT_ON_START
     bool "Default backlight state"
@@ -494,7 +512,7 @@ if SETTINGS
 
 config ZMK_SETTINGS_SAVE_DEBOUNCE
     int "Milliseconds to debounce settings saves"
-    default 60000
+    default 29500
 
 #SETTINGS
 endif

app/boards/arm/corneish_zen/widgets/output_status.c

@@ -14,9 +14,8 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
 #include <zmk/display.h>
 #include "output_status.h"
 #include <zmk/event_manager.h>
-#include <zmk/events/usb_conn_state_changed.h>
 #include <zmk/events/ble_active_profile_changed.h>
-#include <zmk/events/endpoint_selection_changed.h>
+#include <zmk/events/endpoint_changed.h>
 #include <zmk/usb.h>
 #include <zmk/ble.h>
 #include <zmk/endpoints.h>
@@ -39,31 +38,31 @@ LV_IMG_DECLARE(USB_connected);
 static sys_slist_t widgets = SYS_SLIST_STATIC_INIT(&widgets);
 
 struct output_status_state {
-    enum zmk_endpoint selected_endpoint;
+    struct zmk_endpoint_instance selected_endpoint;
     bool active_profile_connected;
     bool active_profile_bonded;
     uint8_t active_profile_index;
 };
 
 static struct output_status_state get_state(const zmk_event_t *_eh) {
-    return (struct output_status_state){.selected_endpoint = zmk_endpoints_selected(),
-                                        .active_profile_connected =
-                                            zmk_ble_active_profile_is_connected(),
-                                        .active_profile_bonded = !zmk_ble_active_profile_is_open(),
-                                        .active_profile_index = zmk_ble_active_profile_index()};
+    return (struct output_status_state){
+        .selected_endpoint = zmk_endpoints_selected(),
+        .active_profile_connected = zmk_ble_active_profile_is_connected(),
+        .active_profile_bonded = !zmk_ble_active_profile_is_open(),
+    };
     ;
 }
 
 static void set_status_symbol(lv_obj_t *icon, struct output_status_state state) {
-    switch (state.selected_endpoint) {
-    case ZMK_ENDPOINT_USB:
+    switch (state.selected_endpoint.transport) {
+    case ZMK_TRANSPORT_USB:
         lv_img_set_src(icon, &USB_connected);
         break;
-    case ZMK_ENDPOINT_BLE:
+    case ZMK_TRANSPORT_BLE:
         if (state.active_profile_bonded) {
             if (state.active_profile_connected) {
                 // sprintf(text, LV_SYMBOL_BLUETOOTH "%i " LV_SYMBOL_OK, active_profile_index);
-                switch (state.active_profile_index) {
+                switch (state.selected_endpoint.ble.profile_index) {
                 case 0:
                     lv_img_set_src(icon, &bluetooth_connected_1);
                     break;
@@ -84,7 +83,7 @@ static void set_status_symbol(lv_obj_t *icon, struct output_status_state state)
                 lv_img_set_src(icon, &bluetooth_disconnected_right);
             }
         } else {
-            switch (state.active_profile_index) {
+            switch (state.selected_endpoint.ble.profile_index) {
             case 0:
                 lv_img_set_src(icon, &bluetooth_advertising_1);
                 break;
@@ -113,11 +112,9 @@ static void output_status_update_cb(struct output_status_state state) {
 
 ZMK_DISPLAY_WIDGET_LISTENER(widget_output_status, struct output_status_state,
                             output_status_update_cb, get_state)
-ZMK_SUBSCRIPTION(widget_output_status, zmk_endpoint_selection_changed);
-
-#if IS_ENABLED(CONFIG_USB_DEVICE_STACK)
-ZMK_SUBSCRIPTION(widget_output_status, zmk_usb_conn_state_changed);
-#endif
+ZMK_SUBSCRIPTION(widget_output_status, zmk_endpoint_changed);
+// We don't get an endpoint changed event when the active profile connects/disconnects
+// but there wasn't another endpoint to switch from/to, so update on BLE events too.
 #if defined(CONFIG_ZMK_BLE)
 ZMK_SUBSCRIPTION(widget_output_status, zmk_ble_active_profile_changed);
 #endif

app/include/dt-bindings/zmk/rgb.h

@@ -18,7 +18,8 @@
 #define RGB_EFF_CMD 11
 #define RGB_EFR_CMD 12
 #define RGB_EFS_CMD 13
-#define RGB_COLOR_HSB_CMD 14
+#define RGB_MEFS_CMD 14
+#define RGB_COLOR_HSB_CMD 15
 
 #define RGB_TOG RGB_TOG_CMD 0
 #define RGB_ON RGB_ON_CMD 0
@@ -33,6 +34,8 @@
 #define RGB_SPD RGB_SPD_CMD 0
 #define RGB_EFF RGB_EFF_CMD 0
 #define RGB_EFR RGB_EFR_CMD 0
+#define RGB_EFS RGB_EFS_CMD
+#define RFB_MEFS RGB_MEFS_CMD
 #define RGB_COLOR_HSB_VAL(h, s, v) (((h) << 16) + ((s) << 8) + (v))
 #define RGB_COLOR_HSB(h, s, v) RGB_COLOR_HSB_CMD##(RGB_COLOR_HSB_VAL(h, s, v))
 #define RGB_COLOR_HSV RGB_COLOR_HSB

app/include/zmk/backlight.h

@@ -6,11 +6,17 @@
 
 #pragma once
 
+struct backlight_state {
+    uint8_t brightness;
+    bool on;
+};
+
 int zmk_backlight_on();
 int zmk_backlight_off();
 int zmk_backlight_toggle();
 bool zmk_backlight_is_on();
 
+int zmk_backlight_update_vals(struct backlight_state new_state);
 int zmk_backlight_set_brt(uint8_t brightness);
 uint8_t zmk_backlight_get_brt();
 uint8_t zmk_backlight_calc_brt(int direction);

app/include/zmk/ble.h

@@ -26,6 +26,7 @@ int zmk_ble_prof_prev();
 int zmk_ble_prof_select(uint8_t index);
 
 int zmk_ble_active_profile_index();
+int zmk_ble_profile_index(const bt_addr_le_t *addr);
 bt_addr_le_t *zmk_ble_active_profile_addr();
 bool zmk_ble_active_profile_is_open();
 bool zmk_ble_active_profile_is_connected();
@@ -36,3 +37,7 @@ int zmk_ble_unpair_all();
 #if IS_ENABLED(CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
 int zmk_ble_put_peripheral_addr(const bt_addr_le_t *addr);
 #endif /* IS_ENABLED(CONFIG_ZMK_SPLIT_ROLE_CENTRAL) */
+
+#if IS_ENABLED(CONFIG_ZMK_HANDLE_BLE_DISCONNECTION)
+bool ble_seeking_connection();
+#endif

app/include/zmk/endpoints.h

@@ -6,10 +6,66 @@
 
 #pragma once
 
+#include <zmk/ble.h>
 #include <zmk/endpoints_types.h>
 
-int zmk_endpoints_select(enum zmk_endpoint endpoint);
-int zmk_endpoints_toggle();
-enum zmk_endpoint zmk_endpoints_selected();
+/**
+ * Recommended length of string buffer for printing endpoint identifiers.
+ */
+#define ZMK_ENDPOINT_STR_LEN 10
+
+#ifdef CONFIG_ZMK_USB
+#define ZMK_ENDPOINT_USB_COUNT 1
+#else
+#define ZMK_ENDPOINT_USB_COUNT 0
+#endif
+
+#ifdef CONFIG_ZMK_BLE
+#define ZMK_ENDPOINT_BLE_COUNT ZMK_BLE_PROFILE_COUNT
+#else
+#define ZMK_ENDPOINT_BLE_COUNT 0
+#endif
+
+/**
+ * The total number of different (struct zmk_endpoint_instance) values that can
+ * be selected.
+ *
+ * Note that this value may change between firmware versions, so it should not
+ * be used in any persistent storage.
+ */
+#define ZMK_ENDPOINT_COUNT (ZMK_ENDPOINT_USB_COUNT + ZMK_ENDPOINT_BLE_COUNT)
+
+bool zmk_endpoint_instance_equals(struct zmk_endpoint_instance a, struct zmk_endpoint_instance b);
+
+/**
+ * Writes a string identifying an endpoint instance.
+ *
+ * @param str Address of output string buffer
+ * @param len Length of string buffer. See ZMK_ENDPOINT_STR_LEN for recommended length.
+ *
+ * @returns Number of characters written.
+ */
+int zmk_endpoint_instance_print(char *str, size_t len, struct zmk_endpoint_instance endpoint);
+
+/**
+ * Gets a unique index for an endpoint instance. This can be used together with
+ * ZMK_ENDPOINT_COUNT to manage separate state for each endpoint instance.
+ *
+ * Note that the index for a specific instance may change between firmware versions,
+ * so it should not be used in any persistent storage.
+ */
+int zmk_endpoint_instance_to_index(struct zmk_endpoint_instance endpoint);
+
+/**
+ * Sets the preferred endpoint transport to use. (If the preferred endpoint is
+ * not available, a different one may automatically be selected.)
+ */
+int zmk_endpoints_select_transport(enum zmk_transport transport);
+int zmk_endpoints_toggle_transport(void);
+
+/**
+ * Gets the currently-selected endpoint.
+ */
+struct zmk_endpoint_instance zmk_endpoints_selected(void);
 
 int zmk_endpoints_send_report(uint16_t usage_page);

app/include/zmk/endpoints_types.h

@@ -6,7 +6,33 @@
 
 #pragma once
 
-enum zmk_endpoint {
-    ZMK_ENDPOINT_USB,
-    ZMK_ENDPOINT_BLE,
+/**
+ * The method by which data is sent.
+ */
+enum zmk_transport {
+    ZMK_TRANSPORT_USB,
+    ZMK_TRANSPORT_BLE,
+};
+
+/**
+ * Configuration to select an endpoint on ZMK_TRANSPORT_USB.
+ */
+struct zmk_transport_usb_data {};
+
+/**
+ * Configuration to select an endpoint on ZMK_TRANSPORT_BLE.
+ */
+struct zmk_transport_ble_data {
+    int profile_index;
+};
+
+/**
+ * A specific endpoint to which data may be sent.
+ */
+struct zmk_endpoint_instance {
+    enum zmk_transport transport;
+    union {
+        struct zmk_transport_usb_data usb; // ZMK_TRANSPORT_USB
+        struct zmk_transport_ble_data ble; // ZMK_TRANSPORT_BLE
+    };
 };

app/include/zmk/events/endpoint_selection_changed.h → app/include/zmk/events/endpoint_changed.h

@@ -11,8 +11,8 @@
 #include <zmk/endpoints_types.h>
 #include <zmk/event_manager.h>
 
-struct zmk_endpoint_selection_changed {
-    enum zmk_endpoint endpoint;
+struct zmk_endpoint_changed {
+    struct zmk_endpoint_instance endpoint;
 };
 
-ZMK_EVENT_DECLARE(zmk_endpoint_selection_changed);
+ZMK_EVENT_DECLARE(zmk_endpoint_changed);

app/include/zmk/events/hid_indicators_changed.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zmk/hid_indicators_types.h>
+#include <zmk/event_manager.h>
+
+struct zmk_hid_indicators_changed {
+    zmk_hid_indicators indicators;
+};
+
+ZMK_EVENT_DECLARE(zmk_hid_indicators_changed);