From 14d98c5207c2591895801bc050abbbfdd539a6fa Mon Sep 17 00:00:00 2001 From: Chris Andreae Date: Tue, 14 Nov 2023 12:12:10 +0900 Subject: [PATCH] fixup! Rename BT_DISCONNECT to BT_DISC --- app/include/dt-bindings/zmk/bt.h | 4 ++-- app/src/behaviors/behavior_bt.c | 2 +- docs/docs/behaviors/bluetooth.md | 18 +++++++++--------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/app/include/dt-bindings/zmk/bt.h b/app/include/dt-bindings/zmk/bt.h index 215f8559..7af89ddb 100644 --- a/app/include/dt-bindings/zmk/bt.h +++ b/app/include/dt-bindings/zmk/bt.h @@ -9,7 +9,7 @@ #define BT_PRV_CMD 2 #define BT_SEL_CMD 3 // #define BT_FULL_RESET_CMD 4 -#define BT_DISCONNECT_CMD 5 +#define BT_DISC_CMD 5 /* Note: Some future commands will include additional parameters, so we @@ -20,4 +20,4 @@ defines these aliases up front. #define BT_NXT BT_NXT_CMD 0 #define BT_PRV BT_PRV_CMD 0 #define BT_SEL BT_SEL_CMD -#define BT_DISCONNECT BT_DISCONNECT_CMD +#define BT_DISC BT_DISC_CMD diff --git a/app/src/behaviors/behavior_bt.c b/app/src/behaviors/behavior_bt.c index 319014b4..bf98532c 100644 --- a/app/src/behaviors/behavior_bt.c +++ b/app/src/behaviors/behavior_bt.c @@ -31,7 +31,7 @@ static int on_keymap_binding_pressed(struct zmk_behavior_binding *binding, return zmk_ble_prof_prev(); case BT_SEL_CMD: return zmk_ble_prof_select(binding->param2); - case BT_DISCONNECT_CMD: + case BT_DISC_CMD: return zmk_ble_prof_disconnect(binding->param2); default: LOG_ERR("Unknown BT command: %d", binding->param1); diff --git a/docs/docs/behaviors/bluetooth.md b/docs/docs/behaviors/bluetooth.md index c4408a7c..f3434dc2 100644 --- a/docs/docs/behaviors/bluetooth.md +++ b/docs/docs/behaviors/bluetooth.md @@ -14,7 +14,7 @@ When pairing to a host device ZMK saves bond information to the selected profile A ZMK device may show as "connected" on multiple hosts at the same time. This is working as intended, and only the host associated with the active profile will receive keystrokes. -An inactive connected profile can be explicitly disconnected using the `BT_DISCONNECT` behavior. This can be helpful in +An inactive connected profile can be explicitly disconnected using the `BT_DISC` behavior. This can be helpful in cases when host devices behave differently when a bluetooth keyboard is connected, for example by hiding their on-screen keyboard. @@ -33,14 +33,14 @@ This will allow you to reference the actions defined in this header such as `BT_ Here is a table describing the command for each define: -| Define | Action | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BT_CLR` | Clear bond information between the keyboard and host for the selected profile. | -| `BT_NXT` | Switch to the next profile, cycling through to the first one when the end is reached. | -| `BT_PRV` | Switch to the previous profile, cycling through to the last one when the beginning is reached. | -| `BT_SEL` | Select the 0-indexed profile by number. Please note: this definition must include a number as an argument in the keymap to work correctly. eg. `BT_SEL 0` | -| `BT_DISCONNECT` | Disconnect from the 0-indexed profile by number, if it's currently connected and inactive. Please note: this definition must include a number as an | -| | argument in the keymap to work correctly. eg. `BT_DISCONNECT 0` | +| Define | Action | +| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `BT_CLR` | Clear bond information between the keyboard and host for the selected profile. | +| `BT_NXT` | Switch to the next profile, cycling through to the first one when the end is reached. | +| `BT_PRV` | Switch to the previous profile, cycling through to the last one when the beginning is reached. | +| `BT_SEL` | Select the 0-indexed profile by number. Please note: this definition must include a number as an argument in the keymap to work correctly. eg. `BT_SEL 0` | +| `BT_DISC` | Disconnect from the 0-indexed profile by number, if it's currently connected and inactive. Please note: this definition must include a number as an | +| | argument in the keymap to work correctly. eg. `BT_DISC 0` | :::note Selected profile persistence The profile that is selected by the `BT_SEL`/`BT_PRV`/`BT_NXT` actions will be saved to flash storage and hence persist across restarts and firmware flashes.