8 releases

0.2.1 Nov 13, 2024
0.2.0 Oct 28, 2024
0.1.6 Oct 3, 2024
0.1.5 Sep 11, 2024
0.1.0 May 9, 2024

#933 in Hardware support

Download history 142/week @ 2024-08-02 20/week @ 2024-08-09 2/week @ 2024-08-16 7/week @ 2024-08-23 8/week @ 2024-08-30 352/week @ 2024-09-06 64/week @ 2024-09-13 30/week @ 2024-09-20 200/week @ 2024-09-27 68/week @ 2024-10-04 22/week @ 2024-10-11 12/week @ 2024-10-18 160/week @ 2024-10-25 45/week @ 2024-11-01 125/week @ 2024-11-08 39/week @ 2024-11-15

370 downloads per month
Used in 5 crates (3 directly)

MIT/Apache

14KB
287 lines

This crate contains all configurations that you can customize RMK.

There are two TYPES of configuration: [toml_config] and [keyboard_config].

  • [toml_config]: the configuration describles how the RMK toml configuration file looks like. It can be loaded directly from a toml file.

Why we have two configurations?

We want to provide a user-friendly representation of configurations, that's why [toml_config] exists. For example, to define the keyboard matrix, users can just use a list of string in toml like: ["PA1", "PA2"]. This list could be automatically converted to an actual GPIO matrix associated to microncontroller in [keyboard_config].

  • [keyboard_config]: the configuration which is internally used in RMK. [keyboard_config] is what RMK's code receives. You can safely ignore it unless you want to dive into the RMK source code.

Dependencies

~0–1.1MB
~22K SLoC