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
  40 Build
  41 -----
  42 Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)
  43
  44 $ cd <target> (hhkb or macway)
  45 $ make
  46
  47
  48 AVR Target board
  49 ----------------
  50 Teensy/Teensy++
  51 http://www.pjrc.com/teensy
  52
  53
  54 Projects related
  55 ----------------
  56 PJRC USB Keyboard/Mouse Example
  57     http://www.pjrc.com/teensy/usb_keyboard.html
  58     http://www.pjrc.com/teensy/usb_mouse.html
  59 kbupgrade
  60     http://github.com/rhomann/kbupgrade
  61     http://geekhack.org/showwiki.php?title=Island:8406
  62 c64key
  63     http://symlink.dk/projects/c64key/
  64 rump
  65     http://mg8.org/rump/
  66     http://github.com/clee/rump
  67 dulcimer
  68     http://www.schatenseite.de/dulcimer.html
  69 humblehacker-keyboard
  70     http://github.com/humblehacker
  71     http://www.humblehacker.com/keyboard/
  72     http://geekhack.org/showwiki.php?title=Island:6292
  73 ps2avr
  74     http://sourceforge.net/projects/ps2avr/
  75
  76
  77 TODO & ideas
  78 ------------
  79 licensing notes(GPL)
  80     I think GPL is not infringement of PJRC license.
  81 souce code cleaning
  82 sleep&wakeup
  83 debouncing logic
  84     will be coded when bouncing occurs.
  85     bouncing doesnt occur on my ALPS switch so far.
  86     scan rate is too slow?(to be measure)
  87
  88 Trackpoint(PS/2)
  89     receive PS/2 signal from TrackPoint
  90     send USB HID report
  91 Thinkpad keyboard support
  92     turn keyboard to USB keyboard/mouse composite device
  93 mouse horizontal wheel
  94     http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
  95     http://www.keil.com/forum/15671/
  96     http://www.microsoft.com/whdc/device/input/wheel.mspx
  97 setting menu(configure without changing firmware)
  98     console for display
  99     keymap/layer setting
 100     mouse speed/acceleration
 101     matrix display
 102 PS/2 keyboard mode
 103     with USB to PS/2 dumb adapter(possible?)
 104 AT90USBKEY support
 105     and other AVR USB boards
 106
 107 DONE:
 108 support for HHKB pro matrix signal
 109     exchange controller board with teensy
 110     2010/10/11
 111
 112
 113 EOF