README

   1 t.m.k. Keyboard Firmware
   2 ========================
   3 http://github.com/tmk/tmk_keyboard
   4
   5 This is keyboard firmware for PFU HHKB style keyboard and Teensy/Teensy++ 2.0.
   6 OS see this as composite device which has keyboard and mouse.
   7
   8 The project is heavily based on PJRC USB Keyboard/Mouse Example and
   9 owes a debt to preceding keyboard firmware projects.
  10
  11
  12 Version
  13 -------
  14 0.1     2010/08/23
  15         It works as normal keyboard.
  16         It is for modified Macway keyboard(TP-999KB-E).
  17
  18 1.0     2010/10/02
  19         keyboard has mouse key now.
  20         keyboard with layers.(see keymap.c)
  21             FN_1(right cmd):
  22                 vi style layer
  23             FN_2(next to right shift):
  24                 HHKB style layer
  25             FN_3(left bottom):
  26                 h j k l:   mouse move
  27                 a s d spc: mouse buttons
  28                 m ,:       mouse wheel
  29
  30 1.1     2010/10/08
  31         Matrix wiring changed for casing.
  32         (and my Teensy PD3 seems to be latchuped and unusable. :<)
  33
  34 1.2     2010/10/13
  35         HHKB support
  36         horizontal mouse wheel support
  37         change keymaps
  38
  39 2.0     2010/10/27
  40         HHKB/Macway support merged
  41
  42
  43 Build
  44 -----
  45 Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)
  46
  47 $ cd <target> (hhkb or macway)
  48 $ make
  49
  50
  51 Debuging
  52 --------
  53 Debug print is on if 4 keys are pressed during booting.
  54 Use PJRC's hid_listen.exe to see debug messages.
  55
  56
  57 AVR Target board
  58 ----------------
  59 Teensy/Teensy++
  60 http://www.pjrc.com/teensy
  61
  62
  63 Projects related
  64 ----------------
  65 PJRC USB Keyboard/Mouse Example
  66     http://www.pjrc.com/teensy/usb_keyboard.html
  67     http://www.pjrc.com/teensy/usb_mouse.html
  68 kbupgrade
  69     http://github.com/rhomann/kbupgrade
  70     http://geekhack.org/showwiki.php?title=Island:8406
  71 c64key
  72     http://symlink.dk/projects/c64key/
  73 rump
  74     http://mg8.org/rump/
  75     http://github.com/clee/rump
  76 dulcimer
  77     http://www.schatenseite.de/dulcimer.html
  78 humblehacker-keyboard
  79     http://github.com/humblehacker
  80     http://www.humblehacker.com/keyboard/
  81     http://geekhack.org/showwiki.php?title=Island:6292
  82 ps2avr
  83     http://sourceforge.net/projects/ps2avr/
  84
  85
  86 TODO & ideas
  87 ------------
  88 licensing notes(GPL)
  89     I think GPL is not infringement of PJRC license.
  90 souce code cleaning
  91 sleep&wakeup
  92 debouncing logic
  93     will be coded when bouncing occurs.
  94     bouncing doesnt occur on my ALPS switch so far.
  95     scan rate is too slow?(to be measure)
  96 layer switching
  97     time before switching
  98     timeout when not used during specific time
  99
 100 Trackpoint(PS/2)
 101     receive PS/2 signal from TrackPoint
 102     send USB HID report
 103 Thinkpad keyboard support
 104     turn keyboard to USB keyboard/mouse composite device
 105 setting menu(configure without changing firmware)
 106     console for display
 107     keymap/layer setting
 108     mouse speed/acceleration
 109     matrix display
 110 PS/2 keyboard mode
 111     with USB to PS/2 dumb adapter(possible?)
 112 AT90USBKEY support
 113     and other AVR USB boards
 114
 115 DONE:
 116 support for HHKB pro matrix signal
 117     exchange controller board with teensy
 118     2010/10/11
 119 keymap
 120     Matias half keyboard style
 121     2010/10/23
 122 souce code cleaning
 123     2010/10/23
 124 debug on/off
 125     debug off by default
 126     pressing keys during booting
 127     2010/10/23
 128 mouse horizontal wheel
 129     http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
 130     http://www.keil.com/forum/15671/
 131     http://www.microsoft.com/whdc/device/input/wheel.mspx
 132     2010/10/13
 133 debug on/off
 134     Fn key conbination during normal operation
 135     matrix print on/off
 136     key print on/off
 137     mouse print on/off
 138     2010/10/26
 139
 140
 141 EOF