From 201f5719de896172fcc7264ea6348c1cd9cbeac4 Mon Sep 17 00:00:00 2001 From: ReFil <31960031+ReFil@users.noreply.github.com> Date: Wed, 13 Nov 2024 15:06:26 +0000 Subject: [PATCH] Address review comments --- app/include/dt-bindings/zmk/bt.h | 6 +++--- app/include/zmk/ble.h | 4 ++-- app/src/behaviors/behavior_bt.c | 6 +++--- app/src/ble.c | 4 ++-- docs/docs/keymaps/behaviors/bluetooth.md | 10 +++++++--- 5 files changed, 17 insertions(+), 13 deletions(-) diff --git a/app/include/dt-bindings/zmk/bt.h b/app/include/dt-bindings/zmk/bt.h index 489c665f69c..a1e012699b6 100644 --- a/app/include/dt-bindings/zmk/bt.h +++ b/app/include/dt-bindings/zmk/bt.h @@ -25,6 +25,6 @@ defines these aliases up front. #define BT_SEL BT_SEL_CMD #define BT_CLR_ALL BT_CLR_ALL_CMD 0 #define BT_DISC BT_DISC_CMD -#define ADV_OFF BT_ADV_OFF_CMD 0 -#define ADV_ON BT_ADV_ON_CMD 0 -#define ADV_TOG BT_ADV_TOG_CMD 0 \ No newline at end of file +#define BT_ADV_OFF BT_ADV_OFF_CMD 0 +#define BT_ADV_ON BT_ADV_ON_CMD 0 +#define BT_ADV_TOG BT_ADV_TOG_CMD 0 \ No newline at end of file diff --git a/app/include/zmk/ble.h b/app/include/zmk/ble.h index 9f78f682fc5..26024c3521f 100644 --- a/app/include/zmk/ble.h +++ b/app/include/zmk/ble.h @@ -47,8 +47,8 @@ int zmk_ble_unpair_all(void); int zmk_ble_set_device_name(char *name); -void zmk_ble_adv_mode_set(bool mode); -bool zmk_ble_adv_mode_get(void); +void zmk_bt_adv_enabled_set(bool adv_enabled); +bool zmk_bt_adv_enabled_get(void); #if IS_ENABLED(CONFIG_ZMK_SPLIT_ROLE_CENTRAL) int zmk_ble_put_peripheral_addr(const bt_addr_le_t *addr); diff --git a/app/src/behaviors/behavior_bt.c b/app/src/behaviors/behavior_bt.c index 0ac21a664dc..12ccebc5766 100644 --- a/app/src/behaviors/behavior_bt.c +++ b/app/src/behaviors/behavior_bt.c @@ -121,13 +121,13 @@ static int on_keymap_binding_pressed(struct zmk_behavior_binding *binding, case BT_DISC_CMD: return zmk_ble_prof_disconnect(binding->param2); case BT_ADV_ON_CMD: - zmk_ble_adv_mode_set(true); + zmk_bt_adv_enabled_set(true); return 0; case BT_ADV_OFF_CMD: - zmk_ble_adv_mode_set(false); + zmk_bt_adv_enabled_set(false); return 0; case BT_ADV_TOG_CMD: - zmk_ble_adv_mode_set(zmk_ble_adv_mode_get() ? false : true); + zmk_bt_adv_enabled_set(zmk_bt_adv_enabled_get() ? false : true); return 0; default: LOG_ERR("Unknown BT command: %d", binding->param1); diff --git a/app/src/ble.c b/app/src/ble.c index e6d05e7da76..80c53ecd811 100644 --- a/app/src/ble.c +++ b/app/src/ble.c @@ -208,7 +208,7 @@ static void update_advertising_callback(struct k_work *work) { update_advertisin K_WORK_DEFINE(update_advertising_work, update_advertising_callback); -void zmk_ble_adv_mode_set(bool mode) { +void zmk_bt_adv_enabled_set(bool adv_enabled) { if (mode) { if (advertising_status != ZMK_ADV_CONN) { permit_adv = true; @@ -228,7 +228,7 @@ void zmk_ble_adv_mode_set(bool mode) { } } -bool zmk_ble_adv_mode_get(void) { return permit_adv; } +bool zmk_bt_adv_enabled_get(void) { return permit_adv; } static void clear_profile_bond(uint8_t profile) { if (bt_addr_le_cmp(&profiles[profile].peer, BT_ADDR_LE_ANY)) { diff --git a/docs/docs/keymaps/behaviors/bluetooth.md b/docs/docs/keymaps/behaviors/bluetooth.md index 6e7c4186170..bd9652224ba 100644 --- a/docs/docs/keymaps/behaviors/bluetooth.md +++ b/docs/docs/keymaps/behaviors/bluetooth.md @@ -46,15 +46,19 @@ Here is a table describing the command for each define: | `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; must include a number as an argument in the keymap to work correctly, e.g. `BT_SEL 0`. | | `BT_DISC` | Disconnect from the 0-indexed profile by number, if it's currently connected and inactive; must include a number as an argument in the keymap to work correctly, e.g. `BT_DISC 0`. | -| `ADV_OFF` | Disable advertising and disconnect from all profiles | -| `ADV_ON` | Enable advertising and attempt to reconnect to profiles | -| `ADV_TOG` | Toggle advertising on and off | +| `BT_ADV_OFF` | Disable advertising and disconnect from all profiles | +| `BT_ADV_ON` | Enable advertising and attempt to reconnect to profiles | +| `BT_ADV_TOG` | Toggle advertising on and off | :::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. However it will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE`](../../config/system.md#general) milliseconds in order to reduce potential wear on the flash memory. ::: +:::note[Advertising] +By default bluetooth advertising is enabled in all situations and doesn't have to be explicitly commanded +::: + ## Bluetooth Behavior The bluetooth behavior completes an bluetooth action given on press.