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** with [TMK converter].
   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 - 2016/09: Unimap support - keymap editor on web browser
  25
  26
  27
  28 Hardware
  29 --------
  30 You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy].
  31
  32 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`.
  33
  34 [![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg)
  35
  36 ### 4P4C phone handset cable
  37 Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
  38
  39 <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
  40
  41 [Teensy]: http://www.pjrc.com/teensy/
  42 [TMK converter]: https://geekhack.org/index.php?topic=72052.0
  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={intl|spacefn}]
  64
  65 Use `Maefile.rev1` for TMK converter rev.1 and Teensy(ATMega32u4), instead.
  66
  67
  68
  69 Keymap
  70 ------
  71 To create your own keymap copy existent keymap file to `keymap_<name>.c` and edit it. You can build with `make -f Makefile.rev2 KEYMAP=<name>`.
  72
  73 Or you can edit keymap on web browser and download firmware.
  74
  75 http://www.tmk-kbd.com/tmk_keyboard/editor/
  76
  77
  78 Debug
  79 -----
  80 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.
  81
  82 - Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)