keyboards/handwired/frenchdev/readme.md

   1 # Frenchdev : My take on a splitted keyboard for dev and french language
   2 Concept based on
   3  - [ergodox](https://ergodox-ez.com/)
   4  - [katy](https://deskthority.net/workshop-f7/katy-keyboard-or-k80cs-key80-contoured-split-t8524.html)
   5
   6 with the added possibility to connect up to 6 external switches like pedals,
   7  and somewhat like the katy, not all keys are on the same level for easier reach.
   8
   9 ### Photos
  10 - [default layout](http://i.imgur.com/r2Nvr4p.png)
  11 - [editable layout on keyboard layout editor](http://www.keyboard-layout-editor.com/#/gists/4480e3ab8026eb7c710a7e22203ef4aa) (keys placement is NOT precise on this)
  12 - [the thing when finished](http://imgur.com/a/6FY8v)
  13 - [concept and cardboard mockup](http://imgur.com/a/R0vvs)
  14
  15 ## Build instructions
  16
  17     docker run --rm -e keymap=default -e keyboard=frenchdev --rm -v D:/Repositories/qmk:/qmk:rw edasque/qmk_firmware
  18
  19 ## Laser-cuttable file
  20 There is intentionnaly no hole for the TRRS connector, you are supposed to use a drill for it.
  21 This way if you don't want to use the pedals you don't have a useless hole. Plus it's cleaner.
  22
  23 ## Side stickers
  24 You can find my original file here : http://qmk.fm/frenchdev/example_printable_stickers.svg
  25
  26 I used it when training but now I use blanks and the layout is different.
  27 I still uploaded it because I think it can be a good jumpstart for any temporary stickers on the
  28 side of keycaps.
  29
  30 ## List of parts
  31 - I2C mcp23018
  32 - [teensy 2](https://www.pjrc.com/store/teensy.html)
  33 - 3 LED, 5mm tall with flat head
  34 - 3 330 ohm resistor
  35 - 2 470 ohm resistor
  36 - 2 TRRS connectors
  37 - 1 [micro usb breakout board](http://www.ebay.com/itm/-/201387922085?)
  38 - 88 cherry/gateron switchs
  39 - 94 4148 diodes
  40 - 34 R4 keys
  41 - 14 R3 keys
  42 - 20 R2 keys
  43 - 22 R1 keys
  44
  45 If you fancy adding pedals :
  46 [these are good enough and cheap](https://www.amazon.fr/gp/product/B00V7WITKI/ref=oh_aui_detailpage_o04_s00?ie=UTF8&psc=1). You also need a RCA connector for each of those to replace the included cable
  47
  48 If you (or your coworkers) find them too loud you can replace the switch inside them.
  49 For once we don't really care about what's inside :)
  50
  51 ## Various indications
  52
  53 The PHYSICAL rows and columns are connected as such :
  54
  55 on right hand (slave) :
  56
  57               I2C mcp23018
  58            .-------   --------.
  59       GND -| 1 VSS \_/  NC 28 |
  60            | 2 NC       A7 27 |- C15
  61        R5 -| 3 B0       A6 26 |- C14
  62        R4 -| 4 B1       A5 25 |- C13
  63        R3 -| 5 B2       A4 24 |- C12
  64        R2 -| 6 B3       A3 23 |- C11
  65        R1 -| 7 B4       A2 22 |- C10
  66        R0 -| 8 B5       A1 21 |- C9
  67            | 9 B6       A0 20 |- C8
  68            | 10 B7    INTA 19 |
  69       VCC -| 11 VDD   INTB 18 |
  70       SCL -| 12 SCL     NC 17 |
  71       SDA -| 13 SDA    RST 16 |- VCC
  72            | 14 NC    ADDR 15 |- GND
  73            `------------------'
  74
  75 and on left hand (main) :
  76
  77                   TEENSY
  78            .------------------.
  79            | GND          VCC |
  80        C7 -| B0            F0 |- R5
  81        C6 -| B1            F1 |- R4
  82        C5 -| B2            F4 |- R3
  83        C4 -| B3            F5 |- R2
  84      LEDC -| B7            F6 |- R1
  85       SCL -| D0            F7 |- R0
  86       SDA -| D1            B6 |- LEDB
  87        C3 -| D2            B5 |- LEDA
  88        C2 -| D3            B4 |
  89        C1 -| C6            D7 |
  90        C0 -| C7            D6 |- GND
  91            | D5            D4 |
  92            | VCC          RST |
  93            | E6           GND |
  94            `------------------'
  95
  96 We use pull up resistor for SCL and VDA, see https://github.com/ErgoDox-EZ/docs/blob/master/ErgoDox%20EZ%20Schematic.pdf for example
  97
  98 The connector is a standard TRRS (jack with audio + mic)
  99
 100 Diode direction is row to column
 101