tmk_keyboard_custom/converter/m0110_usb/README.md

M0110/M0110A to USB keyboard converter
======================================
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)


- M0110A support was contributed by [skagon@github](https://github.com/skagon).
- M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys.


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**.

<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.
[![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
- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>

![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)


### 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 Firmware
-----------------
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 -f Makefile clean
    $ make -f Makefile [KEYMAP={default|plain|intl|spacefn|hasu}]

Use `Makefile.teensy` instead for Teensy.


Keymap
------
To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.

    $ make -f Makefile clean
    $ make -f Makefile 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 `<Magic>+H` simultaneously to get help.

- Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00			`M0110/M0110A to USB keyboard converter`
			`======================================`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			`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.`
Fix README of M0110 2013-09-21 12:20:05 +00:00
Change keymaps of M0110 2014-06-22 05:15:38 +00:00			`Read README of top directory too.`

Spellchecking converter README files. 2014-01-05 03:45:52 +00:00			`Pictures of M0110 + M0120 and M0110A.`
Fix README of M0110 2013-09-21 12:20:05 +00:00
			`![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)`
			`![M0110A](http://i.imgur.com/HuHOEoHm.jpg)`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00

Fix keymaps in README.(M0110) 2012-12-05 10:45:00 +00:00			`- M0110A support was contributed by [skagon@github](https://github.com/skagon).`
			`- M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys.`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00


Change Makefile and port setting - Makefile use LUFA now - Change MCU ports PF{0,1} to PD{0,1} - Add build option for keymap to Makefile: make keymap=hasu 2013-08-04 07:13:51 +00:00			`Update`
			`------`
Fix README of M0110 2013-09-21 12:20:05 +00:00			- 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.
Change keymaps of M0110 2014-06-22 05:15:38 +00:00			`- 2014/06: Change keymaps`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			`- 2015/03: Add support for "International"(ISO) keyboard(keymap_intl.c)`
Change Makefile and port setting - Makefile use LUFA now - Change MCU ports PF{0,1} to PD{0,1} - Add build option for keymap to Makefile: make keymap=hasu 2013-08-04 07:13:51 +00:00


Fix README of M0110 2013-09-21 12:20:05 +00:00			`Building Hardware`
			`-----------------`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			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`.
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Fix README of M0110 2013-09-21 12:20:05 +00:00			`[![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Fix README of M0110 2013-09-21 12:20:05 +00:00			`### 4P4C phone handset cable`
			`Note that original cable used with Mac is straight while phone handset cable is crossover.`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Fix README of M0110 2013-09-21 12:20:05 +00:00			`<http://en.wikipedia.org/wiki/Modular_connector#4P4C>`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Spellchecking converter README files. 2014-01-05 03:45:52 +00:00			`Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.`
Fix README of M0110 2013-09-21 12:20:05 +00:00			`[![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Fix README of M0110 2013-09-21 12:20:05 +00:00			`[Teensy]: http://www.pjrc.com/teensy/`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			`[TMK converter]: https://github.com/tmk/keyboard_converter`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00

Fix README of M0110 2013-09-21 12:20:05 +00:00			`### Socket Pinout`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00			`- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>`

			`![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)`


Spellchecking converter README files. 2014-01-05 03:45:52 +00:00			`### 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.
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00


Spellchecking converter README files. 2014-01-05 03:45:52 +00:00			`Building Firmware`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00			`-----------------`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			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.
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00
Update M0110 keymap and add a Make target 'hasu'. - change keymap for M0110 - add a Make target 'hasu' to build with hasu keymap. 2012-05-27 05:13:02 +00:00			`$ git clone git://github.com/tmk/tmk_keyboard.git (or download source)`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00			`$ cd m0110_usb`
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			`$ make -f Makefile clean`
			`$ make -f Makefile [KEYMAP={default\|plain\|intl\|spacefn\|hasu}]`
Change keymaps of M0110 2014-06-22 05:15:38 +00:00
m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			Use `Makefile.teensy` instead for Teensy.
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00


			`Keymap`
			`------`
Change keymaps of M0110 2014-06-22 05:15:38 +00:00			To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.

m0110: Add support for international keyboard 2015-03-18 06:56:07 +00:00			`$ make -f Makefile clean`
			`$ make -f Makefile KEYMAP=name`
Added M0110A support contributed by skagon@github. - README is written with markdown notation. - m0110.c can handles Arrow keys and Calc keys of M0110A. - EXTRAFLAGS and EXTRALDFLAGS are added in rules.mk to give flags on make command line. 2012-04-27 16:57:36 +00:00


			`Debug`
			`-----`
m0110: Fix README.md and keymap_intl.c 2015-03-18 21:39:13 +00:00			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.
Change IS_COMMAND.(M0110) 2012-12-03 06:56:59 +00:00
m0110: Fix README.md and keymap_intl.c 2015-03-18 21:39:13 +00:00			- Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)