converter/m0110_usb/README.md

   1 M0110/M0110A to USB keyboard converter
   2 ======================================
   3 This firmware converts the protocol of Apple Macintosh keyboard **M0110**, **M0110A** and **M0120** into USB. Target of this project is USB AVR controller **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
   4
   5 Pictures of **M0110 + M0120** and **M0110A**.
   6
   7 ![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
   8 ![M0110A](http://i.imgur.com/HuHOEoHm.jpg)
   9
  10
  11 - M0110A support was contributed by [skagon@github](https://github.com/skagon).
  12 - M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys.
  13
  14
  15
  16 Update
  17 ------
  18 - 2013/08: Change port for signals `PF` to `PD`
  19 - 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now.
  20
  21
  22
  23 Building Hardware
  24 -----------------
  25 You need **4P4C** cable and **ATMega32U4** board like PJRC [Teensy]. Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`.
  26
  27 [![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)
  28
  29 ### 4P4C phone handset cable
  30 Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
  31
  32 <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
  33
  34 Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.
  35 [![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)
  36
  37 [Teensy]: http://www.pjrc.com/teensy/
  38
  39
  40 ### Socket Pinout
  41 - <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
  42
  43 ![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
  44
  45
  46 ### Pull-up Resistor
  47 You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors.
  48
  49
  50
  51 Building Firmware
  52 -----------------
  53 To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to change compile options and pin configuration.
  54
  55     $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
  56     $ cd m0110_usb
  57     $ make -f Makefile clean
  58     $ make -f Makefile
  59
  60 and program your Teensy with [PJRC Teensy loader](http://www.pjrc.com/teensy/loader.html).
  61
  62
  63
  64 Keymap
  65 ------
  66 You can change keymaps by editing *keymap.c*.
  67
  68 ### M0110 & M0120
  69 #### *Default Layer*
  70     ,---------------------------------------------------------.     ,---------------.
  71     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs|     |Clr|  -|Lft|Rgt|
  72     |---------------------------------------------------------|     |---------------|
  73     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|     |  7|  8|  9| Up|
  74     |---------------------------------------------------------|     |---------------|
  75     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Enter |     |  4|  5|  6| Dn|
  76     |---------------------------------------------------------|     |---------------|
  77     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift   |     |  1|  2|  3|   |
  78     `---------------------------------------------------------'     |-----------|Ent|
  79          |Ctl|Gui |         Space               |Alt |Ctl|          |      0|  .|   |
  80          `-----------------------------------------------'          `---------------'
  81
  82 - `Space` and  `Enter` also work as `Fn` layer switch key when holding down.
  83
  84 #### *Function Layer(WASD/HHKB)*
  85     ,---------------------------------------------------------.     ,---------------.
  86     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet|     |Nlk|  -|Lft|Rgt|
  87     |---------------------------------------------------------|     |---------------|
  88     |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|  \|     |  7|  8|  9| Up|
  89     |---------------------------------------------------------|     |---------------|
  90     |Caps  |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Enter |     |  4|  5|  6| Dn|
  91     |---------------------------------------------------------|     |---------------|
  92     |Shift   |End|   |PgD|   |   |   |   |End|PgD|Dow|Shift   |     |  1|  2|  3|   |
  93     `---------------------------------------------------------'     |-----------|Ent|
  94          |Ctl|Gui |         Space               |Alt |Ctl|          |      0|  .|   |
  95          `-----------------------------------------------'          `---------------'
  96
  97
  98 ### M0110A
  99 #### *Default Layer*
 100     ,---------------------------------------------------------. ,---------------.
 101     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Clr|  =|  /|  *|
 102     |---------------------------------------------------------| |---------------|
 103     |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
 104     |-----------------------------------------------------'   | |---------------|
 105     |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Enter | |  4|  5|  6|  +|
 106     |---------------------------------------------------------| |---------------|
 107     |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft| Up| |  1|  2|  3|   |
 108     |---------------------------------------------------------| |-----------|Ent|
 109     |Ctrl |Gui    |         Space             |  \|Lft|Rgt|Dwn| |      0|  .|   |
 110     `---------------------------------------------------------' `---------------'
 111
 112 - `Space` and  `Enter` also work as `Fn` layer switch key when holding down.
 113 - `Backslash(\)` also works as `Alt` when holding down.
 114
 115 #### *Function Layer(WASD/HHKB)*
 116     ,---------------------------------------------------------. ,---------------.
 117     |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk|  =|  /|  *|
 118     |---------------------------------------------------------| |---------------|
 119     |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|   | |  7|  8|  9|  -|
 120     |-----------------------------------------------------'   | |---------------|
 121     |Caps  |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Enter | |  4|  5|  6|  +|
 122     |---------------------------------------------------------| |---------------|
 123     |Shift   |End|   |PgD|   |   |   |   |End|PgD|Dow|Shif|PgU| |  1|  2|  3|   |
 124     |---------------------------------------------------------| |-----------|Ent|
 125     |Ctrl |Gui    |         Space             |  \|Hom|End|PgD| |      0|  .|   |
 126     `---------------------------------------------------------' `---------------'
 127
 128
 129
 130 Debug
 131 -----
 132 You can use [PJRC HID listen](http://www.pjrc.com/teensy/hid_listen.html) to see debug output. The converter has some functions for debug, press `<Command>+H` simultaneously to get help.
 133
 134 - Command: `Shift+Option+Command`(`Shift+Alt+Gui` or `Shift+Alt+Control`)