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

Added info on connecting keyboard

Browse source
This commit is contained in:
Kevin 2020-08-29 17:25:37 -07:00
parent 76095c64c6
commit d7bd09149b
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/docs/user-setup.md
View file

@ -11,8 +11,7 @@ Unlike other keyboard firmwares, ZMK Firmware has been built from the ground up
their own keyboard configurations, including keymaps, specific hardware details, etc. all outside of the their own keyboard configurations, including keymaps, specific hardware details, etc. all outside of the
core ZMK Firmware source repository. core ZMK Firmware source repository.
In addition to this, most users do not need to install any complicated toolchains or tools to build ZMK, In addition to this, most users will not need to install any complicated toolchains or tools to build ZMK. GitHub Actions is used instead to automatically build the user's configured firmware for them.
instead using GitHub Actions to automatically build the user's configured firmware for them.
## Summary ## Summary
@ -170,7 +169,7 @@ a link to download the `firmware` upload:
Once downloaded, extract the zip and you can verify it should contain one or more `uf2` files, which will be copied to Once downloaded, extract the zip and you can verify it should contain one or more `uf2` files, which will be copied to
your keyboard. your keyboard.
### Installing UF2 Files ### Flashing UF2 Files
To flash the firmware, first put your board into bootloader mode by double clicking the reset button (either on the MCU board itself, To flash the firmware, first put your board into bootloader mode by double clicking the reset button (either on the MCU board itself,
or the one that is part of your keyboard). The controller should appear in your OS as a new USB storage device. or the one that is part of your keyboard). The controller should appear in your OS as a new USB storage device.
@ -178,6 +177,14 @@ or the one that is part of your keyboard). The controller should appear in your
Once this happens, copy the correct UF2 file (e.g. left or right if working on a split), and paste it onto the root of that USB mass Once this happens, copy the correct UF2 file (e.g. left or right if working on a split), and paste it onto the root of that USB mass
storage device. Once the flash is complete, the controller should automatically restart, and load your newfly flashed firmware. storage device. Once the flash is complete, the controller should automatically restart, and load your newfly flashed firmware.
## Wirelessly Connecting Your Keyboard
Connecting your keyboard wirelessly is the same as adding other Bluetooth devides: press the reset button and scan for devices. However, pairing and bonding is still currently being worked on to increase relability and ease of use. In addition, users have in general reported that Bluetooth pairing with computers tends to be quite finnicky. Try out the connection with your tablet or phone first, as those devices seem to work much more consistently. See [BLE Reset](./bond-reset.md) for help on resetting your MCUs if you're experiencing connection issues.
### Connecting Split Keyboard Halves
For split keyboards, after flashing each half individually you can connect them together by resetting them at the same time. Within a few seconds of resetting, both halves should automatically connect to each other.
## Customization ## Customization
### Configuration Changes ### Configuration Changes
@ -199,3 +206,5 @@ GitHub Actions job to build your firmware which you can download once it complet
:::note :::note
If you need to, a review of [Learn The Basics Of Git In Under 10 Minutes](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/) will help you get these steps right. If you need to, a review of [Learn The Basics Of Git In Under 10 Minutes](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/) will help you get these steps right.
::: :::
For split keyboards, only the central (usually left) side will need to be reflashed after making updates to your keymap.