Skip to content

Commit

Permalink
chore(docs): update README
Browse files Browse the repository at this point in the history
Introduce a quick-ref section.
  • Loading branch information
MattSturgeon committed Mar 27, 2024
1 parent 92a4577 commit e6dd69a
Showing 1 changed file with 76 additions and 8 deletions.
84 changes: 76 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,26 +67,93 @@ This can also be run using `nix run . -- flash` without entering the dev shell.
- Run `flash`
- Done!

## Bootloader Mode
## Quick reference

Bootloader mode can be entered two ways:
### Booting into bootloader mode

### With the keyboard half powered off
See the [user guide](https://docs.moergo.com/glove80-user-guide/customizing-key-layout/#putting-glove80-into-bootloader-for-firmware-loading) for more info.

- Hold the outside bottom-row key (traditionally, `<Ctrl>`)
- Hold the middle-finger row-2 key (Colemak `F` or `U`, Qwerty `E` or `I`)
- Hold the `C6 R6` key (extreme bottom corner)
- Also hold the `C3 R2` key (middle-finger; Colemak `F` or `U`, Qwerty `E` or `I`)
- Power on the keyboard

### With the keyboard half powered on
![Activating bootloader](https://docs.moergo.com/glove80-user-guide/images/bootloader-power-up-method.png)

#### You can tell if a Glove80 half is in bootloader mode using the red LED next to the power switch:

- Slow LED: in bootloader mode and connected via USB.
- Fast LED: in bootloader mode but there is no USB connection.
- Solid or no LED: not in bootloader mode.

### Factory reset

See the [user guide](https://docs.moergo.com/glove80-user-guide/troubleshooting/#configuration-factory-reset-and-re-pairing-left-and-right-halves) for more info.

Similar to booting into bootloader mode, but use `R2` (numrow) instead of `R3`. Hold for ~5s powered on, before powering off again.

![Activating reset](https://docs.moergo.com/glove80-user-guide/images/configuration-factory-reset.png)

Note, the reset will not affect the saved keymap. Instead it wipes things like Bluetooth devices.

To re-pair the two halves: first power both on at the same time, then toggle RGB on/off with (Colemak) `Magic`+`B` or (Qwerty) `Magic`+`T`.

### Bluetooth

See the [user guide](https://docs.moergo.com/glove80-user-guide/operating-glove80-wirelessly) for more info.

#### Status

When tapping the `Magic` key, status indicators will appear on the Bluetooth keys.

<!-- Catppuccin themed "LED indicator" bullet points 😅 -->
<p>
<img alt="White LED"
title="White LED"
height="11"
hspace="4"
src="https://github.com/MattSturgeon/glove80-config/assets/5046562/46cf34a5-efa4-4b6c-a9d5-703b4d4c32bd">
<strong>Connected</strong> (in use)
<br>
<img alt="Green LED"
title="Green LED"
height="11"
hspace="4"
src="https://github.com/MattSturgeon/glove80-config/assets/5046562/41369794-bf61-4873-b7fc-4949868a322e">
<strong>Connected</strong> (not in use)
<br>
<img alt="Red LED"
title="Red LED"
height="11"
hspace="4"
src="https://github.com/MattSturgeon/glove80-config/assets/5046562/da7e6899-9833-4c82-a856-947f8f429d1a">
<strong>Paired</strong> (not connected)
<br>
<img alt="Purple LED"
title="Purple LED"
height="11"
hspace="4"
src="https://github.com/MattSturgeon/glove80-config/assets/5046562/0579c055-75ff-4ddd-9a99-a7fadd3df992">
<strong>Not paired</strong>
</p>


#### Pairing

- First ensure the profile is unpaired (white status LED)
- Select the profile
- Pair using the host device's interface

#### Unpairing

Unpair the selected Bluetooth profile using the `BT_Clear` key (see [magic layer] above). Alternatively unpair all devices using `BT_Clear_All`.

- Hold the Magic key
- Tap the outside home-row key (traditionally, `<CAPS>` or `'`)

## Resources
- [@nickcoutsos]'s [Keymap Editor].
- [@caksoylar]'s [Keymap Drawer].

- [Glove80 User Guide](https://docs.moergo.com/glove80-user-guide).
- [Glove80 Troubleshooting](https://docs.moergo.com/troubleshooting-faqs).
- MoErgo's [Glove80 Support](https://moergo.com/glove80-support) page.
- MoErgo's [Discord Server](https://moergo.com/discord).

Expand All @@ -95,6 +162,7 @@ Bootloader mode can be entered two ways:

- MoErgo's [ZMK Distribution](https://github.com/moergo-sc/zmk).

[magic layer]: #moergos-magic-layer
[@nickcoutsos]: https://github.com/nickcoutsos
[@caksoylar]: https://github.com/caksoylar
[Keymap Editor]: https://github.com/nickcoutsos/keymap-editor
Expand Down

0 comments on commit e6dd69a

Please sign in to comment.