Crate rmk_types

Crate rmk_types 

Source
Expand description

§RMK Types

This crate provides fundamental type definitions and data structures used in RMK.

§Modules

§Core Modules

  • action - Keyboard actions and behaviors (key presses, layer operations, macros)
  • keycode - Keycode definitions including HID keycodes, media keys, and system control keycodes
  • modifier - Modifier key combinations and operations
  • mouse_button - Mouse button state and combinations
  • led_indicator - LED indicator states and operations
  • protocol - Communication protocol

§Integration with RMK Ecosystem

This crate is designed to work with other RMK components:

  • rmk: Core firmware logic uses these types for state management
  • rmk-config: Configuration parsing produces these types
  • rmk-macro: Code generation macros work with these type definitions

Modules§

action
Keyboard actions and behaviors.
keycode
Complete keycode definitions.
led_indicator
LED indicator.
modifier
Modifier keys and their operations.
mouse_button
Mouse button state and operations.
protocol
Communication protocol definitions.