keyboard/fc980c/README.md

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