rumcake
is a rust library that lets you build featureful keyboard firmware with ease.
Warning
rumcake is still a work in progress. Expect some bugs and breaking changes.
Under the hood, rumcake
uses embassy-rs
as the embedded framework.
Providing rumcake
as a library allows you to build your firmware in your own Cargo workspace, removing the need to push code to the central rumcake
repo.
The rumcake
library:
- Provides
embassy-executor
tasks for common keyboard activities, including matrix polling, host communication, LED rendering, etc. - Provides macros that allow you to configure your keyboard firmware in an easy-to-understand way.
keyberon
is also used under the hood for keyboard layout configuration. - Aims to be platform-agnostic, and uses different HALs (hardware abstraction libraries) under the hood, depending on the chip you decide to build for.
rumcake
uses some Rust features that are only found on the nightly
toolchain.
Please use the latest nightly toolchain when compiling your firmware.
Note that building and flashing instructions may change depending on the MCU. See the templates for some build and flashing instructions for some common setups.