You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Pete Johanson 02584a4549 Minor prep for settings loading, once working. 4 years ago
.vscode Refactor build/config/keymaps. 4 years ago
boards Implement raise/lower for default keymap. 4 years ago
cmake Implement raise/lower for default keymap. 4 years ago
dts/bindings Start to get layers + keymaps pulled in from DTS. 4 years ago
include Initial basic modifiers support. 4 years ago
src Minor prep for settings loading, once working. 4 years ago
.gitignore Initial work. 4 years ago
.gitlab-ci.yml Small tweak. 4 years ago
CMakeLists.txt Implement raise/lower for default keymap. 4 years ago
Dockerfile Remove locale tweaks. 4 years ago
Kconfig Move BLE passkey entry behind config flag. 4 years ago
LICENSE Add LICENSE 4 years ago
README.md Remove some kscan GPIO to-do items that are done. 4 years ago
prj.conf Commented logging directives for use later. 4 years ago
west.yml Try using west.yml file instead. 4 years ago

README.md

Zephyr Mechanical Keyboard (ZMK) Firmware

This project is a complete work in progress, with absolutely nothing functioning yet. The goal is to explore a new MK firmware with a less restritive license and better BLE support, built on top of the Zephyr Project

TODO

  • Document boards/shields/keymaps usage.
  • Move most Kconfig setings to the board/keymap defconfigs and out of the toplevel prj.conf file.
  • Merge the Kscan GPIO driver upstream, or integrate it locally, to avoid use of Zephyr branch.
  • Display support, including displaying BLE SC auth numbers for "numeric comparison" mode if we have the screen.
  • Fix BT settings to work w/ Zephyr. Do we really need them?
  • Tests?

Missing Features

  • Consumer Key Support (play/pause, etc)
  • Mod Tap
  • One Shot
  • Shell over BLE?
  • Split support
    • custom kscan driver? that recieves events from other side over BLE notifications?
    • Need to figure out how to do "custom" GATT services. Custom UUID?
    • Do we need to send any state updates over from primary to secondary side?
  • Encoders
  • Battery reporting.
  • Low power mode, with wakeup from interrupt?

Long Term

  • Tool to convert keymap info.json files into a DTS keymap file?
  • Firmware build service?