X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=converter%2Fm0110_usb%2FREADME.md;h=bfd3261df539859d8aab1c8162b373e775687fff;hb=8ec1d41a28d5223a147218bfb7fefd933b906d22;hp=059b840c31cfc19f9f84ac142f288d72a073f5c3;hpb=07b6c1a58c8ccfd6e5d5bc57e34f6c44c24841a8;p=qmk_firmware.git diff --git a/converter/m0110_usb/README.md b/converter/m0110_usb/README.md index 059b840c3..bfd3261df 100644 --- a/converter/m0110_usb/README.md +++ b/converter/m0110_usb/README.md @@ -1,124 +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. -![M0110](https://github.com/tmk/tmk_keyboard/raw/master/m0110_usb/doc/m0110.jpg) +Read README of top directory too. -M0110A support was contributed by [skagon@github](https://github.com/skagon). +Pictures of **M0110 + M0120** and **M0110A**. +![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg) +![M0110A](http://i.imgur.com/HuHOEoHm.jpg) -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*. +- M0110A support was contributed by [skagon@github](https://github.com/skagon). +- M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys. -You can find 4P4C plugs on telephone handset cable. Note that it is *crossover* connection -while Macintosh keyboard cable is *straight*. -[![Conection](http://i.imgur.com/vJoVOm.jpg)](http://i.imgur.com/vJoVO.jpg) -In this pic: +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) + + + +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`. + +[![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg) + +### 4P4C phone handset cable +Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. + + -1. `GND`(Black) -2. `CLOCK`(Red) -3. `DATA`(Green) -4. `+5V`(Yellow) +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) -Note that wire colors may vary in your cable. +[Teensy]: http://www.pjrc.com/teensy/ +[TMK converter]: https://github.com/tmk/keyboard_converter -### Pinout +### 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 -#### *Default* - ,---------------------------------------------------------. - | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backs| - |---------------------------------------------------------| - |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| - |---------------------------------------------------------| - |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return| - |---------------------------------------------------------| - |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shift | - `---------------------------------------------------------' - |Ctr|Alt | Space |Gui |Ctr| - `-----------------------------------------------' -#### *HHKB/WASD Layer* - ,---------------------------------------------------------. - |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| - |---------------------------------------------------------| - |Caps |Hom| Up|PgU| | | | |Psc|Slk|Pau|Up | |Ins| - |---------------------------------------------------------| - |Fn0 |Lef|Dow|Rig| | | | |Hom|PgU|Lef|Rig|Return| - |---------------------------------------------------------| - |Shift |End| |PgD| |VoD|VoU|Mut|End|PgD|Dow|Shift | - `---------------------------------------------------------' - |Ctr|Alt | Space |Gui |Ctr| - `-----------------------------------------------' - -### M0110A -#### *Default* - ,---------------------------------------------------------. ,---------------. - | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backs| |Gui| =| /| *| - |---------------------------------------------------------| |---------------| - |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| - |Ctrl |Alt | Space | \|Lft|Rgt|Dn | | 0| .| | - `---------------------------------------------------------' `---------------' -#### *HHKB/WASD/mousekey Layer* - ,---------------------------------------------------------. ,---------------. - |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk|Mb1|Mb3|Mb2| - |---------------------------------------------------------| |---------------| - |Caps |Hom| Up|PgU| | | | |Psc|Slk|Pau|Up | | | |MwD|McU|MwU|MwU| - |-----------------------------------------------------' | |---------------| - |Fn0 |Lef|Dow|Rig| | | | |Hom|PgU|Lef|Rig|Return| |McL|McD|McR|MwD| - |---------------------------------------------------------| |---------------| - |Shift |End| |PgD| |VoD|VoU|Mut|End|PgD|Dow|Shif|Up | |MwL|McD|MwR| | - |---------------------------------------------------------| |-----------|Mb2| - |Ctrl |Alt | Space |Ins|Lft|Rgt|Dn | | Mb1|Mb3| | - `---------------------------------------------------------' `---------------' +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. +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. -The converter has some functions for debug, press `Alt+Gui+H` simultaneously to get help. -These function is totally undocumented, tentative, inconsistent and buggy. +- Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)