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 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
  24
  25
  26 Building Hardware
  27 -----------------
  28 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`.
  29
  30 [![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)
  31
  32 ### 4P4C phone handset cable
  33 Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
  34
  35 <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
  36
  37 Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.
  38 [![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)
  39
  40 [Teensy]: http://www.pjrc.com/teensy/
  41
  42
  43 ### Socket Pinout
  44 - <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
  45
  46 ![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
  47
  48
  49 ### Pull-up Resistor
  50 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.
  51
  52
  53
  54 Building Firmware
  55 -----------------
  56 To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to change compile options and pin configuration.
  57
  58     $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
  59     $ cd m0110_usb
  60     $ make clean
  61     $ make
  62
  63 To select keymap use `KEYMAP` option.
  64
  65     $ make clean
  66     $ make KEYMAP={plain|spacefn|hasu}
  67
  68
  69
  70 Keymap
  71 ------
  72 To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.
  73
  74     $ make clean
  75     $ make KEYMAP=name
  76
  77
  78
  79 Debug
  80 -----
  81 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.
  82
  83 - Command: `Shift+Option+Command`(`Shift+Alt+Gui` or `Shift+Alt+Control`)