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/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) 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 Pinouts
  29 -------
  30
  31     |Switch  |Controller |
  32     |  board |     board |Description                           |Schematic  |ATmega32u4
  33     |--------|-----------|--------------------------------------|-----------|------------
  34     | 1      |20         | FG                                   |FG         |GND
  35     | 2      |19         | GND                                  |GND        |GND
  36     | 3      |18         | GND                                  |GND        |GND
  37     | 4      |17         | 3.3V                                 |V33        |3.3V/5V
  38     | 5      |16         | 5V                                   |Vcc        |5V
  39     | 6      |15         |*Z6-TP1684-4-HYS(o)                   |FBSTB      |PC7
  40     | 7      |14         |*Z6-TP1684-2-KEY(i)                   |OUT        |PC6
  41     | 8      |13         |*Z2-AD5258-5-SCL(I2C)                 |SCL        |PD0(TWI)
  42     | 9      |12         |*Z2-AD5258-4-SDA(I2C)                 |SDA        |PD1(TWI)
  43     |10      |11         |*Z4-LV4051A-6-~EN(Col 0-7)            |INH_1      |PB4
  44     |11      |10         |*Z5-LV4051A-6-~EN(Col 8-F)            |INH_2      |PB3
  45     |12      | 9         |+Z7-LV07A-5 (LV4051A-9-C)             |SEL_C      |PB2
  46     |13      | 8         |+Z7-LV07A-1 (LV4051A-10-B)            |SEL_B      |PB1
  47     |14      | 7         |+Z7-LV07A-3 (LV4051A-11-A)            |SEL_A      |PB0
  48     |15      | 6         |+Z3-LVC138A-3-C                       |COL4       |PD6
  49     |16      | 5         |+Z3-LVC138A-2-B                       |COL3       |PD5
  50     |17      | 4         |+Z3-LVC138A-1-A                       |COL2       |PD4
  51     |18      | 3         |+Z3-LVC138A-4-~G2A  Z6-TP1684-5-~EN   |COL1       |PD7
  52     |19      | 2         |+Z7-LV07A-11-~InsertLED               |LED1       |PB5
  53     |20      | 1         |+Z7-LV07A-13-~CapsLED                 |LED2       |PB6
  54
  55 ```
  56 * 5V intferface
  57 + 3.3V interface
  58 ```
  59
  60 - Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg
  61 - Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg
  62
  63
  64 Key Matrix
  65 ----------
  66 Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason.
  67
  68     |    |0   |1   |2   |3   |4   |5   |6   |7   |8   |9   |A   |B   |C   |D   |E   |F   |
  69     |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
  70     |   0|Q   |W   |E   |Tab |R   |U   |T   |Y   |O   |P   |[   |I   |]   |    |\   |Del |
  71     |   1|1   |2   |3   |Esc |4   |7   |5   |6   |9   |0   |-   |8   |=   |    |BSpc|Ins |
  72     |   2|    |LWin|LAlt|LCtl|    |    |    |Spc |RAlt|    |RCtl|    |Fn  |Down|Left|Rght|
  73     |   3|    |Z   |X   |LSft|C   |N   |V   |B   |,   |.   |/   |M   |RSft|Up  |    |    |
  74     |   4|A   |S   |D   |Caps|F   |J   |G   |H   |L   |;   |'   |K   |    |    |Entr|    |
  75     |   5|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  76     |   6|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  77     |   7|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  78
  79 Logic analyzer pics:
  80 - http://i.imgur.com/9XoNTev.png
  81 - https://i.imgur.com/5FCP1Ay.png
  82
  83 This code emuluates what original cotnroller does for matrix scan.
  84 - https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c
  85
  86
  87 ### Row designation
  88 LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18).
  89
  90     |Row |A/17|B/16|C/15|
  91     |----|----|----|----|
  92     |0   |0   |0   |0   |
  93     |1   |1   |0   |0   |
  94     |2   |0   |1   |0   |
  95     |3   |1   |1   |0   |
  96     |4   |0   |0   |1   |
  97     |5   |1   |0   |1   |
  98     |6   |0   |1   |1   |
  99     |7   |1   |1   |1   |
 100
 101
 102 ### Column designation
 103 LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
 104
 105     |Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11|
 106     |----|----|----|----|--------|--------|
 107     |0   |0   |0   |0   |0       |1       |
 108     |1   |1   |0   |0   |0       |1       |
 109     |2   |0   |1   |0   |0       |1       |
 110     |3   |1   |1   |0   |0       |1       |
 111     |4   |0   |0   |1   |0       |1       |
 112     |5   |1   |0   |1   |0       |1       |
 113     |6   |0   |1   |1   |0       |1       |
 114     |7   |1   |1   |1   |0       |1       |
 115     |8   |0   |0   |0   |1       |0       |
 116     |9   |1   |0   |0   |1       |0       |
 117     |A   |0   |1   |0   |1       |0       |
 118     |B   |1   |1   |0   |1       |0       |
 119     |C   |0   |0   |1   |1       |0       |
 120     |D   |1   |0   |1   |1       |0       |
 121     |E   |0   |1   |1   |1       |0       |
 122     |F   |1   |1   |1   |1       |0       |
 123
 124
 125 FCC documents
 126 -------------
 127 https://fccid.io/RPKFC660C
 128
 129 - schematic: https://fccid.io/pdf.php?id=1888185
 130 - part list: https://fccid.io/pdf.php?id=1888184
 131
 132
 133 Datasheets
 134 ----------
 135 - Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
 136 - LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
 137 - LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
 138 - LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
 139 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 140
 141
 142 3.3V power supply
 143 -----------------
 144 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:
 145
 146 > Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
 147
 148 Digipot AD5258
 149 --------------
 150 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.
 151
 152 Lower value of RDAC register causes shallower actuation point.
 153
 154 Resources
 155 ---------
 156 - Pics: https://imgur.com/a/UTR8Z