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

#819 in Hardware support

Download history 244/week @ 2024-10-01 28/week @ 2024-10-08 13/week @ 2024-10-15 99/week @ 2024-10-22 98/week @ 2024-10-29 22/week @ 2024-11-05 150/week @ 2024-11-12 118/week @ 2024-11-19 280/week @ 2024-11-26 22/week @ 2024-12-03 98/week @ 2024-12-10 12/week @ 2024-12-17

914 downloads per month
Used in 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