di0ib/controller
Archived
1
0
Fork 0
Code Releases Activity
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
79ee501e03
controller/README.markdown
Jacob Alexander 59c14fcdea Adding initial WhiteFox support. 
- Includes fix for over-range ScanCodes (would cause hard faults)
- Updated some documentation
- Requires recent kll compiler for the layout
2015-08-16 12:27:12 -07:00

2.1 KiB
Raw Blame History

The Kiibohd Controller

This is the main Kiibohd Firmware. In general, this should be the only git repo you need to clone. The KLL git repo is automatically cloned during the build process.

Please refer to the KLL repo or kiibohd.com for details on the KLL (Keyboard Layout Language) Spec.

Official Keyboards

  • MD1 (Infinity Keyboard/IC60 2014/10/15)
  • MDErgo1 (Infinity Ergodox /ICED 2015/03/31)
  • WhiteFox (Soon to be released?)

The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.

Compilation

Compilation is possible and tested on Windows/Linux/Mac. Linux is the easiest using this VM.

For most people refer here.

For the full compilation details, please refer to the wiki.

Supported Microcontrollers

  • Teensy 2.0 (Partial)
  • Teensy 2.0++
  • Teesny 3.0
  • Teensy 3.1
  • mk20dx128vlf5
  • mk20dx256vlh7

Adding support for more microcontrollers is possible. Some considerations for minimum specs:

  • ~8 kB of SRAM
  • ~25 kB of Flash

It's possible to port chips with lower specs, but will be more effort and have fewer features.

Contributions

Contributions welcome!

  • Bug reports
  • Documentation and Wiki editing
  • Patches (including new features)

Licensing

Licensing is done on a per-file basis. Some of the source code is from PJRC/Teensy, other source code is from the McHck Project. Code written specifically for the Kiibohd Controller use the following licenses:

  • MIT
  • GPLv3
  • Public Domain

Contact

If you really need to get a hold of HaaTa, email is best: haata@kiibohd.com

IRC is likely faster though. #geekhack@irc.freenode.net #deskthority@irc.freenode.net