2015-02-12 06:22:12 +00:00
The Kiibohd Controller
======================
2015-03-16 04:37:57 +00:00
This is the main Kiibohd Firmware.
In general, this should be the **only** git repo you need to clone.
The [KLL ](https://github.com/kiibohd/kll ) git repo is automatically cloned during the build process.
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Please refer to the [KLL ](https://github.com/kiibohd/kll ) repo or [kiibohd.com ](http://kiibohd.com ) for details on the KLL (Keyboard Layout Language) Spec.
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Official Keyboards
------------------
2015-02-12 06:22:12 +00:00
2015-08-16 19:27:12 +00:00
* MD1 (Infinity Keyboard/IC60 2014/10/15)
* MDErgo1 (Infinity Ergodox /ICED 2015/03/31)
* WhiteFox (Soon to be released?)
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Compilation
-----------
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Compilation is possible and tested on Windows/Linux/Mac.
Linux is the easiest using this [VM ](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz ).
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
For most people refer [here ](https://github.com/kiibohd/controller/tree/master/Keyboards ).
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
For the full compilation details, please refer to the [wiki ](https://github.com/kiibohd/controller/wiki ).
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Supported Microcontrollers
--------------------------
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
* Teensy 2.0 (Partial)
* Teensy 2.0++
2016-01-13 23:04:45 +00:00
* Teensy 3.0
* Teensy 3.1/3.2
2015-03-16 04:37:57 +00:00
* mk20dx128vlf5
* mk20dx256vlh7
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Adding support for more microcontrollers is possible.
Some considerations for minimum specs:
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
* ~8 kB of SRAM
* ~25 kB of Flash
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
It's possible to port chips with lower specs, but will be more effort and have fewer features.
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Contributions
-------------
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Contributions welcome!
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
* Bug reports
* Documentation and Wiki editing
* Patches (including new features)
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Licensing
---------
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Licensing is done on a per-file basis.
Some of the source code is from [PJRC/Teensy ](http://pjrc.com ), other source code is from the [McHck Project ](https://mchck.org ).
Code written specifically for the Kiibohd Controller use the following licenses:
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
* MIT
* GPLv3
* Public Domain
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
Contact
-------
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
If you really need to get a hold of HaaTa, email is best: `haata@kiibohd.com`
2015-02-12 06:22:12 +00:00
2015-03-16 04:37:57 +00:00
IRC is likely faster though.
2016-02-08 16:28:38 +00:00
`#input.club@irc.freenode.net`
2015-03-16 04:37:57 +00:00
`#geekhack@irc.freenode.net`
`#deskthority@irc.freenode.net`
2015-02-12 06:22:12 +00:00