Read these yet?
See this first! https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
In short,
$ make clean
$ make [KEYMAP=...]
You'll need make clean
after you edit config.h or change options like KEYMAP
.
Frist remove all files made in previous build,
$ make clean
then build new frimware.
$ make [KEYMAP=...]
Also you can always try make clean
when you get other strange result during build.
It is no longer recommended and may cause some problem. See Issue #99.
Use LUFA.
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. See also Issue #50 and Issue #58.
Try these.
This will be needed when you edit config.h.
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.
You will need this after editing CONSOLE_ENABLE
, NKRO_ENABLE
, EXTRAKEY_ENABLE
or MOUSEKEY_ENABLE
option in Makefile.
You can use any ID you want with editing config.h
. Using any presumably unused ID will be no problem in fact except for very least chance of collision with other product.
For example TMK uses following numbers by default.
keyboard:
hhkb: FEED:CAFE
gh60: FEED:6060
converter:
x68k: FEED:6800
ps2: FEED:6512
adb: FEED:0ADB
ibm4704: FEED:4704
pc98: FEED:9898
Also see this. https://github.com/tmk/tmk_keyboard/issues/150
You can buy a really unique VID:PID here. I don't think you need this for personal use.
When debug console of your device is not ready you will see like this:
Waiting for device:.........
once the device is pluged in then hid_listen finds it you will get this message:
Waiting for new device:.........................
Listening:
Check if you can't get this 'Listening:' message:
CONSOLE_ENABLE=yes
in Makefile.Check:
debug_enable=yes
usually in matrix_init()
in matrix.c.Just use 'sudo' to execute hid_listen with privilege.
$ sudo hid_listen
Or add an udev rule for TMK devices with placing a file in rules directory. The directory may vary on each system.
File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
# tmk keyboard products https://github.com/tmk/tmk_keyboard
SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
Build with this option of Makefile
NKRO_ENABLE = yes
After boot keyboard may be in boot mode(6KRO), you will need to replug keyboard to enable NKRO.
Or use Magic
N command to toggle NKRO function.(LShift+RShift+N
by default)
Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
Use 1UL<<16
intead 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
.
In some case converters needed to have pull-up resistors to work correctly. Place the resistor between VCC and signal line in parallel.
For example:
Keyboard Conveter
,------.
5V------+------|VCC |
| | |
R | |
| | |
Signal--+------|PD0 |
| |
GND------------|GND |
`------'
R: 1K Ohm resistor
https://github.com/tmk/tmk_keyboard/issues/71
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. http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with Magic command and Boot Magic.
# Boot Section Size in *bytes*
# Teensy halfKay 512
# Teensy++ halfKay 1024
# Atmel DFU loader 4096 (TMK Alt Controller)
# LUFA bootloader 4096
# USBaspLoader 2048
OPT_DEFS += -DBOOTLOADER_SIZE=4096
http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018
You need to define EXTRAKEY_ENABLE
in makefile to use them in TMK.
EXTRAKEY_ENABLE = yes # Audio control and System control
http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-60.html#p157919
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.
Note that Arduino pin naming is different from actual chip. For example, Arduino pin D0
is not PD0
. Check circuit with its schematics yourself.
Arduino leonardo and micro have ATMega32U4 and can be used for TMK, though Arduino bootloader may be a problem.
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 ATMegaU 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.
See this code.
// JTAG disable for PORT F. write JTD bit twice within four cycles.
MCUCR |= (1<<JTD);
MCUCR |= (1<<JTD);
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.
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