Fix SET_DEFAULT_LAYER action and keymap of gh60
[tmk_keyboard.git] / README.md
CommitLineData
afb08462 1t.m.k. Keyboard Firmware Collection
2====================================
3This is a keyboard firmware with some features for Atmel AVR controller.
4
5Source code is available here: <http://github.com/tmk/tmk_keyboard>
6
7
8Features
9--------
48e6d084 10* Multi-layer Keymap - Multiple keyboard layouts with layer switching.
74ecdd15 11* Mouse key - Mouse control with keyboard
12* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
13* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
14* USB NKRO - 120 keys(+ 8 modifiers) simultaneously
15* PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
16* Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
17* User Function - Customizable function of key with writing code
18* Macro - Very primitive at this time
19* Keyboard Tricks - Oneshot modifier and modifier with tapping feature
20* Debug Console - Messages for debug and interaction with firmware
afb08462 21
22
23Projects
24--------
25### converter
784c6e39 26* ps2_usb - [PS/2 keyboard to USB][GH_ps2]
27* adb_usb - [ADB keyboard to USB][GH_adb]
28* m0110_usb - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
29* terminal_usb - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
30* news_usb - [Sony NEWS keyboard to USB][GH_news]
31* x68k_usb - [Sharp X68000 keyboard to USB][GH_x68k]
74ecdd15 32* sun_usb - Sun to USB(type4, 5 and 3?)
33* usb_usb - USB to USB(experimental)
afb08462 34
35### keyboard
74ecdd15 36* hhkb - [Happy Hacking Keyboard professional][GH_hhkb]
37* macway - [Compact keyboard mod][GH_macway]
38* hbkb - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
39* IIgs_Standard - Apple IIGS keyboard mod(by JeffreySung)
40* hid_liber - [HID liberation controller][HID_liber](by alaricljs)
41* phantom - [Phantom keyboard][PHANTOM] (by Tranquilite)
42* gh60 - [GH60 keyboard][GH60]
784c6e39 43
afb08462 44[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
45[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
46[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
47[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
48[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
49[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
81706d11 50[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
afb08462 51[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
52[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
81706d11 53[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
74ecdd15 54[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
55[PHANTOM]: http://geekhack.org/index.php?topic=26742
56[GH60]: http://geekhack.org/index.php?topic=34959
afb08462 57
58
59
74ecdd15 60Build & Program
61---------------
62### Install Tools
63First, you need tools to build firmware and program your controller. I assume you are on Windows here.
afb08462 64
74ecdd15 651. Install [WinAVR][winavr]. This is old but works well for this purpose. `WinAVR` is a tool set to build firmware including C compiler(gcc) and make commands. You can use [CrossPack][crosspack] instead if you are on Mac.
66
672. Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller(ATMega32u4) via DFU bootloader. ATMega32u4 has DFU bootloader by factory default. You can use [dfu-programmer][dfu-prog] instead if you are on Mac.
68
693. Install driver for DFU bootloader. At first time you start DFU bootloader on Chip 'Found New Hardware Wizard' will come up on Windows. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you shall need to update its driver on 'Device Manager'. You will find the driver in `FLIP` install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. If you use `dfu-programmer` install its driver.
70
71If you use PJRC Teensy you don't need step 2 and 3, just get [Teensy loader][teensy-loader].
72
73
74### Download source
75You can find firmware source at github: https://github.com/tmk/tmk_keyboard
76
77If you are familiar with `Git` tools you are recommended to use it.
78If not you can download zip archive from: https://github.com/tmk/tmk_keyboard/archive/master.zip
afb08462 79
80
afb08462 81### Build firmware
74ecdd15 821. Open terminal window to get access to commands. You can use `cmd` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in Run command dialog showing up.
83
842. Move to project directory in the firmware source.
85
86 cd tmk_keyboard/{keyboard or converter}/<project>
87
883. Build firmware using GNU `make` command. You'll see <project>_<variant>.hex file in that directory unless something unexpected occurs in build process.
89
90 mkae -f Makefile.<variant> clean
91 make -f Makefile.<variant>
afb08462 92
afb08462 93
afb08462 94
afb08462 95
96### Program Controller
74ecdd15 97Sock AVR USB chip including ATmega32U4 has DFU bootloader by factory default, you can use DFU tools for this purpose. `FLIP` is a DFU tool on Windows offered by Atmel. Open source command line DFU tool `dfu-programmer` also supports AVR chips, which run on Linux, Mac OSX and even Windows. If you have a PJRC Teensy you should use `Teensy Loader`.
98
99#### DFU bootloader
100To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
784c6e39 101If you have a proper program command in `Makefile` just type this.
afb08462 102
74ecdd15 103`FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial section below.
104To use command line tool run this command. Note that you need to set PATH variable properly.
105
106 $ make -f Makefile.<variant> flip
107
108To program with `dfu-programmer` run:
109
110 $ make -f Makefile.<variant> dfu
afb08462 111
74ecdd15 112#### Teensy
113If you have PJRC Teensy see instruction of `Teensy Loader` at: <http://www.pjrc.com/teensy/loader.html>
114Or use this command if you have command line version of Teensy Loader installed.
115
116 $ make -f Makefile.<variant> teensy
117
118
119#### Other programmer
120You may want to use other you favorite programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring PROGRAM_CMD in Makefile.
121
122 $ make -f Makefile.<variant> program
123
124
125
126#### FLIP GUI tutorial
1271. On menu bar click Device -> Select, then. `ATmega32u4`.
1282. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
129At this point you'll see greyouted widgets on the app get colored and ready.
130
1313. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
1324. On 'Operations Flow' panel click 'Run' button to load the firmware binary to the chip. Note that you should keep 'Erase', 'Blank Check', 'Program' and 'Verify' check boxes selected.
1335. Re-plug USB cord or click 'Start Application' button to restart your controller.
134Done.
135
136See also these instaructions if you need.
137
138- <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
139- <http://www.atmel.com/Images/doc7769.pdf>
140
141
142[winavr]: http://winavr.sourceforge.net/
143[crosspack]: http://www.obdev.at/products/crosspack/index.html
144[flip]: http://www.atmel.com/tools/FLIP.aspx
145[dfu-prog]: http://dfu-programmer.sourceforge.net/
146[teensy-loader]:http://www.pjrc.com/teensy/loader.html
afb08462 147
148
149
784c6e39 150Makefile Options
151----------------
152### 1. MCU and Frequency.
153
afb08462 154 MCU = atmega32u4 # Teensy 2.0
155 #MCU = at90usb1286 # Teensy++ 2.0
156 F_CPU = 16000000
157
784c6e39 158### 2. Features
afb08462 159Note that ***comment out*** to disable them.
784c6e39 160
afb08462 161 MOUSEKEY_ENABLE = yes # Mouse keys
162 PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
163 EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control)
164 NKRO_ENABLE = yes # USB Nkey Rollover
165
784c6e39 166### 3. Programmer
74ecdd15 167Optional. Set proper command for your controller, bootloader and programmer.
784c6e39 168
afb08462 169 # for PJRC Teensy
170 PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
171
74ecdd15 172 # for Atmel chip with DFU bootloader
afb08462 173 PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex
174
74ecdd15 175 # avrdude with other methods
afb08462 176 PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
177 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
178 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
179
74ecdd15 180
181
182Config.h Options
784c6e39 183----------------
184### 1. USB vendor/product ID and device description
afb08462 185 #define VENDOR_ID 0xFEED
186 #define PRODUCT_ID 0xBEEF
187 /* device description */
188 #define MANUFACTURER t.m.k.
189 #define PRODUCT Macway mod
190 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
191
784c6e39 192### 2. Keyboard matrix configuration
afb08462 193 #define MATRIX_ROWS 8
194 #define MATRIX_COLS 8
195 #define MATRIX_HAS_GHOST
196
784c6e39 197### 3. Mouse keys
198
199### 4. PS/2 mouse
200
201### 5. COMMAND key combination
afb08462 202
784c6e39 203 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
afb08462 204
205
206Keymap
207------
74ecdd15 208Many of existent projects offer keymap framework to define your own keymap easily. The following will explain how you can define keymap using this framework.
209 Instead, you can also implement your own `keymap_get_action()` to return action code for each key if you want.
210
39d09333 211This is keymap example for [HHKB](http://en.wikipedia.org/wiki/Happy_Hacking_Keyboard) keyboard. Keymap is defined in `keymaps[]` array.
74ecdd15 212
213 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
03689360 214 /* Keymap 0: Default Layer
74ecdd15 215 * ,-----------------------------------------------------------.
216 * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
217 * |-----------------------------------------------------------|
218 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
219 * |-----------------------------------------------------------|
03689360 220 * |Contro| A| S| D| F| G| H| J| K| L|Fn1| '|Enter |
74ecdd15 221 * |-----------------------------------------------------------|
03689360 222 * |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |Fn0|
74ecdd15 223 * `-----------------------------------------------------------'
224 * |Gui|Alt |Space |Alt |Fn2|
225 * `-------------------------------------------'
226 */
227 KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
228 TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
03689360 229 LCTL,A, S, D, F, G, H, J, K, L, FN1, QUOT,ENT, \
230 LSFT,Z, X, C, V, B, N, M, COMM,DOT, SLSH,RSFT,FN0, \
74ecdd15 231 LGUI,LALT, SPC, RALT,FN3),
03689360 232 /* Keymap 1: colemak */
233 KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
234 TAB, Q, W, F, P, G, J, L, U, Y, SCLN,LBRC,RBRC,BSPC, \
235 BSPC,A, R, S, T, D, H, N, E, I, O, QUOT,ENT, \
236 LSFT,Z, X, C, V, B, K, M, COMM,DOT, SLSH,RSFT,FN0, \
237 LGUI,LALT, SPC, RALT,FN2),
238 };
74ecdd15 239
03689360 240 static const uint8_t PROGMEM overlays[][MATRIX_ROWS][MATRIX_COLS] = {
241 /* Overlay 0: HHKB mode (HHKB Fn)
74ecdd15 242 * ,-----------------------------------------------------------.
243 * |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
244 * |-----------------------------------------------------------|
245 * |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
246 * |-----------------------------------------------------------|
247 * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
248 * |-----------------------------------------------------------|
03689360 249 * |Shift | | | | | | +| -|End|PgD|Dow|Shift | |
74ecdd15 250 * `-----------------------------------------------------------'
251 * |Gui |Alt |Space |Alt |Gui|
252 * `--------------------------------------------'
253 */
254 KEYMAP(PWR, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
03689360 255 CAPS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,PSCR,SLCK,PAUS,UP, TRNS,BSPC, \
256 LCTL,VOLD,VOLU,MUTE,TRNS,TRNS,PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
257 LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,PPLS,PMNS,END, PGDN,DOWN,RSFT,TRNS, \
74ecdd15 258 LGUI,LALT, SPC, RALT,RGUI),
03689360 259 /* Overlay 1: Mouse mode (Semicolon)
74ecdd15 260 * ,-----------------------------------------------------------.
261 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
262 * |-----------------------------------------------------------|
263 * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
264 * |-----------------------------------------------------------|
03689360 265 * |Contro| | | | | |McL|McD|McU|McR| | |Return |
74ecdd15 266 * |-----------------------------------------------------------|
267 * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
268 * `-----------------------------------------------------------'
03689360 269 * |Gui |Alt |Mb1 |Alt | |
74ecdd15 270 * `--------------------------------------------'
271 * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
272 */
273 KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
03689360 274 TAB, TRNS,TRNS,TRNS,TRNS,TRNS,WH_L,WH_D,WH_U,WH_R,TRNS,TRNS,TRNS,BSPC, \
275 LCTL,TRNS,ACL0,ACL1,ACL2,TRNS,MS_L,MS_D,MS_U,MS_R,TRNS,QUOT,ENT, \
276 LSFT,TRNS,TRNS,TRNS,TRNS,BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,TRNS, \
277 LGUI,LALT, BTN1, RALT,TRNS),
74ecdd15 278 };
afb08462 279
74ecdd15 280 static const uint16_t PROGMEM fn_actions[] = {
03689360 281 ACTION_OVERLAY(0), // FN0
282 ACTION_OVERLAY_TAP_KEY(1, KC_SCLN), // FN1
283 ACTION_OVERLAY_TOGGLE(1), // FN2
74ecdd15 284 };
285
286
287
288### 1. Keycode
39d09333 289See `common/keycode.h`. Keycode is 8bit internal code to inidicate action performed on key in keymap. Keycode has `KC_` prefixed symbol respectively. Most of keycodes like `KC_A` have simple action register key on press and unregister on release, on the other some of keycodes has some special actions like Fn keys, Media contorl keys, System control keys and Mouse keys.
74ecdd15 290
291 ***In `KEYMAP` definition you need to omit prefix part `KC_` of keycode to keep keymap compact.*** For example, just use `A` instead you place `KC_A` in `KEYMAP`. Some keycodes has 4-letter short name in addition to descriptive name, you'll prefer short one in `KEYMAP`.
292
48e6d084 293#### 1.0 Other key
39d09333 294- `KC_NO` for no aciton
48e6d084 295- `KC_TRNS` for transparent layer
296
297#### 1.1 Normal key
39d09333 298- `KC_A` to `KC_Z`, `KC_1` to `KC_0` for alpha numeric key
299- `KC_MINS`, `KC_EQL`, `KC_GRV`, `KC_RBRC`, `KC_LBRC`, `KC_COMM`, `KC_DOT`, `KC_BSLS`, `KC_SLSH`, `KC_SCLN`, `KC_QUOT`
300- `KC_ESC`, `KC_TAB`, `KC_SPC`, `KC_BSPC`, `KC_ENT`, `KC_DEL`, `KC_INS`
301- `KC_UP`, `KC_DOWN`, `KC_RGHT`, `KC_LEFT`, `KC_PGUP`, `KC_PGDN`, `KC_HOME`, `KC_END`
302- `KC_CAPS`, `KC_NLCK`, `KC_SLCK`, `KC_PSCR`, `KC_PAUS`, `KC_APP`, `KC_F1` to `KC_F24`
303- `KC_P1` to `KC_P0`, `KC_PDOT`, `KC_PCMM`, `KC_PSLS`, `KC_PAST`, `KC_PMNS`, `KC_PPLS`, `KC_PEQL`, `KC_PENT` for keypad.
74ecdd15 304
39d09333 305#### 1.2 Modifier
306There are 8 modifiers which has discrimination between left and right.
74ecdd15 307
39d09333 308- `KC_LCTL` and `KC_RCTL` for Control
309- `KC_LSFT` and `KC_RSFT` for Shift
310- `KC_LALT` and `KC_RALT` for Alt
311- `KC_LGUI` and `KC_RGUI` for Windows key or Command key in Mac
312
03689360 313#### 1.3 Mousekey
39d09333 314- `KC_MS_U`, `KC_MS_D`, `KC_MS_L`, `KC_MS_R` for mouse cursor
315- `KC_WH_U`, `KC_WH_D`, `KC_WH_L`, `KC_WH_R` for mouse wheel
316- `KC_BTN1`, `KC_BTN2`, `KC_BTN3`, `KC_BTN4`, `KC_BTN5` for mouse buttons
317
03689360 318#### 1.4 System & Media key
39d09333 319- `KC_PWR`, `KC_SLEP`, `KC_WAKE` for Power, Sleep, Wake
320- `KC_MUTE`, `KC_VOLU`, `KC_VOLD` for audio volume control
321- `KC_MNXT`, `KC_MPRV`, `KC_MSTP`, `KC_MPLY`, `KC_MSEL` for media control
322- `KC_MAIL`, `KC_CALC`, `KC_MYCM` for application launch
323- `KC_WSCH`, `KC_WHOM`, `KC_WBAK`, `KC_WFWD`, `KC_WSTP`, `KC_WREF`, `KC_WFAV` for web browser operation
324
03689360 325#### 1.5 Fn key
326`KC_FNnn` are `Fn` keys which not given any action at the beginning unlike most of keycodes has its own action. To use these keys in `KEYMAP` you need to assign action you want at first. Action of `Fn` is defined in `fn_actions[]` and index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` designates action defined in first element of the array. ***32 `Fn` keys can be defined at most.***
327
39d09333 328#### Keycode Table
329 See [keycode table](doc/keycode.txt) in `doc/keycode.txt` or `common/keycode.h` for the detail or other keycodes.
74ecdd15 330
331 In regard to implementation side most of keycodes are identical with [HID usage] sent to host for real and some virtual keycodes are defined to support special actions.
332[HID usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf
333
334
335
336### 2. Action
337See `common/action.h`. Action is a 16bit code and defines function to perform on events of a key like press, release, hold and tap. You can define various actions to use various action codes.
338
03689360 339Most of keys just register 8bit keycodes(HID usage) to host, while to support other complex features needs 16bit extended action codes internally. But using 16bit action codes in keymap results in double size in memory against keycodes. To avoid this waste 8bit keycodes are used in `KEYMAP` to define instead of action codes.
340
341You can just use keycodes of `Normal key`, `Modifier`, `Mousekey` and `System & Media key` in keymap to indicate corresponding actions, instead of action code itself. In the end you can map most of keys just with 8bit keycodes.
342
343To use other special actions you should use `Fn key` keycode defined with such action yourself.
344
74ecdd15 345
346#### 2.1 Key action
03689360 347Key is simple action that registers keycode on press event of key and unregister on release.
348
349##### 2.1.1 Normal key and Modifier
39d09333 350You can define `Key` action on *'A'* key with:
74ecdd15 351
352 ACTION_KEY(KC_A)
03689360 353 ACTION_KEY(KC_LSHIFT)
74ecdd15 354
03689360 355***** 2.1.2 Key with modifiers
39d09333 356 Say you want to assign a key to `Shift + 1` to get charactor *'!'* or `Alt + Tab` to switch windows.
74ecdd15 357
358 ACTION_MOD_KEY(KC_LSHIFT, KC_1)
359 ACTION_MOD_KEY(KC_LALT, KC_TAB)
360
39d09333 361Or `Alt,Shift + Tab` can be defined.
362
74ecdd15 363 ACTION_MODS_KEY((MOD_BIT(KC_LALT) | MOD_BIT(KC_LSHIFT)), KC_TAB)
364
365These actions are comprised of strokes of modifiers and a key. `Macro` action is needed if you want more complex key strokes.
366
367#### 2.2 Layer Actions
03689360 368
369##### 2.2.0 Return to Default Layer
74ecdd15 370This sets `default layer` into `current layer`. With this action you can return to `default layer`.
03689360 371with clear other layers.
372
373 ACTION_DEFAULT_LAYER
74ecdd15 374
03689360 375##### 2.2.1 Keymap
376`Keymap` action validate given layer which ranges from 0 to 15.
74ecdd15 377
03689360 378 ACTION_KEYMAP_MOMENTARY(layer)
379 ACTION_KEYMAP_TOGGLE(layer)
380 ACTION_KEYMAP_TAP_KEY(layer, key)
381 ACTION_KEYMAP_TAP_TOGGLE(layer)
74ecdd15 382
03689360 383##### 2.2.2 Overlay
384`Overlay` action validate
74ecdd15 385
03689360 386 ACTION_KEYMAP_MOMENTARY(layer)
387 ACTION_KEYMAP_TOGGLE(layer)
388 ACTION_KEYMAP_TAP_KEY(layer, key)
389 ACTION_KEYMAP_TAP_TOGGLE(layer)
74ecdd15 390
03689360 391##### 2.2.3 Set Default layer
392These acitons change `default layer` to given layer.
74ecdd15 393
03689360 394 ACTION_SET_DEFAULT_LAYER(layer)
74ecdd15 395
396
397#### 2.3 Macro action
03689360 398***TBD***
399
39d09333 400`Macro` action indicates complex key strokes.
401
402 MACRO( MD(LSHIFT), D(D), END )
403 MACRO( U(D), MU(LSHIFT), END )
404 MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END )
405
406##### 2.3.1 Normal mode
407- **I()** change interavl of stroke.
408- **D()** press key
409- **U()** release key
410- **T()** type key(press and release)
411- **W()** wait
412- **MD()** modifier down
413- **MU()** modifier up
414- **END** end mark
415
416##### 2.3.2 Extended mode
417
418***TODO: sample impl***
419See `keyboard/hhkb/keymap.c` for sample.
74ecdd15 420
421
422#### 2.4 Function action
03689360 423***TBD***
424
39d09333 425There are two type of action, normal `Function` and tappable `Function`.
426These actions call user defined function with `id`, `opt`, and key event information as arguments.
427
428##### 2.4.1 Function
429To define normal `Function` action in keymap use this.
430
431 ACTION_FUNCTION(id, opt)
432
433##### 2.4.2 Function with tap
434To define tappable `Function` action in keymap use this.
435
436 ACTION_FUNCTION_TAP(id, opt)
437
438##### 2.4.3 Implement user function
439`Function` actions can be defined freely with C by user in callback function:
440
441 void keymap_call_function(keyrecord_t *event, uint8_t id, uint8_t opt)
442
443This C function is called every time key is operated, argument `id` selects action to be performed and `opt` can be used for option. Functon `id` can be 0-255 and `opt` can be 0-15.
444
445 `keyrecord_t` is comprised of key event and tap count. `keyevent_t` indicates which and when key is pressed or released. From `tap_count` you can know tap state, 0 means no tap. These information will be used in user function to decide how action of key is performed.
446
447 typedef struct {
448 keyevent_t event;
449 uint8_t tap_count;
450 } keyrecord_t;
451
452 typedef struct {
453 key_t key;
454 bool pressed;
455 uint16_t time;
456 } keyevent_t;
457
458 typedef struct {
459 uint8_t col;
460 uint8_t row;
461 } key_t;
462
463***TODO: sample impl***
464See `keyboard/hhkb/keymap.c` for sample.
465
466
74ecdd15 467
468
469
470### 3. Layer
03689360 471 Layer is key-action map to assign action to every physical key. You can define multiple layers in keymap and make layers active out of keymap during operation at will.
74ecdd15 472
40f1a493 473 First layer is indexed by `0` which usually become `default layer` and active in initial state.
03689360 474
475You can define **16 layers** at most in each keymaps[] and overlays[].
74ecdd15 476
477 you can define a layer with placing keycode symbols separated with `comma` in `KEYMAP`, which is formed with resemblance to physical keyboard layout so as you can easily put keycode on place you want to map. ***You can define most of keys with just using keycodes*** except for `Fn` key serving special actions.
478
479
480
481### 4. Layer switching
482You can have some ways to switch layer with these actions.
483There are two kind of layer switch action `Layer Set` and `Layer Bit` and two type of switching behaviour **Momentary** and **Toggle**.
484
485#### 4.1 Momentary switching
486Momentary switching changes layer only while holding Fn key.
487
488##### 4.1.1 Momentary Set
03689360 489This action makes `Layer 1` active on key press event and inactive on release event..
490
491 ACTION_KEYMAP_MOMENTARY(1)
74ecdd15 492
74ecdd15 493
494It switches to destination layer immediately when key is pressed, after that actions on keymap of destination layer is perfomed. ***Thus you shall need to place action to come back on destination layer***, or you will be stuck in destination layer without way to get back. To get back to `default layer` you can use this action.
495
496 ACTION_LAYER_DEFAULT
497
498##### 4.1.2 Momentary Bit
39d09333 499This `Layer Bit` action performs XOR `1` with `current layer` on both press and release event. If you are on `Layer 0` now next layer to switch will be `Layer 1`. To come back to previous layer you need to place same action on destination layer.
74ecdd15 500
501 ACTION_LAYER_BIT(1)
502
503#### 4.2 Toggle switching
504Toggle switching changes layer after press then release. You keep being on the layer until you press key to return.
505
506##### 4.2.1 Toggle Set
507This `Layer Set Toggle` action is to set `Layer 1` to `current layer` on release and do none on press.
508
509 ACTION_LAYER_SET_TOGGLE(1)
510
511To get back to `default layer` you can use this action.
512
513 ACTION_LAYER_DEFAULT
514
515##### 4.2.2 Toggle Bit
516This `Layer Bit Toggle` action is to XOR `1` with `current layer` on release and do none on press. If you are on `Layer 2` you'll switch to `Layer 3` on press. To come back to previous layer you need to place same action on destination layer.
517
518 ACTION_LAYER_BIT_TOGGLE(1)
519
520
521#### 4.3 Momentary switching with Tap key
522These actions switch to layer only while holding `Fn` key and register key on tap. **Tap** means to press and release key quickly.
523
524 ACTION_LAYER_SET_TAP_KEY(2, KC_SCLN)
525 ACTION_LAYER_SET_BIT_KEY(2, KC_SCLN)
526
527With these you can place layer switching function on normal alphabet key like `;` without losing its original register function.
528
529#### 4.4 Momentary switching with Tap Toggle
530This changes layer only while holding `Fn` key and toggle layer after several taps. **Tap** means to press and release key quickly.
531
532 ACTION_LAYER_SET_TAP_TOGGLE(layer)
533 ACTION_LAYER_BIT_TAP_TOGGLE(layer)
534
535Number of taps can be defined with `TAPPING_TOGGLE` in `config.h`, `5` by default.
536
537
538
539
540Legacy Keymap
541-------------
542This was used in prior version and still works due to legacy support code in `common/keymap.c`. Legacy keymap doesn't support many of features that new keymap offers.
543
544In comparison with new keymap how to define Fn key is different. It uses two arrays `fn_layer[]` and `fn_keycode[]`. The index of arrays corresponds with postfix number of `Fn` key. Array `fn_layer[]` indicates destination layer to switch and `fn_keycode[]` has keycodes to send when tapping `Fn` key.
545
546In following setting example, `Fn0`, `Fn1` and `Fn2` switch layer to 1, 2 and 2 respectively. `Fn2` registers `Space` key when tap while `Fn0` and `Fn1` doesn't send any key.
547
548 static const uint8_t PROGMEM fn_layer[] = {
549 1, // Fn0
550 2, // Fn1
551 2, // Fn2
552 };
553
554 static const uint8_t PROGMEM fn_keycode[] = {
555 KC_NO, // Fn0
556 KC_NO, // Fn1
557 KC_SPC, // Fn2
558 };
afb08462 559
afb08462 560
561
562Debuging
563--------
74ecdd15 564Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
565
566You will see output from firmware like this.
567
568 r/c 01234567
569 00: 00000000
570 01: 00000000
571 02: 00000000
572 03: 00000000
573 04: 00000000
574 05: 00000000
575 06: 00000000
576 07: 00000000
577
578 ---- action_exec: start -----
579 EVENT: 0307u(22511)
580 Tapping: Tap release(2)
581 ACTION: ACT_LAYER[5:2C]
582 LAYER_PRESSED: Tap: unregister_code
583 TAPPING_KEY=0307u(22511):2
584 processed: 0307u(22511):2
585
586 Tapping: End(Timeout after releasing last tap): FFFFu(22715)
587 TAPPING_KEY=0000u(0):0
588
afb08462 589
590
74ecdd15 591
592Magic Comannds
593--------------
594To see help press `Magic` + `H`.
595
596 `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.
597
598Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
599
600 ----- Command Help -----
601 c: enter console mode
602 d: toggle debug enable
603 x: toggle matrix debug
604 k: toggle keyboard debug
605 m: toggle mouse debug
606 p: toggle print enable
607 v: print device version & info
608 t: print timer count
609 s: print status
610 0/F10: switch to Layer0
611 1/F1: switch to Layer1
612 2/F2: switch to Layer2
613 3/F3: switch to Layer3
614 4/F4: switch to Layer4
615 PScr: power down/remote wake-up
616 Caps: Lock Keyboard(Child Proof)
617 Paus: jump to bootloader
618
39d09333 619### Boot Magic
620Magic commands are executed when boot time. Press `Magic` command key then pulgin.
621
622Define these macros in config.h.
623
624 IS_BOOTMAGIC_DEBUG
625 IS_BOOTMAGIC_BOOTLOADER
626
627***TODO: sample impl***
628See `keyboard/hhkb/config.h` for sample.
629
74ecdd15 630
631
632Start Your Own Project
afb08462 633-----------------------
afb08462 634
afb08462 635
afb08462 636
74ecdd15 637Files & Directories
638-------------------
639### Top
640* common/ - common codes
641* protocol/ - keyboard protocol support
642* keyboard/ - keyboard projects
643* converter/ - protocol converter projects
644* doc/ - documents
645* common.mk - Makefile for common
646* protoco.mk - Makefile for protocol
647* rules.mk - Makefile for build rules
648
649### Common
0be309cc 650* action.[ch]
651* action_macro.[ch]
652* bootloader.[ch]
653* command.[ch]
654* controller_teensy.h
655* debug.[ch]
656* host.[ch]
657* host_driver.h
658* keyboard.[ch]
659* keycode.h
660* keymap.[ch]
661* led.h
662* matrix.h
663* mousekey.[ch]
664* print.[ch]
665* report.h
666* sendchar.h
667* sendchar_null.c
668* sendchar_uart.c
669* timer.[ch]
670* uart.[ch]
671* util.[ch]
74ecdd15 672
673### Keyboard Protocols
674* lufa/ - LUFA USB stack
675* pjrc/ - PJRC USB stack
676* vusb/ - Objective Development V-USB
677* iwrap/ - Bluetooth HID for Bluegiga iWRAP
678* ps2.c - PS/2 protocol
679* adb.c - Apple Desktop Bus protocol
680* m0110.c - Macintosh 128K/512K/Plus keyboard protocol
681* news.c - Sony NEWS keyboard protocol
682* x68k.c - Sharp X68000 keyboard protocol
683* serial_soft.c - Asynchronous Serial protocol implemented by software
afb08462 684
afb08462 685
afb08462 686
74ecdd15 687License
688-------
689Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`.
48e6d084 690LUFA, PJRC and V-USB stack have their own license respectively.
Imprint / Impressum