Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. M0110/M0110A to USB keyboard converter
  2. ======================================
  3. 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.
  4. Read README of top directory too.
  5. Pictures of **M0110 + M0120** and **M0110A** with [TMK converter].
  6. ![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
  7. ![M0110A](http://i.imgur.com/HuHOEoHm.jpg)
  8. - M0110A support was contributed by [skagon@github](https://github.com/skagon).
  9. - M0120 also is supported. keys(+ * / and ,) on M0120 are recognized as cursor keys.
  10. Update
  11. ------
  12. - 2013/08: Change port for signals `PF` to `PD`
  13. - 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now.
  14. - 2014/06: Change keymaps
  15. - 2015/03: Add support for "International"(ISO) keyboard(keymap_intl.c)
  16. - 2016/09: Unimap support - keymap editor on web browser
  17. Hardware
  18. --------
  19. You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy].
  20. 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`.
  21. [![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg)
  22. ### 4P4C phone handset cable
  23. Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
  24. <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
  25. [Teensy]: http://www.pjrc.com/teensy/
  26. [TMK converter]: https://geekhack.org/index.php?topic=72052.0
  27. ### Socket Pinout
  28. - <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
  29. ![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
  30. ### Pull-up Resistor
  31. 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.
  32. Building Firmware
  33. -----------------
  34. 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.
  35. $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
  36. $ cd m0110_usb
  37. $ make -f Makefile.rev2 clean
  38. $ make -f Makefile.rev2 [KEYMAP={intl|spacefn}]
  39. Use `Maefile.rev1` for TMK converter rev.1 and Teensy(ATMega32u4), instead.
  40. Keymap
  41. ------
  42. To create your own keymap copy existent keymap file to `keymap_<name>.c` and edit it. You can build with `make -f Makefile.rev2 KEYMAP=<name>`.
  43. Or you can edit keymap on web browser and download firmware.
  44. http://www.tmk-kbd.com/tmk_keyboard/editor/
  45. Debug
  46. -----
  47. 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.
  48. - Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)