qmk-firmware/ps2_usb
tmk e2afc305ed PS/2 to USB: fix comments. 2011-12-09 14:51:30 +09:00
..
Makefile PS/2 to USB: fix comments. 2011-12-09 14:51:30 +09:00
Makefile.vusb Added Bulegiga iWRAP support into HHKB.(Bluetooth) 2011-09-17 23:53:18 +09:00
README Added ISO/JIS keyboard support. 2011-12-05 16:14:45 +09:00
README.vusb Added ISO/JIS keyboard support. 2011-12-05 16:14:45 +09:00
config_pjrc.h Added Bulegiga iWRAP support into HHKB.(Bluetooth) 2011-09-17 23:53:18 +09:00
config_vusb.h Added Bulegiga iWRAP support into HHKB.(Bluetooth) 2011-09-17 23:53:18 +09:00
keymap.c PS/2 to USB: fix comments. 2011-12-09 14:51:30 +09:00
led.c added copyright and license notice. 2011-07-21 00:32:52 +09:00
matrix.c Added ISO/JIS keyboard support. 2011-12-05 16:14:45 +09:00
usbconfig.h integrate V-USB support into ps2_usb 2011-02-22 03:09:14 +09:00

README

PS/2 to USB keyboard converter
==============================
This firmware converts PS/2 keyboard protocol to USB and for now supports only Scan Code Set 2.


Features
--------
Mouse keys
    You can emulates mouse move and button click using keyboard.

System/Media control
    You can sends Power event, Volume down/up and Mute.

USB NKRO(actually 120KRO+8Modifiers)
    You can tolggles NKRO feature.

Keymap customization
    You can customize keymaps easily by editing source code. See keymap.c.


Build Converter
---------------
0. Connect PS/2 keyboard into Teensy with 4 lines(Vcc, GND, Data, Clock).
   By default Clock is on PF0 and Data on PF1.
   You can change this pin configuration by editing config_pjrc.h.
   In this photo Vcc is yellow, GND is green, Data is red and Clock is black.
   http://img17.imageshack.us/img17/7243/201101181933.jpg


Build Frimware
--------------
1. Edit Makefile for build options and MCU setting.
   Use 'atmega32u4' for Teensy 2.0 or 'at90usb1286' for Teensy++ 2.0.
2. make
   Just type 'make' in a terminal.
3. program with Teensy Loader.
   http://www.pjrc.com/teensy/loader.html


Demonstration of Features
-------------------------
In default configuration, you can try several keymaps, mousekeys and USB NKRO.
Use following magic key combinations to enable some features.

keymaps and NKRO:
    Magic+0:    Qwerty with mousekeys(default)
    Magic+1:    Qwerty without mousekeys
    Magic+2:    Colemak
    Magic+3:    Dvorak
    Magic+4:    Workman
    Magic+N:    toggles NKRO/6KRO(6KRO by default)
    Magic+Esc:  sends Power Event(Power button)

    where Magic=(LShift+RShift) or (LControl+RShift)

Fn layer function:
    Fn0+(hjkl): Mousekey move(vi cursor like)
    Fn0+(yuio): Mouse wheel(left,down,up,right)
    Fn0+space:  Mouse left button
    Fn0+(mnb):  Mouse buttons(m=left, n=right, b=middle)
    Fn0+(zxc):  Media control(Volup, Voldown, Mute)
    Fn1+(hjkl): Cursor move(vi cursor like)
    Fn1+(nm,.): Cursor move(Home,PageDown,PageUp,End)

    where Fn0=;, Fn1=/


Keymap
------
You can change a keymap by editing code of keymap.c like following.
How to define the keymap is probably obvious. You can find  key symbols in usb_keycodes.h.
To define keymap layer switching may needs a bit of your effort at this time.

    /* Default Layer: plain keymap
     * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.     ,-----------.
     * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|     |Pwr|Slp|Wak|
     * `---'   `---------------' `---------------' `---------------' `-----------'     `-----------'
     * ,-----------------------------------------------------------. ,-----------. ,---------------.
     * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backspa| |Ins|Hom|PgU| |NmL|  /|  *|  -|
     * |-----------------------------------------------------------| |-----------| |---------------|
     * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD| |  7|  8|  9|   |
     * |-----------------------------------------------------------| `-----------' |-----------|  +|
     * |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |               |  4|  5|  6|   |
     * |-----------------------------------------------------------|     ,---.     |---------------|
     * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift     |     |Up |     |  1|  2|  3|   |
     * |-----------------------------------------------------------| ,-----------. |-----------|Ent|
     * |Ctrl |Gui |Alt |         Space         |Alt |Gui |Menu|Ctrl| |Lef|Dow|Rig| |      0|  .|   |
     * `-----------------------------------------------------------' `-----------' `---------------'
     */
    KEYMAP(
    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
    TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
    CAPS,A,   S,   D,   F,   G,   H,   J,   K,   L,   SCLN,QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
    LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, SLSH,          RSFT,          UP,           P1,  P2,  P3,
    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
    ),


Multimedia keys
---------------
Following lists PS/2 special keys supported by Windows.
http://msdn.microsoft.com/en-us/windows/hardware/gg463372.aspx

Key                         PS/2(Set2)      HID
---------------------------------------------------
System Power                E0 37           01 0081
System Sleep                E0 3F           01 0082
System Wake                 E0 5E           01 0083
System Mute                 E0 23           0C 00E2
Volume Up                   E0 32           0C 00E9
Volume Down                 E0 21           0C 00EA
Scan Next Track             E0 4D           0C 00B5
Scan Previous Track         E0 15           0C 00B6
Stop                        E0 3B           0C 00B7
Play/Pause                  E0 34           0C 00CD
Media Select                E0 50           0C 0183
Mail                        E0 48           0C 018A
Calculator                  E0 2B           0C 0192
My Computer                 E0 40           0C 0194
WWW Search                  E0 10           0C 0221
WWW Home                    E0 3A           0C 0223
WWW Back                    E0 38           0C 0224
WWW Forward                 E0 30           0C 0225
WWW Stop                    E0 28           0C 0226
WWW Refresh                 E0 20           0C 0227
WWW Favorites               E0 18           0C 022A


EOF