aboutsummaryrefslogtreecommitdiff
path: root/keyboards/planck
diff options
context:
space:
mode:
authorTimothy Beck <52902223+BeckTimothy@users.noreply.github.com>2021-02-12 11:43:52 -0700
committerGitHub <noreply@github.com>2021-02-12 13:43:52 -0500
commit3f71bc8e797ef45d9fc499b0e817addaff7bb1bf (patch)
tree994cb5a9ab26e61f036e332868a3b3b5b1c6c8c8 /keyboards/planck
parent550359a4b4510890bc0e3c4adddb3fd5d07a798b (diff)
downloadqmk_firmware-3f71bc8e797ef45d9fc499b0e817addaff7bb1bf.tar.gz
qmk_firmware-3f71bc8e797ef45d9fc499b0e817addaff7bb1bf.zip
added dear_vehicle_owner meme keymap to planck keyboard (#11478)
* added default as a starting point * added readme per guidelines * made necessary changed to keymap to follow guidelines * changed debounce mode for more smooth usage at the cost of mem * increased polling interval * Revert "made necessary changed to keymap to follow guidelines" yikes! I modified the WRONG directory. reverted. This reverts commit 8ba3d97af538796d765c47b48537dbcf55c3dbc1. * reverted commit that modified file in incorrect directory. modified intended file. * added license tp config.h
Diffstat (limited to 'keyboards/planck')
-rw-r--r--keyboards/planck/keymaps/dear_vehicle_owner/config.h57
-rw-r--r--keyboards/planck/keymaps/dear_vehicle_owner/keymap.c358
-rw-r--r--keyboards/planck/keymaps/dear_vehicle_owner/readme.md4
-rw-r--r--keyboards/planck/keymaps/dear_vehicle_owner/rules.mk2
4 files changed, 421 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/dear_vehicle_owner/config.h b/keyboards/planck/keymaps/dear_vehicle_owner/config.h
new file mode 100644
index 000000000..cff232c97
--- /dev/null
+++ b/keyboards/planck/keymaps/dear_vehicle_owner/config.h
@@ -0,0 +1,57 @@
1/* Copyright 2021 Timothy Beck
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#pragma once
18
19#ifdef AUDIO_ENABLE
20 #define STARTUP_SONG SONG(PLANCK_SOUND)
21 // #define STARTUP_SONG SONG(NO_SOUND)
22
23 #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
24 SONG(COLEMAK_SOUND), \
25 SONG(DVORAK_SOUND) \
26 }
27#endif
28
29/*
30 * MIDI options
31 */
32
33/* Prevent use of disabled MIDI features in the keymap */
34//#define MIDI_ENABLE_STRICT 1
35
36/* enable basic MIDI features:
37 - MIDI notes can be sent when in Music mode is on
38*/
39
40#define MIDI_BASIC
41
42/* enable advanced MIDI features:
43 - MIDI notes can be added to the keymap
44 - Octave shift and transpose
45 - Virtual sustain, portamento, and modulation wheel
46 - etc.
47*/
48//#define MIDI_ADVANCED
49
50/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
51//#define MIDI_TONE_KEYCODE_OCTAVES 2
52
53// Most tactile encoders have detents every 4 stages
54#define ENCODER_RESOLUTION 4
55
56//switch polling rate to 1000 per second
57#define USB_POLLING_INTERVAL_MS 1
diff --git a/keyboards/planck/keymaps/dear_vehicle_owner/keymap.c b/keyboards/planck/keymaps/dear_vehicle_owner/keymap.c
new file mode 100644
index 000000000..9cbcbf3ca
--- /dev/null
+++ b/keyboards/planck/keymaps/dear_vehicle_owner/keymap.c
@@ -0,0 +1,358 @@
1/* Copyright 2021 Timothy Beck
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 QMK_KEYBOARD_H
18#include "muse.h"
19
20
21enum planck_layers {
22 _QWERTY,
23 _COLEMAK,
24 _DVORAK,
25 _LOWER,
26 _RAISE,
27 _PLOVER,
28 _ADJUST
29};
30
31enum planck_keycodes {
32 QWERTY = SAFE_RANGE,
33 COLEMAK,
34 DVORAK,
35 PLOVER,
36 BACKLIT,
37 EXT_PLV,
38 DR_VO
39};
40
41#define LOWER MO(_LOWER)
42#define RAISE MO(_RAISE)
43
44const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
45
46/* Qwerty
47 * ,-----------------------------------------------------------------------------------.
48 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
49 * |------+------+------+------+------+------+------+------+------+------+------+------|
50 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
51 * |------+------+------+------+------+------+------+------+------+------+------+------|
52 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
53 * |------+------+------+------+------+------+------+------+------+------+------+------|
54 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
55 * `-----------------------------------------------------------------------------------'
56 */
57[_QWERTY] = LAYOUT_planck_grid(
58 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
59 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
60 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
61 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
62),
63
64/* Colemak
65 * ,-----------------------------------------------------------------------------------.
66 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
67 * |------+------+------+------+------+------+------+------+------+------+------+------|
68 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
69 * |------+------+------+------+------+------+------+------+------+------+------+------|
70 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
71 * |------+------+------+------+------+------+------+------+------+------+------+------|
72 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
73 * `-----------------------------------------------------------------------------------'
74 */
75[_COLEMAK] = LAYOUT_planck_grid(
76 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
77 KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
78 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
79 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
80),
81
82/* Dvorak
83 * ,-----------------------------------------------------------------------------------.
84 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
85 * |------+------+------+------+------+------+------+------+------+------+------+------|
86 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
87 * |------+------+------+------+------+------+------+------+------+------+------+------|
88 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
89 * |------+------+------+------+------+------+------+------+------+------+------+------|
90 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
91 * `-----------------------------------------------------------------------------------'
92 */
93[_DVORAK] = LAYOUT_planck_grid(
94 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
95 KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
96 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
97 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
98),
99
100/* Lower
101 * ,-----------------------------------------------------------------------------------.
102 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
103 * |------+------+------+------+------+------+------+------+------+------+------+------|
104 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
105 * |------+------+------+------+------+------+------+------+------+------+------+------|
106 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
107 * |------+------+------+------+------+------+------+------+------+------+------+------|
108 * | DR_VO| DR_VO| DR_VO| DR_VO| | | | DR_VO| DR_VO| DR_VO| DR_VO|
109 * `-----------------------------------------------------------------------------------'
110 */
111[_LOWER] = LAYOUT_planck_grid(
112 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
113 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
114 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
115 DR_VO, DR_VO, DR_VO, DR_VO, _______, _______, _______, _______, DR_VO, DR_VO, DR_VO, DR_VO
116),
117
118/* Raise
119 * ,-----------------------------------------------------------------------------------.
120 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
121 * |------+------+------+------+------+------+------+------+------+------+------+------|
122 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
123 * |------+------+------+------+------+------+------+------+------+------+------+------|
124 * | DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO| DR_VO|
125 * |------+------+------+------+------+------+------+------+------+------+------+------|
126 * | DR_VO| DR_VO| DR_VO| DR_VO| | | | DR_VO| DR_VO| DR_VO| DR_VO|
127 * `-----------------------------------------------------------------------------------'
128 */
129[_RAISE] = LAYOUT_planck_grid(
130 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
131 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
132 DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO, DR_VO,
133 DR_VO, DR_VO, DR_VO, DR_VO, _______, _______, _______, _______, DR_VO, DR_VO, DR_VO, DR_VO
134),
135
136/* Plover layer (http://opensteno.org)
137 * ,-----------------------------------------------------------------------------------.
138 * | # | # | # | # | # | # | # | # | # | # | # | # |
139 * |------+------+------+------+------+------+------+------+------+------+------+------|
140 * | | S | T | P | H | * | * | F | P | L | T | D |
141 * |------+------+------+------+------+------+------+------+------+------+------+------|
142 * | | S | K | W | R | * | * | R | B | G | S | Z |
143 * |------+------+------+------+------+------+------+------+------+------+------+------|
144 * | Exit | | | A | O | | E | U | | | |
145 * `-----------------------------------------------------------------------------------'
146 */
147[_PLOVER] = LAYOUT_planck_grid(
148 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
149 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
150 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
151 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
152),
153
154/* Adjust (Lower + Raise)
155 * v------------------------RGB CONTROL--------------------v
156 * ,-----------------------------------------------------------------------------------.
157 * | | Reset|Debug | RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| Del |
158 * |------+------+------+------+------+------+------+------+------+------+------+------|
159 * | | |MUSmod|Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
160 * |------+------+------+------+------+------+------+------+------+------+------+------|
161 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|TermOn|TermOf| | | |
162 * |------+------+------+------+------+------+------+------+------+------+------+------|
163 * | | | | | | | | | | | |
164 * `-----------------------------------------------------------------------------------'
165 */
166[_ADJUST] = LAYOUT_planck_grid(
167 _______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
168 _______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
169 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______,
170 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
171)
172
173};
174
175#ifdef AUDIO_ENABLE
176 float plover_song[][2] = SONG(PLOVER_SOUND);
177 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
178#endif
179
180layer_state_t layer_state_set_user(layer_state_t state) {
181 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
182}
183
184bool process_record_user(uint16_t keycode, keyrecord_t *record) {
185 switch (keycode) {
186 case QWERTY:
187 if (record->event.pressed) {
188 print("mode just switched to qwerty and this is a huge string\n");
189 set_single_persistent_default_layer(_QWERTY);
190 }
191 return false;
192 break;
193 case COLEMAK:
194 if (record->event.pressed) {
195 set_single_persistent_default_layer(_COLEMAK);
196 }
197 return false;
198 break;
199 case DVORAK:
200 if (record->event.pressed) {
201 set_single_persistent_default_layer(_DVORAK);
202 }
203 return false;
204 break;
205 case BACKLIT:
206 if (record->event.pressed) {
207 register_code(KC_RSFT);
208 #ifdef BACKLIGHT_ENABLE
209 backlight_step();
210 #endif
211 #ifdef KEYBOARD_planck_rev5
212 writePinLow(E6);
213 #endif
214 } else {
215 unregister_code(KC_RSFT);
216 #ifdef KEYBOARD_planck_rev5
217 writePinHigh(E6);
218 #endif
219 }
220 return false;
221 break;
222 case PLOVER:
223 if (record->event.pressed) {
224 #ifdef AUDIO_ENABLE
225 stop_all_notes();
226 PLAY_SONG(plover_song);
227 #endif
228 layer_off(_RAISE);
229 layer_off(_LOWER);
230 layer_off(_ADJUST);
231 layer_on(_PLOVER);
232 if (!eeconfig_is_enabled()) {
233 eeconfig_init();
234 }
235 keymap_config.raw = eeconfig_read_keymap();
236 keymap_config.nkro = 1;
237 eeconfig_update_keymap(keymap_config.raw);
238 }
239 return false;
240 break;
241 case EXT_PLV:
242 if (record->event.pressed) {
243 #ifdef AUDIO_ENABLE
244 PLAY_SONG(plover_gb_song);
245 #endif
246 layer_off(_PLOVER);
247 }
248 return false;
249 break;
250 case DR_VO:
251 if (record->event.pressed) {
252 SEND_STRING("We've been trying to reach you concerning your vehicle's extended warranty. You should've received a notice in the mail about your car's extended warranty eligibility. Since we've not gotten a response, we're giving you a final courtesy call before we close out your file. Press 2 to be removed and placed on our do-not-call list. To speak to someone about possibly extending or reinstating your vehicle's warranty, press 1 to speak with a warranty specialist.\n");
253 }
254 return false;
255 break;
256 }
257 return true;
258}
259
260bool muse_mode = false;
261uint8_t last_muse_note = 0;
262uint16_t muse_counter = 0;
263uint8_t muse_offset = 70;
264uint16_t muse_tempo = 50;
265
266void encoder_update(bool clockwise) {
267 if (muse_mode) {
268 if (IS_LAYER_ON(_RAISE)) {
269 if (clockwise) {
270 muse_offset++;
271 } else {
272 muse_offset--;
273 }
274 } else {
275 if (clockwise) {
276 muse_tempo+=1;
277 } else {
278 muse_tempo-=1;
279 }
280 }
281 } else {
282 if (clockwise) {
283 #ifdef MOUSEKEY_ENABLE
284 tap_code(KC_MS_WH_DOWN);
285 #else
286 tap_code(KC_PGDN);
287 #endif
288 } else {
289 #ifdef MOUSEKEY_ENABLE
290 tap_code(KC_MS_WH_UP);
291 #else
292 tap_code(KC_PGUP);
293 #endif
294 }
295 }
296}
297
298void dip_switch_update_user(uint8_t index, bool active) {
299 switch (index) {
300 case 0: {
301#ifdef AUDIO_ENABLE
302 static bool play_sound = false;
303#endif
304 if (active) {
305#ifdef AUDIO_ENABLE
306 if (play_sound) { PLAY_SONG(plover_song); }
307#endif
308 layer_on(_ADJUST);
309 } else {
310#ifdef AUDIO_ENABLE
311 if (play_sound) { PLAY_SONG(plover_gb_song); }
312#endif
313 layer_off(_ADJUST);
314 }
315#ifdef AUDIO_ENABLE
316 play_sound = true;
317#endif
318 break;
319 }
320 case 1:
321 if (active) {
322 muse_mode = true;
323 } else {
324 muse_mode = false;
325 }
326 }
327}
328
329void matrix_scan_user(void) {
330#ifdef AUDIO_ENABLE
331 if (muse_mode) {
332 if (muse_counter == 0) {
333 uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
334 if (muse_note != last_muse_note) {
335 stop_note(compute_freq_for_midi_note(last_muse_note));
336 play_note(compute_freq_for_midi_note(muse_note), 0xF);
337 last_muse_note = muse_note;
338 }
339 }
340 muse_counter = (muse_counter + 1) % muse_tempo;
341 } else {
342 if (muse_counter) {
343 stop_all_notes();
344 muse_counter = 0;
345 }
346 }
347#endif
348}
349
350bool music_mask_user(uint16_t keycode) {
351 switch (keycode) {
352 case RAISE:
353 case LOWER:
354 return false;
355 default:
356 return true;
357 }
358}
diff --git a/keyboards/planck/keymaps/dear_vehicle_owner/readme.md b/keyboards/planck/keymaps/dear_vehicle_owner/readme.md
new file mode 100644
index 000000000..c8173cd9a
--- /dev/null
+++ b/keyboards/planck/keymaps/dear_vehicle_owner/readme.md
@@ -0,0 +1,4 @@
1# dear vehicle owner
2
3We've been trying to reach you concerning your vehicle's extended warranty. You should've received a notice in the mail about your car's extended warranty eligibility. Since we've not gotten a response, we're giving you a final courtesy call before we close out your file. Press 2 to be removed and placed on our do-not-call list. To speak to someone about possibly extending or reinstating your vehicle's warranty, press 1 to speak with a warranty specialist.
4
diff --git a/keyboards/planck/keymaps/dear_vehicle_owner/rules.mk b/keyboards/planck/keymaps/dear_vehicle_owner/rules.mk
new file mode 100644
index 000000000..d03e978b8
--- /dev/null
+++ b/keyboards/planck/keymaps/dear_vehicle_owner/rules.mk
@@ -0,0 +1,2 @@
1SRC += muse.c
2DEBOUNCE_TYPE = sym_eager_pk
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-18 16:27:55 +0000