X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=converter%2Fm0110_usb%2FREADME.md;h=bfd3261df539859d8aab1c8162b373e775687fff;hb=fb1fb122a5971723f374cd737b7cc0aefd470af3;hp=206f4342512de6aa08de3f1517c4ea7d38984409;hpb=72dc413a19562b6a67509d4fd6a1cb9c07227d3d;p=max%2Ftmk_keyboard.git diff --git a/converter/m0110_usb/README.md b/converter/m0110_usb/README.md index 206f4342..bfd3261d 100644 --- a/converter/m0110_usb/README.md +++ b/converter/m0110_usb/README.md @@ -1,127 +1,79 @@ M0110/M0110A to USB keyboard converter ====================================== -This firmware converts the protocol of Apple Macintosh keyboard M0110/M0110A into USB. -Target board of this project is [PJRC Teensy](http://www.pjrc.com/teensy/), though, -you can use other board with USB AVR like `ATmega32U4` and `AT90USB`. +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. + +Read README of top directory too. + +Pictures of **M0110 + M0120** and **M0110A**. + +![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg) +![M0110A](http://i.imgur.com/HuHOEoHm.jpg) -![M0110](https://raw.github.com/tmk/tmk_keyboard/master/converter/m0110_usb/doc/m0110.jpg) - M0110A support was contributed by [skagon@github](https://github.com/skagon). - M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys. -Connection ----------- -You need 4P4C plug and cable to connect Teensy or other AVR dev board into the keyboard. -Teensy port `PF0` is assigned for `CLOCK` line and `PF1` for `DATA` by default, -you can change pin configuration with editing *config.h*. +Update +------ +- 2013/08: Change port for signals `PF` to `PD` +- 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now. +- 2014/06: Change keymaps +- 2015/03: Add support for "International"(ISO) keyboard(keymap_intl.c) -You can find 4P4C plugs on telephone handset cable. Note that it is *crossover* connection -while Macintosh keyboard cable is *straight*. -[![Conection](https://raw.github.com/tmk/tmk_keyboard/master/converter/m0110_usb/doc/teensy.jpg)] -In this pic: +Building Hardware +----------------- +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`. -1. `GND`(Black) -2. `CLOCK`(Red) -3. `DATA`(Green) -4. `+5V`(Yellow) +[![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg) -Note that wire colors may vary in your cable. +### 4P4C phone handset cable +Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. + -### Pinout +Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge. +[![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1) + +[Teensy]: http://www.pjrc.com/teensy/ +[TMK converter]: https://github.com/tmk/keyboard_converter + + +### Socket Pinout - -- ![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) -### Pull-up Registor -You may need pull-up registors on signal lines(`CLOCK`, `DATA`) in particular -when you have long or coiled cable. 1k-10k Ohm will be OK for this purpose. -In some cases MCU can't read signal from keyboard correctly without pull-up resistors. +### Pull-up Resistor +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. -Building Frimware +Building Firmware ----------------- -To compile firmware you need AVR GCC. You can use [WinAVR](http://winavr.sourceforge.net/) on Windows. -You can edit *Makefile* and *config.h* to change compile options and pin configuration. +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. $ git clone git://github.com/tmk/tmk_keyboard.git (or download source) $ cd m0110_usb - $ make + $ make -f Makefile.rev2 clean + $ make -f Makefile.rev2 [KEYMAP={default|intl|spacefn|hasu}] -and program your Teensy with [PJRC Teensy loader](http://www.pjrc.com/teensy/loader.html). +Use `Maefile.tmk_rev1` for TMK converter Rev.1, `Makefile.teensy` for Teensy instead. Keymap ------ -You can change keymaps by editing *keymap.c*. - -### M0110 & M0120 -#### *Default* - ,---------------------------------------------------------. ,---------------. - | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backs| |Ctl| -|Lft|Rgt| - |---------------------------------------------------------| |---------------| - |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| | 7| 8| 9| Up| - |---------------------------------------------------------| |---------------| - |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return| | 4| 5| 6| Dn| - |---------------------------------------------------------| |---------------| - |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shift | | 1| 2| 3| | - `---------------------------------------------------------' |-----------|Ent| - |Alt|Gui | Space |Ctl |Alt| | 0| .| | - `-----------------------------------------------' `---------------' -#### *HHKB/WASD Layer(WASD/IJKL)* - ,---------------------------------------------------------. ,---------------. - |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk| -|Lft|Rgt| - |---------------------------------------------------------| |---------------| - |Caps |Hom| Up|PgU| | | |PgU| Up|Hom|Psc|Slk|Pau|Ins| | 7| 8| 9| Up| - |---------------------------------------------------------| |---------------| - |Fn0 |Lef|Dow|Rig| | | |Lef|Dow|Rig| | |Return| | 4| 5| 6| Dn| - |---------------------------------------------------------| |---------------| - |Shift |End| |PgD| | | |PgD| |End| |Shift | | 1| 2| 3| | - `---------------------------------------------------------' |-----------|Ent| - |Alt|Gui | Space |Ctl |Alt| | 0| .| | - `-----------------------------------------------' `---------------' - -### M0110A -#### *Default* - ,---------------------------------------------------------. ,---------------. - | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backs| |Ctl| =| /| *| - |---------------------------------------------------------| |---------------| - |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| | | 7| 8| 9| -| - |-----------------------------------------------------' | |---------------| - |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return| | 4| 5| 6| +| - |---------------------------------------------------------| |---------------| - |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shft| Up| | 1| 2| 3| | - |---------------------------------------------------------| |-----------|Ent| - |Alt |Gui | Space | \|Lft|Rgt| Dn| | 0| .| | - `---------------------------------------------------------' `---------------' -#### *Cursor Layer(WASD/IJKL)* - ,---------------------------------------------------------. ,---------------. - |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk| =| /| *| - |---------------------------------------------------------| |---------------| - |Caps |Hom| Up|PgU| | | |PgU| Up|Hom|Psc|Slk|Pau| | | 7| 8| 9| -| - |-----------------------------------------------------' | |---------------| - |Fn0 |Lef|Dow|Rig| | | |Lef|Dow|Rig| | |Return| | 4| 5| 6| +| - |---------------------------------------------------------| |---------------| - |Shift |End| |PgD| | | |PgD| |End| |Shif|PgU| | 1| 2| 3| | - |---------------------------------------------------------| |-----------|Ent| - |Alt |Gui | Space |Ins|Hom|End|PgD| | 0| .| | - `---------------------------------------------------------' `---------------' +To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. Debug ----- -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 `+H` simultaneously to get help. -These function is totally undocumented, tentative, inconsistent and buggy. +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 `+H` simultaneously to get help. -magickey: Shift+Option+Command(Shift+Alt+Gui or Shift+Alt+Control) +- Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)