pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #254 from kurtis-lew/docissue220

Browse source 
Documented Issue #220
This commit is contained in:
Pete Johanson 2020-10-09 16:02:25 -04:00 committed by GitHub
commit 405ca7267f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/bond-reset.md
View file

@ -1,7 +1,7 @@
--- ---
id: bond-reset id: bond-reset
title: Reset BLE Connections title: Reset BLE Connections (DEPRECATED)
sidebar_label: BLE Reset sidebar_label: BLE Reset (DEPRECATED)
--- ---
Known as a 'bond reset', each keyboard has a special key combination independent of the user defined key map which will Known as a 'bond reset', each keyboard has a special key combination independent of the user defined key map which will

17
docs/docs/troubleshooting.md
View file

@ -63,3 +63,20 @@ After opening the `<board>.dts.pre.tmp:<line number>` and scrolling down to the
| ![Healthy Keymap Temp](../docs/assets/troubleshooting/keymaps/healthyEDIT.png) | | ![Healthy Keymap Temp](../docs/assets/troubleshooting/keymaps/healthyEDIT.png) |
| :-------------------------------------------------------------------------------: | | :-------------------------------------------------------------------------------: |
| A properly defined keymap with successful compilation. As shown in red, the corrected keycode (`&kp SPC`) references the proper Usage ID defined in the [USB HID Usage Tables](https://www.usb.org/document-library/hid-usage-tables-12)| | A properly defined keymap with successful compilation. As shown in red, the corrected keycode (`&kp SPC`) references the proper Usage ID defined in the [USB HID Usage Tables](https://www.usb.org/document-library/hid-usage-tables-12)|
### 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, a much simpler procedure of performing a bluetooth reset for split keyboards has come about, without the need for any file modification:
**New Procedure:**
1. Log into Github and download the "settings clear" UF2 image from the [latest build in Github Actions](https://github.com/zmkfirmware/zmk/actions?query=workflow%3ABuild+branch%3Amain)
1. Put each half of the split keyboard into bootloader mode
1. Flash one of the halves of the split with the "settings clear" UF2 image from step 1. Immediately after flashing "settings clear" to the chosen half, immediately put it into bootloader mode
to avoid accidental bonding between the halves.
1. Repeat step 3 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.

1
docs/sidebars.js
View file

@ -6,7 +6,6 @@ module.exports = {
"faq", "faq",
"user-setup", "user-setup",
"customization", "customization",
"bond-reset",
"troubleshooting" "troubleshooting"
], ],
Features: [ Features: [