converter/ibm4704_usb/README.md

   1 IBM 4704 to USB keyboard converter
   2 ==================================
   3 This firmware converts IBM 4704 keyboard protocol to USB HID.
   4
   5 Keyboard initialization process takes a few seconds at start up. During that you will hear buzzer from the keyboard. **You need to plug USB cable after hooking up your keyboard to the converter.**
   6
   7
   8 Update
   9 ------
  10 - 2015/09/07  Added keymap for Alps 102-key. Thanks, tai @ geekhack!
  11 - 2015/05/05  Added keymaps for 107-key, 77-key and 50-key. Thanks, orihalcon @ geekhack!
  12 - 2015/05/19  Fixed a protocol handling bug.
  13
  14
  15
  16 Supported Keyboard
  17 ------------------
  18 ### IBM capacitive switch models:
  19 - 6019273 Model 100 50-key (grid layout)      http://kishy.ca/?p=894
  20 - 6019284 Model 200 62-key Alpha(60% layout)  http://kishy.ca/?p=894
  21 - 6019303 Model 300 77-key Expanded Alpha     http://deskthority.net/photos-f62/ibm-6019303-t8502.html
  22 - 6020218 Model 400 107-key Full key          http://kishy.ca/?p=894
  23
  24 ### Alps switch(vintage Green) models:
  25
  26 - 5954339 Japanese 102-key    http://deskthority.net/post87127.html#p87127
  27 - 6112883 Japanese 102-key    http://geekhack.org/index.php?topic=52888.msg1194489#msg1194489
  28 - 6112884 Japanese 102-key    http://geekhack.org/index.php?topic=50437.msg1193047#msg1193047
  29 - 6341739 Chinese 102-key     http://geekhack.org/index.php?topic=52888.msg1176566#msg1176566
  30
  31
  32 Connector
  33 ---------
  34 Keyboard Plug from front:
  35
  36     DSUB-9
  37     -------------
  38     \ N 2 3 4 5 /
  39      \ N N N N /
  40       ---------
  41     2   GND
  42     3   VCC 5V
  43     4   DATA
  44     5   CLOCK
  45     N   No connection/No pin.
  46
  47
  48 Connection
  49 ----------
  50 In case of using ATMega32U4/U2
  51
  52 1. Supply power with VCC and GND.
  53 2. Connect CLOCK to PD1 and DATA to PD0. You can change pin with config.h.
  54 3. Optionally you may need pull-up register. 1KOhm probably work.
  55
  56 TMK Converter can supports IBM 4704.
  57 https://github.com/tmk/keyboard_converter
  58
  59
  60 Build Firmware
  61 --------------
  62 Just run `make`:
  63
  64     $ make -f <makefile>
  65
  66 For TMK Converter rev.1 use `Makefile.tmk_rev1` as makefile:
  67
  68     $ make -f Makefile.tmk_rev1
  69
  70 For TMK Converter rev.2 use `Makefile.tmk_rev2` as makefile:
  71
  72     $ make -f Makefile.tmk_rev2
  73
  74 To select keymap:
  75
  76     $ make -f <makefile> KEYMAP=[plain|...]
  77
  78 To indentify your TMK Converter revision see [this](https://github.com/tmk/keyboard_converter#pcb-revisions).
  79
  80
  81 Keymap
  82 ------
  83 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
  84
  85 Use `KEYMAP_ALPS102()` to define your keymap for Alps models.