https://github.com/ia0/onekibu
USB keyboard firmware for devices with a single button
https://github.com/ia0/onekibu
embedded keyboard nrf52 nrf52840 rust
Last synced: 6 months ago
JSON representation
USB keyboard firmware for devices with a single button
- Host: GitHub
- URL: https://github.com/ia0/onekibu
- Owner: ia0
- License: apache-2.0
- Created: 2022-01-05T21:05:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T13:41:51.000Z (almost 3 years ago)
- Last Synced: 2025-03-26T08:51:33.207Z (7 months ago)
- Topics: embedded, keyboard, nrf52, nrf52840, rust
- Language: Rust
- Homepage:
- Size: 55.7 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Onekibu (One-Button Keyboard)
Onekibu is a firmware providing a USB keyboard interface for devices with a
single button, like the [nRF52840 dongle] or the [nRF52840 MDK dongle]. As such,
keys are pressed (and released) with patterns similar to [Morse code].
## How to release
To release for `$BOARD` (see below for board-specific instructions), run the
following command:
```
cargo xtask build --board=$BOARD --release --flash
```
The `--size` flag can be added to show the binary size before flashing.
### nRF52840 dongle
To release on the [nRF52840 dongle] using `nrfdfu` (which you can install with
`cargo install nrfdfu`):
1. Plug the dongle.
2. Press its reset button (may also be done while plugging).
3. Run the command above with `BOARD=nrf52840-dongle`.
### nRF52840 MDK dongle
To release on the [nRF52840 MDK dongle] using `uf2conv.py` (which you can copy
from [here][uf2conv]):
1. Plug the dongle while pressing its button.
2. Make sure an external drive named `MDK-DONGLE` is visible.
3. Run the command above with `BOARD=nrf52840-mdk-dongle`.
## How to debug
To build and run on the nRF52840 dev-kit using `probe-run` (which you can
install with `cargo install probe-run`), run the following command:
```
cargo xtask build --flash
```
The `--log=` flag can be used to set the [defmt logging filter]. For
example, `--log=warn` would only should warnings or errors.
To attach gdb, run the following command in a separate terminal:
```
cargo xtask gdb server
```
Then run the following command:
```
cargo xtask gdb client
```
[defmt logging filter]: https://defmt.ferrous-systems.com/filtering.html
## Disclaimer
This is not an official Google product.
[Morse code]: https://en.wikipedia.org/wiki/Morse_code
[nRF52840 MDK dongle]: https://wiki.makerdiary.com/nrf52840-mdk-usb-dongle
[nRF52840 dongle]: https://www.nordicsemi.com/Products/Development-hardware/nrf52840-dongle
[uf2conv]: https://github.com/microsoft/uf2/tree/master/utils