Update documentation for keys that are actually handled.

This commit is contained in:
Nick Brassel 2024-08-13 11:50:54 +10:00
parent 89ac5cb0ff
commit 2577f05cb3
No known key found for this signature in database
3 changed files with 12 additions and 11 deletions

View File

@ -40,7 +40,7 @@ BLUETOOTH_DRIVER = bluefruit_le # or rn42
This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both. This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.
| Key | Aliases | Description | | Key | Aliases | Description |
|---------------------|---------|----------------------------------------------| |-----------------------|----------------------|------------------------------------------------|
|`QK_OUTPUT_AUTO` |`OU_AUTO`|Automatically switch between USB and Bluetooth| | `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth |
| `QK_OUTPUT_USB` | `OU_USB` | USB only | | `QK_OUTPUT_USB` | `OU_USB` | USB only |
| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | | `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only |

View File

@ -295,8 +295,8 @@ See also: [Backlighting](features/backlight)
See also: [Bluetooth](features/bluetooth) See also: [Bluetooth](features/bluetooth)
| Key | Aliases | Description | | Key | Aliases | Description |
|---------------------|---------|----------------------------------------------| |-----------------------|----------------------|------------------------------------------------|
|`QK_OUTPUT_AUTO` |`OU_AUTO`|Automatically switch between USB and Bluetooth| | `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth |
| `QK_OUTPUT_USB` | `OU_USB` | USB only | | `QK_OUTPUT_USB` | `OU_USB` | USB only |
| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | | `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only |

View File

@ -7,7 +7,7 @@ bool process_connection(uint16_t keycode, keyrecord_t *record) {
if (record->event.pressed) { if (record->event.pressed) {
switch (keycode) { switch (keycode) {
case QK_OUTPUT_NEXT: case QK_OUTPUT_NEXT:
set_output(OUTPUT_AUTO); set_output(OUTPUT_AUTO); // This should cycle through the outputs going forward. Ensure `docs/features/bluetooth.md` is updated when it does.
return false; return false;
case QK_OUTPUT_USB: case QK_OUTPUT_USB:
set_output(OUTPUT_USB); set_output(OUTPUT_USB);
@ -28,6 +28,7 @@ bool process_connection(uint16_t keycode, keyrecord_t *record) {
case QK_BLUETOOTH_PROFILE4: case QK_BLUETOOTH_PROFILE4:
case QK_BLUETOOTH_PROFILE5: case QK_BLUETOOTH_PROFILE5:
// As-yet unimplemented. // As-yet unimplemented.
// When implementation is done, ensure `docs/features/bluetooth.md` is updated accordingly.
return false; return false;
} }
} }