aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryttyx <yttyx@users.noreply.github.com>2020-05-27 02:17:16 +0100
committerGitHub <noreply@github.com>2020-05-27 02:17:16 +0100
commit10c1e1b3abd5c91dd498610c985a9f4873a20288 (patch)
tree131ddbfe3810b72a635476b228675666d3bb2966
parent00c1401d3c3b6d5d672719f21795c10a387d15c8 (diff)
downloadqmk_firmware-10c1e1b3abd5c91dd498610c985a9f4873a20288.tar.gz
qmk_firmware-10c1e1b3abd5c91dd498610c985a9f4873a20288.zip
[Keymap] Update yttyx Planck keymap (#9191)
* Normalise layout and README from yttyx niu keymap. * Correct case of README. * Changes following review. Co-authored-by: Nick Willis <nick@theb.org.uk>
-rw-r--r--keyboards/planck/keymaps/yttyx/README.md30
-rw-r--r--keyboards/planck/keymaps/yttyx/config.h1
-rw-r--r--keyboards/planck/keymaps/yttyx/keymap.c167
-rw-r--r--keyboards/planck/keymaps/yttyx/readme.md68
-rw-r--r--keyboards/planck/keymaps/yttyx/rules.mk2
5 files changed, 89 insertions, 179 deletions
diff --git a/keyboards/planck/keymaps/yttyx/README.md b/keyboards/planck/keymaps/yttyx/README.md
new file mode 100644
index 000000000..963438e3b
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/README.md
@@ -0,0 +1,30 @@
1# Overview
2
3This layout uses a mirror variant of Balance 12, created by Sasha Viminitz. See [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/)
4for more information.
5
6## To build
7
8```
9make planck/rev6:yttyx
10```
11
12## To build and flash
13
14```
15make planck/rev6:yttyx:flash
16```
17
18## Layers
19
20### Balance 12 base (BA) layer
21![Base layer](https://i.imgur.com/I0TkIHT.png)
22
23### Numeric/Punctuation (NP) layer
24![Numeric/Punctuation layer](https://i.imgur.com/GgZ0PCq.png)
25
26### Function/Cursor (FC) layer
27![Function/Cursor layer](https://i.imgur.com/zcVID2d.png)
28
29### Plover (PL) layer
30![Plover layer](https://i.imgur.com/RikOGXe.png)
diff --git a/keyboards/planck/keymaps/yttyx/config.h b/keyboards/planck/keymaps/yttyx/config.h
index 88d0c07e9..b9e113ec0 100644
--- a/keyboards/planck/keymaps/yttyx/config.h
+++ b/keyboards/planck/keymaps/yttyx/config.h
@@ -2,4 +2,3 @@
2#define NO_ACTION_ONESHOT 2#define NO_ACTION_ONESHOT
3#define NO_ACTION_MACRO 3#define NO_ACTION_MACRO
4#define NO_ACTION_FUNCTION 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
index 0fcbae892..fa2a95a89 100644
--- a/keyboards/planck/keymaps/yttyx/keymap.c
+++ b/keyboards/planck/keymaps/yttyx/keymap.c
@@ -1,39 +1,32 @@
1 1
2#include QMK_KEYBOARD_H 2#include QMK_KEYBOARD_H
3#include <keymap_steno.h> 3#include "keymap_steno.h"
4 4
5enum planck_layers { 5enum layers {
6 _BA, // Base (Balance Twelve mirror variant) 6 _BA, // Base (Balance Twelve mirror variant)
7 _PL, // Plover (http://opensteno.org) 7 _NP, // Numeric/Punctuation
8 _NP, // Numeric/punctuation 8 _FC, // Function
9 _FC // Function/cursor 9 _PL // Plover
10}; 10};
11 11
12enum planck_keycodes {
13 BA = SAFE_RANGE,
14 PL
15};
16
17
18// Abbreviations 12// Abbreviations
19#define KX_SFT_Z MT(MOD_LSFT, KC_Z) 13#define KX_SFT_Z MT(MOD_LSFT, KC_Z)
20#define KX_SFT_X MT(MOD_RSFT, KC_X) 14#define KX_SFT_X MT(MOD_LSFT, KC_X)
21#define LT_ESC_FC LT(_FC, KC_ESC) 15#define LT_ESC_FC LT(_FC, KC_ESC)
22 16
23
24const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { 17const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
25 18
26 /* BA 19 /* Base
27 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. 20 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
28 | P | L | C | D | W | | | U | O | Y | K | Q | 21 | P | L | C | D | W | | | U | O | Y | K | Q |
29 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 22 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
30 | N | R | S | T | M | | BS | A | E | I | H | V | 23 | N | R | S | T | M | | BS | A | E | I | H | V |
31 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 24 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
32 | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | | 25 | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | |
33 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 26 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
34 | Ctl | Alt | Sup | NP | Spc | Esc/FC | Sft | Sft | Sup | Alt | Ctl | | 27 | Ctl | Alt | Sup | NP | Spc | Esc FC | Sft | Sft | Sup | Alt | Ctl | |
35 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' 28 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
36 */ 29 */
37 [_BA] = LAYOUT_planck_grid( 30 [_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, 31 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, 32 KC_N, KC_R, KC_S, KC_T, KC_M, XXXXXXX, KC_BSPC, KC_A, KC_E, KC_I, KC_H, KC_V,
@@ -41,106 +34,62 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
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 34 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 ), 35 ),
43 36
44 /* Plover 37 /* Numeric/Punctuation (NP)
45 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. 38 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
46 | # | # | # | # | # | BA | # | # | # | # | # | # | 39 | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) |
47 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 40 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
48 | S | T | P | H | * | | * | F | P | L | T | D | 41 | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | | [ { | ] } | - _ | ; : | \ | |
49 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 42 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
50 | S | K | W | R | * | | * | R | B | G | S | Z | 43 | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | |
51 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 44 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
52 | | | | A | O | | E | U | | | | | 45 | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | |
53 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' 46 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
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 */ 47 */
73 [_NP] = LAYOUT_planck_grid( 48 [_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, 49 KC_1, KC_2, KC_3, KC_4, KC_5, TO(_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, 50 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, 51 KC_LSFT, XXXXXXX, XXXXXXX, KC_DEL, KC_INS, XXXXXXX, XXXXXXX, KC_SLSH, KC_EQL, KC_NUHS, KC_GRV, XXXXXXX,
77 _______, _______, _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX 52 _______, _______, _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX
78 ), 53 ),
79 54
80 /* Function/cursor 55 /* Function/Cursor (FC)
81 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. 56 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
82 | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | | 57 | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | |
83 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 58 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
84 | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | | 59 | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | |
85 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 60 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
86 | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | | 61 | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | |
87 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| 62 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
88 | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | | 63 | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | |
89 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' 64 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
90 */ 65 */
91 [_FC] = LAYOUT_planck_grid( 66 [_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, 67 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, 68 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, 69 _______, XXXXXXX, XXXXXXX, KC_F11, KC_F12, XXXXXXX, XXXXXXX, KC_PSCR, KC_BRK, KC_SLCK, KC_CAPS, XXXXXXX,
95 _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, XXXXXXX 70 _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, XXXXXXX
71 ),
72
73 /* Plover (PL)
74 .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.
75 | # | # | # | # | # | BA | # | # | # | # | # | # |
76 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
77 | S | T | P | H | * | | * | F | P | L | T | D |
78 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
79 | S | K | W | R | * | | * | R | B | G | S | Z |
80 |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
81 | | | | A | O | | E | U | | | | |
82 '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'
83 */
84 [_PL] = LAYOUT_planck_grid(
85 STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, TO(_BA), STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM,
86 STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, XXXXXXX, STN_ST1, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR,
87 STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, XXXXXXX, STN_ST2, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR,
88 XXXXXXX, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, STN_E, STN_U, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
96 ) 89 )
97 90
98}; 91};
99 92
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() { 93void matrix_init_user() {
144 steno_set_mode(STENO_MODE_GEMINI); 94 steno_set_mode(STENO_MODE_GEMINI);
145} 95}
146
diff --git a/keyboards/planck/keymaps/yttyx/readme.md b/keyboards/planck/keymaps/yttyx/readme.md
deleted file mode 100644
index 6661c3170..000000000
--- a/keyboards/planck/keymaps/yttyx/readme.md
+++ /dev/null
@@ -1,68 +0,0 @@
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
index 27dac6d4d..94f639279 100644
--- a/keyboards/planck/keymaps/yttyx/rules.mk
+++ b/keyboards/planck/keymaps/yttyx/rules.mk
@@ -1,5 +1,5 @@
1# Build Options 1# Build Options
2AUDIO_ENABLE = yes 2AUDIO_ENABLE = no
3CONSOLE_ENABLE = no 3CONSOLE_ENABLE = no
4EXTRAKEY_ENABLE = no 4EXTRAKEY_ENABLE = no
5MIDI_ENABLE = no 5MIDI_ENABLE = no