Skip to content

Commit

Permalink
update firmware details
Browse files Browse the repository at this point in the history
  • Loading branch information
280Zo committed Nov 13, 2024
1 parent 9f8a4e1 commit d342ca0
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions help/bluetooth.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,14 +179,20 @@ You can either mount the battery between the MCU and holder PCB, or tape it to t

# Firmware

The firmware can be downloaded from the [charybdis-wireless-mini-zmk-firmware](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware) repository by opening the [Actions Workflows](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware/actions?query=is%3Acompleted+branch%3Amain), selecting latest successful run on the main branch, then downloading the `firmware-charybdis-nanov2-qwerty` artifact. There's also a colemak dh firmware for those that want to use that layout. Note that you have to be logged into Github to be able to download the files.
The firmware can be downloaded from the [charybdis-wireless-mini-zmk-firmware](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware) repository by logging into GitHub,
opening the [Actions Workflows](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware/actions?query=is%3Acompleted+branch%3Amain), selecting latest successful run on the main branch, then downloading the firmware that best fits your use case. The repo has firmware for bluetooth and dongle configurations, both in QWERTY and Colemak dh layouts. If you're unsure which one to use, you probably want the firmware-charybdis-qwerty build.

To add support for the PMW3610 sensor, [inorichi's driver](https://github.com/inorichi/zmk-pmw3610-driver?tab=readme-ov-file) is included in the firmware, along with
[Petejohanson's work](https://github.com/petejohanson/zmk/blob/feat/pointers-move-scroll/docs/docs/behaviors/mouse-emulation.md) to allow mouse keys.
- **firmware-charybdis-qwerty** - Bluetooth/USB with QWERTY layout
- **firmware-charybdis-qwerty-dongle** - Dongle with QWERTY layout
- **firmware-charybdis-colemak** - Bluetooth/USB with Colemak DH layout
- **firmware-charybdis-colemak-dongle** - Dongle with Colemak DH layout
- **firmware-reset-nanov2** - Reset the firmware completely

The firmware is heavily influenced by Miryoku and home row mods that use bilateral combinations to make typing as efficient and ergonomic as possible. If you'd like to see the key layout, a layer map is available on the repo's [README](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware).
To add support for the PMW3610 sensor, badjeff's [zmk-pmw3610-driver](https://github.com/badjeff/zmk-pmw3610-driver), [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener?tab=readme-ov-file), and [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay) modules are included in the firmware. A separate branch builds the Bluetooth firmware using [inorichi's driver](https://github.com/inorichi/zmk-pmw3610-driver?tab=readme-ov-file) as an alternative to badjeff's driver.

Check warning on line 191 in help/bluetooth.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (badjeff's)

Check warning on line 191 in help/bluetooth.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (badjeff's)

If you'd like to learn how to customize the key bindings and layers, or for tips on how to modify the firmware build configuration yourself, these are also available on the README.
Pete Johanson's [pointers-with-input-processors](https://github.com/zmkfirmware/zmk/pull/2477) feature is also included to allow mouse keys to move and scroll.

Check warning on line 193 in help/bluetooth.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Johanson's)

The firmware supports ZMK Studio, and the base layer makes use of home row mods to make typing as efficient and comfortable as possible. If you'd like to see the key layout, a layer map is automatically generated by the pipeline and added to the repo's [README](https://github.com/280Zo/charybdis-wireless-mini-zmk-firmware). Here you can also find information on how to customize the key bindings and layers, and tips on how to modify the firmware build configuration yourself.

Additional links:

Expand Down

0 comments on commit d342ca0

Please sign in to comment.