keyboards/fc980c/README.md

   1
   2
   3 FC980C Alt Controller
   4 =====================
   5
   6 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
   7
   8 ------------
   9
  10 - Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
  11 - Hardware Supported: Hasu's Alt Controller (see below)
  12 - Hardware Availability: https://geekhack.org/index.php?topic=90104.0
  13
  14 Make example for this keyboard (after setting up your build environment):
  15
  16     make fc980c:default
  17
  18 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.
  19
  20 To flash the firmware, press the reset button on the controller and run:
  21
  22     sudo make fc980c:default:dfu
  23
  24 -----------
  25
  26 This controller replaces original controller of Leopold FC980C and makes the keyboard programmable.
  27
  28 Discuss this here: https://geekhack.org/index.php?topic=90681.0
  29
  30 The keyboard is very similar electronically to its sibling model FC660C you can also refer this.
  31
  32 FC660C Alt Controller: https://geekhack.org/index.php?topic=88439.0
  33
  34
  35 Hardware
  36 --------
  37 This project uses common and familiar ATmega32u4 but any microcontroller with 5V I/O will work.
  38
  39 - Schematic of Alt controller: schematic.pdf
  40
  41
  42 Pin configuration
  43 -----------------
  44 Connector bridging between switch board and controller is Hirose DF14A-20P-1.25H.
  45
  46     |Switch  |Controller |
  47     |  board |     board |Description                           |Function   |ATmega32u4
  48     |--------|-----------|--------------------------------------|-----------|------------
  49     | 1      |20         | FG                                   |FG         |GND
  50     | 2      |19         | GND                                  |GND        |GND
  51     | 3      |18         | GND                                  |GND        |GND
  52     | 4      |17         | 3.3V                                 |V33        |3.3V/5V
  53     | 5      |16         | 5V                                   |Vcc        |5V
  54     | 6      |15         |*Z6-TP1684-4-HYS(o)                   |KEY_HYS    |PC7
  55     | 7      |14         |*Z6-TP1684-2-KEY(i)                   |KEY_STATE  |PC6
  56     | 8      |13         |*Z7-AD5258-5-SCL(I2C)                 |I2C_SCL    |PD0(TWI)
  57     | 9      |12         |*Z7-AD5258-4-SDA(I2C)                 |I2C_SDA    |PD1(TWI)
  58     |10      |11         |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4)      |COL_bit3   |PB3
  59     |11      |10         |+Z3-LV07A-5 (LV4051A-9-C)             |COL_bit2   |PB2
  60     |12      | 9         |+Z3-LV07A-1 (LV4051A-10-B)            |COL_bit1   |PB1
  61     |13      | 8         |+Z3-LV07A-3 (LV4051A-11-A)            |COL_bit0   |PB0
  62     |14      | 7         |+Z1-LVC138A-3-C                       |ROW_bit2   |PD6
  63     |15      | 6         |+Z1-LVC138A-2-B                       |ROW_bit1   |PD5
  64     |16      | 5         |+Z1-LVC138A-1-A                       |ROW_bit0   |PD4
  65     |17      | 4         |+Z1-LVC138A-4-~G2A  Z6-TP1684-5-~EN   |KEY_ENABLE |PD7
  66     |18      | 3         |+Q4-NPN-B-NumLock_LED(Hi:On)          |LED_NUML   |PB4
  67     |19      | 2         |+Q3-NPN-B-CapsLock_LED(Hi:On)         |LED_CAPS   |PB5
  68     |20      | 1         |+Q2-NPN-B-ScrollLock_LED(Hi:On)       |LED_SCRL   |PB6
  69
  70 ```
  71 * 5V intferface
  72 + 3.3V interface
  73 ```
  74
  75
  76 Switch matrix
  77 -------------
  78
  79     |    |0   |1   |2   |3   |4   |5   |6   |7   |8   |9   |A   |B   |C   |D   |E   |F   |
  80     |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
  81     |   0|Left|RCtl|RAlt|    |Down|P.  |Righ|P0  |X   |LGui|`   |V   |    |Esc |M   |Spc |
  82     |   1|Fn  |.   |    |    |P1  |PEnt|P2  |P3  |Z   |LAlt|LCtl|C   |K   |    |N   |B   |
  83     |   2|'   |/   |,   |    |P4  |P+  |P5  |P6  |D   |A   |LSft|F   |J   |F1  |H   |G   |
  84     |   3|RSft|;   |L   |]   |Up  |    |    |    |S   |Q   |Caps|R   |I   |F3  |U   |T   |
  85     |   4|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  86     |   5|=   |-   |0   |\   |NLck|BSpc|P/  |P*  |3   |2   |    |4   |9   |F2  |7   |6   |
  87     |   6|[   |P   |O   |Ent |P7  |P-  |P8  |P9  |W   |1   |Tab |E   |8   |F4  |Y   |5   |
  88     |   7|F11 |F10 |F9  |F12 |Del |PgDn|Ins |PgUp|    |    |    |    |F8  |F5  |F7  |F6  |
  89
  90
  91 Row designation
  92 ---------------
  93 LV138A(Z1) selects one of 8 row lines and gives strobe by enabling with ~G2A(17).
  94
  95     |ROW |bit0|bit1|bit2|
  96     |----|----|----|----|
  97     |0   |0   |0   |0   |
  98     |1   |1   |0   |0   |
  99     |2   |0   |1   |0   |
 100     |3   |1   |1   |0   |
 101     |4   |0   |0   |1   |
 102     |5   |1   |0   |1   |
 103     |6   |0   |1   |1   |
 104     |7   |1   |1   |1   |
 105
 106
 107 Column designation
 108 ------------------
 109 LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
 110
 111     |COL |bit0|bit1|bit2|bit3|
 112     |----|----|----|----|----|
 113     |0   |0   |0   |0   |0   |
 114     |1   |1   |0   |0   |0   |
 115     |2   |0   |1   |0   |0   |
 116     |3   |1   |1   |0   |0   |
 117     |4   |0   |0   |1   |0   |
 118     |5   |1   |0   |1   |0   |
 119     |6   |0   |1   |1   |0   |
 120     |7   |1   |1   |1   |0   |
 121     |8   |0   |0   |0   |1   |
 122     |9   |1   |0   |0   |1   |
 123     |A   |0   |1   |0   |1   |
 124     |B   |1   |1   |0   |1   |
 125     |C   |0   |0   |1   |1   |
 126     |D   |1   |0   |1   |1   |
 127     |E   |0   |1   |1   |1   |
 128     |F   |1   |1   |1   |1   |
 129
 130
 131 Firmware
 132 --------
 133 Just `make` to build firmware. And consult with wiki for further information.
 134
 135 - https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc660c
 136 - https://github.com/tmk/tmk_keyboard/wiki
 137
 138
 139 Datasheets
 140 ----------
 141 - Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
 142 - LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
 143 - LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
 144 - LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
 145 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 146 - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf
 147 - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/
 148 - TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/tyu/TU1252series.pdf
 149 - Tr(E42) for LED?: http://cj-elec.com/txUpfile/2013614923661845.pdf
 150
 151
 152 3.3V power supply
 153 -----------------
 154 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:
 155
 156 > Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
 157
 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
 166 USB connector board
 167 -------------------
 168 The keyboard has USB receptacle on small separate 1.0mm-thick PCB. USB receptacle is Hirose UX60SC-MB-5S8 while wire-to-PCB connector is TYU TU1252WNR-05S.
 169
 170 http://i.imgur.com/Nucn6h9.jpg
 171
 172
 173 Resources
 174 ---------
 175 - Pics: http://imgur.com/a/HhyIq