rktk 0.0.1

rktk - Rust Keyboard Toolkit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# rktk

Rust keybord toolkit.

Currently, the firmware is for the Keyball61, but by separating the core
functionality from the driver, the core functionality is architecture- and
hardware-independent and can be easily extended.

Our current goal is to port it to the NRF52840 chip and connect it via
bluetooth.

## Features

- ✅ : Working
- 🟡 : WIP, partly implemented.
- 🔴 : WIP, not working yet.
- ❌ : Only planned. Not implemented yet.
- Empty: Not planned/Not needed.

### Core features

| Feature            | Status |
| ------------------ | ------ |
| Keyscan            | ✅     |
| Media key support  | ✅     |
| Mouse              | ✅     |
| Layer system       | 🟡     |
| Split keyboard     | ✅     |
| Non-Split keyboard | 🟡     |
| Display            | 🟡     |
| Backlight LED      | 🟡     |
| USB                | ✅     |
| Bluetooth          | ❌     |
| VIA/Vial support   | ❌     |
| Double-tap reset   | ✅     |

### Drivers

#### Key scanner

| Driver                | RP2040 | NRF52840 |
| --------------------- | ------ | -------- |
| Duplex-Matrix Scanner | ✅     | 🔴       |

#### Mouse

| Driver  | RP2040 | NRF52840 |
| ------- | ------ | -------- |
| PMW3360 | ✅     | 🔴       |

#### Display

| Driver  | RP2040 | NRF52840 |
| ------- | ------ | -------- |
| SSD1306 | ✅     | 🔴       |

#### Split

| Driver          | RP2040 | NRF52840 |
| --------------- | ------ | -------- |
| Half-duplex pio | ✅     |          |
| Bitbang         | ❌     | ❌       |

#### Backlight

| Driver     | RP2040 | NRF52840 |
| ---------- | ------ | -------- |
| ws2812 pio | ✅     |          |
| Bitbang    | ❌     | ❌       |

#### USB

| RP2040 | NRF52840 |
| ------ | -------- |
| ✅     | 🔴       |

#### Bluetooth

| RP2040 | NRF52840 |
| ------ | -------- |
|        | ❌       |

#### Double tap reset

| RP2040 | NRF52840 |
| ------ | -------- |
| ✅     |          |

## Architecture

There are `rktk`, `rktk-drivers-common`, `rktk-drivers-{rp2040,nrf52}` and a
crate for each keyboard.

The `rktk` crate is completely hardware independent and provides the core
functionality of the keyboard.

The `rktk-drivers-common` uses the abstraction of embedded-hal and
embedded-hal-async to provide the basis for drivers that can be used universally
on a variety of chips. This makes porting drivers to various chips very easy.

The `rktk-drivers-*` crate provides drivers for each chip. Most drivers are
wrappings of `rktk-drivers-common`, but some are proprietary implementations,
such as `ws2812-pio`.

Each keyboard crate can then create a driver for the appropriate chip and pass
it to `rktk::task::start` to configure the actual working keyboard firmware. The
only keyboard that currently works is `keyball61-rp2040`, but it is not too
difficult to create your own keyboard by referring to the
`keyboards/keyball61-rp2040` directory.

## Credits

- [rumcake](https://github.com/Univa/rumcake) (rp2040 double-tap-to-bootloader
  driver)
- [uf2](https://github.com/microsoft/uf2) (uf2conv.py, uf2families.json)
- ARM GNU Toolchain (arm-none-eabi-objcopy)
- [rust-dilemma](https://github.com/simmsb/rusty-dilemma/blob/5ffe8f5d2b6b0d534a4309edc737364cd96f44f1/firmware/src/interboard/onewire.rs)
  and
  [qmk](https://github.com/qmk/qmk_firmware/blob/master/platforms/chibios/drivers/vendor/RP/RP2040/serial_vendor.c)
  for pio half-duplex