diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 8 insertions, 5 deletions
| @@ -7,7 +7,7 @@ Source code is available here: <http://github.com/tmk/tmk_keyboard> | |||
| 7 | 7 | ||
| 8 | Features | 8 | Features |
| 9 | -------- | 9 | -------- |
| 10 | * Multi-layer keymap - Multiple keyboard layouts with layer switching. | 10 | * Multi-layer Keymap - Multiple keyboard layouts with layer switching. |
| 11 | * Mouse key - Mouse control with keyboard | 11 | * Mouse key - Mouse control with keyboard |
| 12 | * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up | 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 | 13 | * Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc |
| @@ -283,8 +283,11 @@ See `common/keycode.h`. Keycode is 8bit internal code to inidicate action perfor | |||
| 283 | 283 | ||
| 284 | ***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`. | 284 | ***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`. |
| 285 | 285 | ||
| 286 | #### 1.1 Normal key | 286 | #### 1.0 Other key |
| 287 | - `KC_NO` for no aciton | 287 | - `KC_NO` for no aciton |
| 288 | - `KC_TRNS` for transparent layer | ||
| 289 | |||
| 290 | #### 1.1 Normal key | ||
| 288 | - `KC_A` to `KC_Z`, `KC_1` to `KC_0` for alpha numeric key | 291 | - `KC_A` to `KC_Z`, `KC_1` to `KC_0` for alpha numeric key |
| 289 | - `KC_MINS`, `KC_EQL`, `KC_GRV`, `KC_RBRC`, `KC_LBRC`, `KC_COMM`, `KC_DOT`, `KC_BSLS`, `KC_SLSH`, `KC_SCLN`, `KC_QUOT` | 292 | - `KC_MINS`, `KC_EQL`, `KC_GRV`, `KC_RBRC`, `KC_LBRC`, `KC_COMM`, `KC_DOT`, `KC_BSLS`, `KC_SLSH`, `KC_SCLN`, `KC_QUOT` |
| 290 | - `KC_ESC`, `KC_TAB`, `KC_SPC`, `KC_BSPC`, `KC_ENT`, `KC_DEL`, `KC_INS` | 293 | - `KC_ESC`, `KC_TAB`, `KC_SPC`, `KC_BSPC`, `KC_ENT`, `KC_DEL`, `KC_INS` |
| @@ -301,7 +304,7 @@ There are 8 modifiers which has discrimination between left and right. | |||
| 301 | - `KC_LGUI` and `KC_RGUI` for Windows key or Command key in Mac | 304 | - `KC_LGUI` and `KC_RGUI` for Windows key or Command key in Mac |
| 302 | 305 | ||
| 303 | #### 1.3 Fn key | 306 | #### 1.3 Fn key |
| 304 | **`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.*** | 307 | `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.*** |
| 305 | 308 | ||
| 306 | #### 1.4 Mousekey | 309 | #### 1.4 Mousekey |
| 307 | - `KC_MS_U`, `KC_MS_D`, `KC_MS_L`, `KC_MS_R` for mouse cursor | 310 | - `KC_MS_U`, `KC_MS_D`, `KC_MS_L`, `KC_MS_R` for mouse cursor |
| @@ -359,7 +362,7 @@ This sets `default layer` into `current layer`. With this action you can return | |||
| 359 | ACTION_LAYER_SET_TAP_KEY(layer, key) | 362 | ACTION_LAYER_SET_TAP_KEY(layer, key) |
| 360 | ACTION_LAYER_SET_TAP_TOGGLE(layer) | 363 | ACTION_LAYER_SET_TAP_TOGGLE(layer) |
| 361 | 364 | ||
| 362 | `Layer Bit` action XOR bits with `current layer`. `Layer Bit` action can take 0 to 8 as argument. | 365 | `Layer Bit` action XOR given bits with `current layer`. `Layer Bit` action can take 0 to 15 as argument. |
| 363 | 366 | ||
| 364 | ACTION_LAYER_BIT(bits) | 367 | ACTION_LAYER_BIT(bits) |
| 365 | ACTION_LAYER_BIT_TOGGLE(bits) | 368 | ACTION_LAYER_BIT_TOGGLE(bits) |
| @@ -659,4 +662,4 @@ Files & Directories | |||
| 659 | License | 662 | License |
| 660 | ------- | 663 | ------- |
| 661 | Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`. | 664 | Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`. |
| 662 | LUFA and PJRC stack have their own license respectively. | 665 | LUFA, PJRC and V-USB stack have their own license respectively. |
