README

   1 t.m.k. Keyboard Firmware
   2 ========================
   3 This is keyboard firmware for PFU HHKB style keyboard and teensy 2.0.
   4 OS see this as composite device which has keyboard and mouse.
   5
   6 The project is heavily based on PJRC USB Keyboard/Mouse Example and
   7 owes a debt to preceding keyboard firmware projects.
   8
   9
  10 VERSION
  11 -------
  12 0.1     2010/08/23
  13         It works as normal keyboard.
  14         It is for modified Macway keyboard(TP-999KB-E).
  15
  16 1.0     2010/10/02
  17         keyboard has mouse key now.
  18         keyboard with layers.(see keymap.c)
  19             FN_1(right cmd):
  20                 vi style layer
  21             FN_2(next to right shift):
  22                 HHKB style layer
  23             FN_3(left bottom):
  24                 h j k l:   mouse move
  25                 a s d spc: mouse buttons
  26                 m ,:       mouse wheel
  27
  28
  29 target board
  30 ------------
  31 Teensy 2.0
  32 http://www.pjrc.com/teensy
  33
  34
  35 projects related
  36 ----------------
  37 PJRC USB Keyboard/Mouse Example
  38     http://www.pjrc.com/teensy/usb_keyboard.html
  39     http://www.pjrc.com/teensy/usb_mouse.html
  40 kbupgrade
  41     http://github.com/rhomann/kbupgrade
  42     http://geekhack.org/showwiki.php?title=Island:8406
  43 c64key
  44     http://symlink.dk/projects/c64key/
  45 rump
  46     http://mg8.org/rump/
  47     http://github.com/clee/rump
  48 dulcimer
  49     http://www.schatenseite.de/dulcimer.html
  50 humblehacker-keyboard
  51     http://github.com/humblehacker
  52     http://www.humblehacker.com/keyboard/
  53     http://geekhack.org/showwiki.php?title=Island:6292
  54 ps2avr
  55     http://sourceforge.net/projects/ps2avr/
  56
  57
  58 TODO
  59 ----
  60 licensing notes(GPL)
  61     I think GPL is not infringement of PJRC license.
  62 souce code cleaning
  63 sleep&wakeup
  64 debouncing
  65     will be coded when bouncing occurs.
  66     bouncing doesnt occur on my ALPS switch so far.
  67     scan rate is too slow?(to be measure)
  68 setting menu(wizard)
  69     debug console
  70     keymap setting
  71     matrix display
  72 PS/2 keyboard mode
  73 support for HHKB pro matrix signal
  74 Trackpoint(PS/2) support
  75 Thinkpad keyboard support
  76 mouse horizontal wheel
  77
  78
  79 EOF