FAQ.md

   1 # Build
   2 ## 'make clean' needs after changing config.h
   3 To build with new **config.h** you need
   4
   5     $ make clean
   6
   7 ## WINAVR is obsolete
   8 It is no longer recommended and may cause some problem.
   9 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  10
  11 ## USB stack: LUFA or PJRC?
  12 Use **LUFA**.
  13
  14 **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.
  15 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
  16
  17
  18 ## Edit configuration but not change
  19 Try these.
  20 ### 1. make clean
  21 This will be needed when you edit **config.h**.
  22
  23 ### 2. Remove Drivers from Device Manager(Windows)
  24 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**.
  25
  26 You will need this after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
  27
  28
  29 # Keymap
  30 ## Power key doesn't work
  31 Use `KC_PWR` instead of 'KC_POWER` or vice versa.
  32 - `KC_PWR` works with Windows and Linux, not with OSX.
  33 - `KC_POWER` works with OSX and Linux, not with Windows.
  34
  35 http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
  36
  37
  38
  39 # Degug Console
  40 ## hid_listen can't find device
  41 When debug console of your device is not ready you will see like this:
  42
  43     Waiting for device:.........
  44
  45 once the device is pluged in then *hid_listen* finds it you will get this message:
  46
  47     Waiting for new device:.........................
  48     Listening:
  49
  50 Check if you can't get this 'Listening:' message:
  51 - build with `CONSOLE_ENABLE=yes` in **Makefile**.
  52
  53 ## Can't get message from console
  54 Check:
  55 - connect the device to *hid_listen*. See above.
  56 - push **LShift+RShift+d** to enable debug. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
  57 - set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.
  58 - try using 'print' function instead of debug print. See **common/print.h**.
  59 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
  60
  61 ***
  62
  63 # Miscellaneous
  64 ## NKRO Doesn't work
  65 1. Build with this option of Makefile
  66
  67     NKRO_ENABLE = yes
  68
  69 2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO.
  70
  71 3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default)
  72
  73
  74
  75 ## TrackPoint needs reset circuit(PS/2 mouse support)
  76 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
  77
  78 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
  79 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
  80
  81
  82 ## Can't read comlumn of matrix beyond 16
  83 Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.
  84
  85 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`.
  86
  87 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
  88
  89
  90
  91 ## Pull-up Resistor
  92 In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.
  93
  94 ```
  95 Keyboard       Conveter
  96                ,------.
  97 5V------+------|VCC   |
  98         |      |      |
  99         R      |      |
 100         |      |      |
 101 Signal--+------|PD0   |
 102                |      |
 103 GND------------|GND   |
 104                `------'
 105 R: 1K Ohm resistor
 106 ```
 107
 108
 109 ## Arduino Micro's pin naming is confusing
 110 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.
 111 http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
 112
 113
 114
 115 ## Bootloader jump doesn't work
 116 Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
 117 - https://github.com/tmk/tmk_keyboard#magic-commands
 118 - https://github.com/tmk/tmk_keyboard#bootloader
 119
 120 ```
 121 # Boot Section Size in *bytes*
 122 #   Teensy halfKay   512
 123 #   Teensy++ halfKay 1024
 124 #   Atmel DFU loader 4096       (TMK Alt Controller)
 125 #   LUFA bootloader  4096
 126 #   USBaspLoader     2048
 127 OPT_DEFS += -DBOOTLOADER_SIZE=4096
 128 ```
 129 http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018
 130
 131
 132 ## Special Extra key doesn't work(System, Audio control keys)
 133 You need to define `EXTRAKEY_ENABLE` in **makefile** to use them in TMK.
 134 ```
 135 EXTRAKEY_ENABLE = yes          # Audio control and System control
 136 ```
 137 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-60.html#p157919
 138
 139
 140 ## Wakeup from sleep doesn't work
 141 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
 142
 143 Pressing any key during sleep should wake host.