aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Guelpa <nicolas@guelpa.me>2017-09-18 17:13:01 -0400
committerJack Humbert <jack.humb@gmail.com>2017-09-18 17:13:01 -0400
commit31739244219a797c666269ddf3b653c981ed39f9 (patch)
tree1047fceef0ea4abf9b355edfcdddeefaad00dba8
parenta89183591c8dc5e7a814c1429a66fdadf58a7b49 (diff)
downloadqmk_firmware-31739244219a797c666269ddf3b653c981ed39f9.tar.gz
qmk_firmware-31739244219a797c666269ddf3b653c981ed39f9.zip
Adding a new layout for the planck that helps when coming from the pok3r (#1701)
* adding new layout for the planck that helps when coming from the pok3r * Fixing the function layer * Update readme.md * Update keymap.c Making some small adjustments * Update keymap.c switching GUI and Esc * Update keymap.c
-rw-r--r--keyboards/planck/keymaps/pok3r/Makefile3
-rw-r--r--keyboards/planck/keymaps/pok3r/config.h42
-rw-r--r--keyboards/planck/keymaps/pok3r/keymap.c288
-rw-r--r--keyboards/planck/keymaps/pok3r/readme.md15
4 files changed, 348 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/pok3r/Makefile b/keyboards/planck/keymaps/pok3r/Makefile
new file mode 100644
index 000000000..457a3d01d
--- /dev/null
+++ b/keyboards/planck/keymaps/pok3r/Makefile
@@ -0,0 +1,3 @@
1ifndef QUANTUM_DIR
2 include ../../../../Makefile
3endif
diff --git a/keyboards/planck/keymaps/pok3r/config.h b/keyboards/planck/keymaps/pok3r/config.h
new file mode 100644
index 000000000..b406e2fed
--- /dev/null
+++ b/keyboards/planck/keymaps/pok3r/config.h
@@ -0,0 +1,42 @@
1#ifndef CONFIG_USER_H
2#define CONFIG_USER_H
3
4#include "../../config.h"
5
6#ifdef AUDIO_ENABLE
7 #define STARTUP_SONG SONG(PLANCK_SOUND)
8 // #define STARTUP_SONG SONG(NO_SOUND)
9
10 #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
11 SONG(COLEMAK_SOUND), \
12 SONG(DVORAK_SOUND) \
13 }
14#endif
15
16#define MUSIC_MASK (keycode != KC_NO)
17
18/*
19 * MIDI options
20 */
21
22/* Prevent use of disabled MIDI features in the keymap */
23//#define MIDI_ENABLE_STRICT 1
24
25/* enable basic MIDI features:
26 - MIDI notes can be sent when in Music mode is on
27*/
28
29#define MIDI_BASIC
30
31/* enable advanced MIDI features:
32 - MIDI notes can be added to the keymap
33 - Octave shift and transpose
34 - Virtual sustain, portamento, and modulation wheel
35 - etc.
36*/
37//#define MIDI_ADVANCED
38
39/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
40//#define MIDI_TONE_KEYCODE_OCTAVES 2
41
42#endif \ No newline at end of file
diff --git a/keyboards/planck/keymaps/pok3r/keymap.c b/keyboards/planck/keymaps/pok3r/keymap.c
new file mode 100644
index 000000000..b5848a9b6
--- /dev/null
+++ b/keyboards/planck/keymaps/pok3r/keymap.c
@@ -0,0 +1,288 @@
1/* Copyright 2015-2017 Jack Humbert
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include "planck.h"
18#include "action_layer.h"
19
20extern keymap_config_t keymap_config;
21
22enum planck_layers {
23 _QWERTY,
24 _COLEMAK,
25 _DVORAK,
26 _LOWER,
27 _RAISE,
28 _PLOVER,
29 _ADJUST,
30 _FUNCTION
31};
32
33enum planck_keycodes {
34 QWERTY = SAFE_RANGE,
35 COLEMAK,
36 DVORAK,
37 PLOVER,
38 LOWER,
39 RAISE,
40 BACKLIT,
41 EXT_PLV,
42 FUNCTION
43};
44
45const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
46
47/* Qwerty
48 * ,-----------------------------------------------------------------------------------.
49 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
50 * |------+------+------+------+------+-------------+------+------+------+------+------|
51 * | Func | A | S | D | F | G | H | J | K | L | ; | " |
52 * |------+------+------+------+------+------|------+------+------+------+------+------|
53 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
54 * |------+------+------+------+------+------+------+------+------+------+------+------|
55 * | Ctrl | GUI | Esc | Alt |Lower | Space |Raise | Left | Up | Down |Right |
56 * `-----------------------------------------------------------------------------------'
57 */
58[_QWERTY] = {
59 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
60 {FUNCTION,KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
61 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
62 {KC_LCTL, KC_LGUI, KC_ESC, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_UP, KC_DOWN, KC_RGHT}
63},
64
65/* Colemak
66 * ,-----------------------------------------------------------------------------------.
67 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
68 * |------+------+------+------+------+-------------+------+------+------+------+------|
69 * | Func | A | R | S | T | D | H | N | E | I | O | " |
70 * |------+------+------+------+------+------|------+------+------+------+------+------|
71 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
72 * |------+------+------+------+------+------+------+------+------+------+------+------|
73 * | Ctrl | GUI | Esc | Alt |Lower | Space |Raise | Left | Down | Up |Right |
74 * `-----------------------------------------------------------------------------------'
75 */
76[_COLEMAK] = {
77 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
78 {FUNCTION,KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
79 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
80 {KC_LCTL, KC_LGUI, KC_ESC, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
81},
82
83/* Dvorak
84 * ,-----------------------------------------------------------------------------------.
85 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
86 * |------+------+------+------+------+-------------+------+------+------+------+------|
87 * | Func | A | O | E | U | I | D | H | T | N | S | / |
88 * |------+------+------+------+------+------|------+------+------+------+------+------|
89 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
90 * |------+------+------+------+------+------+------+------+------+------+------+------|
91 * | Ctrl | GUI | Esc | Alt |Lower | Space |Raise | Left | Down | Up |Right |
92 * `-----------------------------------------------------------------------------------'
93 */
94[_DVORAK] = {
95 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
96 {FUNCTION,KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
97 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
98 {KC_LCTL, KC_LGUI, KC_ESC, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
99},
100
101/* Lower
102 * ,-----------------------------------------------------------------------------------.
103 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
104 * |------+------+------+------+------+-------------+------+------+------+------+------|
105 * | | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
106 * |------+------+------+------+------+------|------+------+------+------+------+------|
107 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
108 * |------+------+------+------+------+------+------+------+------+------+------+------|
109 * | | | | | | | | Home |Pg Up |Pg Dn | End |
110 * `-----------------------------------------------------------------------------------'
111 */
112[_LOWER] = {
113 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL },
114 {_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
115 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______},
116 {_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END}
117},
118
119/* Raise
120 * ,-----------------------------------------------------------------------------------.
121 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
122 * |------+------+------+------+------+-------------+------+------+------+------+------|
123 * | | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
124 * |------+------+------+------+------+------|------+------+------+------+------+------|
125 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
126 * |------+------+------+------+------+------+------+------+------+------+------+------|
127 * | | | | | | | | Home |Pg Up |Pg Dn | End |
128 * `-----------------------------------------------------------------------------------'
129 */
130[_RAISE] = {
131 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL },
132 {_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
133 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
134 {_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END}
135},
136
137/* Plover layer (http://opensteno.org)
138 * ,-----------------------------------------------------------------------------------.
139 * | # | # | # | # | # | # | # | # | # | # | # | # |
140 * |------+------+------+------+------+-------------+------+------+------+------+------|
141 * | | S | T | P | H | * | * | F | P | L | T | D |
142 * |------+------+------+------+------+------|------+------+------+------+------+------|
143 * | | S | K | W | R | * | * | R | B | G | S | Z |
144 * |------+------+------+------+------+------+------+------+------+------+------+------|
145 * | Exit | | | A | O | | E | U | | | |
146 * `-----------------------------------------------------------------------------------'
147 */
148
149[_PLOVER] = {
150 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
151 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
152 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
153 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
154},
155
156/* Adjust (Lower + Raise)
157 * ,-----------------------------------------------------------------------------------.
158 * | | Reset| | | | | | | | | | Del |
159 * |------+------+------+------+------+-------------+------+------+------+------+------|
160 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
161 * |------+------+------+------+------+------|------+------+------+------+------+------|
162 * | Caps |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
163 * |------+------+------+------+------+------+------+------+------+------+------+------|
164 * | | | | | | | | | | | |
165 * `-----------------------------------------------------------------------------------'
166 */
167[_ADJUST] = {
168 {_______, RESET, DEBUG, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
169 {_______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
170 {KC_CAPS, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
171 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
172},
173
174/* Function
175 * ,-----------------------------------------------------------------------------------.
176 * | Esc | | Prev | Play | Next | | |Pg Up | Up |Pg Dn |Prt Sc| Del |
177 * |------+------+------+------+------+-------------+------+------+------+------+------|
178 * | | | Vol- | Mute | Vol+ | | Home | Left | Down |Right | End | |
179 * |------+------+------+------+------+------|------+------+------+------+------+------|
180 * | | | | | | | | | | | | |
181 * |------+------+------+------+------+------+------+------+------+------+------+------|
182 * | | | | | Esc | | Esc | Home |Pg Up |Pg Dn | End |
183 * `-----------------------------------------------------------------------------------'
184 */
185[_FUNCTION] = {
186 {KC_ESC , _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, KC_PGUP, KC_UP, KC_PGDN, KC_PSCR, KC_DEL},
187 {_______, _______, KC_VOLD, KC_MUTE, KC_VOLU, _______, KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, KC_END , _______},
188 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
189 {_______, _______, _______, _______, KC_ESC , _______, _______, KC_ESC , KC_HOME, KC_PGUP, KC_PGDN, KC_END}
190}
191
192};
193
194#ifdef AUDIO_ENABLE
195 float plover_song[][2] = SONG(PLOVER_SOUND);
196 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
197#endif
198
199bool process_record_user(uint16_t keycode, keyrecord_t *record) {
200 switch (keycode) {
201 case QWERTY:
202 if (record->event.pressed) {
203 set_single_persistent_default_layer(_QWERTY);
204 }
205 return false;
206 break;
207 case COLEMAK:
208 if (record->event.pressed) {
209 set_single_persistent_default_layer(_COLEMAK);
210 }
211 return false;
212 break;
213 case DVORAK:
214 if (record->event.pressed) {
215 set_single_persistent_default_layer(_DVORAK);
216 }
217 return false;
218 break;
219 case LOWER:
220 if (record->event.pressed) {
221 layer_on(_LOWER);
222 update_tri_layer(_LOWER, _RAISE, _ADJUST);
223 } else {
224 layer_off(_LOWER);
225 update_tri_layer(_LOWER, _RAISE, _ADJUST);
226 }
227 return false;
228 break;
229 case RAISE:
230 if (record->event.pressed) {
231 layer_on(_RAISE);
232 update_tri_layer(_LOWER, _RAISE, _ADJUST);
233 } else {
234 layer_off(_RAISE);
235 update_tri_layer(_LOWER, _RAISE, _ADJUST);
236 }
237 return false;
238 break;
239 case BACKLIT:
240 if (record->event.pressed) {
241 register_code(KC_RSFT);
242 #ifdef BACKLIGHT_ENABLE
243 backlight_step();
244 #endif
245 } else {
246 unregister_code(KC_RSFT);
247 }
248 return false;
249 break;
250 case PLOVER:
251 if (record->event.pressed) {
252 #ifdef AUDIO_ENABLE
253 stop_all_notes();
254 PLAY_SONG(plover_song);
255 #endif
256 layer_off(_RAISE);
257 layer_off(_LOWER);
258 layer_off(_ADJUST);
259 layer_on(_PLOVER);
260 if (!eeconfig_is_enabled()) {
261 eeconfig_init();
262 }
263 keymap_config.raw = eeconfig_read_keymap();
264 keymap_config.nkro = 1;
265 eeconfig_update_keymap(keymap_config.raw);
266 }
267 return false;
268 break;
269 case EXT_PLV:
270 if (record->event.pressed) {
271 #ifdef AUDIO_ENABLE
272 PLAY_SONG(plover_gb_song);
273 #endif
274 layer_off(_PLOVER);
275 }
276 return false;
277 break;
278 case FUNCTION:
279 if (record->event.pressed) {
280 layer_on(_FUNCTION);
281 } else {
282 layer_off(_FUNCTION);
283 }
284 return false;
285 break;
286 }
287 return true;
288}
diff --git a/keyboards/planck/keymaps/pok3r/readme.md b/keyboards/planck/keymaps/pok3r/readme.md
new file mode 100644
index 000000000..66320e991
--- /dev/null
+++ b/keyboards/planck/keymaps/pok3r/readme.md
@@ -0,0 +1,15 @@
1This layout adds a new function layer similar to the default one from the pok3r:
2
3 /* Function
4 * ,-----------------------------------------------------------------------------------.
5 * | Esc | | Prev | Play | Next | | |Pg Up | Up |Pg Dn |Prt Sc| Del |
6 * |------+------+------+------+------+-------------+------+------+------+------+------|
7 * | | | Vol- | Mute | Vol+ | | Home | Left | Down |Right | End | |
8 * |------+------+------+------+------+------|------+------+------+------+------+------|
9 * | | | | | | | | | | | | |
10 * |------+------+------+------+------+------+------+------+------+------+------+------|
11 * | | | | | | | | Home |Pg Up |Pg Dn | End |
12 * `-----------------------------------------------------------------------------------'
13 */
14
15You can acces this layer by holding the first key on the second line from the top.