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 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
  35 Target board
  36 ------------
  37 Teensy 2.0
  38 http://www.pjrc.com/teensy
  39
  40
  41 Projects related
  42 ----------------
  43 PJRC USB Keyboard/Mouse Example
  44     http://www.pjrc.com/teensy/usb_keyboard.html
  45     http://www.pjrc.com/teensy/usb_mouse.html
  46 kbupgrade
  47     http://github.com/rhomann/kbupgrade
  48     http://geekhack.org/showwiki.php?title=Island:8406
  49 c64key
  50     http://symlink.dk/projects/c64key/
  51 rump
  52     http://mg8.org/rump/
  53     http://github.com/clee/rump
  54 dulcimer
  55     http://www.schatenseite.de/dulcimer.html
  56 humblehacker-keyboard
  57     http://github.com/humblehacker
  58     http://www.humblehacker.com/keyboard/
  59     http://geekhack.org/showwiki.php?title=Island:6292
  60 ps2avr
  61     http://sourceforge.net/projects/ps2avr/
  62
  63
  64 TODO & ideas
  65 ------------
  66 licensing notes(GPL)
  67     I think GPL is not infringement of PJRC license.
  68 souce code cleaning
  69 sleep&wakeup
  70 debouncing logic
  71     will be coded when bouncing occurs.
  72     bouncing doesnt occur on my ALPS switch so far.
  73     scan rate is too slow?(to be measure)
  74
  75 support for HHKB pro matrix signal
  76     exchange controller board with teensy
  77 Trackpoint(PS/2)
  78     receive PS/2 signal from TrackPoint
  79     send USB HID report
  80 Thinkpad keyboard support
  81     turn keyboard to USB keyboard/mouse composite device
  82 mouse horizontal wheel
  83     http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
  84     http://www.keil.com/forum/15671/
  85     http://www.microsoft.com/whdc/device/input/wheel.mspx
  86 setting menu(configure without changing firmware)
  87     console for display
  88     keymap/layer setting
  89     mouse speed/acceleration
  90     matrix display
  91 PS/2 keyboard mode
  92     with USB to PS/2 dumb adapter(possible?)
  93
  94
  95 EOF