FAQ.md

   1 # Documents You Need To Read\r
   2 Read these yet?\r
   3  \r
   4 1. First **README** under top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md\r
   5 2. For **Build**: https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md\r
   6 3. And **README** under each project(keyboard/converter) directory\r
   7 \r
   8 Note that you should read two **README**.\r
   9 \r
  10 \r
  11 # Build\r
  12 ## How to Build\r
  13 See this first!\r
  14 https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md\r
  15 \r
  16 In short,\r
  17 \r
  18     $ make clean\r
  19     $ make [KEYMAP=...]\r
  20 \r
  21 \r
  22 ## Do 'make clean' before 'make'\r
  23 You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.\r
  24 \r
  25 Frist remove all files made in previous build,\r
  26 \r
  27     $ make clean\r
  28 \r
  29 then build new frimware. \r
  30 \r
  31     $ make [KEYMAP=...]\r
  32 \r
  33 Also you can always try `make clean` when you get other strange result during build.\r
  34 \r
  35 \r
  36 ## WINAVR is obsolete\r
  37 It is no longer recommended and may cause some problem.\r
  38 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).\r
  39 \r
  40 ## USB stack: LUFA or PJRC?\r
  41 Use **LUFA**.\r
  42 \r
  43 **PJRC** stack won't be supported actively anymore. There is no reason to hesitate to use LUFA except for binary size(about 1KB lager?). But **PJRC** is still very useful for debug and development purpose.\r
  44 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).\r
  45 \r
  46 \r
  47 ## Edit configuration but not change\r
  48 Try these.\r
  49 ### 1. make clean\r
  50 This will be needed when you edit **config.h**.\r
  51 \r
  52 ### 2. Remove Drivers from Device Manager(Windows)\r
  53 Windows only. Linux, OSX and other OS's doesn't require this. It looks like Windows keeps using driver installed when device was connected first time even after the device changes its configuration. To load proper drivers for new configuration you need to remove existent drivers from **Drvice Manager**.\r
  54 \r
  55 You will need this after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.\r
  56 \r
  57 \r
  58 # Keymap\r
  59 ## Power key doesn't work\r
  60 Use `KC_PWR` instead of `KC_POWER` or vice versa.\r
  61 - `KC_PWR` works with Windows and Linux, not with OSX.\r
  62 - `KC_POWER` works with OSX and Linux, not with Windows.\r
  63 \r
  64 http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264\r
  65 \r
  66 ## Oneshot modifier\r
  67 Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'.  Oneshot Shift mitgates this for me.\r
  68 https://github.com/tmk/tmk_keyboard/issues/67\r
  69 \r
  70 ## Modifier/Layer stuck\r
  71 Modifier keys or layers can be stuck unless layer switching is configured properly.\r
  72 For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to  unregister the modifier key or return to previous layer on release event.\r
  73 \r
  74 https://github.com/tmk/tmk_keyboard/blob/master/doc/keymap.md#31-momentary-switching\r
  75 http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604\r
  76 \r
  77 \r
  78 ## Mechanical Lock Switch Support\r
  79 https://github.com/tmk/tmk_keyboard#mechanical-locking-support\r
  80 \r
  81 This feature is for *mechanical lock switch* like this Alps one.\r
  82 http://deskthority.net/wiki/Alps_SKCL_Lock\r
  83 \r
  84 Using enabling this feature and using keycodes `LCAP`, `LNUM` or `LSCR` in keymap you can use physical locking CapsLock, NumLock or ScrollLock keys as you expected.\r
  85 \r
  86 Old vintage mechanical keyboards occasionally have lock switches but modern ones don't have. ***You don't need this feature in most case and just use keycodes `CAPS`, `NLCK` and `SLCK`.***\r
  87 \r
  88 \r
  89 \r
  90 # Degug Console\r
  91 ## hid_listen can't recognize device\r
  92 When debug console of your device is not ready you will see like this:\r
  93 \r
  94     Waiting for device:.........\r
  95 \r
  96 once the device is pluged in then *hid_listen* finds it you will get this message:\r
  97 \r
  98     Waiting for new device:.........................\r
  99     Listening:\r
 100 \r
 101 Check if you can't get this 'Listening:' message:\r
 102 - build with `CONSOLE_ENABLE=yes` in **Makefile**.\r
 103 \r
 104 ## Can't get message on console\r
 105 Check:\r
 106 - *hid_listen* finds your device. See above.\r
 107 - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).\r
 108 - set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.\r
 109 - try using 'print' function instead of debug print. See **common/print.h**.\r
 110 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).\r
 111 \r
 112 ## Linux or UNIX like system requires Super User privilege\r
 113 Just use 'sudo' to execute *hid_listen* with privilege.\r
 114 ```\r
 115 $ sudo hid_listen\r
 116 ```\r
 117 \r
 118 Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.\r
 119 \r
 120 File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)\r
 121 ```\r
 122 # tmk keyboard products     https://github.com/tmk/tmk_keyboard\r
 123 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"\r
 124 ```\r
 125 \r
 126 ***\r
 127 \r
 128 # Miscellaneous\r
 129 ## NKRO Doesn't work\r
 130 1. Build with this option of Makefile\r
 131 \r
 132     NKRO_ENABLE = yes\r
 133 \r
 134 2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO.\r
 135 \r
 136 3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default)\r
 137 \r
 138 \r
 139 \r
 140 ## TrackPoint needs reset circuit(PS/2 mouse support)\r
 141 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.\r
 142 \r
 143 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447\r
 144 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf\r
 145 \r
 146 \r
 147 ## Can't read comlumn of matrix beyond 16 \r
 148 Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.\r
 149 \r
 150 In C `1` means one of **int** type which is **16bit** in case of AVR so you can't shift left more than 15. You will get unexpected zero when you say `1<<16`. You have to use **unsigned long** type with `1UL`.\r
 151 \r
 152 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279\r
 153 \r
 154 \r
 155 \r
 156 ## Pull-up Resistor\r
 157 In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.\r
 158 \r
 159 For example:\r
 160 ```\r
 161 Keyboard       Conveter\r
 162                ,------.\r
 163 5V------+------|VCC   |\r
 164         |      |      |\r
 165         R      |      |\r
 166         |      |      |\r
 167 Signal--+------|PD0   |\r
 168                |      |\r
 169 GND------------|GND   |\r
 170                `------'\r
 171 R: 1K Ohm resistor\r
 172 ```\r
 173 \r
 174 https://github.com/tmk/tmk_keyboard/issues/71\r
 175 \r
 176 \r
 177 ## Arduino Micro's pin naming is confusing\r
 178 Note that Arduino Micro PCB marking is different from real AVR port name. D0 of Arduino Micro is not PD0, PD0 is D3. Check schematic yourself.\r
 179 http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf\r
 180 \r
 181 \r
 182 \r
 183 ## Bootloader jump doesn't work\r
 184 Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.\r
 185 - https://github.com/tmk/tmk_keyboard#magic-commands\r
 186 - https://github.com/tmk/tmk_keyboard#bootloader\r
 187 \r
 188 ```\r
 189 # Boot Section Size in *bytes*\r
 190 #   Teensy halfKay   512\r
 191 #   Teensy++ halfKay 1024\r
 192 #   Atmel DFU loader 4096       (TMK Alt Controller)\r
 193 #   LUFA bootloader  4096\r
 194 #   USBaspLoader     2048\r
 195 OPT_DEFS += -DBOOTLOADER_SIZE=4096\r
 196 ```\r
 197 http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018\r
 198 \r
 199 \r
 200 ## Special Extra key doesn't work(System, Audio control keys)\r
 201 You need to define `EXTRAKEY_ENABLE` in **makefile** to use them in TMK.\r
 202 ```\r
 203 EXTRAKEY_ENABLE = yes          # Audio control and System control\r
 204 ```\r
 205 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-60.html#p157919\r
 206 \r
 207 \r
 208 ## Wakeup from sleep doesn't work\r
 209 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.\r
 210 \r
 211 Pressing any key during sleep should wake host.\r
 212 \r
 213 \r
 214 ## Using Arduino?\r
 215 **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.\r
 216 \r
 217 - http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf\r
 218 - http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf\r
 219 \r
 220 Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.\r
 221 \r
 222 \r
 223 ## Using PF4-7 pins of USB AVR?\r
 224 You need to set JTD bit of MCUCR yourself to use PF4-7 as GPIO. Those pins are configured to serve JTAG function by default. MCUs like ATMega*U* or AT90USB* are affeteced with this.\r
 225 \r
 226 If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.\r
 227 \r
 228 See this code.\r
 229 ```\r
 230     // JTAG disable for PORT F. write JTD bit twice within four cycles.\r
 231     MCUCR |= (1<<JTD);\r
 232     MCUCR |= (1<<JTD);\r
 233 ```\r
 234 https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67\r
 235 \r
 236 And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.\r
 237 \r
 238 \r
 239 ## Adding LED indicators of Lock keys\r
 240 You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.\r
 241 \r
 242 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560