README.md

Rust Firmware for the Cantor36 keyboard

This firmware written in Rust is targetted for the Cantor36 keyboard built with a STM32F401CDUx/STM32F411CDUx MCU on a WeAct Black Pill.

It is based on the Keyberon library.

Features

• Multi layers keymaps
• Multiple keymaps
• Hold Tap actions
• Sequences
• CapsLock & NumLock

On CapsLock & NumLock support

The firmware generates an event on Col 0, Row 3 when the CapsLock led changes states. This is not a wired element but can be used to support CapsLock on the keymap, to have a different behavior when CapsLock is set.

The same occurs with NumLock but the event is on Col 1, Row 3.

What's missing

• No support for controlling the mouse
• One Shot Actions
• ...

Installing the needed tools

Considering one has rust installed by rustup.rs, then one has to run the following commands:

cargo install cargo-binutils
rustup component add llvm-tools-preview
cargo install probe-rs --features cli

Compile & Flashing

The possible keymaps are:

• keymap_basic
• keymap_borisfaure
• keymap_test

In order to generate and install the firmware for the keymap keymap_basic for the left side using probe-rs:

cargo f --release --no-default-features --features="left,keymap_borisfaure"

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.