]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/hhkb/keymaps/lxol/keymap.c
Add documentation for led matrix
[qmk_firmware.git] / keyboards / hhkb / keymaps / lxol / keymap.c
1 /*  -*-  eval: (turn-on-orgtbl); -*-
2  * lxol HHKB Layout
3  */
4 #include QMK_KEYBOARD_H
5
6 #define BASE 0
7 #define WIN 1
8 #define HHKB 2
9 #define RGUILEV 3
10 #define LGUILEV 4
11 #define RALTLEV 5
12 #define LALTLEV 6
13
14 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
15
16     /* Layer 0: Default Layer
17      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
18      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0   | -     | =        | \     | ` |
19      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
20      | Tab    | Q | W | E | R | T | Y | U | I | O | P   | [     | ]        | Backs |   |
21      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
22      | Contro | A | S | D | F | G | H | J | K | L | ;   | '     | RCtl/Ent |       |   |
23      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
24      | Shift  | Z | X | C | V | B | N | M | , | . | Fn2 | Shift | Fn0      |       |   |
25      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
26
27                  |------+------+-------+------+------|
28                  | LAlt | LGUI | Space | RGUI | RAlt |
29                  |------+------+-------+------+------|
30     */
31
32     [BASE] = LAYOUT( // layer 0 : default
33
34         KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_GRV,
35         KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
36         KC_LCTL, LT(LALTLEV, KC_A), LT(LGUILEV, KC_S), KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, LT(RGUILEV, KC_L), LT(RALTLEV, KC_SCLN), KC_QUOT, KC_FN0,
37         KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(HHKB),
38         KC_LALT, KC_LGUI, KC_SPC, KC_RGUI, KC_RALT),
39
40     /* Layer 1: HHKB mode (HHKB Fn)
41       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
42       | Pwr  | F1  | F2  | F3  | F4 | F5 | F6 | F7 | F8  | F9  | F10 | F11 | F12   | Ins   | Del |
43       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
44       | Caps |     |     |     |    |    |    |    | Psc | Slk | Pus | Up  |       | Backs |     |
45       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
46       |      | VoD | VoU | Mut |    |    | *  | /  | Hom | PgU | Lef | Rig | Enter |       |     |
47       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
48       |      |     |     |     |    |    | +  | -  | End | PgD | Dow |     |       |       |     |
49       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
50
51                       |---+---+---+---+---|
52                       |   |   |   |   |   |
53                       |---+---+---+---+---|
54      */
55
56     [HHKB] = LAYOUT(
57         KC_PWR, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_INS, KC_DEL,
58         KC_CAPS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PSCR, KC_SLCK, KC_PAUS, KC_UP, KC_TRNS, KC_BSPC,
59         KC_TRNS, KC_VOLD, KC_VOLU, KC_MUTE, KC_TRNS, KC_TRNS, KC_PAST, KC_PSLS, KC_HOME, KC_PGUP, KC_LEFT, KC_RGHT, KC_PENT,
60         KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PPLS, KC_PMNS, KC_END, KC_PGDN, KC_DOWN, KC_TRNS, KC_TRNS,
61         KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
62
63     /* Layer LGUI: All keys with RGUI modifier
64      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
65      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0   | -     | =        | \     | ` |
66      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
67      | Tab    | Q | W | E | R | T | Y | U | I | O | P   | [     | ]        | Backs |   |
68      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
69      | Contro | A | S | D | F | G | H | J | K |   | ;   | '     | RCtl/Ent |       |   |
70      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
71      | Shift  | Z | X | C | V | B | N | M | , | . | Fn2 | Shift | Fn0      |       |   |
72      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
73
74                  |------+------+-------+------+------|
75                  | LAlt | LGUI | Space | RGUI | RAlt |
76                  |------+------+-------+------+------|
77     */
78
79     [RGUILEV] = LAYOUT( // Right GUI layer  by KC_L
80
81         RGUI(KC_ESC), RGUI(KC_1), RGUI(KC_2), RGUI(KC_3), RGUI(KC_4), RGUI(KC_5), RGUI(KC_6), RGUI(KC_7), RGUI(KC_8), RGUI(KC_9), RGUI(KC_0), RGUI(KC_MINS), RGUI(KC_EQL), RGUI(KC_BSLS), RGUI(KC_GRV),
82         RGUI(KC_TAB), RGUI(KC_Q), RGUI(KC_W), RGUI(KC_E), RGUI(KC_R), RGUI(KC_T), RGUI(KC_Y), RGUI(KC_U), RGUI(KC_I), RGUI(KC_O), RGUI(KC_P), RGUI(KC_LBRC), RGUI(KC_RBRC), RGUI(KC_BSPC),
83         RGUI(KC_LCTL), RGUI(KC_A), RGUI(KC_S), RGUI(KC_D), RGUI(KC_F), RGUI(KC_G), RGUI(KC_H), RGUI(KC_J), RGUI(KC_K), KC_TRNS, KC_TRNS, RGUI(KC_QUOT), KC_FN0,
84         RGUI(KC_LSFT), RGUI(KC_Z), RGUI(KC_X), RGUI(KC_C), RGUI(KC_V), RGUI(KC_B), RGUI(KC_N), RGUI(KC_M), RGUI(KC_COMM), RGUI(KC_DOT), RGUI(KC_SLSH), RGUI(KC_RSFT), KC_TRNS,
85         KC_LALT, KC_LGUI, RGUI(KC_SPC), KC_RGUI, KC_RALT),
86
87     /* Layer LGUI: All keys with LGUI modifier
88      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
89      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0   | -     | =        | \     | ` |
90      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
91      | Tab    | Q | W | E | R | T | Y | U | I | O | P   | [     | ]        | Backs |   |
92      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
93      | Contro | A | S | D | F | G | H | J | K |   | ;   | '     | RCtl/Ent |       |   |
94      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
95      | Shift  | Z | X | C | V | B | N | M | , | . | Fn2 | Shift | Fn0      |       |   |
96      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
97
98                  |------+------+-------+------+------|
99                  | LAlt | LGUI | Space | LGUI | RAlt |
100                  |------+------+-------+------+------|
101     */
102
103     [LGUILEV] = LAYOUT( // Right GUI layer  by KC_L
104
105         LGUI(KC_ESC), LGUI(KC_1), LGUI(KC_2), LGUI(KC_3), LGUI(KC_4), LGUI(KC_5), LGUI(KC_6), LGUI(KC_7), LGUI(KC_8), LGUI(KC_9), LGUI(KC_0), LGUI(KC_MINS), LGUI(KC_EQL), LGUI(KC_BSLS), LGUI(KC_GRV),
106         LGUI(KC_TAB), LGUI(KC_Q), LGUI(KC_W), LGUI(KC_E), LGUI(KC_R), LGUI(KC_T), LGUI(KC_Y), LGUI(KC_U), LGUI(KC_I), LGUI(KC_O), LGUI(KC_P), LGUI(KC_LBRC), LGUI(KC_RBRC), LGUI(KC_BSPC),
107         LGUI(KC_LCTL), KC_TRNS, KC_TRNS, LGUI(KC_D), LGUI(KC_F), LGUI(KC_G), LGUI(KC_H), LGUI(KC_J), LGUI(KC_K), LGUI(KC_L), LGUI(KC_SCLN), LGUI(KC_QUOT), KC_FN0,
108         KC_LSFT, LGUI(KC_Z), LGUI(KC_X), LGUI(KC_C), LGUI(KC_V), LGUI(KC_B), LGUI(KC_N), LGUI(KC_M), LGUI(KC_COMM), LGUI(KC_DOT), LGUI(KC_SLSH), KC_RSFT, KC_TRNS,
109         KC_LALT, KC_LGUI, LGUI(KC_SPC), KC_LGUI, KC_RALT),
110
111     /* Layer LALT: All keys with RALT modifier
112      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
113      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0   | -     | =        | \     | ` |
114      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
115      | Tab    | Q | W | E | R | T | Y | U | I | O | P   | [     | ]        | Backs |   |
116      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
117      | Contro | A | S | D | F | G | H | J | K |   | ;   | '     | RCtl/Ent |       |   |
118      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
119      | Shift  | Z | X | C | V | B | N | M | , | . | Fn2 | Shift | Fn0      |       |   |
120      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
121
122                  |------+------+-------+------+------|
123                  | LAlt | LGUI | Space | RGUI | RAlt |
124                  |------+------+-------+------+------|
125     */
126
127     [RALTLEV] = LAYOUT( // Right ALT layer  by KC_L
128
129         RALT(KC_ESC), RALT(KC_1), RALT(KC_2), RALT(KC_3), RALT(KC_4), RALT(KC_5), RALT(KC_6), RALT(KC_7), RALT(KC_8), RALT(KC_9), RALT(KC_0), RALT(KC_MINS), RALT(KC_EQL), RALT(KC_BSLS), RALT(KC_GRV),
130         RALT(KC_TAB), RALT(KC_Q), RALT(KC_W), RALT(KC_E), RALT(KC_R), RALT(KC_T), RALT(KC_Y), RALT(KC_U), RALT(KC_I), RALT(KC_O), RALT(KC_P), RALT(KC_LBRC), RALT(KC_RBRC), RALT(KC_BSPC),
131         RALT(KC_LCTL), RALT(KC_A), RALT(KC_S), RALT(KC_D), RALT(KC_F), RALT(KC_G), RALT(KC_H), RALT(KC_J), RALT(KC_K), KC_TRNS, KC_TRNS, RALT(KC_QUOT), KC_FN0,
132         RALT(KC_LSFT), RALT(KC_Z), RALT(KC_X), RALT(KC_C), RALT(KC_V), RALT(KC_B), RALT(KC_N), RALT(KC_M), RALT(KC_COMM), RALT(KC_DOT), RALT(KC_SLSH), RALT(KC_RSFT), KC_TRNS,
133         KC_LALT, KC_LGUI, RALT(KC_SPC), KC_RGUI, KC_RALT),
134
135     /* Layer LALT: All keys with LALT modifier
136      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
137      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0   | -     | =        | \     | ` |
138      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
139      | Tab    | Q | W | E | R | T | Y | U | I | O | P   | [     | ]        | Backs |   |
140      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
141      | Contro | A | S | D | F | G | H | J | K |   | ;   | '     | RCtl/Ent |       |   |
142      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
143      | Shift  | Z | X | C | V | B | N | M | , | . | Fn2 | Shift | Fn0      |       |   |
144      |--------+---+---+---+---+---+---+---+---+---+-----+-------+----------+-------+---|
145
146                  |------+------+-------+------+------|
147                  | LAlt | LGUI | Space | LGUI | RAlt |
148                  |------+------+-------+------+------|
149     */
150
151     [LALTLEV] = LAYOUT( // Right ALT layer  by KC_L
152
153         LALT(KC_ESC), LALT(KC_1), LALT(KC_2), LALT(KC_3), LALT(KC_4), LALT(KC_5), LALT(KC_6), LALT(KC_7), LALT(KC_8), LALT(KC_9), LALT(KC_0), LALT(KC_MINS), LALT(KC_EQL), LALT(KC_BSLS), LALT(KC_GRV),
154         LALT(KC_TAB), LALT(KC_Q), LALT(KC_W), LALT(KC_E), LALT(KC_R), LALT(KC_T), LALT(KC_Y), LALT(KC_U), LALT(KC_I), LALT(KC_O), LALT(KC_P), LALT(KC_LBRC), LALT(KC_RBRC), LALT(KC_BSPC),
155         LALT(KC_LCTL), KC_TRNS, KC_TRNS, LALT(KC_D), LALT(KC_F), LALT(KC_G), LALT(KC_H), LALT(KC_J), LALT(KC_K), LALT(KC_L), LALT(KC_SCLN), LALT(KC_QUOT), KC_FN0,
156         KC_LSFT, LALT(KC_Z), LALT(KC_X), LALT(KC_C), LALT(KC_V), LALT(KC_B), LALT(KC_N), LALT(KC_M), LALT(KC_COMM), LALT(KC_DOT), LALT(KC_SLSH), KC_RSFT, KC_TRNS,
157         KC_LALT, KC_LGUI, LALT(KC_SPC), KC_LGUI, KC_RALT),
158
159     /* Layer WIN: Win layer
160      |--------+---+---+---+---+---+---+---+---+---+---+-------+----------+-------+---|
161      | Esc    | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | -     | =        | \     | ` |
162      |--------+---+---+---+---+---+---+---+---+---+---+-------+----------+-------+---|
163      | Tab    | Q | W | E | R | T | Y | U | I | O | P | [     | ]        | Backs |   |
164      |--------+---+---+---+---+---+---+---+---+---+---+-------+----------+-------+---|
165      | Contro | A | S | D | F | G | H | J | K | L | ; | '     | RCtl/Ent |       |   |
166      |--------+---+---+---+---+---+---+---+---+---+---+-------+----------+-------+---|
167      | Shift  | Z | X | C | V | B | N | M | , | . | / | Shift | Fn0      |       |   |
168      |--------+---+---+---+---+---+---+---+---+---+---+-------+----------+-------+---|
169
170                  |------+------+-------+------+------|
171                  | LGui | LAlt | Space | RGui | Ralt |
172                  |------+------+-------+------+------|
173     */
174
175     [WIN] = LAYOUT( // BASE level with swapped GUI/ALT
176
177         KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_GRV,
178         KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
179         KC_LCTL, LT(LGUILEV, KC_A), LT(LALTLEV, KC_S), KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, LT(RALTLEV, KC_L), LT(RGUILEV, KC_SCLN), KC_QUOT, KC_FN0,
180         KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(HHKB),
181         KC_RGUI, KC_RALT, KC_SPC, KC_RALT, KC_RGUI)};
182
183 const uint16_t PROGMEM fn_actions[] = {
184     [0] = ACTION_MODS_TAP_KEY(MOD_RCTL, KC_ENT) // RControl with tap Enter*
185 };
186
187 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
188 {
189     // MACRODOWN only works in this function
190     switch (id)
191     {
192     case 0:
193         if (record->event.pressed)
194         {
195             register_code(KC_RSFT);
196         }
197         else
198         {
199             unregister_code(KC_RSFT);
200         }
201         break;
202     }
203     return MACRO_NONE;
204 };