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

#682 in Hardware support

Download history 374/week @ 2024-09-09 50/week @ 2024-09-16 29/week @ 2024-09-23 244/week @ 2024-09-30 23/week @ 2024-10-07 19/week @ 2024-10-14 15/week @ 2024-10-21 182/week @ 2024-10-28 24/week @ 2024-11-04 146/week @ 2024-11-11 40/week @ 2024-11-18 360/week @ 2024-11-25 23/week @ 2024-12-02 99/week @ 2024-12-09 14/week @ 2024-12-16

504 downloads per month
Used in 3 crates (via rmk-cli)

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