]> git.donarmstrong.com Git - tmk_firmware.git/blob - converter/ibm4704_usb/README.md
Fix README.md and ibm4704.txt
[tmk_firmware.git] / 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 Keyboard models
9 ---------------
10 IBM capacitive switch models:
11     6019273 Model 100 50-key (grid layout)      http://kishy.dyndns.org/?p=977
12     6019284 Model 200 62-key Alpha(60% layout)  http://kishy.dyndns.org/?p=894
13     6019303 Model 300 77-key Expanded Alpha     http://kbtalking.cool3c.com/article/23272
14     6020218 Model 400 107-key Full key          http://kishy.dyndns.org/?p=980
15
16 Alps switch(vintage Green) models:
17     5954339 Japanese 102-key    http://deskthority.net/post87127.html#p87127
18     6112883 Japanese 102-key    http://geekhack.org/index.php?topic=52888.msg1194489#msg1194489
19     6112884 Japanese 102-key    http://geekhack.org/index.php?topic=50437.msg1193047#msg1193047
20     6341739 Chinese 102-key     http://geekhack.org/index.php?topic=52888.msg1176566#msg1176566
21
22
23 Connector
24 ---------
25 Keyboard Plug from front:
26
27     DSUB-9
28     -------------
29     \ N 2 3 4 5 /
30      \ N N N N /
31       ---------
32     2   GND
33     3   VCC 5V
34     4   DATA
35     5   CLOCK
36     N   No connection/No pin.
37
38
39 Connection
40 ----------
41 In case of using ATMega32U4(Teensy2.0):
42
43 1. Supply power with VCC and GND.
44 2. Connect CLOCK to PD1 and DATA to PD0. You can change pin with config.h.
45 3. Optionally you may need pull-up register. 1KOhm probably work.
46
47
48 Build Firmware
49 --------------
50 Just run `make`:
51
52     $ make
53
54 To select keymap:
55
56     $ make KEYMAP=[plain|...]
57
58
59 Keymap
60 ------
61 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.