Go to file

Ben Blazak 4b21800302 (the smallest aesthetic change in the world)		2012-08-23 01:48:33 -07:00
build-scripts	(the smallest aesthetic change in the world)	2012-08-23 01:48:33 -07:00
contrib	created a contrib folder	2012-06-06 12:26:36 -07:00
src	wrote the ui-info generating script for Ben (aka OrangeJewce)	2012-08-23 01:31:25 -07:00
license.md	updated toplevel license and readme	2012-07-15 17:45:58 -07:00
makefile	(small makefile fix)	2012-08-23 01:34:05 -07:00
readme.md	updated toplevel license and readme	2012-07-15 17:45:58 -07:00
references.md	bug fixes, mostly; and other things	2012-06-15 14:36:50 -07:00

readme.md

ergodox-firmware: Firmware for the ErgoDox keyboard

Also see the [geekhack] (http://geekhack.org/showthread.php?22780-Interest-Check-Custom-split-ergo-keyboard) and [deskthority] (http://deskthority.net/workshop-f7/split-ergonomic-keyboard-project-t1753.html) discussion threads.

About this File

If you're viewing this on github, please note that directory links will only work if you're viewing this from the directory, and file links will only work if you're viewing this as a file. This is true for all the '.md' files here. The limitation is due to the way github addresses directories and files, and the fact that Markdown doesn't have any way (that I know of) to rewrite the URLs as would be required.

About this Project

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. And [references.md] (references.md) contains lots of good links, along with descriptions.

If you're just trying to compile, jump to the bottom of the file and read the [Dependencies] (#dependencies-for-building-from-source) section. Once that's taken care of, navigate to the [src] (src) directory, compile using Make, and fire up your teensy loader to transfer the '.hex' file. Just to be safe, you should also check the '.eep' file. If it's larger than 0 bytes, you need to load it too.

If you're looking to hack on the source, or just feel like reading it, you probably don't need much direction for a small project like this. I'll try to write more later (for people who are new to AVR programming, like I was when I started this project), but for now:

[src/lib] (src/lib) is for generally useful stuff. The TWI and USB libraries are in there, along with the file containing basic key press and release functions.
[src/keyboard] (src/keyboard) is for keyboard specific stuff. All the chip initialization code is there, along with the layout files, the software matrix to hardware matrix mapping, and hardware specific documentation.
[src/main.c] (src/main.c) ties it all together.

Open issues, feature requests, and such are tracked [on github] (/benblazak/ergodox-firmware/issues).

Notes

Features as of 2012-04-11 : first major release on branch 'main'

6KRO
Teensy 2.0, MCP23018 I/O expander
~167 Hz scan rate (most of which is spent communicating via I²C)
firmware level layers

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), and Make. I'm compiling with GNU tools under Ubuntu, but other environments (especially [WinAVR] (http://winavr.sourceforge.net/) under Windows) should work too.
I also assume that you are using [git] (http://git-scm.com/) (for make clean).