keyboards/converter/modelm101/readme.md

   1 # modelm101
   2
   3 ![IBM Model M 101 ANSI/102 ISO](https://i.imgur.com/DAE3W7g.jpg)
   4
   5 This is a configuration for the QMK firmware for reversible conversion of IBM's Model M keyboards (common 101-key ANSI and 102-key ISO models) from stock, power-hungry controller, to a modern one, running the USB bus.
   6 Configuration is build for the Atmel AT90USB1286 controller, which you can easily use on the Teensy 2.0++ board (produced by PJRC).
   7 Project is heavely based on 2 other projects:
   8 1. Teensy 2.0++-based custom Model M controller running TMK firmware ('modelm" by [lmorchard](https://blog.lmorchard.com/2016/02/21/modelm-controller/)); - had a few issues.
   9 2. Teensy 2.0++-based custom Model M 122-key controller running QMK firmware ("ibm122m" by [lukexorz](https://github.com/lukexorz)); - had wrong layout for 101/102-key boards and no status LED support.
  10
  11 For this conversion you will need:
  12 1. Teensy 2.0++ dev board itself (can be used a different dev board, but it will require some changes in configuration);
  13 2. Ribbon connectors to connect the membrane to a dev board. Depending on your Model M variation, you will need 1 Trio-mate 16pin connector (6-520315-6 or 6-520415-6) and 1 Trio-mate 8pin connector (5-120628-8 or 5-520314-8), or 2 Trio-mate 16pin connectors;
  14 3. Full-sized breadboard (without power rails; half-size should do, but full-sized one looks more native) or a PCB to wire everything up;
  15 4. A bunch of jumper wires;
  16 5. mini-USB male cable with any USB socket you want to use to connect Teensy inside the keyboard to your PC (I use short mini-USB male to mini-USB female cable);
  17 6. (optional) Resistors for connecting status LEDs if your LED PCB doesn't have any;
  18 7. (optional) Double-sided tape to fix USB socket on or inside the keyboard case.
  19
  20 Pins of the Teensy board you should use by default:
  21 ```
  22 Columns: 1  2  3  4  5  6  7  8  9  10 11 12 13 14 15 16
  23 Pins:    C7 C6 C5 C4 C3 C2 C1 C0 E1 E0 D7 D6 D5 D4 D3 D2
  24 --------------------------------------------------------
  25 Rows: 1  2  3  4  5  6  7  8
  26 Pins: F7 F6 F5 F4 F3 F2 F1 F0
  27 --------------------------------------------------------
  28 Status LEDs: CapsLock +5V ScrollLock NumLock
  29 Pins:        B6       5V  B5         B4
  30 ```
  31
  32 Please note that some versions of Model M have LED connected with a ribbon cable, and not with separate wires.
  33
  34 Keyboard Maintainer: [iw0rm3r](https://github.com/iw0rm3r)
  35 Hardware Supported: Teensy 2.0++ board by PJRC
  36 Hardware Availability: https://www.pjrc.com/store/teensypp.html
  37
  38 Make example for this keyboard (after setting up your build environment):
  39
  40     make converter/modelm101:default:teensy
  41
  42 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).