From d342ca02d898427944092b0058c2b6e51a0f0aed Mon Sep 17 00:00:00 2001 From: AJ <1754228+280Zo@users.noreply.github.com> Date: Tue, 12 Nov 2024 16:26:52 -0800 Subject: [PATCH] update firmware details --- help/bluetooth.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/help/bluetooth.md b/help/bluetooth.md index ab9c23f..95cee81 100644 --- a/help/bluetooth.md +++ b/help/bluetooth.md @@ -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. -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. + +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: