opensteno_qmk/converter/m0110_usb/README.md

84 lines
2.8 KiB
Markdown
Raw Normal View History

M0110/M0110A to USB keyboard converter
======================================
2013-09-21 12:20:05 +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 **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
2014-06-22 05:15:38 +00:00
Read README of top directory too.
2014-01-05 03:45:52 +00:00
Pictures of **M0110 + M0120** and **M0110A**.
2013-09-21 12:20:05 +00:00
![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
![M0110A](http://i.imgur.com/HuHOEoHm.jpg)
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.
Update
------
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.
2014-06-22 05:15:38 +00:00
- 2014/06: Change keymaps
2013-09-21 12:20:05 +00:00
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`.
2013-09-21 12:20:05 +00:00
[![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)
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**.
2013-09-21 12:20:05 +00:00
<http://en.wikipedia.org/wiki/Modular_connector#4P4C>
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.
2013-09-21 12:20:05 +00:00
[![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)
2013-09-21 12:20:05 +00:00
[Teensy]: http://www.pjrc.com/teensy/
2013-09-21 12:20:05 +00:00
### Socket Pinout
- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
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.
2014-01-05 03:45:52 +00:00
Building Firmware
-----------------
2013-09-21 12:20:05 +00:00
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
2014-06-22 05:15:38 +00:00
$ make clean
$ make
To select keymap use `KEYMAP` option.
2014-06-22 05:15:38 +00:00
$ make clean
$ make KEYMAP={plain|spacefn|hasu}
Keymap
------
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.
$ make clean
$ make KEYMAP=name
Debug
-----
2013-09-21 12:20:05 +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 `<Command>+H` simultaneously to get help.
2012-12-03 06:56:59 +00:00
2013-09-21 12:20:05 +00:00
- Command: `Shift+Option+Command`(`Shift+Alt+Gui` or `Shift+Alt+Control`)