Merge e8fcc9272a into ad7fbfef92

feat(ble): Use appearance set in the BT_DEVICE_APPEARANCE config (#3115 )
Properly use the BT_DEVICE_APPEARANCE Zephyr symbol to advertise the correct appearance, allowing overrides, for e.g. mice. Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-12-05 16:40:32 +01:00 · 2025-12-04 13:53:47 -05:00 · 2025-10-20 05:11:54 +00:00
5 changed files with 4382 additions and 270 deletions
--- a/app/Kconfig
+++ b/app/Kconfig
@ -25,6 +25,9 @@ config USB_DEVICE_PID
 config USB_DEVICE_MANUFACTURER
    default "ZMK Project"

+config BT_DEVICE_APPEARANCE
+    default 961
+
 config BT_DIS_PNP_VID
    default 0x1D50

--- a/app/src/ble.c
+++ b/app/src/ble.c
@ -65,13 +65,15 @@ static uint8_t active_profile;

 #define DEVICE_NAME CONFIG_BT_DEVICE_NAME
 #define DEVICE_NAME_LEN (sizeof(DEVICE_NAME) - 1)
+#define DEVICE_APPEARANCE                                                                          \
+    (uint8_t) CONFIG_BT_DEVICE_APPEARANCE, (uint8_t)(CONFIG_BT_DEVICE_APPEARANCE >> 8)

 BUILD_ASSERT(
    DEVICE_NAME_LEN <= CONFIG_BT_DEVICE_NAME_MAX,
    "ERROR: BLE device name is too long. Max length: " STRINGIFY(CONFIG_BT_DEVICE_NAME_MAX));

 static struct bt_data zmk_ble_ad[] = {
-    BT_DATA_BYTES(BT_DATA_GAP_APPEARANCE, 0xC1, 0x03),
+    BT_DATA_BYTES(BT_DATA_GAP_APPEARANCE, DEVICE_APPEARANCE),
    BT_DATA_BYTES(BT_DATA_FLAGS, (BT_LE_AD_GENERAL | BT_LE_AD_NO_BREDR)),
    BT_DATA_BYTES(BT_DATA_UUID16_SOME, 0x12, 0x18, /* HID Service */
                  0x0f, 0x18                       /* Battery Service */
--- a/docs/docs/config/bluetooth.md
+++ b/docs/docs/config/bluetooth.md
@ -16,3 +16,4 @@ See [Configuration Overview](index.md) for instructions on how to change these s
 | `CONFIG_ZMK_BLE_EXPERIMENTAL_FEATURES` | bool | Aggregate config that enables both `CONFIG_ZMK_BLE_EXPERIMENTAL_CONN` and `CONFIG_ZMK_BLE_EXPERIMENTAL_SEC`.                                                                                                       | n       |
 | `CONFIG_ZMK_BLE_PASSKEY_ENTRY`         | bool | Enable passkey entry during pairing for enhanced security. (Note: After enabling this, you will need to re-pair all previously paired hosts.)                                                                      | n       |
 | `CONFIG_BT_GATT_ENFORCE_SUBSCRIPTION`  | bool | Low level setting for GATT subscriptions. Set to `n` to work around an annoying Windows bug with battery notifications.                                                                                            | y       |
+| `CONFIG_BT_DEVICE_APPEARANCE`          | int  | Bluetooth device [appearance value](https://bluetooth.com/specifications/assigned-numbers) (should be converted from hexadecimal to decimal).                                                                      | 961     |
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/package.json
+++ b/docs/package.json
@ -16,7 +16,7 @@
  },
  "dependencies": {
    "@docusaurus/core": "^3.9.1",
-    "@docusaurus/preset-classic": "^3.9.1",
+    "@docusaurus/preset-classic": "^3.9.2",
    "@docusaurus/theme-mermaid": "^3.9.1",
    "@fortawesome/fontawesome-svg-core": "^6.7.1",
    "@fortawesome/free-solid-svg-icons": "^6.7.1",