zmk_mf68/docs/docs/hardware.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2020-05-26 11:33:21 +10:00
---
id: hardware
title: Supported Hardware
sidebar_label: Supported Hardware
---
:::warning
2020-08-04 13:44:53 +10:00
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.
2020-05-26 11:33:21 +10:00
:::
2020-08-30 10:46:00 +10:00
With the solid technical foundation of Zephyr™ RTOS, ZMK can support a wide diversity of hardware targets.
2020-08-04 13:44:53 +10:00
That being said, there are currently only a few specific [boards](/docs/faq#what-is-a-board)/[shields](/docs/faq#what-is-a-shield) that have been written and tested by the ZMK contributors.
## Boards
- [nice!nano](https://docs.nicekeyboards.com/#/nice!nano/) (`nice_nano`)
- [nrfMicro](https://github.com/joric/nrfmicro) (`nrfmicro_13`, `nrfmicro_11`, `nrfmicro_11_flipped`)
- [BlueMicro840](https://store.jpconstantineau.com/#/group/bluemicro) (`bluemicro840_v1`)
2020-08-04 13:44:53 +10:00
- [QMK Proton-C](https://qmk.fm/proton-c/) (`proton_c`)
## Keyboard Shields
- [Kyria](https://splitkb.com/products/kyria-pcb-kit) (`kyria_left` and `kyria_right`)
2020-08-11 02:54:34 +10:00
- [Corne](https://github.com/foostan/crkbd) (`corne_left` and `corne_right`)
2020-08-04 13:44:53 +10:00
- [Lily58](https://github.com/kata0510/Lily58) (`lily58_left` and `lily58_right`)
## Other Hardware
In addition to the basic keyboard functionality, there is some initial support for additional keyboard hardware:
- Encoders
- OLEDs
- RGB Underglow
2020-08-06 04:51:31 +10:00
Until detailed documentation is available, feel free to ask questions about how these are supported in the [Discord server](https://zmkfirmware.dev/community/discord/invite).
2020-08-04 13:44:53 +10:00
## Contributing
If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](/docs/dev-guide-new-shield) documentation.