Go to file

Ben Blazak 15efb43b76 fixed *.md indenting apparently, sublists need to be indented 4 spaces (1 tab) or more to be recognized as such (because subsequent lines of a list may be indented up to 3 spaces). it's right there on the markdown syntax page, but i didn't catch it the first time.		2012-04-26 03:44:20 -07:00
src	fixed *.md indenting	2012-04-26 03:44:20 -07:00
.gitignore	rewrote makefile (standalone now); removed some unnecessary stuff	2012-04-18 01:29:38 -07:00
license.md	(no code yet - still researching and setting stuff up)	2012-03-11 18:33:21 -07:00
readme.md	rewrote makefile (standalone now); removed some unnecessary stuff	2012-04-18 01:29:38 -07:00
references.md	fixed *.md indenting	2012-04-26 03:44:20 -07:00

readme.md

ergodox-firmware: Firmware for the ergoDOX keyboard

This project is definitely in beta, but I'll do my best to keep the 'master' branch working. Please see the source (and especially the accompanying '*.md' files) for documentation.

Notes

(2012-04-11)

As of now, it looks like we have a working 6-KRO keyboard firmware for a Teensy 2.0 with a MCP23018 I/O expander. It's scanning at ~167 Hz, most of which is spent communicating over I²C. This should be fast enough, I think. Slight improvements might be possible (without finding a microprocessor capable of > 400 kHz I²C or using SPI, that is, which I imagine would speed things up a lot - but it'd also be much less convenient). I'll attempt them if I see the need.

Also, layers are implemented, but untested, as no keymaps are written to use them yet. Implementing on-keyboard hardware remapping seems like it'd be very possible too, but I'd need to try it (and learn how to programmatically store stuff in program space) to see if it'd work; and I'm not sure of a good way to do the interface, since different people will likely have different keycap layouts on the ergoDOX.

Getting to N-KRO is a goal, but I honestly have no idea whether it'll be accomplished. Ideally, I'd like a variable-KRO, where the keyboard is 6-KRO till you press the 7th key (so if you're worried about compatibility, just don't press more than 6 keys at a time). From what I've read, it might be possible, but I just finished everything else (so I'm slightly tired), and the USB spec is scary.

Discussions about the project as a whole are going on at the forum page (linked in the title) so if you have any imput (or want to participate in the group buy!), please stop by. :) .

Dependencies (for building from source)

See the PJRC [Getting Started] (http://pjrc.com/teensy/first_use.html) page for instructions on how to set up an AVR programming environment. This project uses C (not Arduino).
I also assume that you are using [git] (http://git-scm.com/) (for make clean).