zmk/docs/docs/hardware.md

id	title	sidebar_label
hardware	Supported Hardware	Supported Hardware

:::warning

ZMK Firmware is still an early stage project. Many features are still waiting to be implemented, and only a select few keyboards have had their hardware details codified in boards/shields for ZMK.

:::

With the solid technical foundation of Zephyr™ RTOS, ZMK can support a wide diversity of hardware targets. That being said, there are currently only a few specific boards/shields that have been written and tested by the ZMK contributors.

Boards

• nice!nano (nice_nano)
• nrfMicro (nrfmicro_13, nrfmicro_11, nrfmicro_11_flipped)
• BlueMicro840 (bluemicro840_v1)
• QMK Proton-C (proton_c)

Keyboard Shields

• Kyria (kyria_left and kyria_right)
• Corne (corne_left and corne_right)
• Lily58 (lily58_left and lily58_right)
• Sofle (sofle_left and sofle_right)
• Splitreus62 (splitreus62_left and splitreus62_right)
• RoMac+ v4 (romac_plus)
• RoMac v2 (`romac')
• QAZ (qaz)

Other Hardware

In addition to the basic keyboard functionality, there is some initial support for additional keyboard hardware:

• Encoders
• OLEDs
• RGB Underglow

Until detailed documentation is available, feel free to ask questions about how these are supported in the Discord server.

Contributing

If you'd like to add support for a new keyboard shield, head over to the New Keyboard Shield documentation.