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

Reduce instructional steps

Browse source
This commit is contained in:
Albert Y 2022-03-30 07:44:05 +08:00
parent 8613a02ea9
commit 4c387224a2
1 changed files with 18 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
docs/docs/troubleshooting.md
View file

@ -51,13 +51,11 @@ If you are reviewing these errors in the GitHub Actions tab, the contents of `<b
### Split Keyboard Halves Unable to Pair
Previously, pairing split keyboard halves involved a **BLE Reset** via a combination of held keys that removed all bluetooth profile information from the keyboard.
Since then, Bluetooth reset for split keyboards can be performed by flashing a settings reset firmware to both halves with one of the following options:
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:
#### Option 1: Build Reset UF2 in 'zmk-config'
Find the `build.yaml` file in your `zmk-config` folder and add an additional settings reset build for the board used by your split keyboard. For example assume that
we have setup nice!nano v2 for Corne, apppend the following `settings_reset` shield to the `build.yaml` file:
Find the `build.yaml` file in your `zmk-config` folder and add an additional settings reset build for the board used by your split keyboard. For example assume that we have setup nice!nano v2 for Corne, apppend the following `settings_reset` shield to the `build.yaml` file:
```yml
include:
@ -69,31 +67,28 @@ include:
shield: settings_reset
```
Save the file, commit the changes and push them to GitHub. Download the new firmware zip file build by the latest GitHub Actions job. In it you will find an
additional `settings_reset` UF2 image file. Reset the split keyboard with the following steps:
Save the file, commit the changes and push them to GitHub. Download the new firmware zip file build by the latest GitHub Actions job. In it you will find an additional `settings_reset` UF2 image file.
#### Option 2: Download Reset UF2 from ZMK's Workflow
1. [Open the GitHub `Actions` tab and select the `Build` workflow](https://github.com/zmkfirmware/zmk/actions?query=workflow%3ABuild+branch%3Amain+event%3Apush).
2. Find one of the 'results' for which the core-coverage job was successfully run, indicated by a green checkmark in the core-coverage bubble like the image example below.
3. From the next page under "Artifacts", download and unzip the `$boardname-settings_reset-zmk` zip file for the UF2 image.
| ![Successful core-coverage Job](../docs/assets/troubleshooting/splitpairing/corecoverage.png) |
| :-------------------------------------------------------------------------------------------: |
| An example of a successful core-coverage job which will produce a settings_reset firmware. |
#### Reset Split Keyboard Procedure
Perform the following steps to reset both halves of your split keyboard:
1. Put each half of the split keyboard into bootloader mode.
2. Flash one of the halves of the split with the downloaded settings reset UF2 image. Immediately after flashing the chosen half, immediately put it into bootloader mode to avoid accidental bonding between the halves.
3. Repeat step 2 with the other half of the split keyboard.
4. 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).
#### Option 2: Download Reset UF2 from ZMK's Workflow
1. [Open the GitHub `Actions` tab and select the `Build` workflow](https://github.com/zmkfirmware/zmk/actions?query=workflow%3ABuild+branch%3Amain+event%3Apush).
2. Find one of the 'results' for which the core-coverage job was successfully run, indicated by a green checkmark in the core-coverage bubble.
3. From the next page under "Artifacts", download the `$boardname-settings_reset-zmk` zip file.
4. Unzip the downloaded file.
5. Put each half of the split keyboard into bootloader mode.
6. Flash one of the halves of the split with the "settings reset" UF2 image from step 4. Immediately after flashing the chosen half, immediately put it into bootloader mode to avoid accidental bonding between the halves.
7. Repeat step 6 with the other half of the split keyboard.
8. 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).
| ![Successful core-coverage Job](../docs/assets/troubleshooting/splitpairing/corecoverage.png) |
| :-------------------------------------------------------------------------------------------: |
| An example of a successful core-coverage job which will produce a settings_reset firmware. |
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.
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.
### Connectivity Issues