rmk_types/
lib.rs

1//! # RMK Types
2//!
3//! This crate provides fundamental type definitions and data structures used in RMK.
4//!
5//! ## Modules
6//!
7//! ### Core Modules
8//! - [`action`] - Keyboard actions and behaviors (key presses, layer operations, macros)
9//! - [`keycode`] - Keycode definitions including HID keycodes, media keys, and system control keycodes
10//! - [`modifier`] - Modifier key combinations and operations
11//! - [`mouse_button`] - Mouse button state and combinations
12//! - [`led_indicator`] - LED indicator states and operations
13//! - [`protocol`] - Communication protocol
14//!
15//!
16//! ## Integration with RMK Ecosystem
17//!
18//! This crate is designed to work with other RMK components:
19//!
20//! - **rmk**: Core firmware logic uses these types for state management
21//! - **rmk-config**: Configuration parsing produces these types
22//! - **rmk-macro**: Code generation macros work with these type definitions
23
24#![no_std]
25
26pub mod action;
27pub mod keycode;
28pub mod led_indicator;
29pub mod modifier;
30pub mod mouse_button;
31pub mod protocol;