pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
zmk_mf68/README.md
Pete Johanson 1423fe175c Add link to WIP website.
2020-05-27 10:42:35 -04:00

1.4 KiB
Raw Blame History

Zephyr Mechanical Keyboard (ZMK) Firmware

Netlify Status

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

Basic WIP website to learn more: https://zmk.netlify.app/

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?