Firmware
When to use
You should use this document when you're using and/or experiencing the following.
Products
This page applies to the following products:
- The Halcyon Dongle
Situations
Use this page when:
- You want to create firmware to use the Halcyon dongle with a non-splitkb.com product.
Expected outcome
After following the instructions on this page:
- A working dongle setup.
When to avoid
Do not use this page when:
- You have a bought a Halcyon keyboard from splitkb.com.
Adding ZMK Halcyon module
You will want to add our ZMK Halcyon module to the build. This can be done by modifying the config/west.yml in your ZMK config. You can read more about it in the ZMK documentation.
Example:
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: splitkb
url-base: https://github.com/splitkb
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
- name: zmk-halcyon-module
remote: splitkb
revision: main
self:
path: config
You can then use the halcyon_dongle//zmk board to compile your dongle.
We also have a v0.3 branch if you're still on that ZMK version. Your config/west.yml will then look something like this.
Example:
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: splitkb
url-base: https://github.com/splitkb
projects:
- name: zmk
remote: zmkfirmware
revision: v0.3
import: app/west.yml
- name: zmk-halcyon-module
remote: splitkb
revision: v0.3
self:
path: config
You can then use the halcyon_dongle board to compile your dongle.
Creating dongle firmware
After adding our ZMK Halcyon module to your build, you can now follow the official ZMK documentation on adding a dongle with the board names as mentioned above.
Go to the ZMK dongle documentation