Crate rmk

../README.md

Feature flags

• col2row (enabled by default) — If your PCB diode’s direction is col2row, enable this feature. If it’s row2col, disable this feature.
• rapid_debouncer (enabled by default) — Use rapid debouncer

BLE feature flags

⚠️ Due to the limitation of docs.rs, functions gated by BLE features won’t show in docs.rs. You have to head to examples folder of RMK repo for their usages.

• nrf52840_ble — Enable feature if you want to use nRF52840 with BLE.
• nrf52832_ble — Enable feature if you want to use nRF52832 with BLE.
• esp32c3_ble — Enable feature if you want to use ESP32C3 with BLE.
• esp32s3_ble — Enable feature if you want to use ESP32S3 with BLE.

Re-exports

• pub use embedded_hal;
• pub use rmk_config as config;
• pub use rmk_macro as macros;

Modules

• action
• keyboard
• keycode
• keymap
• layout_macro

Macros

• a
  Create a normal action: KeyAction
• k
  Create a normal key. For example, k!(A) represents KeyAction::Single(Action::Key(KeyCode::A))
• layer
  Create a layer in keymap
• lm
  Create a layer activate with modifier action
• lt
  Create a layer activate action or tap key(tap/hold)
• mo
  Create a layer activate action. For example, mo!(1) activates layer 1.
• osl
  Create an oneshot layer key in keymap
• tg
  Create a layer toggle action
• tt
  Create a layer activate or tap toggle action

Functions

• initialize_keyboard_and_run
  Initialize and run the keyboard service, with given keyboard usb config. This function never returns.
• initialize_keyboard_and_run_async_flash
  Initialize and run the keyboard service, with given keyboard usb config. This function never returns.