Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TeXitoi/keyberon
A rust crate to create a pure rust keyboard firmware.
https://github.com/TeXitoi/keyberon
embedded firmware keyboard rust usb usb-hid
Last synced: about 1 month ago
JSON representation
A rust crate to create a pure rust keyboard firmware.
- Host: GitHub
- URL: https://github.com/TeXitoi/keyberon
- Owner: TeXitoi
- License: mit
- Created: 2019-03-21T09:37:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T13:42:04.000Z (6 months ago)
- Last Synced: 2024-07-13T07:52:18.533Z (5 months ago)
- Topics: embedded, firmware, keyboard, rust, usb, usb-hid
- Language: Rust
- Homepage:
- Size: 9.5 MB
- Stars: 1,026
- Watchers: 17
- Forks: 79
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - TeXitoi/keyberon - A rust crate to create a pure rust keyboard firmware. (Rust)
README
# Keyberon [](https://travis-ci.org/TeXitoi/keyberon) [](https://crates.io/crates/keyberon) [](https://docs.rs/keyberon)
A rust crate to create a pure rust keyboard firmware.
It is exposed as a library giving you the different building blocks to
create a featureful keyboard firmware. As the different functionality
are interconected by the user of the crate, you can use only the parts
you are interested in or easily insert your own code in between.
This crate is a no_std crate, running on stable rust. To use it on a
given MCU, you need GPIO throw the [embedded hal
crate](https://crates.io/crates/embedded-hal) to read the key states,
and the [usb-device crate](https://crates.io/crates/usb-device) for
USB communication.
## Projects using this firmware
[List of Repositories using Keyberon](./KEYBOARDS.md)
The first project using this firmware is [Keyberon
grid](https://github.com/TeXitoi/keyberon-grid), a handwired keyboard
with a grid of keys. It is based on the blue pill, a cheap development
board based on a STM32F103 MCU.
There is a [port](https://github.com/TeXitoi/ortho60-keyberon) to
[Cannon Keys](https://cannonkeys.com/)'s [Ortho60 keyboard
kit](https://cannonkeys.com/collections/frontpage/products/ortho60)
(blue pill based).
Another handwired project using keyberon is
[keyberon-f4](https://github.com/TeXitoi/keyberon-f4), a unsplitted
ergo keyboard. It runs on a [WeAct
MiniF4](https://github.com/WeActStudio/WeActStudio.MiniSTM32F4x1) based on a
STM32F401 MCU.
[TssT16](https://github.com/TssT16)'s 4x12 keyboard (blue pill based):
[gilescope](https://github.com/gilescope)'s 4x12 keyboard (keyberon
grid, blue pill based):
[covah901](https://www.reddit.com/user/covah901/)'s keyboard ([WeAct
MiniF4](https://github.com/WeActStudio/WeActStudio.MiniSTM32F4x1) based):
[KeySeeBee](https://github.com/TeXitoi/keyseebee), a split ergo
keyboard (STM32F072 based).
[Arisu handwired](https://github.com/help-14/arisu-handwired) using STM32F401.
## Features
The supported features are:
- Layers when holding a key (aka the fn key). When holding multiple
layer keys, the last pressed layer action sets the layer.
- Transparent key, i.e. when on an alternative layer, the key will
inherit the behavior of the default layer.
- Change default layer dynamically.
- Multiple keys sent on an single key press. It allows to have keys
for complex shortcut, for example a key for copy and paste or alt tab, or
for whatever you want.
- Chording multiple keys together to act as a single key
- hold tap: different action depending if the key is held or
tapped. For example, you can have a key acting as layer change when
held, and space when tapped.
## FAQ
### Keyberon, what's that name?
To find new, findable and memorable project names, some persons in the rust community try to mix the name of a city with some keyword related to the project. For example, you have the [Tokio project](https://tokio.rs/) that derive its name from the Japanese capital Tokyo and IO for Input Output, the main subject of this project.
So, I have to find such a name. In the mechanical keyboard community, "keeb" is slang for keyboard. Thus, I searched for a city with the sound [kib], preferably in France as it is the country of origin of the project. I found [Quiberon](https://en.wikipedia.org/wiki/Quiberon), and thus I named the project Keyberon.