tmk 5f469a4ac1 Add BACKLIGHT_ENABLE conditional | 11 anni fa | |
---|---|---|
common | 11 anni fa | |
doc | 11 anni fa | |
protocol | 11 anni fa | |
.gitignore | 13 anni fa | |
.gitmodules | 12 anni fa | |
README.md | 11 anni fa | |
common.mk | 11 anni fa | |
protocol.mk | 12 anni fa | |
rules.mk | 11 anni fa |
This is a keyboard firmware with some useful features for Atmel AVR controller.
Source code is available here: http://github.com/tmk/tmk_keyboard
These features can be used in your keyboard.
You can find some keyboard specific projects under converter
and keyboard
directory.
GPLv2 or later. Some protocol files are under Modified BSD License. LUFA, PJRC and V-USB stack have their own license respectively.
See doc/build.md.
See doc/keymap.md.
To see help press Magic
+ H
.
Magic
key bind may be LShift
+ RShift
in many project, but Power
key on ADB converter. Magic
keybind can be vary on each project, check config.h
in project directory.
Following commands can be also executed with Magic
+ key. In console mode Magic
keybind is not needed.
----- Command Help -----
c: enter console mode
d: toggle debug enable
x: toggle matrix debug
k: toggle keyboard debug
m: toggle mouse debug
v: print device version & info
t: print timer count
s: print status
e: print eeprom config
n: toggle NKRO
0/F10: switch to Layer0
1/F1: switch to Layer1
2/F2: switch to Layer2
3/F3: switch to Layer3
4/F4: switch to Layer4
PScr: power down/remote wake-up
Caps: Lock Keyboard(Child Proof)
Paus: jump to bootloader
TBD
Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable. Note that you must use keys of Layer 0 as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
ESC
)Backspace
)B
)D
)D
+X
)D
+K
)D
+M
)Left Control
)Casp Lock
)Left Alt
)Right Alt
)Left Gui
)Grave
)Back Slash
)0
)1
)2
)3
)4
)5
)6
)7
)Unintentional use of this feature will cause user confusion.
TODO: Magic key combination to avoid unintentional press during plug in
TBD
To enable this feature define these two macros in config.h
and use KC_LCAP
for locking CapsLock in keymap instead of normal KC_CAPS
. Resync option tries to keep lock switch state consistent with keyboard LED state.
#define CAPSLOCK_LOCKING_ENABLE
#define CAPSLOCK_LOCKING_RESYNC_ENABLE
TBD
#define VENDOR_ID 0xFEED
#define PRODUCT_ID 0xBEEF
#define MANUFACTURER t.m.k.
#define PRODUCT Macway mod
#define DESCRIPTION t.m.k. keyboard firmware for Macway mod
#define MATRIX_ROWS 8
#define MATRIX_COLS 8
#define MATRIX_HAS_GHOST
Architecture Diagram
+---------------+---------------+-------------+
| Host | Keyboard | Matrix, LED |
___________ |-----------+-+ +-------------+ | +-----------|
/ /| Keys/Mouse | Protocol |d| | Action | | | Protocol |
/__________/ |<-----------| LUFA |r| | Layer, Tap | | | Matrix |
|.--------.| | LED | V-USB |i| |-------------| | | PS/2,IBM | __________________
|| || |----------->| PJRC |v| | Keymap | | | ADB,M0110| Keys / /_/_/_/_/_/_/_/ /|
|| Host || | Console | iWRAP(BT)|e| | Mousekey | | | SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
||________||/.<-----------| UART |r| | Report | | | X68K/PC98| Control / /_/_/_/_/_/_/_/ / /
`_========_'/| |---------------------------------------------|-------->/___ /_______/ ___/ /
|_o______o_|/ | Sendchar, Print, Debug, Command, ... | |_________________|/
+---------------------------------------------+ Keyboard
Use PJRC’s hid_listen
to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
You can use xprintf() to display debug info on hid_listen
, see common/xprintf.h
.