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 like **ATmega32U2** and **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
   4
   5 Read README of top directory too.
   6
   7 Pictures of **M0110 + M0120** and **M0110A**.
   8
   9 ![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
  10 ![M0110A](http://i.imgur.com/HuHOEoHm.jpg)
  11
  12
  13 - M0110A support was contributed by [skagon@github](https://github.com/skagon).
  14 - M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys.
  15
  16
  17
  18 Update
  19 ------
  20 - 2013/08: Change port for signals `PF` to `PD`
  21 - 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now.
  22 - 2014/06: Change keymaps
  23 - 2015/03: Add support for "International"(ISO) keyboard(keymap_intl.c)
  24
  25
  26
  27 Building Hardware
  28 -----------------
  29 You need [TMK converter] or AVR dev 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`.
  30
  31 [![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)
  32
  33 ### 4P4C phone handset cable
  34 Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
  35
  36 <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
  37
  38 Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.
  39 [![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)
  40
  41 [Teensy]: http://www.pjrc.com/teensy/
  42 [TMK converter]: https://github.com/tmk/keyboard_converter
  43
  44
  45 ### Socket Pinout
  46 - <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
  47
  48 ![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
  49
  50
  51 ### Pull-up Resistor
  52 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.
  53
  54
  55
  56 Building Firmware
  57 -----------------
  58 To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to change compile options and pin configuration. Also `KEYMAP` option can be used to select keymap.
  59
  60     $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
  61     $ cd m0110_usb
  62     $ make -f Makefile.rev2 clean
  63     $ make -f Makefile.rev2 [KEYMAP={default|intl|spacefn|hasu}]
  64
  65 Use `Maefile.tmk_rev1` for TMK converter Rev.1, `Makefile.teensy` for Teensy instead.
  66
  67
  68
  69 Keymap
  70 ------
  71 To create your own keymap copy existent keymap file to `keymap_name.c` and edit it.
  72
  73
  74
  75 Debug
  76 -----
  77 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 `<Magic>+H` simultaneously to get help.
  78
  79 - Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)