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 http://qmk.fm/frenchdev/frenchdev_v1_lasercut_template.svg
  23
  24 ##Side stickers
  25 You can find my original file here : http://qmk.fm/frenchdev/example_printable_stickers.svg
  26
  27 I used it when training but now I use blanks and the layout is different.
  28 I still uploaded it because I think it can be a good jumpstart for any temporary stickers on the
  29 side of keycaps.
  30
  31 ##List of parts
  32 - I2C mcp23018
  33 - [teensy 2](https://www.pjrc.com/store/teensy.html)
  34 - 3 LED, 5mm tall with flat head
  35 - 3 330 ohm resistor
  36 - 2 470 ohm resistor
  37 - 2 TRRS connectors
  38 - 1 [micro usb breakout board](http://www.ebay.com/itm/-/201387922085?)
  39 - 88 cherry/gateron switchs
  40 - 94 4148 diodes
  41 - 34 R4 keys
  42 - 14 R3 keys
  43 - 20 R2 keys
  44 - 22 R1 keys
  45
  46 if you fancy adding pedals :
  47 [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
  48
  49 If you (or your coworkers) find them too loud you can replace the switch inside them.
  50 For once we don't really care about what's inside :)
  51
  52 ##Various indications
  53
  54 The PHYSICAL rows and columns are connected as such :
  55
  56 on right hand (slave) :
  57
  58               I2C mcp23018
  59            .-------   --------.
  60       GND -| 1 VSS \_/  NC 28 |
  61            | 2 NC       A7 27 |- C15
  62        R5 -| 3 B0       A6 26 |- C14
  63        R4 -| 4 B1       A5 25 |- C13
  64        R3 -| 5 B2       A4 24 |- C12
  65        R2 -| 6 B3       A3 23 |- C11
  66        R1 -| 7 B4       A2 22 |- C10
  67        R0 -| 8 B5       A1 21 |- C9
  68            | 9 B6       A0 20 |- C8
  69            | 10 B7    INTA 19 |
  70       VCC -| 11 VDD   INTB 18 |
  71       SCL -| 12 SCL     NC 17 |
  72       SDA -| 13 SDA    RST 16 |- VCC
  73            | 14 NC    ADDR 15 |- GND
  74            `------------------'
  75
  76 and on left hand (main) :
  77
  78                   TEENSY
  79            .------------------.
  80            | GND          VCC |
  81        C7 -| B0            F0 |- R5
  82        C6 -| B1            F1 |- R4
  83        C5 -| B2            F4 |- R3
  84        C4 -| B3            F5 |- R2
  85      LEDC -| B7            F6 |- R1
  86       SCL -| D0            F7 |- R0
  87       SDA -| D1            B6 |- LEDB
  88        C3 -| D2            B5 |- LEDA
  89        C2 -| D3            B4 |
  90        C1 -| C6            D7 |
  91        C0 -| C7            D6 |- GND
  92            | D5            D4 |
  93            | VCC          RST |
  94            | E6           GND |
  95            `------------------'
  96
  97 We use pull up resistor for SCL and VDA, see https://github.com/ErgoDox-EZ/docs/blob/master/ErgoDox%20EZ%20Schematic.pdf for example
  98
  99 the connector is a standard TRRS (jack with audio + mic)
 100
 101 Diode direction is row to column
 102