keyboards/kinesis/stapelberg/readme.md

   1 # kinesis_stapelberg keyboard firmware
   2
   3 This folder contains the firmware customization required to run QMK on the custom controller for the Kinesis Advantage created by Michael Stapelberg.
   4 It differs from the `alvicstep` keyboard in that the existing QMK Kinesis Advantage project uses the existing controller board provided by Kinesis.
   5
   6 The controller board hardware is described
   7 [here](http://michael.stapelberg.de/Artikel/kinesis_custom_controller)
   8
   9 Mapping the pin assignments was done using the corresponding matrix description provided at this
  10 [link](https://github.com/stapelberg/kinesis-firmware/blob/master/kb_kinesis/config.kspec)
  11
  12 This code makes no attempt to drive the four LEDs provided on the controller board.
  13
  14
  15 ## Building the Hardware
  16
  17 If you want to perform this customization, these parts may be helpful.
  18
  19 | Function                                               | Quantity | Vendor   | Part Number  |
  20 | ------------------------------------------------------ | -------- | -------  | ------------ |
  21 | 13 pin connector for function keys and finger keywells | 4        | Digi-Key | WM14526-ND   |
  22 | 10 pin headers for thumb clusters                      | 4        | Digi-Key | 609-3250-ND  |
  23 | 8 pin cable for thumb clusters                         | 2        | Digi-Key | SAM8928-ND   |
  24 | Teensy++ 2.0                                           | 1        | Digi-Key | 1528-1056-ND |
  25 | 2 pin right angle header for reset                     | 1        | Digi-Key | 3M9467-ND    |
  26 | Reset cables                                           | 2        | Sparkfun | PRT-09140    |
  27
  28 The board and connections are shown here
  29 ![controller board](https://i.imgur.com/2ZPMwvZ.jpg)
  30
  31 The Teensy mounting detail can be seen here.
  32 I used a socket for prototyping.
  33 ![teensy detail](https://i.imgur.com/HrkGUjc.jpg)
  34
  35
  36 Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board.
  37 Shorting these two pins together will reset the board.
  38 I also put female to male header jumper cables on these so they could be accessed outside the enclosure.
  39 The exterior cables can be seen here.
  40 ![exterior reset](https://i.imgur.com/JNoxI40.jpg)
  41
  42
  43 ## Keymaps
  44
  45 ### Default
  46
  47 To build with the default keymap, run `make kinesis/stapelberg` while in the QMK directory.
  48
  49 ### Dvorak
  50
  51 This keymap contains a dvorak implementation as well as media and symbol layers.
  52
  53 Run `make kinesis/stapelberg:dvorak` while in the QMK directory.