diff --git a/README.md b/README.md index afa7f1c1..012fd548 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,20 @@ 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](https://www.zephyrproject.org/) +## TODO + +- Debouncing in the kscan driver itself? Only some GPIO drivers in Zephyr support it "natively" +- Better DTS overlay setup for _keymaps_. Current use of SHIELDs works, but perhaps would be better with something more integrated. +- 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. +- BLE SC by typing in the # prompted on the host. + - Store the connection being authenticated. + - Hook into endpoint flow to detect keypresses and store/send them to the connection once 6 are typed. +- 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? + +## Long Term + +- Tool to convert keymap `info.json` files into a DTS keymap file? +- Firmware build service?