# peng-zhihui/HelloWord-Keyboard

Repository: https://github.com/peng-zhihui/HelloWord-Keyboard
Canonical: https://ross.abutalabs.com/products/helloword-keyboard
Language: C
License: GPL-3.0
License Family: copyleft
Last push: 2024-01-12T16:53:22+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 1495, "days_push": 964, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 6655, forks 1069 (observed 2026-08-28T04:09:47.418207+00:00)

## What it is
An open-source modular smart mechanical keyboard project (Hanwen/HelloWord) including full hardware design files (10 PCBs, enclosures, 3D models), STM32-based keyboard and module firmware, and a secondary development SDK. The left-side module slot supports swappable components, with the default Dynamic module featuring an e-ink display and a FOC force-feedback knob.

## Use cases
- build a custom modular mechanical keyboard from open hardware
- customize keyboard firmware with multi-layer key mappings and RGB effects
- develop apps for a force-feedback knob with e-ink display module
- integrate keyboard RGB control with SignalRGB via HID protocol
- learn FOC motor control and shift-register key scanning on STM32
- flash prebuilt firmware onto the keyboard and Dynamic module

## When to choose
- you want to fabricate and assemble your own smart keyboard from open PCB and enclosure files
- you need a hackable STM32 keyboard firmware base with HID, RGB, and non-volatile config
- you want to experiment with modular input devices like force-feedback knobs and touch bars

## When to avoid
- you just need an off-the-shelf keyboard with software-only customization
- you expect a polished consumer product with guaranteed support and documentation
- you need a keyboard firmware for non-STM32 or QMK/ZMK-compatible hardware

## Facets
- artifact type: application
- maturity: active
- function: embedded, sdk, graphics, middleware
- domain: hardware, embedded-systems, developer-tools, cross-platform
- platform: embedded, c, cross-platform
- tags: mechanical-keyboard, firmware, hardware-design, pcb, stm32, foc-motor-control, e-ink-display, rgb-lighting, hid, modular-design, diy-hardware

## Member repositories
- peng-zhihui/HelloWord-Keyboard (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:47.418207+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:43:06.639920+00:00, confidence not recorded.
  - readme: https://github.com/peng-zhihui/HelloWord-Keyboard (fetched 2026-08-28T04:09:47.418207+00:00, sha cad8ffc8c7db)
- Data as of 2026-08-30T08:39:29.467469+00:00.