Firmware
To allow the use of Halcyon modules on your keyboard, you will need to modify the firmware slightly. The specific steps are outlined in the respective GitHub repositories.
We already converted the following keyboards to use with Halcyon modules. You can find downloadable files for this on our firmware site.
| Keyboard name |
|---|
| Aurora Sweep (rev1) |
| Aurora Lily58 (rev1) |
| Aurora Corne (rev1) |
| Aurora Helix (rev1) |
| Aurora Sofle v2 (rev1) |
| Kyria (rev3) |
You can find instructions on how to manually build the keyboard firmware for these keyboards in the main README of the respective GitHub repository.
For a wired keyboard:
Go to the QMK userspace READMEFor a wireless keyboard:
Go to the ZMK config README.Updating keymap
If you already have an existing keymap, and you want to add support for the Encoder buttons, please follow only the specific step about the keymap integration.
For a wired keyboard:
Go to the QMK userspace keymap integration page.For a wireless keyboard:
Go to the ZMK config keymap integration page.Porting
If you want to port another keyboard, which is not yet supported, to use Halcyon modules, please follow the respective guides below.
For a wired keyboard:
Go to the QMK userspace porting guide.For a wireless keyboard:
Go to the ZMK config porting guide.