keyboards/fc660c/README.md

   1 FC660C Alt Controller
   2 =================
   3
   4 This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c
   5
   6 ------------
   7
   8 - Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
   9 - Hardware Supported: Hasu's Alt Controller (see below)
  10 - Hardware Availability: https://geekhack.org/index.php?topic=90317.0
  11
  12 Make example for this keyboard (after setting up your build environment):
  13
  14     make fc660c:default
  15
  16 See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
  17
  18 To flash the firmware, press the reset button on the controller and run:
  19
  20     sudo make fc660c:default:dfu
  21
  22 --------
  23
  24 Thread on Geekhack: https://geekhack.org/index.php?topic=88439.0
  25
  26 Also: https://geekhack.org/index.php?topic=88720.0
  27
  28
  29 Actuation Point adjustment
  30 --------------------------
  31 You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`.
  32 A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation.
  33 Be careful with this setting and use small values (+/-5).
  34 See the `actuation-point-example` keymap of the `fc980c` keyboard for an example.
  35 For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c).
  36 Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards.
  37
  38
  39 Pinouts
  40 -------
  41
  42     |Switch  |Controller |
  43     |  board |     board |Description                           |Schematic  |ATmega32u4
  44     |--------|-----------|--------------------------------------|-----------|------------
  45     | 1      |20         | FG                                   |FG         |GND
  46     | 2      |19         | GND                                  |GND        |GND
  47     | 3      |18         | GND                                  |GND        |GND
  48     | 4      |17         | 3.3V                                 |V33        |3.3V/5V
  49     | 5      |16         | 5V                                   |Vcc        |5V
  50     | 6      |15         |*Z6-TP1684-4-HYS(o)                   |FBSTB      |PC7
  51     | 7      |14         |*Z6-TP1684-2-KEY(i)                   |OUT        |PC6
  52     | 8      |13         |*Z2-AD5258-5-SCL(I2C)                 |SCL        |PD0(TWI)
  53     | 9      |12         |*Z2-AD5258-4-SDA(I2C)                 |SDA        |PD1(TWI)
  54     |10      |11         |*Z4-LV4051A-6-~EN(Col 0-7)            |INH_1      |PB4
  55     |11      |10         |*Z5-LV4051A-6-~EN(Col 8-F)            |INH_2      |PB3
  56     |12      | 9         |+Z7-LV07A-5 (LV4051A-9-C)             |SEL_C      |PB2
  57     |13      | 8         |+Z7-LV07A-1 (LV4051A-10-B)            |SEL_B      |PB1
  58     |14      | 7         |+Z7-LV07A-3 (LV4051A-11-A)            |SEL_A      |PB0
  59     |15      | 6         |+Z3-LVC138A-3-C                       |COL4       |PD6
  60     |16      | 5         |+Z3-LVC138A-2-B                       |COL3       |PD5
  61     |17      | 4         |+Z3-LVC138A-1-A                       |COL2       |PD4
  62     |18      | 3         |+Z3-LVC138A-4-~G2A  Z6-TP1684-5-~EN   |COL1       |PD7
  63     |19      | 2         |+Z7-LV07A-11-~InsertLED               |LED1       |PB5
  64     |20      | 1         |+Z7-LV07A-13-~CapsLED                 |LED2       |PB6
  65
  66 ```
  67 * 5V intferface
  68 + 3.3V interface
  69 ```
  70
  71 - Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg
  72 - Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg
  73
  74
  75 Key Matrix
  76 ----------
  77 Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason.
  78
  79     |    |0   |1   |2   |3   |4   |5   |6   |7   |8   |9   |A   |B   |C   |D   |E   |F   |
  80     |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
  81     |   0|Q   |W   |E   |Tab |R   |U   |T   |Y   |O   |P   |[   |I   |]   |    |\   |Del |
  82     |   1|1   |2   |3   |Esc |4   |7   |5   |6   |9   |0   |-   |8   |=   |    |BSpc|Ins |
  83     |   2|    |LWin|LAlt|LCtl|    |    |    |Spc |RAlt|    |RCtl|    |Fn  |Down|Left|Rght|
  84     |   3|    |Z   |X   |LSft|C   |N   |V   |B   |,   |.   |/   |M   |RSft|Up  |    |    |
  85     |   4|A   |S   |D   |Caps|F   |J   |G   |H   |L   |;   |'   |K   |    |    |Entr|    |
  86     |   5|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  87     |   6|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  88     |   7|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  89
  90 Logic analyzer pics:
  91 - http://i.imgur.com/9XoNTev.png
  92 - https://i.imgur.com/5FCP1Ay.png
  93
  94 This code emuluates what original cotnroller does for matrix scan.
  95 - https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c
  96
  97
  98 ### Row designation
  99 LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18).
 100
 101     |Row |A/17|B/16|C/15|
 102     |----|----|----|----|
 103     |0   |0   |0   |0   |
 104     |1   |1   |0   |0   |
 105     |2   |0   |1   |0   |
 106     |3   |1   |1   |0   |
 107     |4   |0   |0   |1   |
 108     |5   |1   |0   |1   |
 109     |6   |0   |1   |1   |
 110     |7   |1   |1   |1   |
 111
 112
 113 ### Column designation
 114 LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
 115
 116     |Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11|
 117     |----|----|----|----|--------|--------|
 118     |0   |0   |0   |0   |0       |1       |
 119     |1   |1   |0   |0   |0       |1       |
 120     |2   |0   |1   |0   |0       |1       |
 121     |3   |1   |1   |0   |0       |1       |
 122     |4   |0   |0   |1   |0       |1       |
 123     |5   |1   |0   |1   |0       |1       |
 124     |6   |0   |1   |1   |0       |1       |
 125     |7   |1   |1   |1   |0       |1       |
 126     |8   |0   |0   |0   |1       |0       |
 127     |9   |1   |0   |0   |1       |0       |
 128     |A   |0   |1   |0   |1       |0       |
 129     |B   |1   |1   |0   |1       |0       |
 130     |C   |0   |0   |1   |1       |0       |
 131     |D   |1   |0   |1   |1       |0       |
 132     |E   |0   |1   |1   |1       |0       |
 133     |F   |1   |1   |1   |1       |0       |
 134
 135
 136 FCC documents
 137 -------------
 138 https://fccid.io/RPKFC660C
 139
 140 - schematic: https://fccid.io/pdf.php?id=1888185
 141 - part list: https://fccid.io/pdf.php?id=1888184
 142
 143
 144 Datasheets
 145 ----------
 146 - Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
 147 - LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
 148 - LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
 149 - LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
 150 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 151
 152
 153 3.3V power supply
 154 -----------------
 155 LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says:
 156
 157 > Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
 158
 159 Digipot AD5258
 160 --------------
 161 Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though.
 162
 163 Lower value of RDAC register causes shallower actuation point.
 164
 165 Resources
 166 ---------
 167 - Pics: https://imgur.com/a/UTR8Z