How rust-embedded-community/pc-keyboard works
Project Type and Purpose
• This is a Rust library (“crate”) providing a driver for PC keyboards.
• It supports multiple scancode sets (Set 1 for legacy PCs, Set 2 for PS/2, USB HID) and various keyboard layouts (QWERTY, AZERTY, Dvorak, etc.).
• Its public API revolves around a Keyboard struct that, given a ScancodeSet and Layout, turns raw bytes into KeyEvents.
File Structure
• Top-level:
– Cargo.toml, README.md, examples/, src/, .github/
• src directory:
– src/lib.rs
– src/scancodes/ (mod.rs, set1.rs, set2.rs, usbhid.rs)
– src/layouts/ (mod.rs plus one file per supported layout)
• examples/: sample usage demonstrating decoder, layout mapping, printing, scancode iteration.
README for Insights
• Confirms crate role: “simple driver for handling PC keyboards.”
• References documentation on docs.rs and points to src/lib.rs.
Main Components to Model
a. Input Sources
– Physical keyboard over PS/2 or USB
– In code: raw byte streams passed into the driver
b. Scancode Decoder Modules
– ScancodeSet1
– ScancodeSet2
– USBHID
c. Core Driver
– Keyboard struct (generic over ScancodeSet and Layout)
– decode() / process_byte() API that emits raw KeyCode events
d. Layout Mapper Modules
– Multiple layout files (us104, uk105, azerty, colemak, dvorak, etc.)
– map_keycode() → HostKeyEvent (with shifts, modifiers applied)
e. Output
– High-level KeyEvent / HostKeyEvent stream back to application
f. Examples (optional, for illustrating API usage)
Relationships and Data Flow
• Data flow is strictly unidirectional:
[ Input Source ]
│ raw bytes
▼
[ Scancode Decoder Module ]
│ intermediate KeyCode
▼
[ Keyboard Core Driver ]
│ KeyCode + state (modifiers)
▼
[ Layout Mapper Module ]
│ HostKeyEvent
▼
[ Application / Example Consumer ]
• Each Scancode decoder module implements a common trait (ScancodeSet) consumed by the Keyboard struct.
• Each Layout implements a Layout trait used by the Keyboard to map keycodes to characters or host events.
Architectural Patterns and Principles
• Modular separation of concerns: decoding vs. mapping vs. API surface.
• Generic/trait-based design: ScancodeSet and Layout traits enable easy extension.
• No global state: all state is owned by Keyboard instance.
• Examples folder demonstrates composition of modules.