1 /* TypeMatrix-2030-like keymap */
4 #include "action_layer.h"
5 #include "action_util.h"
7 #include "keymap_extras/keymap_bepo.h"
8 #include "keymap_extras/keymap_canadian_multilingual.h"
11 LR_BASE, // default layer
12 LR_CSA, // BÉPO over Canadian Multilingual (CSA)
13 LR_CSA_SFT, // shifted BÉPO over CSA
14 LR_CSA_AGR, // altgr-ed BÉPO over CSA
15 LR_CSA_AGR_SFT, // altgr-shifted BÉPO over CSA
16 LR_NUMR, // numeric layer
20 #define IS_CA_MULT_ENABLED() (layer_state & (1 << LR_CSA))
23 // Characters that do not exist in CSA and must be implemented based on unicode support
24 // Note: these are intentionally declared first to be used as indexes in spec_chars below
28 END_UC, // indicates the last unicode character macro
30 M_CSA_SFT, // toggle shift on CSA
31 M_CSA_AGR_SFT, // toggle shift on LR_CSA_AGR (goes to LR_CSA_AGR_SFT)
32 M_CSA_SFT_AGR, // toggle AltGr on LR_CSA_SFT (goes to LR_CSA_AGR_SFT)
33 // macros for characters that need to be un-shifted in LR_CA_MULT_SHIFT
48 // macros for characters that don't have a simple key combination in LR_CA_MULT_ALTGR
56 #define CSA(name) M(M_CSA_##name) // calls a CSA macro
58 const uint16_t unicode_chars[] = {
64 /* shortcut for unicode character macros */
65 #define MUC(name) M(UC_##name) // calls a unicode macro
67 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
70 * ,--------------------------------------------------. ,--------------------------------------------------.
71 * | $ | " | « | » | ( | ) | Del | | Del | @ | + | - | / | * | W |
72 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
73 * | Tab | B | É | P | O | È |Backsp| |Backsp| ^ | V | D | L | J | Z |
74 * |--------+------+------+------+------+------|ace | |ace |------+------+------+------+------+--------|
75 * | = | A | U | I | E | , |------| |------| C | T | S | R | N | M |
76 * |--------+------+------+------+------+------|Enter | |Enter |------+------+------+------+------+--------|
77 * | LShift | À | Y | X | . | K | | | | ' | Q | G | H | F | RShift |
78 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
79 * |LCtrl | fn | LGui |numAlt| LAlt | |Alt Gr| % | App | Ç | RCtrl|
80 * `----------------------------------' `----------------------------------'
81 * ,--------------. ,-------------.
82 * | Esc | num | | Left |Right |
83 * ,------+-------+------| |------+------+------.
84 * | | | PgUp | | Up | | |
85 * |Space | Home |------| |------| End |Space |
86 * | | | PgDn | | Down | | |
87 * `---------------------' `--------------------'
89 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
90 // Otherwise, it needs KC_*
91 [LR_BASE] = KEYMAP( // layer 0 : default
93 BP_DLR, KC_1, KC_2, KC_3, KC_4, KC_5, KC_DELT,
94 KC_TAB, BP_B, BP_ECUT, BP_P, BP_O, BP_EGRV, KC_BSPC,
95 BP_EQL, BP_A, BP_U, BP_I, BP_E, BP_COMM,
96 KC_LSFT, BP_AGRV, BP_Y, BP_X, BP_DOT, BP_K, KC_ENT,
97 KC_LCTL, M(M_FNLR), KC_LGUI, M(M_NMAL), KC_LALT,
101 KC_SPC, KC_HOME, KC_PGDN,
104 KC_DELT, KC_6, KC_7, KC_8, KC_9, KC_0, BP_W,
105 KC_BSPC, BP_DCRC, BP_V, BP_D, BP_L, BP_J, BP_Z,
106 BP_C, BP_T, BP_S, BP_R, BP_N, BP_M,
107 KC_ENT, BP_APOS, BP_Q, BP_G, BP_H, BP_F, KC_RSFT,
108 BP_ALGR, BP_PERC, KC_APP, BP_CCED, KC_RCTL,
112 KC_DOWN, KC_END, KC_SPC
115 * Same as default but for use with Canadian Multilingual on OS side
119 KC_DLR, CSA_DQOT, CSA_LGIL, CSA_RGIL, KC_LPRN, KC_RPRN, KC_TRNS,
120 KC_TRNS, KC_B, CSA_ECUT, KC_P, KC_O, CSA_EGRV, KC_TRNS,
121 KC_EQL, KC_A, KC_U, KC_I, KC_E, KC_COMM,
122 CSA(SFT), CSA_AGRV, KC_Y, KC_X, KC_DOT, KC_K, KC_TRNS,
123 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
127 KC_TRNS, KC_TRNS, KC_TRNS,
130 KC_TRNS, KC_AT, KC_PLUS, KC_MINS, CSA_SLSH, KC_ASTR, KC_W,
131 KC_TRNS, CSA_DCRC, KC_V, KC_D, KC_L, KC_J, KC_Z,
132 KC_C, KC_T, KC_S, KC_R, KC_N, KC_M,
133 KC_TRNS, CSA_APOS, KC_Q, KC_G, KC_H, KC_F, CSA(SFT),
134 MO(LR_CSA_AGR), KC_PERC, KC_TRNS, CSA_CCED, KC_LCTL, // RCTL has a special behaviour in CSA so use LCTL
138 KC_TRNS, KC_TRNS, KC_TRNS
140 /* Shifted BÉPO over Canadian Multilingual
142 * ,--------------------------------------------------. ,--------------------------------------------------.
143 * | # | 1 | 2 | 3 | 4 | 5 | | | | 6 | 7 | 8 | 9 | 0 | |
144 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
145 * | | | | | | | | | | ! | | | | | |
146 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
147 * | ° | | | | | ; |------| |------| | | | | | |
148 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
149 * | | | | | : | | | | | ? | | | | | |
150 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
151 * | | | | | | | | ` | | | |
152 * `----------------------------------' `-----------------------------------'
153 * ,-------------. ,-------------.
155 * ,------|------|------| |------+------+------.
157 * | | |------| |------| | |
159 * `--------------------' `--------------------'
161 [LR_CSA_SFT] = KEYMAP(
163 KC_HASH, M(M_1), M(M_2), M(M_3), M(M_4), M(M_5), KC_TRNS,
164 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
165 M(M_DEGR),KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_SCLN),
166 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_COLN, KC_TRNS, KC_TRNS,
167 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
171 M(M_NBSP), KC_TRNS, KC_TRNS,
174 KC_TRNS, M(M_6), M(M_7), M(M_8), M(M_9), M(M_0), KC_TRNS,
175 KC_TRNS, KC_EXLM, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
176 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
177 KC_TRNS, CSA_QEST, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
178 CSA(SFT_AGR), M(M_GRV), KC_TRNS, KC_TRNS, KC_TRNS,
182 KC_TRNS, KC_TRNS, M(M_NBSP)
184 /* AltGr-ed BÉPO over Canadian Multilingual
185 * "////" indicates that the key is disabled (unsupported bépo character)
187 * ,--------------------------------------------------. ,--------------------------------------------------.
188 * | – | — | < | > | [ | ] | | | | ^ | ± | //// | ÷ | × | dead ˘ |
189 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
190 * | | | |dead '| & | œ |dead `| | | | ¡ |dead ˇ| ð | //// | ij | ////// |
191 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
192 * | ////// | æ | ù |dead "| € | ̛’ |------| |------| © | þ | ß | ® |dead ~| dead ¯ |
193 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
194 * | | \ | { | } | … | ~ | | | | ¿ |dead °| μ | //// |dead ˛| |
195 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
196 * | | | | | | | | //// | |dead ¸| |
197 * `----------------------------------' `-----------------------------------'
198 * ,-------------. ,-------------.
200 * ,------|------|------| |------+------+------.
202 * | _ | |------| |------| | _ |
204 * `--------------------' `--------------------'
206 [LR_CSA_AGR] = KEYMAP(
208 MUC(NDSH), MUC(MDSH), CSA_LESS, CSA_GRTR, CSA_LBRC, CSA_RBRC, KC_TRNS,
209 KC_TRNS, CSA_PIPE, CSA_DACT, KC_AMPR, CSA_OE, CSA_DGRV, KC_TRNS,
210 KC_NO, CSA_AE, CSA_UGRV, CSA_DTRM, CSA_EURO, CSA_RQOT,
211 CSA(AGR_SFT), CSA_BSLS, CSA_LCBR, CSA_RCBR, MUC(ELPS), CSA_TILD, KC_TRNS,
212 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
216 KC_UNDS, CSA(AGR_SFT), KC_TRNS,
219 KC_TRNS, M(M_CRC), CSA_PSMS, KC_NO, CSA_DVSN, CSA_TIMS, CSA_DBRV,
220 KC_TRNS, CSA_IXLM, CSA_DCAR, CSA_ETH, KC_NO, CSA_IJ, KC_NO,
221 CSA_CPRT, CSA_THRN, CSA_SRPS, CSA_RTM, CSA_DTLD, CSA_DMCR,
222 KC_TRNS, CSA_IQST, CSA_DRNG, CSA_MU, KC_NO, CSA_DOGO, CSA(AGR_SFT),
223 KC_TRNS, KC_NO, KC_TRNS, CSA_DCED, KC_TRNS,
227 KC_TRNS, CSA(AGR_SFT), KC_UNDS
229 /* AltGr-shifted BÉPO over Canadian Multilingual
230 * "////" indicates that the key is disabled (unsupported bépo character or unused in bépo)
232 * ,--------------------------------------------------. ,--------------------------------------------------.
233 * | ¶ | //// | “ | ” | //// | //// | | | | //// | ¬ | ¼ | ½ | ¾ | ////// |
234 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
235 * | | ¦ | ˝ | § | Œ | ` | | | | //// | //// | Ð | //// | IJ | ////// |
236 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
237 * | ////// | Æ | Ù |dead-˙| //// | //// |------| |------| //// | Þ | ẞ | ™ | //// | º |
238 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
239 * | | //// | ‘ | ’ | //// | //// | | | | //// | //// | //// | //// | ª | |
240 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
241 * | | | | | | | | | | | |
242 * `----------------------------------' `----------------------------------'
243 * ,-------------. ,-------------.
245 * ,------|------|------| |------+------+------.
247 * | | |------| |------| | |
249 * `--------------------' `--------------------'
251 [LR_CSA_AGR_SFT] = KEYMAP(
253 CSA_PARG, KC_NO, CSA_LDQT, CSA_RDQT, KC_NO, KC_NO, KC_TRNS,
254 KC_TRNS, CSA_BPIP, CSA_DDCT, CSA_SECT, S(CSA_OE), M(M_GRV), KC_TRNS,
255 KC_NO, S(CSA_AE), S(CSA_UGRV), CSA_DDTA, KC_NO, KC_NO,
256 CSA(AGR_SFT), KC_NO, CSA_LQOT, CSA_RQOT, KC_NO, KC_NO, KC_TRNS,
257 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
261 KC_TRNS, CSA(AGR_SFT), KC_TRNS,
264 KC_TRNS, KC_NO, CSA_NEGT, CSA_1QRT, CSA_1HLF, CSA_3QRT, KC_NO,
265 KC_TRNS, KC_NO, KC_NO, S(CSA_ETH), KC_NO, S(CSA_IJ), KC_NO,
266 KC_NO, S(CSA_THRN), S(CSA_SRPS), CSA_TM, KC_NO, CSA_ORDO,
267 KC_TRNS, KC_NO, KC_NO, KC_NO, KC_NO, CSA_ORDA, CSA(AGR_SFT),
268 CSA(SFT_AGR), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
272 KC_TRNS, CSA(AGR_SFT), KC_TRNS
276 * ,--------------------------------------------------. ,--------------------------------------------------.
277 * | | F1 | F2 | F3 | F4 | F5 | | | | | | Tab | / | * | - |
278 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
279 * | | F6 | F7 | F8 | F9 | F10 | | | | | Home | 7 | 8 | 9 | + |
280 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
281 * | | F11 | F12 | | | |------| |------| Up | End | 4 | 5 | 6 | + |
282 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
283 * | | | | | | | | | Left | Down | Right| 1 | 2 | 3 |KpEnter |
284 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
285 * | | | | | | | | 0 | 00 | . |Etr/Ctl|
286 * `----------------------------------' `-----------------------------------'
287 * ,-------------. ,-------------.
288 * | | | |n.lock|c.lock|
289 * ,------|------|------| |------+------+------.
291 * | | |------| |------| | |
293 * `--------------------' `--------------------'
298 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_TRNS,
299 KC_TRNS, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_TRNS,
300 KC_TRNS, KC_F11, KC_F12, KC_TRNS, KC_TRNS, KC_TRNS,
301 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
302 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
306 KC_TRNS, KC_TRNS,KC_TRNS,
309 KC_TRNS, KC_F6, KC_F7, KC_TAB, KC_PSLS, KC_PAST, KC_PMNS,
310 KC_TRNS, KC_TRNS, KC_HOME, KC_P7, KC_P8, KC_P9, KC_PPLS,
311 KC_UP, KC_END, KC_P4, KC_P5, KC_P6, KC_PPLS,
312 KC_LEFT, KC_DOWN, KC_RGHT, KC_P1, KC_P2, KC_P3, KC_PENT,
313 KC_TRNS, KC_P0, M(M_DBL0),KC_PDOT, CTL_T(KC_PENT),
317 KC_TRNS, KC_TRNS, KC_TRNS
321 * ,--------------------------------------------------. ,--------------------------------------------------.
322 * |~CA-mult| | | | | |Insert| |Insert|Eject |Power |Sleep | Wake |PrtScr|ScrollLk|
323 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
324 * | | | | | | |VolUp | | | | | | | | Pause |
325 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
326 * | RESET | | | Calc | Mail |Browsr|------| |------| | | | | | |
327 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
328 * | | App | cut | copy |paste | Mute |VolDn | | | | | | | | |
329 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
330 * | | | | | | | | | | | |
331 * `----------------------------------' `----------------------------------'
332 * ,-------------. ,-------------.
334 * ,------|------|------| |------+------+------.
335 * | | | Next | | | | |
336 * | Mute | play |------| |------| | |
337 * | | | Prev | | | | |
338 * `--------------------' `--------------------'
342 TG(LR_CSA), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_INS,
343 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_VOLU,
344 RESET, KC_TRNS, KC_TRNS, KC_CALC, KC_MAIL, KC_WHOM,
345 KC_TRNS, KC_APP, S(KC_DELT), LCTL(KC_INS),S(KC_INS), KC_MUTE, KC_VOLD,
346 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
350 KC_MUTE, KC_MPLY, KC_MNXT,
353 KC_INS, KC_EJCT, KC_PWR, KC_SLEP, KC_WAKE, KC_PSCR, KC_SLCK,
354 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PAUS,
355 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
356 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
357 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
361 KC_TRNS, KC_TRNS, KC_TRNS
365 const uint16_t PROGMEM fn_actions[] = {
368 void hold_shift(void) {
369 register_code(KC_LSHIFT);
372 void release_shift(void) {
373 unregister_code(KC_LSHIFT);
376 uint16_t hextokeycode(int hex) {
379 } else if (hex < 0xA) {
380 return KC_P1 + (hex - 0x1);
382 return KC_A + (hex - 0xA);
386 void send_unicode(uint16_t unicode)
388 // For more info on how this works per OS, see here: https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_code_input
389 // Implemented for Windows:
390 // Pressing ALT followed by + followed by the unicode code point in hex.
391 // Requires registry key HKEY_CURRENT_USER\Control Panel\Input Method\EnableHexNumpad set to String 1
392 register_code(KC_LALT);
393 register_code(KC_PPLS);
394 unregister_code(KC_PPLS);
396 for (int i = 12; i >= 0; i -= 4) {
397 register_code(hextokeycode((unicode >> i) & 0xF));
398 unregister_code(hextokeycode((unicode >> i) & 0xF));
401 unregister_code(KC_LALT);
404 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
406 // MACRODOWN only works in this function
409 if (record->event.pressed) {
410 send_unicode(unicode_chars[id]);
414 // BÉPO over CSA: toggle shift layer
415 layer_invert(LR_CSA_SFT);
416 if (record->event.pressed) {
423 // BÉPO over CSA: from shift layer, momentary altgr+shift layer
424 layer_invert(LR_CSA_AGR);
425 layer_invert(LR_CSA_AGR_SFT);
426 if (record->event.pressed) {
427 // shift not needed for LR_CSA_AGR_SFT
430 // back to shift layer
435 // BÉPO over CSA: from altgr layer, momentary altgr+shift layer
436 layer_invert(LR_CSA_SFT);
437 layer_invert(LR_CSA_AGR_SFT);
444 // macros of the shift layer that require to release shift
445 if (record->event.pressed) {
449 register_code(KC_1 + (id - M_1));
452 return MACRO(DOWN(CSA_ALTGR), D(SCLN), END);
454 return MACRO(D(SCLN), END);
456 return MACRO(I(75), DOWN(CSA_ALTGR), TYPE(CSA_DCRC), UP(CSA_ALTGR), T(SPACE), END);
458 // use weak mod such that pressing another key will not be affected
459 add_weak_mods(MOD_BIT(CSA_ALTGR));
460 return MACRO(D(SPACE), END);
466 unregister_code(KC_1 + (id - M_1));
469 return MACRO(UP(CSA_ALTGR), U(SCLN), END);
471 return MACRO(U(SCLN), END);
473 del_weak_mods(MOD_BIT(CSA_ALTGR));
474 return MACRO(U(SPACE), END);
479 if (record->event.pressed) {
480 return MACRO(I(75), TYPE(CSA_DCRC), T(SPACE), END);
484 if (record->event.pressed) {
485 return MACRO( I(25), T(P0), T(P0), END );
489 layer_invert(LR_NUMR);
493 layer_invert(LR_NUMR);
494 if (record->event.pressed) {
495 register_code(KC_LALT);
497 unregister_code(KC_LALT);
504 // Runs just one time when the keyboard initializes.
505 void matrix_init_user(void) {
508 // Runs constantly in the background, in a loop.
509 void matrix_scan_user(void) {
511 ergodox_board_led_off();
512 ergodox_right_led_1_off();
513 ergodox_right_led_2_off();
514 ergodox_right_led_3_off();
515 // led 1: numeric layer
516 if (layer_state & (1 << LR_NUMR)) {
517 ergodox_right_led_1_on();
519 // led 2: BÉPO over Canadian Multilingual
520 if (IS_CA_MULT_ENABLED()) {
521 ergodox_right_led_2_on();
524 if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
525 ergodox_right_led_3_on();