]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/nyquist/keymaps/i2c/keymap.c
Update keymap layout comments
[qmk_firmware.git] / keyboards / nyquist / keymaps / i2c / keymap.c
1 #include "nyquist.h"
2 #include "action_layer.h"
3 #include "eeconfig.h"
4
5 extern keymap_config_t keymap_config;
6
7 // Each layer gets a name for readability, which is then used in the keymap matrix below.
8 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
9 // Layer names don't all need to be of the same length, obviously, and you can also skip them
10 // entirely and just use numbers.
11 #define _QWERTY 0
12 #define _COLEMAK 1
13 #define _DVORAK 2
14 #define _LOWER 3
15 #define _RAISE 4
16 #define _ADJUST 16
17
18 enum custom_keycodes {
19   QWERTY = SAFE_RANGE,
20   COLEMAK,
21   DVORAK,
22   LOWER,
23   RAISE,
24   ADJUST,
25 };
26
27 // Fillers to make layering more clear
28 #define _______ KC_TRNS
29 #define XXXXXXX KC_NO
30
31 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
32
33 /* Qwerty
34  * ,-----------------------------------------------------------------------------------.
35  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
36  * |------+------+------+------+------+------+------+------+------+------+------+------|
37  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Del  |
38  * |------+------+------+------+------+-------------+------+------+------+------+------|
39  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
40  * |------+------+------+------+------+------|------+------+------+------+------+------|
41  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
42  * |------+------+------+------+------+------+------+------+------+------+------+------|
43  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
44  * `-----------------------------------------------------------------------------------'
45  */
46 [_QWERTY] = KEYMAP( \
47   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
48   KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_DEL, \
49   KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
50   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
51   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
52 ),
53
54 /* Colemak
55  * ,-----------------------------------------------------------------------------------.
56  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
57  * |------+------+------+------+------+------+------+------+------+------+------+------|
58  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Del  |
59  * |------+------+------+------+------+-------------+------+------+------+------+------|
60  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
61  * |------+------+------+------+------+------|------+------+------+------+------+------|
62  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
63  * |------+------+------+------+------+------+------+------+------+------+------+------|
64  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
65  * `-----------------------------------------------------------------------------------'
66  */
67 [_COLEMAK] = KEYMAP( \
68   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
69   KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_DEL, \
70   KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT, \
71   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
72   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
73 ),
74
75 /* Dvorak
76  * ,-----------------------------------------------------------------------------------.
77  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
78  * |------+------+------+------+------+------+------+------+------+------+------+------|
79  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Del  |
80  * |------+------+------+------+------+-------------+------+------+------+------+------|
81  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
82  * |------+------+------+------+------+------|------+------+------+------+------+------|
83  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
84  * |------+------+------+------+------+------+------+------+------+------+------+------|
85  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
86  * `-----------------------------------------------------------------------------------'
87  */
88 [_DVORAK] = KEYMAP( \
89   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
90   KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_DEL, \
91   KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
92   KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
93   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
94 ),
95
96 /* Lower
97  * ,-----------------------------------------------------------------------------------.
98  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
99  * |------+------+------+------+------+-------------+------+------+------+------+------|
100  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
101  * |------+------+------+------+------+-------------+------+------+------+------+------|
102  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |     |    \  |  |   |
103  * |------+------+------+------+------+------|------+------+------+------+------+------|
104  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
105  * |------+------+------+------+------+------+------+------+------+------+------+------|
106  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
107  * `-----------------------------------------------------------------------------------'
108  */
109 [_LOWER] = KEYMAP( \
110   KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, \
111   KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL, \
112   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
113   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______, \
114   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
115 ),
116
117 /* Raise
118  * ,-----------------------------------------------------------------------------------.
119  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
120  * |------+------+------+------+------+-------------+------+------+------+------+------|
121  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
122  * |------+------+------+------+------+-------------+------+------+------+------+------|
123  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
124  * |------+------+------+------+------+------|------+------+------+------+------+------|
125  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
126  * |------+------+------+------+------+------+------+------+------+------+------+------|
127  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
128  * `-----------------------------------------------------------------------------------'
129  */
130 [_RAISE] = KEYMAP( \
131   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
132   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL, \
133   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, \
134   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, _______, \
135   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
136 ),
137
138 /* Adjust (Lower + Raise)
139  * ,-----------------------------------------------------------------------------------.
140  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
141  * |------+------+------+------+------+------+------+------+------+------+------+------|
142  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
143  * |------+------+------+------+------+-------------+------+------+------+------+------|
144  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
145  * |------+------+------+------+------+------|------+------+------+------+------+------|
146  * |      |      |      |      |      |      |      |      |      |      |      |      |
147  * |------+------+------+------+------+------+------+------+------+------+------+------|
148  * |      |      |      |      |      |             |      |      |      |      |      |
149  * `-----------------------------------------------------------------------------------'
150  */
151 [_ADJUST] =  KEYMAP( \
152   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12, \
153   _______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
154   _______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______, \
155   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
156   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
157 )
158
159 };
160
161 #ifdef AUDIO_ENABLE
162 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
163 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
164 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
165 #endif
166
167 void persistent_default_layer_set(uint16_t default_layer) {
168   eeconfig_update_default_layer(default_layer);
169   default_layer_set(default_layer);
170 }
171
172 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
173   switch (keycode) {
174     case QWERTY:
175       if (record->event.pressed) {
176         #ifdef AUDIO_ENABLE
177           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
178         #endif
179         persistent_default_layer_set(1UL<<_QWERTY);
180       }
181       return false;
182       break;
183     case COLEMAK:
184       if (record->event.pressed) {
185         #ifdef AUDIO_ENABLE
186           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
187         #endif
188         persistent_default_layer_set(1UL<<_COLEMAK);
189       }
190       return false;
191       break;
192     case DVORAK:
193       if (record->event.pressed) {
194         #ifdef AUDIO_ENABLE
195           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
196         #endif
197         persistent_default_layer_set(1UL<<_DVORAK);
198       }
199       return false;
200       break;
201     case LOWER:
202       if (record->event.pressed) {
203         layer_on(_LOWER);
204         update_tri_layer(_LOWER, _RAISE, _ADJUST);
205       } else {
206         layer_off(_LOWER);
207         update_tri_layer(_LOWER, _RAISE, _ADJUST);
208       }
209       return false;
210       break;
211     case RAISE:
212       if (record->event.pressed) {
213         layer_on(_RAISE);
214         update_tri_layer(_LOWER, _RAISE, _ADJUST);
215       } else {
216         layer_off(_RAISE);
217         update_tri_layer(_LOWER, _RAISE, _ADJUST);
218       }
219       return false;
220       break;
221     case ADJUST:
222       if (record->event.pressed) {
223         layer_on(_ADJUST);
224       } else {
225         layer_off(_ADJUST);
226       }
227       return false;
228       break;
229   }
230   return true;
231 }