From 52df05a5453685e4e4043a5652793ca1dcc01f30 Mon Sep 17 00:00:00 2001 From: KemoNine Date: Fri, 4 Dec 2020 03:51:29 +0000 Subject: [PATCH] Tweak/cleanup bluetooth documentation so it's more clear which codes should be used in keymaps as well as to call attention to BT_SEL requiring a second parameter --- docs/docs/behaviors/bluetooth.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/docs/docs/behaviors/bluetooth.md b/docs/docs/behaviors/bluetooth.md index be0fb23c..65fdcd1e 100644 --- a/docs/docs/behaviors/bluetooth.md +++ b/docs/docs/behaviors/bluetooth.md @@ -18,26 +18,16 @@ which is added at the top of the keymap file: #include ``` -This will allow you to reference the actions defined in this header such as `BT_CLR_CMD`. +This will allow you to reference the actions defined in this header such as `BT_CLR`. Here is a table describing the command for each define: -| Define | Action | -| ------------ | ---------------------------------------------------------------------------------------------- | -| `BT_CLR_CMD` | Clear bond information between the keyboard and host for the selected profile. | -| `BT_NXT_CMD` | Switch to the next profile, cycling through to the first one when the end is reached. | -| `BT_PRV_CMD` | Switch to the previous profile, cycling through to the last one when the beginning is reached. | -| `BT_SEL_CMD` | Select the 0-indexed profile by number. | - -Because at least one bluetooth commands takes an additional parameter, it is recommended to use -the following aliases in your keymap to avoid having to specify an ignored second parameter: - -| Define | Action | -| -------- | -------------------------------------------------------------------------------- | -| `BT_CLR` | Alias for `BT_CLR_CMD 0` to clear the current profile's bond to the current host | -| `BT_NXT` | Alias for `BT_NXT_CMD 0` to select the next profile | -| `BT_PRV` | Alias for `BT_PRV_CMD 0` to select the previous profile | -| `BT_SEL` | Alias for `BT_SEL_CMD` to select the given profile, e.g. `&bt BT_SEL 1` | +| 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` | ## Bluetooth Behavior @@ -46,8 +36,8 @@ The bluetooth behavior completes an bluetooth action given on press. ### Behavior Binding - Reference: `&bt` -- Parameter #1: The bluetooth command define, e.g. `BT_CLR_CMD` -- Parameter #2: (Reserved for future bluetooth command types) +- Parameter #1: The bluetooth command define, e.g. `BT_CLR` +- Parameter #2: Only applies to `BT_SEL` and is the 0-indexed profile by number ### Examples