]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/ab/keymap.c
AB's practical planck keymap (#435)
[qmk_firmware.git] / keyboards / planck / keymaps / ab / keymap.c
1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
2 // this is the style you want to emulate.
3
4 #include "planck.h"
5 #include "action_layer.h"
6 #include "eeconfig.h"
7 #ifdef BACKLIGHT_ENABLE
8   #include "backlight.h"
9 #endif
10
11 extern keymap_config_t keymap_config;
12
13 // Symbolic names for macro IDs.
14 #define _QWERTY  0 // QUERTY layer
15 #define _RAISE   1 // Raise layer
16 #define _LOWER   2 // Lower layer
17 #define _CUSTOM  3 // Custom layer
18 #define _BL      4 // Backlight
19 #define _MOBILE  5 // Mobile#
20 #define _CUSTOM1 6 // Custom macro 1
21 #define _CUSTOM2 7 // Custom macro 2
22
23 // Macro shortcuts.
24 #define RAISE   M(_RAISE)
25 #define LOWER   M(_LOWER)
26 #define CUSTOM  M(_CUSTOM) // RAISE + LOWER
27 #define BL      M(_BL)
28 #define MOBILE  M(_MOBILE)
29 #define CUSTOM1 M(_CUSTOM1)
30 #define CUSTOM2 M(_CUSTOM2)
31
32 // This config can be found at Keyboard layout editor site: http://goo.gl/zjXL2l
33 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
34 [_QWERTY] = { /* QWERTY */
35     {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
36     {KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT},
37     {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, FUNC(3)},
38     {KC_LCTL, KC_ESC,  KC_LGUI, KC_LALT, RAISE,   KC_SPC,  KC_SPC,  LOWER,   KC_LEFT, KC_UP,   KC_DOWN, KC_RGHT}
39 },
40 [_RAISE] = { /* RAISE */
41     {KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL},
42     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LPRN, KC_RPRN, KC_LCBR, KC_RCBR, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
43     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LBRC, KC_RBRC, KC_QUOT, KC_DQT,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
44     {BL,      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PGUP, KC_PGUP, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS}
45 },
46 [_LOWER] = { /* LOWER */
47     {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12},
48     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LCBR, KC_LCBR, KC_BSLS, KC_TRNS},
49     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_GRV,  KC_TILD, KC_BSLS, KC_PIPE, KC_LBRC, KC_LBRC, KC_TRNS, KC_TRNS},
50     {RESET,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PGDN, KC_PGDN, KC_TRNS, KC_TRNS, KC_VOLD, KC_VOLU, KC_MUTE}
51 },
52 [_CUSTOM] = { /* CUSTOM */
53     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
54     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
55     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, MOBILE,  KC_TRNS, CUSTOM1, CUSTOM2, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
56     {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS}
57 }
58 };
59
60 // Enable these functions using FUNC(n) macro. They seem to be buggy mostly.
61 const uint16_t PROGMEM fn_actions[] = {
62     [0] = ACTION_LAYER_TAP_KEY(_RAISE, KC_PGUP),   // Tap for PgUp, hold for RAISE
63     [1] = ACTION_LAYER_TAP_KEY(_LOWER, KC_PGDN),   // Tap for PgDn, hold for LOWER
64     [2] = ACTION_MODS_TAP_KEY(MOD_LCTL, KC_CAPS),  // Tap for Caps, hold for Ctrl
65     [3] = ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),   // Tap for Enter, hold for Shift
66 };
67
68 // Set a layer persistantly.
69 void persistant_default_layer_set(uint16_t default_layer) {
70   eeconfig_update_default_layer(default_layer);
71   default_layer_set(default_layer);
72 }
73
74 // Macro actions for each corresponding ID.
75 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
76 {
77     switch(id) {
78     case _QWERTY: // Default QWERTY layer. // This case not used for now.
79         if (record->event.pressed) {
80             persistant_default_layer_set(1UL<<_QWERTY);
81         }
82         break;
83     case _RAISE: // Raised layer.
84         if (record->event.pressed) {
85             layer_on(_RAISE);
86             update_tri_layer(_LOWER, _RAISE, _CUSTOM);
87         } else {
88             layer_off(_RAISE);
89             update_tri_layer(_LOWER, _RAISE, _CUSTOM);
90         }
91         break;
92     case _LOWER: // Lowered layer.
93         if (record->event.pressed) {
94             layer_on(_LOWER);
95             update_tri_layer(_LOWER, _RAISE, _CUSTOM);
96         } else {
97             layer_off(_LOWER);
98             update_tri_layer(_LOWER, _RAISE, _CUSTOM);
99         }
100         break;
101     case _BL:// Backlight
102         if (record->event.pressed) {
103             register_code(KC_RSFT);
104 #ifdef BACKLIGHT_ENABLE
105             backlight_step();
106 #endif
107         } else {
108             unregister_code(KC_RSFT);
109         }
110         break;
111     case _MOBILE:// Your mobile# here.
112         return MACRODOWN(T(1), T(2), T(3), T(MINS),
113                          T(1), T(2), T(3), T(MINS),
114                          T(1), T(2), T(3), T(4),
115                          END);
116     case _CUSTOM1:// Your custom macro 1
117         return MACRODOWN(T(E), T(M), T(A), T(C), T(S), T(SPC), END);
118     case _CUSTOM2:// Your custom macro 2
119         return MACRODOWN(T(L), T(S), T(SPC), T(MINS), T(L), T(ENT), END);
120     };
121     return MACRO_NONE;
122 }