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 **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**.
+
+
+
-
- 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
+
-You can find 4P4C plugs on telephone handset cable. Note that it is *crossover* connection
-while Macintosh keyboard cable is *straight*.
-[]
+Building Hardware
+-----------------
+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`.
-In this pic:
+[](http://i.imgur.com/4G2ZOeg.jpg)
-1. `GND`(Black)
-2. `CLOCK`(Red)
-3. `DATA`(Green)
-4. `+5V`(Yellow)
+### 4P4C phone handset cable
+Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
-Note that wire colors may vary in your cable.
+<http://en.wikipedia.org/wiki/Modular_connector#4P4C>
+Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.
+[](http://i.imgur.com/3S9P1mY.jpg?1)
-### Pinout
+[Teensy]: http://www.pjrc.com/teensy/
+
+
+### Socket Pinout
- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
-- <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
-### 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.
$ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
$ cd m0110_usb
+ $ make clean
$ make
-and program your Teensy with [PJRC Teensy loader](http://www.pjrc.com/teensy/loader.html).
+To select keymap use `KEYMAP` option.
+
+ $ make clean
+ $ make KEYMAP={plain|spacefn|hasu}
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. You can build it like this.
+
+ $ make clean
+ $ make KEYMAP=name
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 `<magickey>+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 `<Command>+H` simultaneously to get help.
-magickey: Shift+Option+Command(Shift+Alt+Gui or Shift+Alt+Control)
+- Command: `Shift+Option+Command`(`Shift+Alt+Gui` or `Shift+Alt+Control`)
projects / tmk_firmware.git / blobdiff