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