10 releases

0.2.3 Nov 27, 2024
0.2.2 Nov 25, 2024
0.2.0 Oct 28, 2024
0.1.6 Oct 3, 2024
0.1.0 May 9, 2024

#910 in Hardware support

Download history 1/week @ 2024-08-17 8/week @ 2024-08-24 7/week @ 2024-08-31 363/week @ 2024-09-07 55/week @ 2024-09-14 29/week @ 2024-09-21 230/week @ 2024-09-28 39/week @ 2024-10-05 21/week @ 2024-10-12 11/week @ 2024-10-19 169/week @ 2024-10-26 40/week @ 2024-11-02 131/week @ 2024-11-09 47/week @ 2024-11-16 340/week @ 2024-11-23 49/week @ 2024-11-30

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

MIT/Apache

16KB
341 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

~1.4–2.5MB
~47K SLoC