1 # Documents You Need To Read
4 1. First **README** under top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md
5 2. For **Build**: https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
6 3. And **README** under each project(keyboard/converter) directory
8 Note that you should read two **README**.
14 https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
22 ## Do 'make clean' before 'make'
23 You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
25 Frist remove all files made in previous build,
29 then build new frimware.
33 Also you can always try `make clean` when you get other strange result during build.
37 It is no longer recommended and may cause some problem.
38 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
40 ## USB stack: LUFA or PJRC?
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.
44 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
47 ## Edit configuration but not change
50 This will be needed when you edit **config.h**.
52 ### 2. Remove Drivers from Device Manager(Windows)
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**.
55 You will need this after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
59 ## Power key doesn't work
60 Use `KC_PWR` instead of `KC_POWER` or vice versa.
61 - `KC_PWR` works with Windows and Linux, not with OSX.
62 - `KC_POWER` works with OSX and Linux, not with Windows.
64 http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
69 ## hid_listen can't find device
70 When debug console of your device is not ready you will see like this:
72 Waiting for device:.........
74 once the device is pluged in then *hid_listen* finds it you will get this message:
76 Waiting for new device:.........................
79 Check if you can't get this 'Listening:' message:
80 - build with `CONSOLE_ENABLE=yes` in **Makefile**.
82 ## Can't get message from console
84 - connect the device to *hid_listen*. See above.
85 - push **LShift+RShift+d** to enable debug. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
86 - set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.
87 - try using 'print' function instead of debug print. See **common/print.h**.
88 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
94 1. Build with this option of Makefile
98 2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO.
100 3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default)
104 ## TrackPoint needs reset circuit(PS/2 mouse support)
105 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
107 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
108 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
111 ## Can't read comlumn of matrix beyond 16
112 Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.
114 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`.
116 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
121 In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.
126 5V------+------|VCC |
130 Signal--+------|PD0 |
132 GND------------|GND |
138 ## Arduino Micro's pin naming is confusing
139 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.
140 http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
144 ## Bootloader jump doesn't work
145 Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
146 - https://github.com/tmk/tmk_keyboard#magic-commands
147 - https://github.com/tmk/tmk_keyboard#bootloader
150 # Boot Section Size in *bytes*
152 # Teensy++ halfKay 1024
153 # Atmel DFU loader 4096 (TMK Alt Controller)
154 # LUFA bootloader 4096
156 OPT_DEFS += -DBOOTLOADER_SIZE=4096
158 http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018
161 ## Special Extra key doesn't work(System, Audio control keys)
162 You need to define `EXTRAKEY_ENABLE` in **makefile** to use them in TMK.
164 EXTRAKEY_ENABLE = yes # Audio control and System control
166 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-60.html#p157919
169 ## Wakeup from sleep doesn't work
170 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
172 Pressing any key during sleep should wake host.