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/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) 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 Actuation Point adjustment
  36 --------------------------
  37 You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`.
  38 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.
  39 Be careful with this setting and use small values (+/-5).
  40 See the `actuation-point-example` keymap for an example.
  41 For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c).
  42 Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards.
  43
  44
  45 Hardware
  46 --------
  47 This project uses common and familiar ATmega32u4 but any microcontroller with 5V I/O will work.
  48
  49 - Schematic of Alt controller: schematic.pdf
  50
  51
  52 Pin configuration
  53 -----------------
  54 Connector bridging between switch board and controller is Hirose DF14A-20P-1.25H.
  55
  56     |Switch  |Controller |
  57     |  board |     board |Description                           |Function   |ATmega32u4
  58     |--------|-----------|--------------------------------------|-----------|------------
  59     | 1      |20         | FG                                   |FG         |GND
  60     | 2      |19         | GND                                  |GND        |GND
  61     | 3      |18         | GND                                  |GND        |GND
  62     | 4      |17         | 3.3V                                 |V33        |3.3V/5V
  63     | 5      |16         | 5V                                   |Vcc        |5V
  64     | 6      |15         |*Z6-TP1684-4-HYS(o)                   |KEY_HYS    |PC7
  65     | 7      |14         |*Z6-TP1684-2-KEY(i)                   |KEY_STATE  |PC6
  66     | 8      |13         |*Z7-AD5258-5-SCL(I2C)                 |I2C_SCL    |PD0(TWI)
  67     | 9      |12         |*Z7-AD5258-4-SDA(I2C)                 |I2C_SDA    |PD1(TWI)
  68     |10      |11         |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4)      |COL_bit3   |PB3
  69     |11      |10         |+Z3-LV07A-5 (LV4051A-9-C)             |COL_bit2   |PB2
  70     |12      | 9         |+Z3-LV07A-1 (LV4051A-10-B)            |COL_bit1   |PB1
  71     |13      | 8         |+Z3-LV07A-3 (LV4051A-11-A)            |COL_bit0   |PB0
  72     |14      | 7         |+Z1-LVC138A-3-C                       |ROW_bit2   |PD6
  73     |15      | 6         |+Z1-LVC138A-2-B                       |ROW_bit1   |PD5
  74     |16      | 5         |+Z1-LVC138A-1-A                       |ROW_bit0   |PD4
  75     |17      | 4         |+Z1-LVC138A-4-~G2A  Z6-TP1684-5-~EN   |KEY_ENABLE |PD7
  76     |18      | 3         |+Q4-NPN-B-NumLock_LED(Hi:On)          |LED_NUML   |PB4
  77     |19      | 2         |+Q3-NPN-B-CapsLock_LED(Hi:On)         |LED_CAPS   |PB5
  78     |20      | 1         |+Q2-NPN-B-ScrollLock_LED(Hi:On)       |LED_SCRL   |PB6
  79
  80 ```
  81 * 5V intferface
  82 + 3.3V interface
  83 ```
  84
  85
  86 Switch matrix
  87 -------------
  88
  89     |    |0   |1   |2   |3   |4   |5   |6   |7   |8   |9   |A   |B   |C   |D   |E   |F   |
  90     |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
  91     |   0|Left|RCtl|RAlt|    |Down|P.  |Righ|P0  |X   |LGui|`   |V   |    |Esc |M   |Spc |
  92     |   1|Fn  |.   |    |    |P1  |PEnt|P2  |P3  |Z   |LAlt|LCtl|C   |K   |    |N   |B   |
  93     |   2|'   |/   |,   |    |P4  |P+  |P5  |P6  |D   |A   |LSft|F   |J   |F1  |H   |G   |
  94     |   3|RSft|;   |L   |]   |Up  |    |    |    |S   |Q   |Caps|R   |I   |F3  |U   |T   |
  95     |   4|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  96     |   5|=   |-   |0   |\   |NLck|BSpc|P/  |P*  |3   |2   |    |4   |9   |F2  |7   |6   |
  97     |   6|[   |P   |O   |Ent |P7  |P-  |P8  |P9  |W   |1   |Tab |E   |8   |F4  |Y   |5   |
  98     |   7|F11 |F10 |F9  |F12 |Del |PgDn|Ins |PgUp|    |    |    |    |F8  |F5  |F7  |F6  |
  99
 100
 101 Row designation
 102 ---------------
 103 LV138A(Z1) selects one of 8 row lines and gives strobe by enabling with ~G2A(17).
 104
 105     |ROW |bit0|bit1|bit2|
 106     |----|----|----|----|
 107     |0   |0   |0   |0   |
 108     |1   |1   |0   |0   |
 109     |2   |0   |1   |0   |
 110     |3   |1   |1   |0   |
 111     |4   |0   |0   |1   |
 112     |5   |1   |0   |1   |
 113     |6   |0   |1   |1   |
 114     |7   |1   |1   |1   |
 115
 116
 117 Column designation
 118 ------------------
 119 LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
 120
 121     |COL |bit0|bit1|bit2|bit3|
 122     |----|----|----|----|----|
 123     |0   |0   |0   |0   |0   |
 124     |1   |1   |0   |0   |0   |
 125     |2   |0   |1   |0   |0   |
 126     |3   |1   |1   |0   |0   |
 127     |4   |0   |0   |1   |0   |
 128     |5   |1   |0   |1   |0   |
 129     |6   |0   |1   |1   |0   |
 130     |7   |1   |1   |1   |0   |
 131     |8   |0   |0   |0   |1   |
 132     |9   |1   |0   |0   |1   |
 133     |A   |0   |1   |0   |1   |
 134     |B   |1   |1   |0   |1   |
 135     |C   |0   |0   |1   |1   |
 136     |D   |1   |0   |1   |1   |
 137     |E   |0   |1   |1   |1   |
 138     |F   |1   |1   |1   |1   |
 139
 140
 141 Firmware
 142 --------
 143 Just `make` to build firmware. And consult with wiki for further information.
 144
 145 - https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc660c
 146 - https://github.com/tmk/tmk_keyboard/wiki
 147
 148
 149 Datasheets
 150 ----------
 151 - Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
 152 - LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
 153 - LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
 154 - LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
 155 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 156 - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf
 157 - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/
 158 - Tr(E42) for LED?: http://www.bklighting.com/cimages/specs-758.pdf
 159 - TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf
 160
 161
 162 3.3V power supply
 163 -----------------
 164 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:
 165
 166 > Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
 167
 168
 169 Digipot AD5258
 170 --------------
 171 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.
 172
 173 Lower value of RDAC register causes shallower actuation point.
 174
 175
 176 USB connector board
 177 -------------------
 178 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.
 179
 180 http://i.imgur.com/Nucn6h9.jpg
 181
 182
 183 Resources
 184 ---------
 185 - Pics: http://imgur.com/a/HhyIq