-# Documents You Need To Read\r
-Read these yet?\r
- \r
-1. First **README** under top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md\r
-2. For **Build**: https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md\r
-3. And **README** under each project(keyboard/converter) directory\r
+## READ FIRST\r
+- **README** of top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md\r
+- **README** of target project(keyboard/converter) directory.\r
\r
-Note that you should read two **README**.\r
+Note that you'll need to read **both**.\r
\r
\r
# Build\r
-## How to Build\r
-See this first!\r
-https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md\r
-\r
-In short,\r
-\r
- $ make clean\r
- $ make [KEYMAP=...]\r
-\r
-\r
-## Do 'make clean' before 'make'\r
-You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.\r
-\r
-Frist remove all files made in previous build,\r
-\r
- $ make clean\r
-\r
-then build new frimware. \r
-\r
- $ make [KEYMAP=...]\r
-\r
-Also you can always try `make clean` when you get other strange result during build.\r
-\r
-\r
-## WINAVR is obsolete\r
-It is no longer recommended and may cause some problem.\r
-See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).\r
-\r
-## USB stack: LUFA or PJRC?\r
-Use **LUFA**.\r
-\r
-**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.\r
-See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).\r
-\r
-\r
-## Edit configuration but not change\r
-Try these.\r
-### 1. make clean\r
-This will be needed when you edit **config.h**.\r
-\r
-### 2. Remove Drivers from Device Manager(Windows)\r
-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**.\r
-\r
-You will need this after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.\r
+- [[FAQ/Build]]\r
\r
\r
# Keymap\r
-## Power key doesn't work\r
-Use `KC_PWR` instead of `KC_POWER` or vice versa.\r
-- `KC_PWR` works with Windows and Linux, not with OSX.\r
-- `KC_POWER` works with OSX and Linux, not with Windows.\r
+- [[FAQ/Keymap]]\r
\r
-http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264\r
\r
-\r
-\r
-# Degug Console\r
-## hid_listen can't find device\r
+# Debug Console\r
+## hid_listen can't recognize device\r
When debug console of your device is not ready you will see like this:\r
\r
Waiting for device:.........\r
Check if you can't get this 'Listening:' message:\r
- build with `CONSOLE_ENABLE=yes` in **Makefile**.\r
\r
-## Can't get message from console\r
+You may need privilege to access the device on OS like Linux.\r
+- try `sudo hid_listen`\r
+\r
+## Can't get message on console\r
Check:\r
-- connect the device to *hid_listen*. See above.\r
-- push **LShift+RShift+d** to enable debug. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).\r
-- set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.\r
+- *hid_listen* finds your device. See above.\r
+- Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).\r
+- set `debug_enable=true` usually in `matrix_init()` in **matrix.c**.\r
- try using 'print' function instead of debug print. See **common/print.h**.\r
- disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).\r
\r
+## Linux or UNIX like system requires Super User privilege\r
+Just use 'sudo' to execute *hid_listen* with privilege.\r
+```\r
+$ sudo hid_listen\r
+```\r
+\r
+Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.\r
+\r
+File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)\r
+```\r
+# tmk keyboard products https://github.com/tmk/tmk_keyboard\r
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"\r
+```\r
+\r
***\r
\r
# Miscellaneous\r
## NKRO Doesn't work\r
-1. Build with this option of Makefile\r
+First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.\r
\r
- NKRO_ENABLE = yes\r
+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.\r
\r
-2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO.\r
-\r
-3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default)\r
+If your firmeare built with `BOOTMAGIC_ENABLE` you need to turn its switch on by `BootMagic` **N** command(`Space+N` by default). This setting is stored in EEPROM and keeped over power cycles.\r
\r
+https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch\r
\r
\r
## TrackPoint needs reset circuit(PS/2 mouse support)\r
- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf\r
\r
\r
-## Can't read comlumn of matrix beyond 16 \r
-Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.\r
+## Can't read column of matrix beyond 16 \r
+Use `1UL<<16` instead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.\r
\r
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`.\r
\r
\r
\r
## Bootloader jump doesn't work\r
-Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.\r
-- https://github.com/tmk/tmk_keyboard#magic-commands\r
-- https://github.com/tmk/tmk_keyboard#bootloader\r
-\r
+Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.\r
```\r
-# Boot Section Size in *bytes*\r
-# Teensy halfKay 512\r
-# Teensy++ halfKay 1024\r
-# Atmel DFU loader 4096 (TMK Alt Controller)\r
-# LUFA bootloader 4096\r
-# USBaspLoader 2048\r
+# Size of Bootloaders in bytes:\r
+# Atmel DFU loader(ATmega32U4) 4096 \r
+# Atmel DFU loader(AT90USB128) 8192 \r
+# LUFA bootloader(ATmega32U4) 4096 \r
+# Arduino Caterina(ATmega32U4) 4096 \r
+# USBaspLoader(ATmega***) 2048 \r
+# Teensy halfKay(ATmega32U4) 512 \r
+# Teensy++ halfKay(AT90USB128) 2048\r
OPT_DEFS += -DBOOTLOADER_SIZE=4096\r
```\r
-http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018\r
+AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.\r
+Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**.\r
+\r
+AVR Boot section is located at end of Flash memory like the followings.\r
+```\r
+byte Atmel/LUFA(ATMega32u4) byte Atmel(AT90SUB1286)\r
+0x0000 +---------------+ 0x00000 +---------------+\r
+ | | | |\r
+ | | | |\r
+ | Application | | Application |\r
+ | | | | \r
+ = = = =\r
+ | | 32KB-4KB | | 128KB-8KB\r
+0x6000 +---------------+ 0x1E000 +---------------+\r
+ | Bootloader | 4KB | Bootloader | 8KB\r
+0x7FFF +---------------+ 0x1FFFF +---------------+\r
+\r
+ \r
+byte Teensy(ATMega32u4) byte Teensy++(AT90SUB1286)\r
+0x0000 +---------------+ 0x00000 +---------------+\r
+ | | | |\r
+ | | | |\r
+ | Application | | Application |\r
+ | | | |\r
+ = = = =\r
+ | | 32KB-512B | | 128KB-2KB\r
+0x7E00 +---------------+ 0x1FC00 +---------------+\r
+ | Bootloader | 512B | Bootloader | 2KB\r
+0x7FFF +---------------+ 0x1FFFF +---------------+\r
+```\r
+\r
+And see this discussion for further reference.\r
+https://github.com/tmk/tmk_keyboard/issues/179\r
\r
\r
## Special Extra key doesn't work(System, Audio control keys)\r
```\r
https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67\r
\r
-And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
\ No newline at end of file
+And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.\r
+\r
+\r
+## Adding LED indicators of Lock keys\r
+You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.\r
+\r
+http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560\r
+\r
+## Program Arduino Micro/Leonardo\r
+Push reset button and then run command like this within 8 seconds.\r
+\r
+```\r
+avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0\r
+```\r
+\r
+Device name will vary depending on your system.\r
+\r
+http://arduino.cc/en/Main/ArduinoBoardMicro\r
+https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867\r
+\r
+\r
+## USB 3 compatibility\r
+I heard some people have a problem with USB 3 port, try USB 2 port.\r
+\r
+\r
+## Mac compatibility\r
+### OS X 10.11 and Hub\r
+https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034\r
+\r
+\r
+## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles\r
+Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).\r
+\r
+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. \r
+\r
+https://github.com/tmk/tmk_keyboard/issues/266\r
+https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778\r
+\r
+\r
+\r
+## FLIP doesn't work\r
+### AtLibUsbDfu.dll not found\r
+Remove current driver and reinstall one FLIP provides from DeviceManager.\r
+http://imgur.com/a/bnwzy
\ No newline at end of file
projects / qmk_firmware.git / blobdiff