summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2024-11-14 21:16:52 +1100
committerGitHub <noreply@github.com>2024-11-14 21:16:52 +1100
commit0bda0f47754d01aa904f9831ff58ef760807ab16 (patch)
treead041dd6bf343a021bc5afd9328f74badeafc1e7
parentf8b4e24d3720f369f8146fef7a6d2fd75f228e6f (diff)
Revert removal of `QK_OUTPUT_AUTO`, fixup docs to reflect. (#24593)
-rw-r--r--data/constants/keycodes/keycodes_0.0.6_connection.hjson18
-rw-r--r--docs/_aliases.json4
-rw-r--r--docs/_sidebar.json4
-rw-r--r--docs/features/wireless.md (renamed from docs/features/bluetooth.md)24
-rw-r--r--docs/keycodes.md30
-rw-r--r--docs/reference_info_json.md4
-rw-r--r--quantum/keycodes.h19
-rw-r--r--tests/test_common/keycode_table.cpp1
8 files changed, 69 insertions, 35 deletions
diff --git a/data/constants/keycodes/keycodes_0.0.6_connection.hjson b/data/constants/keycodes/keycodes_0.0.6_connection.hjson
index 9a1a750f1a..9be1106825 100644
--- a/data/constants/keycodes/keycodes_0.0.6_connection.hjson
+++ b/data/constants/keycodes/keycodes_0.0.6_connection.hjson
@@ -7,41 +7,47 @@
7 "keycodes": { 7 "keycodes": {
8 "0x7780": { 8 "0x7780": {
9 "group": "connection", 9 "group": "connection",
10 "key": "QK_OUTPUT_NEXT", 10 "key": "QK_OUTPUT_AUTO",
11 "aliases": [ 11 "aliases": [
12 "OU_NEXT",
13 "OU_AUTO" 12 "OU_AUTO"
14 ] 13 ]
15 }, 14 },
16 "0x7781": { 15 "0x7781": {
17 "group": "connection", 16 "group": "connection",
17 "key": "QK_OUTPUT_NEXT",
18 "aliases": [
19 "OU_NEXT"
20 ]
21 },
22 "0x7782": {
23 "group": "connection",
18 "key": "QK_OUTPUT_PREV", 24 "key": "QK_OUTPUT_PREV",
19 "aliases": [ 25 "aliases": [
20 "OU_PREV" 26 "OU_PREV"
21 ] 27 ]
22 }, 28 },
23 "0x7782": { 29 "0x7783": {
24 "group": "connection", 30 "group": "connection",
25 "key": "QK_OUTPUT_NONE", 31 "key": "QK_OUTPUT_NONE",
26 "aliases": [ 32 "aliases": [
27 "OU_NONE" 33 "OU_NONE"
28 ] 34 ]
29 }, 35 },
30 "0x7783": { 36 "0x7784": {
31 "group": "connection", 37 "group": "connection",
32 "key": "QK_OUTPUT_USB", 38 "key": "QK_OUTPUT_USB",
33 "aliases": [ 39 "aliases": [
34 "OU_USB" 40 "OU_USB"
35 ] 41 ]
36 }, 42 },
37 "0x7784": { 43 "0x7785": {
38 "group": "connection", 44 "group": "connection",
39 "key": "QK_OUTPUT_2P4GHZ", 45 "key": "QK_OUTPUT_2P4GHZ",
40 "aliases": [ 46 "aliases": [
41 "OU_2P4G" 47 "OU_2P4G"
42 ] 48 ]
43 }, 49 },
44 "0x7785": { 50 "0x7786": {
45 "group": "connection", 51 "group": "connection",
46 "key": "QK_OUTPUT_BLUETOOTH", 52 "key": "QK_OUTPUT_BLUETOOTH",
47 "aliases": [ 53 "aliases": [
diff --git a/docs/_aliases.json b/docs/_aliases.json
index f06e032215..0dfcdea1e2 100644
--- a/docs/_aliases.json
+++ b/docs/_aliases.json
@@ -16,6 +16,8 @@
16 "/tutorial": "/newbs", 16 "/tutorial": "/newbs",
17 "/unicode": "/feature_unicode", 17 "/unicode": "/feature_unicode",
18 18
19 "/features/bluetooth": "/features/wireless",
20
19 "/adc_driver": "/drivers/adc", 21 "/adc_driver": "/drivers/adc",
20 "/apa102_driver": "/drivers/apa102", 22 "/apa102_driver": "/drivers/apa102",
21 "/audio_driver": "/drivers/audio", 23 "/audio_driver": "/drivers/audio",
@@ -24,7 +26,7 @@
24 "/feature_auto_shift": "/features/auto_shift", 26 "/feature_auto_shift": "/features/auto_shift",
25 "/feature_autocorrect": "/features/autocorrect", 27 "/feature_autocorrect": "/features/autocorrect",
26 "/feature_backlight": "/features/backlight", 28 "/feature_backlight": "/features/backlight",
27 "/feature_bluetooth": "/features/bluetooth", 29 "/feature_bluetooth": "/features/wireless",
28 "/feature_bootmagic": "/features/bootmagic", 30 "/feature_bootmagic": "/features/bootmagic",
29 "/feature_caps_word": "/features/caps_word", 31 "/feature_caps_word": "/features/caps_word",
30 "/feature_combo": "/features/combo", 32 "/feature_combo": "/features/combo",
diff --git a/docs/_sidebar.json b/docs/_sidebar.json
index d691011d64..7f353ad351 100644
--- a/docs/_sidebar.json
+++ b/docs/_sidebar.json
@@ -166,7 +166,6 @@
166 ] 166 ]
167 }, 167 },
168 { "text": "Audio", "link": "/features/audio" }, 168 { "text": "Audio", "link": "/features/audio" },
169 { "text": "Bluetooth", "link": "/features/bluetooth" },
170 { "text": "Bootmagic", "link": "/features/bootmagic" }, 169 { "text": "Bootmagic", "link": "/features/bootmagic" },
171 { "text": "Converters", "link": "/feature_converters" }, 170 { "text": "Converters", "link": "/feature_converters" },
172 { "text": "Custom Matrix", "link": "/custom_matrix" }, 171 { "text": "Custom Matrix", "link": "/custom_matrix" },
@@ -179,7 +178,8 @@
179 { "text": "Pointing Device", "link": "/features/pointing_device" }, 178 { "text": "Pointing Device", "link": "/features/pointing_device" },
180 { "text": "PS/2 Mouse", "link": "/features/ps2_mouse" }, 179 { "text": "PS/2 Mouse", "link": "/features/ps2_mouse" },
181 { "text": "Split Keyboard", "link": "/features/split_keyboard" }, 180 { "text": "Split Keyboard", "link": "/features/split_keyboard" },
182 { "text": "Stenography", "link": "/features/stenography" } 181 { "text": "Stenography", "link": "/features/stenography" },
182 { "text": "Wireless", "link": "/features/wireless" }
183 ] 183 ]
184 }, 184 },
185 { 185 {
diff --git a/docs/features/bluetooth.md b/docs/features/wireless.md
index d3634498be..0d73ad3583 100644
--- a/docs/features/bluetooth.md
+++ b/docs/features/wireless.md
@@ -1,4 +1,4 @@
1# Bluetooth 1# Wireless / Bluetooth
2 2
3## Bluetooth Known Supported Hardware 3## Bluetooth Known Supported Hardware
4 4
@@ -39,8 +39,20 @@ BLUETOOTH_DRIVER = bluefruit_le # or rn42
39 39
40This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both. 40This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.
41 41
42| Key | Aliases | Description | 42| Key | Aliases | Description |
43|-----------------------|----------------------|------------------------------------------------| 43|-----------------------------|-----------|-----------------------------------------------------------------------------------------------|
44| `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth | 44| `QK_OUTPUT_AUTO` | `OU_AUTO` | Automatically switch to USB when plugged in, otherwise use wireless |
45| `QK_OUTPUT_USB` | `OU_USB` | USB only | 45| `QK_OUTPUT_NEXT` | `OU_NEXT` | Cycle forwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |
46| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | 46| `QK_OUTPUT_PREV` | `OU_PREV` | Cycle backwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |
47| `QK_OUTPUT_NONE` | `OU_NONE` | Disable all output **(not yet implemented)** |
48| `QK_OUTPUT_USB` | `OU_USB` | Output to USB only |
49| `QK_OUTPUT_2P4GHZ` | `OU_2P4G` | Output to 2.4GHz only **(not yet implemented)** |
50| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Output to Bluetooth only |
51| `QK_BLUETOOTH_PROFILE_NEXT` | `BT_NEXT` | Move to the next Bluetooth profile **(not yet implemented)** |
52| `QK_BLUETOOTH_PROFILE_PREV` | `BT_PREV` | Move to the previous Bluetooth profile **(not yet implemented)** |
53| `QK_BLUETOOTH_UNPAIR` | `BT_UNPR` | Un-pair the current Bluetooth profile **(not yet implemented)** |
54| `QK_BLUETOOTH_PROFILE1` | `BT_PRF1` | Swap to Bluetooth profile #1 **(not yet implemented)** |
55| `QK_BLUETOOTH_PROFILE2` | `BT_PRF2` | Swap to Bluetooth profile #2 **(not yet implemented)** |
56| `QK_BLUETOOTH_PROFILE3` | `BT_PRF3` | Swap to Bluetooth profile #3 **(not yet implemented)** |
57| `QK_BLUETOOTH_PROFILE4` | `BT_PRF4` | Swap to Bluetooth profile #4 **(not yet implemented)** |
58| `QK_BLUETOOTH_PROFILE5` | `BT_PRF5` | Swap to Bluetooth profile #5 **(not yet implemented)** |
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 1210390f54..3665747a0b 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -290,15 +290,27 @@ See also: [Backlighting](features/backlight)
290| `QK_BACKLIGHT_DOWN` | `BL_DOWN` | Decrease the backlight level | 290| `QK_BACKLIGHT_DOWN` | `BL_DOWN` | Decrease the backlight level |
291| `QK_BACKLIGHT_TOGGLE_BREATHING` | `BL_BRTG` | Toggle backlight breathing | 291| `QK_BACKLIGHT_TOGGLE_BREATHING` | `BL_BRTG` | Toggle backlight breathing |
292 292
293## Bluetooth {#bluetooth} 293## Wireless/Bluetooth {#bluetooth}
294 294
295See also: [Bluetooth](features/bluetooth) 295See also: [Wireless](features/wireless)
296 296
297| Key | Aliases | Description | 297| Key | Aliases | Description |
298|-----------------------|----------------------|------------------------------------------------| 298|-----------------------------|-----------|-----------------------------------------------------------------------------------------------|
299| `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth | 299| `QK_OUTPUT_AUTO` | `OU_AUTO` | Automatically switch to USB when plugged in, otherwise use wireless |
300| `QK_OUTPUT_USB` | `OU_USB` | USB only | 300| `QK_OUTPUT_NEXT` | `OU_NEXT` | Cycle forwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |
301| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | 301| `QK_OUTPUT_PREV` | `OU_PREV` | Cycle backwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |
302| `QK_OUTPUT_NONE` | `OU_NONE` | Disable all output **(not yet implemented)** |
303| `QK_OUTPUT_USB` | `OU_USB` | Output to USB only |
304| `QK_OUTPUT_2P4GHZ` | `OU_2P4G` | Output to 2.4GHz only **(not yet implemented)** |
305| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Output to Bluetooth only |
306| `QK_BLUETOOTH_PROFILE_NEXT` | `BT_NEXT` | Move to the next Bluetooth profile **(not yet implemented)** |
307| `QK_BLUETOOTH_PROFILE_PREV` | `BT_PREV` | Move to the previous Bluetooth profile **(not yet implemented)** |
308| `QK_BLUETOOTH_UNPAIR` | `BT_UNPR` | Un-pair the current Bluetooth profile **(not yet implemented)** |
309| `QK_BLUETOOTH_PROFILE1` | `BT_PRF1` | Swap to Bluetooth profile #1 **(not yet implemented)** |
310| `QK_BLUETOOTH_PROFILE2` | `BT_PRF2` | Swap to Bluetooth profile #2 **(not yet implemented)** |
311| `QK_BLUETOOTH_PROFILE3` | `BT_PRF3` | Swap to Bluetooth profile #3 **(not yet implemented)** |
312| `QK_BLUETOOTH_PROFILE4` | `BT_PRF4` | Swap to Bluetooth profile #4 **(not yet implemented)** |
313| `QK_BLUETOOTH_PROFILE5` | `BT_PRF5` | Swap to Bluetooth profile #5 **(not yet implemented)** |
302 314
303## Caps Word {#caps-word} 315## Caps Word {#caps-word}
304 316
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index c1061cdf82..99ff7b1f7a 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -177,9 +177,9 @@ Configures the [Backlight](features/backlight) feature.
177 * `pins` <Badge type="info">Array: Pin</Badge> 177 * `pins` <Badge type="info">Array: Pin</Badge>
178 * A list of GPIO pins connected to the backlight LEDs (`software` and `timer` drivers only). 178 * A list of GPIO pins connected to the backlight LEDs (`software` and `timer` drivers only).
179 179
180## Bluetooth {#bluetooth} 180## Wireless/Bluetooth {#bluetooth}
181 181
182Configures the [Bluetooth](features/bluetooth) feature. 182Configures the [Wireless](features/wireless) feature.
183 183
184* `bluetooth` 184* `bluetooth`
185 * `driver` <Badge type="info">String</Badge> 185 * `driver` <Badge type="info">String</Badge>
diff --git a/quantum/keycodes.h b/quantum/keycodes.h
index 38127bb6da..51b7eb6c9a 100644
--- a/quantum/keycodes.h
+++ b/quantum/keycodes.h
@@ -622,12 +622,13 @@ enum qk_keycode_defines {
622 QK_MACRO_29 = 0x771D, 622 QK_MACRO_29 = 0x771D,
623 QK_MACRO_30 = 0x771E, 623 QK_MACRO_30 = 0x771E,
624 QK_MACRO_31 = 0x771F, 624 QK_MACRO_31 = 0x771F,
625 QK_OUTPUT_NEXT = 0x7780, 625 QK_OUTPUT_AUTO = 0x7780,
626 QK_OUTPUT_PREV = 0x7781, 626 QK_OUTPUT_NEXT = 0x7781,
627 QK_OUTPUT_NONE = 0x7782, 627 QK_OUTPUT_PREV = 0x7782,
628 QK_OUTPUT_USB = 0x7783, 628 QK_OUTPUT_NONE = 0x7783,
629 QK_OUTPUT_2P4GHZ = 0x7784, 629 QK_OUTPUT_USB = 0x7784,
630 QK_OUTPUT_BLUETOOTH = 0x7785, 630 QK_OUTPUT_2P4GHZ = 0x7785,
631 QK_OUTPUT_BLUETOOTH = 0x7786,
631 QK_BLUETOOTH_PROFILE_NEXT = 0x7790, 632 QK_BLUETOOTH_PROFILE_NEXT = 0x7790,
632 QK_BLUETOOTH_PROFILE_PREV = 0x7791, 633 QK_BLUETOOTH_PROFILE_PREV = 0x7791,
633 QK_BLUETOOTH_UNPAIR = 0x7792, 634 QK_BLUETOOTH_UNPAIR = 0x7792,
@@ -1309,8 +1310,8 @@ enum qk_keycode_defines {
1309 MC_29 = QK_MACRO_29, 1310 MC_29 = QK_MACRO_29,
1310 MC_30 = QK_MACRO_30, 1311 MC_30 = QK_MACRO_30,
1311 MC_31 = QK_MACRO_31, 1312 MC_31 = QK_MACRO_31,
1313 OU_AUTO = QK_OUTPUT_AUTO,
1312 OU_NEXT = QK_OUTPUT_NEXT, 1314 OU_NEXT = QK_OUTPUT_NEXT,
1313 OU_AUTO = QK_OUTPUT_NEXT,
1314 OU_PREV = QK_OUTPUT_PREV, 1315 OU_PREV = QK_OUTPUT_PREV,
1315 OU_NONE = QK_OUTPUT_NONE, 1316 OU_NONE = QK_OUTPUT_NONE,
1316 OU_USB = QK_OUTPUT_USB, 1317 OU_USB = QK_OUTPUT_USB,
@@ -1494,7 +1495,7 @@ enum qk_keycode_defines {
1494#define IS_AUDIO_KEYCODE(code) ((code) >= QK_AUDIO_ON && (code) <= QK_AUDIO_VOICE_PREVIOUS) 1495#define IS_AUDIO_KEYCODE(code) ((code) >= QK_AUDIO_ON && (code) <= QK_AUDIO_VOICE_PREVIOUS)
1495#define IS_STENO_KEYCODE(code) ((code) >= QK_STENO_BOLT && (code) <= QK_STENO_COMB_MAX) 1496#define IS_STENO_KEYCODE(code) ((code) >= QK_STENO_BOLT && (code) <= QK_STENO_COMB_MAX)
1496#define IS_MACRO_KEYCODE(code) ((code) >= QK_MACRO_0 && (code) <= QK_MACRO_31) 1497#define IS_MACRO_KEYCODE(code) ((code) >= QK_MACRO_0 && (code) <= QK_MACRO_31)
1497#define IS_CONNECTION_KEYCODE(code) ((code) >= QK_OUTPUT_NEXT && (code) <= QK_BLUETOOTH_PROFILE5) 1498#define IS_CONNECTION_KEYCODE(code) ((code) >= QK_OUTPUT_AUTO && (code) <= QK_BLUETOOTH_PROFILE5)
1498#define IS_BACKLIGHT_KEYCODE(code) ((code) >= QK_BACKLIGHT_ON && (code) <= QK_BACKLIGHT_TOGGLE_BREATHING) 1499#define IS_BACKLIGHT_KEYCODE(code) ((code) >= QK_BACKLIGHT_ON && (code) <= QK_BACKLIGHT_TOGGLE_BREATHING)
1499#define IS_LED_MATRIX_KEYCODE(code) ((code) >= QK_LED_MATRIX_ON && (code) <= QK_LED_MATRIX_SPEED_DOWN) 1500#define IS_LED_MATRIX_KEYCODE(code) ((code) >= QK_LED_MATRIX_ON && (code) <= QK_LED_MATRIX_SPEED_DOWN)
1500#define IS_UNDERGLOW_KEYCODE(code) ((code) >= QK_UNDERGLOW_TOGGLE && (code) <= QK_UNDERGLOW_SPEED_DOWN) 1501#define IS_UNDERGLOW_KEYCODE(code) ((code) >= QK_UNDERGLOW_TOGGLE && (code) <= QK_UNDERGLOW_SPEED_DOWN)
@@ -1520,7 +1521,7 @@ enum qk_keycode_defines {
1520#define AUDIO_KEYCODE_RANGE QK_AUDIO_ON ... QK_AUDIO_VOICE_PREVIOUS 1521#define AUDIO_KEYCODE_RANGE QK_AUDIO_ON ... QK_AUDIO_VOICE_PREVIOUS
1521#define STENO_KEYCODE_RANGE QK_STENO_BOLT ... QK_STENO_COMB_MAX 1522#define STENO_KEYCODE_RANGE QK_STENO_BOLT ... QK_STENO_COMB_MAX
1522#define MACRO_KEYCODE_RANGE QK_MACRO_0 ... QK_MACRO_31 1523#define MACRO_KEYCODE_RANGE QK_MACRO_0 ... QK_MACRO_31
1523#define CONNECTION_KEYCODE_RANGE QK_OUTPUT_NEXT ... QK_BLUETOOTH_PROFILE5 1524#define CONNECTION_KEYCODE_RANGE QK_OUTPUT_AUTO ... QK_BLUETOOTH_PROFILE5
1524#define BACKLIGHT_KEYCODE_RANGE QK_BACKLIGHT_ON ... QK_BACKLIGHT_TOGGLE_BREATHING 1525#define BACKLIGHT_KEYCODE_RANGE QK_BACKLIGHT_ON ... QK_BACKLIGHT_TOGGLE_BREATHING
1525#define LED_MATRIX_KEYCODE_RANGE QK_LED_MATRIX_ON ... QK_LED_MATRIX_SPEED_DOWN 1526#define LED_MATRIX_KEYCODE_RANGE QK_LED_MATRIX_ON ... QK_LED_MATRIX_SPEED_DOWN
1526#define UNDERGLOW_KEYCODE_RANGE QK_UNDERGLOW_TOGGLE ... QK_UNDERGLOW_SPEED_DOWN 1527#define UNDERGLOW_KEYCODE_RANGE QK_UNDERGLOW_TOGGLE ... QK_UNDERGLOW_SPEED_DOWN
diff --git a/tests/test_common/keycode_table.cpp b/tests/test_common/keycode_table.cpp
index e4d445de82..a520dd3f2b 100644
--- a/tests/test_common/keycode_table.cpp
+++ b/tests/test_common/keycode_table.cpp
@@ -562,6 +562,7 @@ std::map<uint16_t, std::string> KEYCODE_ID_TABLE = {
562 {QK_MACRO_29, "QK_MACRO_29"}, 562 {QK_MACRO_29, "QK_MACRO_29"},
563 {QK_MACRO_30, "QK_MACRO_30"}, 563 {QK_MACRO_30, "QK_MACRO_30"},
564 {QK_MACRO_31, "QK_MACRO_31"}, 564 {QK_MACRO_31, "QK_MACRO_31"},
565 {QK_OUTPUT_AUTO, "QK_OUTPUT_AUTO"},
565 {QK_OUTPUT_NEXT, "QK_OUTPUT_NEXT"}, 566 {QK_OUTPUT_NEXT, "QK_OUTPUT_NEXT"},
566 {QK_OUTPUT_PREV, "QK_OUTPUT_PREV"}, 567 {QK_OUTPUT_PREV, "QK_OUTPUT_PREV"},
567 {QK_OUTPUT_NONE, "QK_OUTPUT_NONE"}, 568 {QK_OUTPUT_NONE, "QK_OUTPUT_NONE"},