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 # Degug Console
  30 ## hid_listen can't find device
  31 When debug console of your device is not ready you will see like this:
  32
  33     Waiting for device:.........
  34
  35 once the device is pluged in then *hid_listen* finds it you will get this message:
  36
  37     Waiting for new device:.........................
  38     Listening:
  39
  40 Check if you can't get this 'Listening:' message:
  41 - build with `CONSOLE_ENABLE=yes` in **Makefile**.
  42
  43 ## Can't get message from console
  44 Check:
  45 - connect the device to *hid_listen*. See above.
  46 - push **LShift+RShift+d** to enable debug. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
  47 - set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.
  48 - try using 'print' function instead of debug print. See **common/print.h**.
  49 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
  50
  51 ***
  52
  53 # Miscellaneous
  54 ## NKRO Doesn't work
  55 Build with this option of Makefile
  56
  57     NKRO_ENABLE = yes
  58
  59 And use `Magic` command **N** to toggle NKRO feature.
  60 At this time NKRO is not used by default even if it is build with `NKRO_ENABLE`, you still need the `Magic`.
  61
  62 To turn on NKRO by default see this fix.
  63 https://github.com/shayneholmes/tmk_keyboard/commit/b8375a0
  64 ```
  65 --- a/common/host.c
  66 +++ b/common/host.c
  67 @@ -24,7 +24,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  68
  69
  70  #ifdef NKRO_ENABLE
  71 -bool keyboard_nkro = false;
  72 +bool keyboard_nkro = true;
  73  #endif
  74
  75  static host_driver_t *driver;
  76 ```
  77
  78 ## TrackPoint needs reset circuit(PS/2 mouse support)
  79 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
  80
  81 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
  82 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
  83
  84
  85 ## Can't read comlumn of matrix beyond 16
  86 Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.
  87
  88 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`.
  89
  90 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
  91
  92
  93
  94 ## Pull-up Resistor
  95 In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.
  96
  97 ```
  98 Keyboard       Conveter
  99                ,------.
 100 5V------+------|VCC   |
 101         |      |      |
 102         R      |      |
 103         |      |      |
 104 Signal--+------|PD0   |
 105                |      |
 106 GND------------|GND   |
 107                `------'
 108 R: 1K Ohm resistor
 109 ```
 110
 111
 112 ## Arduino Micro's Pin naming is confusing
 113 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.
 114 http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf