aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryttyx <yttyx@users.noreply.github.com>2019-07-11 19:32:47 +0100
committerDrashna Jaelre <drashna@live.com>2019-07-11 11:32:47 -0700
commit676633e1f396d6ab88ef7d5465e8ffccb9f49af2 (patch)
tree815de9ffde2b65e423c9fe4a1bbd751c080b0bcf
parente6420f0bd823fa660d217a2560a919785ccb2343 (diff)
downloadqmk_firmware-676633e1f396d6ab88ef7d5465e8ffccb9f49af2.tar.gz
qmk_firmware-676633e1f396d6ab88ef7d5465e8ffccb9f49af2.zip
[Keymap] Balance Twelve / Steno Keymap for Planck (#6283)
* New keymap. Cursor layer does not work. * Refinements to layout over months of use. * Changes following review. * Changes following review.
Diffstat
-rw-r--r--keyboards/planck/keymaps/yttyx/config.h5
-rw-r--r--keyboards/planck/keymaps/yttyx/keymap.c146
-rw-r--r--keyboards/planck/keymaps/yttyx/readme.md68
-rw-r--r--keyboards/planck/keymaps/yttyx/rules.mk11
4 files changed, 230 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/yttyx/config.h b/keyboards/planck/keymaps/yttyx/config.h
new file mode 100644
index 000000000..88d0c07e9
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/config.h
@@ -0,0 +1,5 @@
1#pragma once
2#define NO_ACTION_ONESHOT
3#define NO_ACTION_MACRO
4#define NO_ACTION_FUNCTION
5#define TAPPING_TOGGLE 2
diff --git a/keyboards/planck/keymaps/yttyx/keymap.c b/keyboards/planck/keymaps/yttyx/keymap.c
new file mode 100644
index 000000000..0fcbae892
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/keymap.c
@@ -0,0 +1,146 @@
1
2#include QMK_KEYBOARD_H
3#include <keymap_steno.h>
4
5enum planck_layers {
6 _BA, // Base (Balance Twelve mirror variant)
7 _PL, // Plover (http://opensteno.org)
8 _NP, // Numeric/punctuation
9 _FC // Function/cursor
10};
11
12enum planck_keycodes {
13 BA = SAFE_RANGE,
14 PL
15};
16
17
18// Abbreviations
19#define KX_SFT_Z MT(MOD_LSFT, KC_Z)
20#define KX_SFT_X MT(MOD_RSFT, KC_X)
21#define LT_ESC_FC LT(_FC, KC_ESC)
22
23
24const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
25
26 /* BA
27 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
28 | P | L | C | D | W | | | U | O | Y | K | Q |
29 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
30 | N | R | S | T | M | | BS | A | E | I | H | V |
31 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
32 | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | |
33 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
34 | Ctl | Alt | Sup | NP | Spc | Esc/FC | Sft | Sft | Sup | Alt | Ctl | |
35 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
36 */
37 [_BA] = LAYOUT_planck_grid(
38 KC_P, KC_L, KC_C, KC_D, KC_W, XXXXXXX, XXXXXXX, KC_U, KC_O, KC_Y, KC_K, KC_Q,
39 KC_N, KC_R, KC_S, KC_T, KC_M, XXXXXXX, KC_BSPC, KC_A, KC_E, KC_I, KC_H, KC_V,
40 KX_SFT_Z, KC_J, KC_F, KC_G, KC_B, XXXXXXX, KC_ENT, KC_QUOT, KC_COMM, KC_DOT, KX_SFT_X, XXXXXXX,
41 KC_LCTL, KC_LALT, KC_LGUI, MO(_NP), KC_SPC, LT_ESC_FC, KC_LSFT, KC_LSFT, KC_LGUI, KC_LALT, KC_LCTL, XXXXXXX
42 ),
43
44 /* Plover
45 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
46 | # | # | # | # | # | BA | # | # | # | # | # | # |
47 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
48 | S | T | P | H | * | | * | F | P | L | T | D |
49 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
50 | S | K | W | R | * | | * | R | B | G | S | Z |
51 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
52 | | | | A | O | | E | U | | | | |
53 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
54 */
55 [_PL] = LAYOUT_planck_grid(
56 STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, BA, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM,
57 STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, XXXXXXX, STN_ST1, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR,
58 STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, XXXXXXX, STN_ST2, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR,
59 XXXXXXX, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, STN_E, STN_U, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
60 ),
61
62 /* Numeric/punctuation
63 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
64 | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) |
65 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
66 | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | BS | [ { | ] } | - _ | ; : | \ | |
67 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
68 | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | |
69 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
70 | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | |
71 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
72 */
73 [_NP] = LAYOUT_planck_grid(
74 KC_1, KC_2, KC_3, KC_4, KC_5, PL, XXXXXXX, KC_6, KC_7, KC_8, KC_9, KC_0,
75 KC_TAB, C(KC_X), C(KC_C), C(KC_V), C(KC_Z), XXXXXXX, _______, KC_LBRC, KC_RBRC, KC_MINS, KC_SCLN, KC_NUBS,
76 KC_LSFT, XXXXXXX, XXXXXXX, KC_DEL, KC_INS, XXXXXXX, XXXXXXX, KC_SLSH, KC_EQL, KC_NUHS, KC_GRV, XXXXXXX,
77 _______, _______, _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX
78 ),
79
80 /* Function/cursor
81 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
82 | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | |
83 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
84 | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | |
85 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
86 | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | |
87 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
88 | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | |
89 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
90 */
91 [_FC] = LAYOUT_planck_grid(
92 KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, XXXXXXX, XXXXXXX, KC_HOME, KC_UP, KC_END, KC_PGUP, XXXXXXX,
93 KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, XXXXXXX,
94 _______, XXXXXXX, XXXXXXX, KC_F11, KC_F12, XXXXXXX, XXXXXXX, KC_PSCR, KC_BRK, KC_SLCK, KC_CAPS, XXXXXXX,
95 _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, XXXXXXX
96 )
97
98};
99
100
101#ifdef AUDIO_ENABLE
102 float plover_on[][2] = SONG(PLOVER_SOUND);
103 float plover_off[][2] = SONG(PLOVER_GOODBYE_SOUND);
104#endif
105
106bool process_record_user(uint16_t keycode, keyrecord_t *record) {
107 switch (keycode) {
108 case PL:
109 if (record->event.pressed) {
110 #ifdef AUDIO_ENABLE
111 stop_all_notes();
112 PLAY_SONG(plover_on);
113 #endif
114
115 layer_off(_NP);
116 layer_off(_FC);
117 layer_on(_PL);
118
119 if (!eeconfig_is_enabled()) {
120 eeconfig_init();
121 }
122
123 keymap_config.raw = eeconfig_read_keymap();
124 keymap_config.nkro = 1;
125 eeconfig_update_keymap(keymap_config.raw);
126 }
127 return false;
128 case BA:
129 if (record->event.pressed) {
130 #ifdef AUDIO_ENABLE
131 PLAY_SONG(plover_off);
132 #endif
133
134 layer_off(_NP);
135 layer_off(_PL);
136 layer_off(_FC);
137 }
138 return false;
139 }
140 return true;
141}
142
143void matrix_init_user() {
144 steno_set_mode(STENO_MODE_GEMINI);
145}
146
diff --git a/keyboards/planck/keymaps/yttyx/readme.md b/keyboards/planck/keymaps/yttyx/readme.md
new file mode 100644
index 000000000..6661c3170
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/readme.md
@@ -0,0 +1,68 @@
1# Overview
2
3* Base layer uses the Balance Twelve layout ([reference](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/))
4* Plover layer uses the same home position as the base layer ([reference](http://www.openstenoproject.org/))
5
6## To build
7
8```
9make planck/rev6:yttyx
10```
11
12## To build and flash
13
14```
15make planck/rev6:yttyx:dfu-util
16```
17
18## Layers
19
20### Base
21
22 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
23 | P | L | C | D | W | | | U | O | Y | K | Q |
24 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
25 | N | R | S | T | M | | BS | A | E | I | H | V |
26 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
27 | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | |
28 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
29 | Ctl | Alt | Sup | NP | Spc | Esc/FC | Sft | Sft | Sup | Alt | Ctl | |
30 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
31
32### Plover
33
34 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
35 | # | # | # | # | # | BA | # | # | # | # | # | # |
36 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
37 | S | T | P | H | * | | * | F | P | L | T | D |
38 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
39 | S | K | W | R | * | | * | R | B | G | S | Z |
40 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
41 | | | | A | O | | E | U | | | | |
42 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
43
44### Numeric/Punctuation
45
46 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
47 | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) |
48 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
49 | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | BS | [ { | ] } | - _ | ; : | \ | |
50 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
51 | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | |
52 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
53 | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | |
54 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
55
56### Function
57
58 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
59 | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | |
60 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
61 | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | |
62 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
63 | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | |
64 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
65 | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | |
66 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
67
68
diff --git a/keyboards/planck/keymaps/yttyx/rules.mk b/keyboards/planck/keymaps/yttyx/rules.mk
new file mode 100644
index 000000000..27dac6d4d
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/rules.mk
@@ -0,0 +1,11 @@
1# Build Options
2AUDIO_ENABLE = yes
3CONSOLE_ENABLE = no
4EXTRAKEY_ENABLE = no
5MIDI_ENABLE = no
6MOUSEKEY_ENABLE = no
7NKRO_ENABLE = yes
8RGBLIGHT_ENABLE = no
9STENO_ENABLE = yes
10VIRTSER_ENABLE = yes
11
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-22 12:06:46 +0000