xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
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.
155 Commits
1 Branch
0 Tags
14 MiB
 
 
 
 
 
Tree: caf934792a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'caf934792a'
${ noResults }
Pete Johanson caf934792a
Exclude some unused Zephyr west submodules. 		5 years ago
.github/workflows Exclude some unused Zephyr west submodules. 5 years ago
.vscode Refactor build/config/keymaps. 5 years ago
app Exclude some unused Zephyr west submodules. 5 years ago
docs Merge pull request #9 from Nicell/docs/update_docs_landing_page 5 years ago
.gitlab-ci.yml Small tweak. 5 years ago
CODE_OF_CONDUCT.md Initial code of conduct documentation. 5 years ago
Dockerfile Remove locale tweaks. 5 years ago
LICENSE Add LICENSE 5 years ago
README.md Update link to website w/ proer domain name. 5 years ago

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Build Contributor Covenant

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

Check out the website to learn more: https://zmkfirmware.dev/

TODO

  • Document boards/shields/keymaps usage.
  • 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

  • Layer Tap
  • One Shot
  • Combos
  • Tap Dance
  • 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?
  • Better keymaps to avoid needing extra KC_NO for locations in the matrix that don't even exist!

Long Term

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