rmk-types 0.3.0

Common types in RMK
Documentation

RMK Types

Shared type definitions used across the RMK keyboard firmware ecosystem.

Modules

Actions & keycodes

  • [action] — What keys do: Action, KeyAction, EncoderAction, LightAction, etc.
  • [keycode] — What keys are: KeyCode, HidKeyCode, ConsumerKey, SystemControlKey

Behaviors (key overrides, combos, tap-dance)

  • [combo] — Combo: combo trigger configuration
  • [fork] — Fork, StateBits: key-override configuration
  • [morse] — Morse, MorsePattern, MorseProfile, MorseMode: tap-dance/tap-hold

Hardware state

  • [modifier] — ModifierCombination bitfield
  • [mouse_button] — MouseButtons bitfield
  • [led_indicator] — LedIndicator bitfield
  • [battery] — BatteryStatus, ChargeState
  • [ble] — BleStatus, BleState
  • [connection] — ConnectionType (USB/BLE), UsbState, ConnectionStatus

Protocol

  • [protocol::vial] — Vial/Via protocol types
  • [protocol::rynk] — RMK native protocol ICD (feature-gated: rynk)

Build-time

  • [constants] — Generated from keyboard.toml by build.rs