diff options
Diffstat (limited to 'docs/faq.md')
| -rw-r--r-- | docs/faq.md | 110 |
1 files changed, 56 insertions, 54 deletions
diff --git a/docs/faq.md b/docs/faq.md index d7f2a6f4fd..3287578ac7 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,10 +1,16 @@ # Frequently Asked Questions -## What is QMK? +## General + +### What is QMK? [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). -## What Differences Are There Between QMK and TMK? +### Why the name Quantum? + +<!-- FIXME --> + +### What Differences Are There Between QMK and TMK? TMK 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. @@ -14,8 +20,22 @@ From a project and community management standpoint TMK maintains all the officia Both approaches have their merits and their drawbacks, and code flows freely between TMK and QMK when it makes sense. -# Debug Console -## hid_listen can't recognize device +# Building + +## Windows + +### I'm on Windows Vista, 7, or 8, how do I setup my build environment? + +Follow the build instructions to [install MHV AVR Tools](https://docs.qmk.fm/build_environment_setup.html#windows-vista-and-later). + +### I'm on Windows 10 without the Creators Update. Do I have to install it? + +No, but if you don't install the creators update you will not be able to build and flash with a single command. You will be able to build but to flash you will have to use a separate program, such as [QMK Flasher](https://github.com/qmk/qmk_flasher). + +# Troubleshooting + +## Debug Console +### hid_listen can't recognize device When debug console of your device is not ready you will see like this: ``` @@ -34,7 +54,7 @@ If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes You may need privilege to access the device on OS like Linux. - try `sudo hid_listen` -## Can't get message on console +### Can't get message on console Check: - *hid_listen* finds your device. See above. - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands). @@ -42,7 +62,7 @@ Check: - try using 'print' function instead of debug print. See **common/print.h**. - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). -## Linux or UNIX like system requires Super User privilege +### Linux or UNIX like system requires Super User privilege Just use 'sudo' to execute *hid_listen* with privilege. ``` $ sudo hid_listen @@ -56,10 +76,9 @@ File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu) SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666" ``` -*** +## Software Issues -# Miscellaneous -## NKRO Doesn't work +### NKRO Doesn't work First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**. Try `Magic` **N** command(`LShift+RShift+N` by default) when **NKRO** still doesn't work. You can use this command to toggle between **NKRO** and **6KRO** mode temporarily. In some situations **NKRO** doesn't work you need to switch to **6KRO** mode, in particular when you are in BIOS. @@ -68,15 +87,7 @@ If your firmeare built with `BOOTMAGIC_ENABLE` you need to turn its switch on by https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch - -## TrackPoint needs reset circuit(PS/2 mouse support) -Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754. - -- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 -- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf - - -## Can't read column of matrix beyond 16 +### Can't read column of matrix beyond 16 Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16. 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`. @@ -84,16 +95,16 @@ In C `1` means one of [int] type which is [16bit] in case of AVR so you can't sh http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 -## Bootloader jump doesn't work +### Bootloader jump doesn't work Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**. ``` # Size of Bootloaders in bytes: -# Atmel DFU loader(ATmega32U4) 4096 -# Atmel DFU loader(AT90USB128) 8192 -# LUFA bootloader(ATmega32U4) 4096 -# Arduino Caterina(ATmega32U4) 4096 -# USBaspLoader(ATmega***) 2048 -# Teensy halfKay(ATmega32U4) 512 +# Atmel DFU loader(ATmega32U4) 4096 +# Atmel DFU loader(AT90USB128) 8192 +# LUFA bootloader(ATmega32U4) 4096 +# Arduino Caterina(ATmega32U4) 4096 +# USBaspLoader(ATmega***) 2048 +# Teensy halfKay(ATmega32U4) 512 # Teensy++ halfKay(AT90USB128) 2048 OPT_DEFS += -DBOOTLOADER_SIZE=4096 ``` @@ -107,14 +118,14 @@ byte Atmel/LUFA(ATMega32u4) byte Atmel(AT90SUB1286) | | | | | | | | | Application | | Application | - | | | | + | | | | = = = = | | 32KB-4KB | | 128KB-8KB 0x6000 +---------------+ 0x1E000 +---------------+ | Bootloader | 4KB | Bootloader | 8KB 0x7FFF +---------------+ 0x1FFFF +---------------+ - + byte Teensy(ATMega32u4) byte Teensy++(AT90SUB1286) 0x0000 +---------------+ 0x00000 +---------------+ | | | | @@ -132,20 +143,28 @@ And see this discussion for further reference. https://github.com/tmk/tmk_keyboard/issues/179 -## Special Extra key doesn't work(System, Audio control keys) +### Special Extra key doesn't work(System, Audio control keys) You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK. ``` EXTRAKEY_ENABLE = yes # Audio control and System control ``` -## Wakeup from sleep doesn't work +### Wakeup from sleep doesn't work In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting. Pressing any key during sleep should wake host. -## Using Arduino? +## Hardware Issues + +### TrackPoint needs reset circuit(PS/2 mouse support) +Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754. + +- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 +- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf + +### Using Arduino? **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself. @@ -154,8 +173,7 @@ Pressing any key during sleep should wake host. Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem. - -## Using PF4-7 pins of USB AVR? +### Using PF4-7 pins of USB AVR? You need to set JTD bit of MCUCR yourself to use PF4-7 as GPIO. Those pins are configured to serve JTAG function by default. MCUs like ATMega*U* or AT90USB* are affeteced with this. If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function. @@ -171,12 +189,7 @@ https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67 And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet. -## Adding LED indicators of Lock keys -You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post. - -http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560 - -## Program Arduino Micro/Leonardo +### Program Arduino Micro/Leonardo Push reset button and then run command like this within 8 seconds. ``` @@ -188,27 +201,16 @@ Device name will vary depending on your system. http://arduino.cc/en/Main/ArduinoBoardMicro https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867 - -## USB 3 compatibility -I heard some people have a problem with USB 3 port, try USB 2 port. - - -## Mac compatibility -### OS X 10.11 and Hub -https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 - - -## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles +### Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles Some people reported their keyboard stops working on BIOS and/or after resume(power cycles). -As of now root of its cause is not clear but some build options seem to be related. In Makefile try to disable those options like `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` and/or others. +As of now root of its cause is not clear but some build options seem to be related. In Makefile try to disable those options like `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` and/or others. https://github.com/tmk/tmk_keyboard/issues/266 https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778 +## Flashing Problems +### Can't use dfu-programmer or QMK Flasher to flash on Windows -## FLIP doesn't work -### AtLibUsbDfu.dll not found -Remove current driver and reinstall one FLIP provides from DeviceManager. -http://imgur.com/a/bnwzy +Windows requires a driver to support the keyboard in DFU mode. You can use [QMK Driver Installer](https://github.com/qmk/qmk_driver_installer/releases) to install the necessary drivers. |