FAQ.md

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