kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update settings_reset documentation

Browse source 
Updated the section for troubleshooting split halves unable to pair now
that the settings_reset shield resets all settings and explicitly
disables CONFIG_ZMK_BLE:

- Added a note that all settings will be reset.
- Removed the section about immediately putting the halves into
  bootloader mode to prevent pairing, as this is not necessary anymore.
- Added a note that you will not be able to see or pair the Bluetooth
  keyboard until you have flashed regular firmware again.
- Added a sentence to clarify that you will need to re-pair the
  keyboard to all host devices.

Also added some text describing common scenarios where this procedure
might be needed.
This commit is contained in:
Joel Spadin 2024-02-04 12:34:26 -06:00 • committed by Pete Johanson
parent 1dfcfc7d3f
commit 14b06a36bf
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/docs/troubleshooting.md
View file

@ -68,7 +68,20 @@ A common mistake that leads to this error is to use [key press keycodes](behavio
### Split Keyboard Halves Unable to Pair
Split keyboard halves pairing issue can be resolved by flashing a settings reset firmware to both controllers. You will first need to acquire the reset UF2 image file with one of the following options:
Split keyboard halves will automatically pair with one another, but there are some cases where this breaks, and the pairing needs to be reset, for example:
- Switching which halves are the central/peripheral.
- Replacing the controller for one of the halves.
These issues can be resolved by flashing a settings reset firmware to both controllers.
:::warning
This procedure will erase all settings, such as Bluetooth profiles, output selection, RGB underglow color, etc.
:::
First, acquire the reset UF2 image file with one of the following options:
#### Option 1: Build Reset UF2 in 'zmk-config'
@ -101,8 +114,16 @@ Save the file, commit the changes and push them to GitHub. Download the new firm
Perform the following steps to reset both halves of your split keyboard:
1. Put each half of the split keyboard into bootloader mode.
1. Flash one of the halves of the split with the downloaded settings reset UF2 image. Immediately after flashing the chosen half, put it into bootloader mode to avoid accidental bonding between the halves.
1. Flash one of the halves of the split with the downloaded settings reset UF2 image.
1. Repeat step 2 with the other half of the split keyboard.
1. Flash the actual image for each half of the split keyboard (e.g `my_board_left.uf2` to the left half, `my_board_right.uf2` to the right half).
After completing these steps, pair the halves of the split keyboard together by resetting them at the same time. Most commonly, this is done by grounding the reset pins for each of your keyboard's microcontrollers or pressing the reset buttons at the same time.
Once this is done, you can remove/forget the keyboard on each host device and pair it again.
:::info
The settings reset firmware has Bluetooth disabled to prevent the two sides from automatically re-pairing until you are done resetting them both. You will not be able to pair your keyboard or see it in any Bluetooth device lists until you have flashed the normal firmware again.
:::