I will never forget that commit. Not because of the code it contained (please don't look, it's not worth it!), but for what it started.
Working on ZMK has given me the opportunity to reconnect with old friends (@brixmeister was my Gentoo mentor/sponsor when I became a contributor there on my first ever OSS project, and is a current active Zephyr RTOS contributor!), make new ones, and learn so much from the amazing mechanical keyboard community.
But I'm getting ahead of myself! Back to early ZMK. I present you the first ZMK keyboard:
That first "keyboard" taught me a lot. It forced me to dust off my long forgotten, rudimentary electronics knowledge, and gave me my first taste of really combining the physical/tangible with code in a way that years of doing backend API development never had.
Early in my brainstorming, I knew I needed a foundation to build upon that would get me "a lot for free." I evaluated several different real-time operating systems (RTOSes) and happened upon Zephyr. It immediately ticked all the boxes I wanted:
Robust, open source Bluetooth stack, supporting multiple SoCs. At the time, I was trying out stm32wb thanks to some interest among keyboard designers, but I also so there were other compelling choices that might be a good fit.
An open source, non-copyleft license. I am a firm believer in F/OSS, and wanted to use a license that was as unrestricted as possible.
Had a lot of core APIs available, so I could focus on the keyboard functionality, not the plumbing. I love tinkering, but I wanted to focus my time on the interesting bits, not infrastructure.
I'm really happy with the choice, it has served us incredibly well the past two years.
At some point, somehow, innovaker introduced me to nicell who graciously sent me a few of the early pre-production nice!nano controllers, which I was able to get running on my Kyria. Doing so required the first split code, as well as lots of general improvements.
The day I was finally able to type on a wireless, split keyboard running ZMK was deeply momentous for me!
ZMK powered keyboards are now available in group buys and in stock at various vendors; compatible controllers have been used in a wide range of builds to empower our users to free themselves from their USB/TRRS cables and move about untethered.
This progress is only possible thanks to all of the contributors who've joined me in the vision for a wireless-first world. I am so grateful for everyone who has given their time to contribute code, answer questions on our Discord server, write more documentation, and especially all the users who have trusted us to make their input devices work.
I can't wait to see what we can accomplish together in the next two years.
Since last time, there have been several new powerful keymap features and behaviors added, including several asked for features, such as tap-dance and macros.
petejohanson added the caps word behavior, i.e. &caps_word, in #823 that allows toggling a mode where all all alpha characters are sent
to the host capitalized until a non-alpha, non-"continue list" keycode is sent. This can be useful for typing things like CONFIG_ENABLE_CAPS_WORD without having to hold down shift. This is similar in spirit to using the caps lock key, but with the added benefit of turning itself off automatically.
petejohanson added the new key repeat behavior in #1034 to allow repeating the last sent key-press again, including any modifiers that were applied to that key press. It can be added to your keymap using the simple &key_repeat reference.
petejohanson, taking heavy inspiration on the initial work from okke-formsma, added macro support in #1168. Several common patterns are documented, but one example, changing the underglow color as you activate/deactivate a layer, looks like:
kurtis-lew worked diligently to add the tap-dance behavior in #1139, allowing different behaviors to be invoked based on the number of times
a user taps a single key in their keymap, e.g.
okke-formsma updated sticky keys in #1122 to add the ignore-modifiers; property; when set, sticky keys won't release when other modifiers are pressed. This allows you to combine sticky modifiers, which is popularly used with "callum-style mods".
petejohanson did some sleuthing and fixed a long standing problem with inconsistent pairing with macOS in [#946]](https://github.com/zmkfirmware/zmk/pull/946). With the changes, macOS more reliably pairs with ZMK devices.
Another persistent bug that Apple users experienced was related to crashes and problems with keyboard configurations, that was traced to an issue with ZMK's HID usage that was fixed by petejohanson in #726.
joelspadin applied some major enhancements to our debouncing approach to allow fine grained control of our debouncing in #888, including allowing eager debouncing which can reduce key press latency.
The long awaited locality enhancement was finally merged by petejohanson in #547, allowing more fine grained control of where certain behaviors are invoked. Some key improvements thanks to the changes:
RGB Underglow behaviors now run globally, so enabling/disabling RGB, changing the color, animation, etc. applies to both sides of a split properly.
Reset/Bootloader behaviors now run wherever the key was pressed. For example, adding a &bootloader reference to the peripheral side of a split will now put that side of the split into the bootloader when pressed.
petejohanson also added fixes to improve split re-connection for certain scenarios in #984, helping ensure splits properly connect when one side or the other is reset.
joelspadin added a new sensor driver to support battery charge calculation by sensing voltage on the VDDH pin on nRF52 chips in #750, which is particularly useful for designs
using "high voltage mode" with that SoC.
dxmh and caksoylar have joined the ZMK organization to help with documentation, and have been doing an amazing job adding new docs, and leading reviewing docs related PRs to free other contributors up to focus on other areas. It's been an incredible addition to ZMK!
petejohanson's work on the HID foundation also included adding support for full NKRO HID in #726 that can be enabled by adding the following to your .conf file for your config:
It's been live for a while, but nicell added an amazing power profiler in #312 to allow users to estimate their battery life for various hardware configurations.
petejohanson helped prepare and test the upgrade of ZMK to Zephyr 3.0 in #1143. The updated Zephyr release brings with it some key BLE stability fixes, as well as various other core improvements that improve ZMK. This was a huge undertaking!
nicell and petejohanson worked together in #883 to settle on a metadata format that is used to document every board and shield. This now drives automatic generation of our supported hardware page and our
more nuanced GH Actions automation for testing changes to ZMK.
As we approach the two year birthday for ZMK, I am reminded of how far we have come in such a short time, in large part thanks to the amazing community that has grown around it. I am so grateful to have so many contributors, testers, and user believing in the project and helping make it a joy to work on.
Existing user config repositories using Github Actions to build will pull down Zephyr 3.0 automatically, however to build properly, the repository needs to be updated to use the stable Docker image tag for the build:
Open .github/workflows/build.yml in your editor/IDE
Change zmkfirmware/zmk-build-arm:2.5 to zmkfirmware/zmk-build-arm:stable wherever it is found
Locate and delete the lines for the DTS output step, which is no longer needed:
- name: ${{ steps.variables.outputs.display-name }} DTS File if: ${{ always() }} run: | if [ -f "build/zephyr/${{ matrix.board }}.pre.tmp" ]; then cat -n build/zephyr/${{ matrix.board }}.pre.tmp; fi if [ -f "build/zephyr/zephyr.dts" ]; then cat -n build/zephyr/zephyr.dts; fi
note
If you created your user config repository a while ago, you may find that your build.yml file instead references
a zephyr-west-action-arm custom GitHub Action instead. In this case, the upgrade is not as direct. We suggest that
instead you re-create your config repository to get an updated setup using the new automation
approach.
The following steps will get you building ZMK locally against Zephyr 3.0:
Run the updated toolchain installation steps, and once completed, remove the previously installed SDK version (optional, existing SDK should still work)
pull the latest ZMK main with git pull for your ZMK checkout
run west update to pull the updated Zephyr version and its dependencies
From there, you should be ready to build as normal!
The following changes have already been completed for all boards/shields in ZMK main branch. For existing or new PRs, or out of tree boards, the following changes are necessary to properly work with the latest changes.
Zephyr's WS2812 led_strip driver added a new required property. When adding underglow to a board, you now must also add the additional include #include <dt-bindings/led/led.h> at the top of your devicetree file, and add a color-mapping property like:
Standard WS2812 LEDs use a wire protocol where the bits for the colors green, red, and blue values are sent in that order.
If your board/shield uses LEDs that require the data sent in a different order, the color-mapping property ordering should be changed to match.
Zephyr unified the way the console/logging device is selected, removing the hacks that special-cased the USB CDC ACM output.
Now, the CDC ACM device is configured in the devicetree as well. To ensure that USB logging properly works with custom board definitions,
two sections of the <board>.dts file need updating.
Previously, to get ZMK to build a UF2 image to flash to a given board required adding a CMakeLists.txt file that added a custom post build command.
Now, the only thing necessary to have Zephyr build a UF2 is to add the following to your <board>_defconfig file:
CONFIG_BUILD_OUTPUT_UF2=y
If updating an existing board, be sure to remove the previous CMakeLists.txt file to avoid generating the UF2 twice during a west build.
For more details on the implementation, see zephyr#31066.
The Seeed(uino) XIAO has gained in popularity for use on smaller boards, and gained more traction with the release of the new XIAO BLE board,
powered by the popular nRF52840 SoC. As part of the 3.0 update, we've also more fully integrated the XIAO and XIAO BLE to make it easier to
build keyboard (shields) using either controller.
One of the exciting items that's one step closer as part of this work is support for Raspberry Pi Pico/RP2040.
With Zephyr 3.0 merged, this start the process for getting those controllers/chips supported by ZMK. Follow the issue to keep track of progress.
This will also enable us to support the XIAO compatible Adafruit Qt Py RP2040 and XIAO RP2040.
As preparation for completing the work to upgrade ZMK to Zephyr 3.0, users with user config repositories who wish to avoid future build failures with their GitHub Actions workflows can take steps to adjust
their repositories now.
GitHub Actions needs to use our latest Docker image to ensure continued compatibility with the ZMK codebase on Zephyr 3.0 (and beyond). You should:
Open .github/workflows/build.yml in your editor/IDE
Change zmkfirmware/zmk-build-arm:2.5 to zmkfirmware/zmk-build-arm:stable wherever it is found
Once the changes are committed and pushed, the build will run as expected.
A future blog post will outline the complete Zephyr 3.0 changes once that work is finalized.
note
If you created your user config repository a while ago, you may find that your build.yml file instead references
a zephyr-west-action-arm custom GitHub Action instead. In this case, the upgrade is not as direct. We suggest that
instead you re-create your config repository to get an updated setup using the new automation
approach.
I'm happy to announce that we have completed the work to upgrade ZMK to Zephyr 2.5!
A big part of this work was some major refactors and improvements by innovaker to our zmk-docker Docker image and GH Actions automation.
Faster build times with improved caching.
Integration tests which automatically verify new images.
PRs to the repo now build properly and run the tests as well.
Build images for multiple target architectures, e.g. zmk-build-riscv64, all in parallel.
Nightly builds to be sure we're pulling in the latest OS/package updates, to ensure we keep our images up to date, address any reported vulnerabilities, etc.
Faster upgrade paths for future Zephyr SDK and Zephyr versions.
In addition, petejohanson did the upgrade work to adjust ZMK for the Zephyr changes.
Updated to newer devicetree/driver Zephyr API
Adjustment for Zephyr pinmux changes
Fixes for power management, LVGL, and formatter changes
Existing user config repositories using Github Actions to build will pull down Zephyr 2.5 automatically,
and should work, fine as is. However, to upgrade to the newer Docker image, you should:
Open .github/workflows/build.yml in your editor/IDE
Change zmkfirmware/zmk-build-arm:2.4 to zmkfirmware/zmk-build-arm:2.5 wherever it is found
note
If you created your user config repository a while ago, you may find that your build.yml file instead references
a zephyr-west-action-arm custom GitHub Action instead. In this case, the upgrade is not as direct. We suggest that
instead you re-create your config repository to get an updated setup using the new automation
approach.
The following steps will get you building ZMK locally against Zephyr 2.5:
Run the updated toolchain installation steps, and once completed, remove the previously installed SDK version (optional, existing SDK should still work)
pull the latest ZMK main with git pull for your ZMK checkout
run west update to pull the updated Zephyr version and its dependencies
From there, you should be ready to build as normal!
The initial combos work has landed! The amazing okke-formsma has once again delivered another powerful feature for ZMK. Combos are "position based", and are configured in a new toplevel node next to they keymap node in user's keymap files.
An example, that would send the ESC keycode when pressing both the first and second positions on your keyboard:
Combos currently are "global", and not scoped to a given active layer. There is future planned work to allow enabling a certain combo for only certain active layers.
okke-formsma also contributed the initial "sticky keys" behavior, which can be used for functionality sometimes called "one shot mods" or "one shot layers". In your keymap, this would like like:
joelspadin completed the Keymap Upgrader which can be used to update your keymap to using the latest supported codes, and move away from the old deprecated codes.
If you've made keymap customizations, please make sure to run your keymaps through the upgrader, since the old deprecated codes will be removed in a future version of ZMK.
There has been lots of work to get display support complete enough for use by end users. Although not quite ready for prime time, it is incredibly close, and we are looking forward to having the last few items completed and the feature documented!
petejohanson added idle blanking for displays, which ensures they will go blank, and into low power mode, after a short period of inactivity from the user. This ensures we avoid burn-in for OLEDs, and helps improve battery life.
petejohanson implemented the first two complete, dynamic "widgets" for the displays for ZMK, adding a small battery indicator, which includes charging status, and a small output indicator, showing the currently active output (USB or BLE). When using BLE, the indicator also shows the active profile slot, as well as if the profile slot is open, awaiting connection from the paired host, or is actively connected to the host for that profile slot.
mcrosson has contributed the next display widget, showing the highest active layer in the keymap. petejohanson then added a small follow up to allow layers in keymaps to add a label property to each layer, e.g. label = "Nav"; and have that label be displayed in the widget instead of the numeric layer number.
New contributor allymparker added our fourth widget, a words-per-minute display! This widget work also included creating the core state logic for tracking the WPM.
For now, this widget is only working on the central side of split keyboards.
innovaker is at it again with some crucial core fixes, helping prepare and test the upgrade of ZMK to Zephyr 2.4. The updated Zephyr release brings with it some key BLE stability fixes, as well as various other core improvements that improve ZMK. This was a huge undertaking!
petejohanson was heads down diagnosing and fixing a deadlock issue on BLE that was frustrating and plaguing many users. After finally pinpointing the underlying root cause, he developed a fix and roped in many testers on Discord to help stress test things before merging.
Previously overriding the selection of left as central, and right as peripheral for wireless splits required making local edits to the configuration files, and maintaining them in a ZMK fork.
petejohanson updated the config files to allow users to override this in their <board>_left.conf/<board>_right.conf files in their user repos.
nicell contributed settings debounce work, to help avoid unnecessary extra writes to flash when making various changes that should be saved,
such as the active BLE profile, external VCC on/off, etc.
Since it's inception, quite a few users have inquired whether they could sponsor any of the contributors involved in ZMK. Although we are not intending to directly fund any individual contributors for their work on ZMK, there is good that can come from folks sponsoring ZMK.
You can see the full discussion on #497, but some items that are being considered with sponsorship funds:
Hiring a designer to complete the logo/mascot work.
Creating stickers to send as thank-yous to first time contributors.
Some items listed in the last coming soon section are still under active development.
A power profiler page for the website, to help users estimate their battery life for a given keyboard - Nicell
Behavior "locality", allowing improved split usage for things like &reset, and controlling external power and RGB underglow for both sides - petejohanson
More modular approach to external boards/shields, custom code, user keymaps, etc.
Welcome to the third ZMK "State Of The Firmware" (SOTF)!
This update will cover all the major activity since SOTF #2. This edition comes a bit later than planned, but the amount of features and changes will hopefully make it worth it!
innovakercompletely overhauled the set of available codes for keymaps, and simultaneously has created
beautifuldocumentation to help users visualize the codes, and also understand if they are supported on their particular operating system.
This also laid the foundation for the other keymap related changes that are now available.
okke-formsma added the ability to apply modifiers to a code, e.g.:
&kp LC(C)
which sends Control + c when pressed. This feature is often used on smaller keyboards to achieve "shifted keycodes", e.g. LS(N1) to send a !.
To make this easier, in addition to all the normal codes, we now have defines for common shifted codes, e.g. EXCL for !, AT for @, etc.
To learn more, check out the Modifiers documentation.
In previous versions of ZMK, users needed to be careful to select between the &kp and &cp behaviors in their keymaps, depending on
whether the particular keycode they wanted to send was in the "HID consumer page" or not. Forcing users to understand the difference and get
this right was awkward and error prone.
petejohanson and innovaker have reduced this complexity. Users can now simply use &kp with all available codes and ZMK will
handle sending the right events to the connected host.
Nicell added the necessary driver and core code to send BLE battery level notifications to hosts that support displaying them. Testing seems to show this works with Windows and GNOME, but macOS does not display the battery info.
megamind4089 added a new driver and behavior to allow users to toggle (on/off) the external power supplied by boards such as the nRFMicro
and nice!nano that have specialized hardware for this purpose.
With this change, you can add
&ext_power EP_TOG
to toggle (on/off) the power to external hardware like RGB underglow or OLEDs. Check out the external power control docs for more info.
petejohanson has contributed the initial deep sleep support to ZMK. This work also
included some automatic power savings by switching to PORT events on the nRF52 chips, which reduces the idle power draw, even without deep sleep. Deep sleep is currently not turned on by default, but will be soon.
joelspadin added output selection to allow selecting whether to send output over USB or BLE if both are connected. This should now help avoid having "double keypresses" when your keyboard is plugged into a host.
Nicell has already blogged about this, but for those that missed it, a major, and incredibly difficult to pin down bug involving corruption of the bootloader on devices using the Adafruit nRF52 bootloader has been fixed by Nicell. If you've encountered this bug, flashing the latest firmware should prevent it from reoccurring. Unfortunately, due to the nature of this fix, you will need to re-pair your keyboard with your hosts, as the fix involves changing where settings are stored in the flash of the controller.
petejohanson has gotten an official USB product ID assigned to the ZMK Firmware. For anyone looking to uniquely identify a USB device running the ZMK Firmware, you can match on:
Vendor ID: 0x1d50
Product ID: 0x615e
We are incredibly grateful that Openmoko Inc., in the wake of discontinuing the openmoko projects, has made this an option for OSS projects.
idan contributed VSCode devcontainer integration to make it easier for developers to build and develop ZMK without having to do complicated local toolchain setup and configuration. This also opens up some amazing future flexibility for things like GitHub Codespaces.
There's some follow up tweaks necessary for better supporting using this with user config repositories, which will be available soon.
There has been an amazing amount of testing from various users as we develop new features. In particular, we'd like to give a shout out to tominabox1 who has been tireless in providing detailed and thorough testing of
changes as they are being developed.
Recently I was able to fix the "stuck in the bootloader" issue in
#322 that had been plaguing us
for quite some time. I want to go over what the issue was, how the issue was
diagnosed, and how it was fixed.
What exactly is the "stuck in the bootloader" issue? Seemingly randomly, users'
keyboards would suddenly stop working and when they would reset their keyboard
they would get put into the bootloader instead of back into the firmware. This
would require the user to re-flash the firmware again to get into the firmware.
That wouldn't be so bad except for the fact that once this occurs, every reset
would require the user to re-flash the firmware again. The only way to really
fix this issue was to re-flash the bootloader itself, which is a huge pain.
Going into this, all we knew was that this issue was most likely introduced
somewhere in the #133, which
added Bluetooth profile management. We've had quite a few attempts at trying to
recreate the issue, but we never were able to get it to happen consistently.
This issue had been happening sporadically for the past month, and I finally
decided to dig in to see what was going on. We started in the Discord and
discussed what was common between all of the people who have experienced this
issue. Everyone who had this issue reported that they did quite a bit of profile
switching. This lined up with the possible connection to the Bluetooth profile
management pull request.
I had a hunch that this was related to the settings system. The settings system
is used by profile Bluetooth switching, and the settings system works directly
with the system flash. Based on this hunch, I tried spamming the RGB underglow
cycle behavior on my main keyboard. Sure enough after a couple minutes, I got
stuck in the bootloader. I was even able to reproduce it again.
This was an important discovery for two reasons. First, I was able to recreate
the issue consistently, which meant I could set up logging and more closely
monitor what the board was doing. Second, this more or less proved that it was
specifically the settings system at fault. Both Bluetooth profile switching and
RGB underglow cycling trigger it, and the one common piece is they save their
state to settings.
To understand what's going wrong, we first need to understand how the settings
system works. Here's a diagram to explain the flash space that the settings
system holds for our nRF52840 based boards (nice!nano, nRFMicro, BlueMicro).
The settings flash space lives at the end of the flash of the chip. In this case
it starts at 0xF8000 and is 0x8000 bytes long, which is 32KB in more
comprehensible units. Then due to the chip's architecture, this flash space is
broken into pages, which are 0x1000 bytes in size (4KB).
The backend that carries out the settings save and read operation in ZMK is
called NVS. NVS calls these pages sectors. Due to how flash works, you can't
write to the same bytes multiple times without erasing them first, and to erase
bytes, you need to erase the entire sector of flash. This means when NVS writes
to the settings flash if there's no erased space available for the new value, it
will need to erase a sector.
So first I enabled logging of the NVS module by adding
CONFIG_NVS_LOG_LEVEL_DBG=y to my .conf file. I repeated the same test of
spamming RGB underglow effect cycle and the resulting logs I got were this:
[00:00:00.000,671] <inf> fs_nvs: 8 Sectors of 4096 bytes [00:00:00.000,671] <inf> fs_nvs: alloc wra: 3, f70 [00:00:00.000,671] <inf> fs_nvs: data wra: 3, f40 // A bunch of effect cycle spam [00:02:34.781,188] <dbg> fs_nvs: Erasing flash at fd000, len 4096 // A bunch more effect cycle spam [00:06:42.219,970] <dbg> fs_nvs: Erasing flash at ff000, len 4096 // A bunch more effect cycle spam // KABOOM - bootloader issue
So at start up, we can see that the 8 sectors of 4KB are found by NVS properly,
however, I wasn't sure what the second and third lines meant, but we'll get back
to that. Nonetheless the next two logs from NVS showed erasing the sector at
0xFD000 and then erasing the 0xFF000 sector.
It's really odd that the third to last sector and the last sector are erased,
and then shortly after the bootloader issue is hit. I really had no explanation
for this behavior.
At this point, I nor anyone else working on the ZMK project knew enough about
NVS to explain what was going on here. Pete
Johanson, project founder, reached out on the
Zephyr Project's Slack (ZMK is built on top of Zephyr if you weren't aware).
Justin B and Laczen assisted by first explaining that those alloc wra and
data wra logs from earlier are showing what data NVS found at startup.
More specifically, data wra should be 0 when it first starts up on a clean
flash. As we can see from my earlier logging on a clean flash I was instead
getting f40. NVS is finding data in our settings sectors when they should be
blank! We were then given the advice to double check our bootloader.
Most of the boards the contributors of ZMK use have the Adafruit nRF52
Bootloader, which allows
for extremely easy flashing by dragging and dropping .uf2 files onto the board
as a USB drive. Every bootloader takes up a portion of the flash, and in the
README explains that the first 0x26000 is reserved for the bootloader with the
nRF52840, and we've properly allocated that.
However, there isn't a full explanation of the flash allocation of the
bootloader in the README. There's a possibility that the bootloader is using
part of the same flash area we're using. I reached out on the Adafruit Discord,
and Dan Halbert pointed me towards the linker
map
of the nRF52840. Let's take a look.
We've found the issue! As you can see from the red bar (representing our
settings flash area), we've put the settings flash area right on top of the
Adafruit bootloader's flash space. Oops!
This also shines some light on why NVS erased 0xFD000 and 0xFF000 sectors.
It's possible there was no flash written to 0xFD000 because the bootloader
didn't use up all of that space it has, and then there possibly weren't any
bootloader settings set yet, so 0xFF000 could be used and erased by NVS too.
After erasing 0xFF000, NVS probably next erased a rather important part of the
bootloader that resulted in this issue at hand. In my opinion, we're pretty
lucky that it didn't delete an even more vital part of the bootloader. At least
we could still get to it, so that we could re-flash the bootloader easily!
Now that we've found the issue, we can pretty easily fix this. We'll need to
move the settings flash area back so that it doesn't overlap with the
bootloader. First we calculate the size of the of flash area the bootloader is using.
0x100000 (end of flash) - 0x0F4000 (start of bootloader) = 0xC000 (48KB)
So the bootloader is using the last 48KB of the flash, this means all we need to
do is shift back the settings area and code space 0xC000 bytes. We'll apply
this to all of the .dts files for the boards that were affected by this issue.
And with those changes, we should no longer run into this issue! In the process
of these changes, we lost 48KB of space for application code, but we're only
using around 20% of it anyways. 🎉
Welcome to the second ZMK "State Of The Firmware" (SOTF)!
This update will cover all the major activity since SOTF #1, preparations for the upcoming
Hacktoberfest activity, and a current open call for community feedback on a ZMK mascot.
With interest and Discord activity growing, it seemed important to lay out the progress made recently, current major bugs/showstoppers, and planned next steps.
Refactoring (#73, #74) of keymaps to make them simpler for users.
Mod-Tap Behavior (docs coming!) is much improved (#69) and usable now.
An initial setup.sh script was created, allowing users to quickly bootstrap a "user config" setup and push it to GitHub, where GitHub Actions will build the firmware for you.
Despite the flurry of activity, there are still some serious bugs and show stoppers that potential ZMK users should be aware of:
Bluetooth Related - There are several key bugs and fixes needed, including one complete show stopper:
Fully working split wireless is not working. In particular, both split halves can properly pair, but once they do so, pairing with the _central_ host will not work. Workaround: You can currently have both halves pair, and use USB on the central side (Left side right now for Kyria, Corne, Lily58) and receive HID events over USB. - Fixed in 8b61beb.
BT bond information is not currently stored to the devices, so after powering off or restarting your device, users need to re-pair
USB - There is one important USB related bug which is a showstopper:
The Zephyr USB stack does not have a built in queue for endpoint data being written. As a result, HID events sent by ZMK are sometimes dropped, or lost. - Fixed by careyk007 in #93.
There's plenty of places to go next! To help keep folks in the loop for what's next, I've created a Core Functionality project/kanban board in GitHub, where users should be able to get some visibility into items being focused on.
Of course, at the top of that list currently is the above bugs/showstoppers, and then from there, I hope to:
Work on power management.
Improve our documentation on various aspects of the system, mostly around:
End user documentation for understanding how to use ZMK, better installation docs, etc.
Developer focused documentation, so interested contributors can start building out more behaviors and ZMK functionality.
Implement true "hold" detection, useful for several behaviors such as Mod-Tap and Layer-Tap.
Hopefully acquire a proper and official USB Product ID for use for the project.
