aboutsummaryrefslogtreecommitdiff
path: root/docs/faq.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/faq.md')
-rw-r--r--docs/faq.md70
1 files changed, 22 insertions, 48 deletions
diff --git a/docs/faq.md b/docs/faq.md
index 0636d8b54..c46861030 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,31 +1,33 @@
1## READ FIRST 1# Frequently Asked Questions
2- **README** of top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md
3- **README** of target project(keyboard/converter) directory.
4 2
5Note that you'll need to read **both**. 3## What is QMK?
6 4
5[QMK](https://github.com/qmk), short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the [QMK firmware](https://github.com/qmk/qmk_firmware), a heavily modified fork of [TMK](https://github.com/tmk/tmk_keyboard).
7 6
8# Build 7## What Differences Are There Between QMK and TMK?
9- [[FAQ/Build]]
10 8
9TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert's](https://github.com/jackhumbert) fork of TMK for the Planck. After a while Jack's fork had diverged quite a bit from TMK, and in 2015 Jack decided to rename his fork to QMK.
11 10
12# Keymap 11From a technical standpoint QMK builds upon TMK by adding several new features. Most notably QMK has expanded the number of available keycodes and uses these to implement advanced features like `S()`, `LCTL()`, and `MO()`. You can see a complete list of these keycodes in [Quantum Keycodes](quantum_keycodes.html).
13- [[FAQ/Keymap]]
14 12
13From a project and community management standpoint TMK prefers to have keyboards maintained in separate forks while QMK prefers to have keyboards maintained in one central repository.
15 14
16# Debug Console 15# Debug Console
17## hid_listen can't recognize device 16## hid_listen can't recognize device
18When debug console of your device is not ready you will see like this: 17When debug console of your device is not ready you will see like this:
19 18
20 Waiting for device:......... 19```
20Waiting for device:.........
21```
21 22
22once the device is pluged in then *hid_listen* finds it you will get this message: 23once the device is pluged in then *hid_listen* finds it you will get this message:
23 24
24 Waiting for new device:......................... 25```
25 Listening: 26Waiting for new device:.........................
27Listening:
28```
26 29
27Check if you can't get this 'Listening:' message: 30If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
28- build with `CONSOLE_ENABLE=yes` in **Makefile**.
29 31
30You may need privilege to access the device on OS like Linux. 32You may need privilege to access the device on OS like Linux.
31- try `sudo hid_listen` 33- try `sudo hid_listen`
@@ -73,41 +75,13 @@ Without reset circuit you will have inconsistent reuslt due to improper initiali
73 75
74 76
75## Can't read column of matrix beyond 16 77## Can't read column of matrix beyond 16
76Use `1UL<<16` instead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16. 78Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
77 79
78In 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`. 80In 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`.
79 81
80http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 82http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
81 83
82 84
83
84## Pull-up Resistor
85In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.
86
87For example:
88```
89Keyboard Conveter
90 ,------.
915V------+------|VCC |
92 | | |
93 R | |
94 | | |
95Signal--+------|PD0 |
96 | |
97GND------------|GND |
98 `------'
99R: 1K Ohm resistor
100```
101
102https://github.com/tmk/tmk_keyboard/issues/71
103
104
105## Arduino Micro's pin naming is confusing
106Note 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.
107http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
108
109
110
111## Bootloader jump doesn't work 85## Bootloader jump doesn't work
112Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**. 86Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
113``` 87```
@@ -157,20 +131,20 @@ https://github.com/tmk/tmk_keyboard/issues/179
157 131
158 132
159## Special Extra key doesn't work(System, Audio control keys) 133## Special Extra key doesn't work(System, Audio control keys)
160You need to define `EXTRAKEY_ENABLE` in **makefile** to use them in TMK. 134You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
135
161``` 136```
162EXTRAKEY_ENABLE = yes # Audio control and System control 137EXTRAKEY_ENABLE = yes # Audio control and System control
163``` 138```
164http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-60.html#p157919
165
166 139
167## Wakeup from sleep doesn't work 140## Wakeup from sleep doesn't work
141
168In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting. 142In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
169 143
170Pressing any key during sleep should wake host. 144Pressing any key during sleep should wake host.
171 145
172
173## Using Arduino? 146## Using Arduino?
147
174**Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself. 148**Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
175 149
176- http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf 150- http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
@@ -235,4 +209,4 @@ https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
235## FLIP doesn't work 209## FLIP doesn't work
236### AtLibUsbDfu.dll not found 210### AtLibUsbDfu.dll not found
237Remove current driver and reinstall one FLIP provides from DeviceManager. 211Remove current driver and reinstall one FLIP provides from DeviceManager.
238http://imgur.com/a/bnwzy \ No newline at end of file 212http://imgur.com/a/bnwzy