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 Debuging
  49 --------
  50 Debug print is on if 4 keys are pressed during booting.
  51 Use PJRC's hid_listen.exe to see debug messages.
  52
  53
  54 AVR Target board
  55 ----------------
  56 Teensy/Teensy++
  57 http://www.pjrc.com/teensy
  58
  59
  60 Projects related
  61 ----------------
  62 PJRC USB Keyboard/Mouse Example
  63     http://www.pjrc.com/teensy/usb_keyboard.html
  64     http://www.pjrc.com/teensy/usb_mouse.html
  65 kbupgrade
  66     http://github.com/rhomann/kbupgrade
  67     http://geekhack.org/showwiki.php?title=Island:8406
  68 c64key
  69     http://symlink.dk/projects/c64key/
  70 rump
  71     http://mg8.org/rump/
  72     http://github.com/clee/rump
  73 dulcimer
  74     http://www.schatenseite.de/dulcimer.html
  75 humblehacker-keyboard
  76     http://github.com/humblehacker
  77     http://www.humblehacker.com/keyboard/
  78     http://geekhack.org/showwiki.php?title=Island:6292
  79 ps2avr
  80     http://sourceforge.net/projects/ps2avr/
  81
  82
  83 TODO & ideas
  84 ------------
  85 licensing notes(GPL)
  86     I think GPL is not infringement of PJRC license.
  87 souce code cleaning
  88 sleep&wakeup
  89 debouncing logic
  90     will be coded when bouncing occurs.
  91     bouncing doesnt occur on my ALPS switch so far.
  92     scan rate is too slow?(to be measure)
  93 layer switching
  94     time before switching
  95     timeout when not used during specific time
  96
  97 Trackpoint(PS/2)
  98     receive PS/2 signal from TrackPoint
  99     send USB HID report
 100 Thinkpad keyboard support
 101     turn keyboard to USB keyboard/mouse composite device
 102 setting menu(configure without changing firmware)
 103     console for display
 104     keymap/layer setting
 105     mouse speed/acceleration
 106     matrix display
 107 PS/2 keyboard mode
 108     with USB to PS/2 dumb adapter(possible?)
 109 AT90USBKEY support
 110     and other AVR USB boards
 111
 112 DONE:
 113 support for HHKB pro matrix signal
 114     exchange controller board with teensy
 115     2010/10/11
 116 keymap
 117     Matias half keyboard style
 118     2010/10/23
 119 souce code cleaning
 120     2010/10/23
 121 debug on/off
 122     debug off by default
 123     pressing keys during booting
 124     2010/10/23
 125 mouse horizontal wheel
 126     http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
 127     http://www.keil.com/forum/15671/
 128     http://www.microsoft.com/whdc/device/input/wheel.mspx
 129     2010/10/13
 130 debug on/off
 131     Fn key conbination during normal operation
 132     matrix print on/off
 133     key print on/off
 134     mouse print on/off
 135     2010/10/26
 136
 137
 138 EOF