From 10c1e1b3abd5c91dd498610c985a9f4873a20288 Mon Sep 17 00:00:00 2001 From: yttyx Date: Wed, 27 May 2020 02:17:16 +0100 Subject: [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 --- keyboards/planck/keymaps/yttyx/README.md | 30 ++++++ keyboards/planck/keymaps/yttyx/config.h | 1 - keyboards/planck/keymaps/yttyx/keymap.c | 167 +++++++++++-------------------- keyboards/planck/keymaps/yttyx/readme.md | 68 ------------- keyboards/planck/keymaps/yttyx/rules.mk | 2 +- 5 files changed, 89 insertions(+), 179 deletions(-) create mode 100644 keyboards/planck/keymaps/yttyx/README.md delete mode 100644 keyboards/planck/keymaps/yttyx/readme.md (limited to 'keyboards/planck') 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 @@ +# Overview + +This layout uses a mirror variant of Balance 12, created by Sasha Viminitz. See [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/) +for more information. + +## To build + +``` +make planck/rev6:yttyx +``` + +## To build and flash + +``` +make planck/rev6:yttyx:flash +``` + +## Layers + +### Balance 12 base (BA) layer +![Base layer](https://i.imgur.com/I0TkIHT.png) + +### Numeric/Punctuation (NP) layer +![Numeric/Punctuation layer](https://i.imgur.com/GgZ0PCq.png) + +### Function/Cursor (FC) layer +![Function/Cursor layer](https://i.imgur.com/zcVID2d.png) + +### Plover (PL) layer +![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 @@ #define NO_ACTION_ONESHOT #define NO_ACTION_MACRO #define NO_ACTION_FUNCTION -#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 @@ #include QMK_KEYBOARD_H -#include +#include "keymap_steno.h" -enum planck_layers { - _BA, // Base (Balance Twelve mirror variant) - _PL, // Plover (http://opensteno.org) - _NP, // Numeric/punctuation - _FC // Function/cursor +enum layers { + _BA, // Base (Balance Twelve mirror variant) + _NP, // Numeric/Punctuation + _FC, // Function + _PL // Plover }; -enum planck_keycodes { - BA = SAFE_RANGE, - PL -}; - - // Abbreviations #define KX_SFT_Z MT(MOD_LSFT, KC_Z) -#define KX_SFT_X MT(MOD_RSFT, KC_X) +#define KX_SFT_X MT(MOD_LSFT, KC_X) #define LT_ESC_FC LT(_FC, KC_ESC) - const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { - /* BA - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | P | L | C | D | W | | | U | O | Y | K | Q | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | N | R | S | T | M | | BS | A | E | I | H | V | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | NP | Spc | Esc/FC | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - */ + /* Base + .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. + | P | L | C | D | W | | | U | O | Y | K | Q | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | N | R | S | T | M | | BS | A | E | I | H | V | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Ctl | Alt | Sup | NP | Spc | Esc FC | Sft | Sft | Sup | Alt | Ctl | | + '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' + */ [_BA] = LAYOUT_planck_grid( KC_P, KC_L, KC_C, KC_D, KC_W, XXXXXXX, XXXXXXX, KC_U, KC_O, KC_Y, KC_K, KC_Q, 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] = { KC_LCTL, KC_LALT, KC_LGUI, MO(_NP), KC_SPC, LT_ESC_FC, KC_LSFT, KC_LSFT, KC_LGUI, KC_LALT, KC_LCTL, XXXXXXX ), - /* Plover - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | # | # | # | # | # | BA | # | # | # | # | # | # | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | S | T | P | H | * | | * | F | P | L | T | D | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | S | K | W | R | * | | * | R | B | G | S | Z | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | | | | A | O | | E | U | | | | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - */ - [_PL] = LAYOUT_planck_grid( - STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, BA, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, - STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, XXXXXXX, STN_ST1, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR, - STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, XXXXXXX, STN_ST2, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR, - XXXXXXX, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, STN_E, STN_U, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX - ), - - /* Numeric/punctuation - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | BS | [ { | ] } | - _ | ; : | \ | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' + /* Numeric/Punctuation (NP) + .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. + | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | | [ { | ] } | - _ | ; : | \ | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | | + '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' */ [_NP] = LAYOUT_planck_grid( - KC_1, KC_2, KC_3, KC_4, KC_5, PL, XXXXXXX, KC_6, KC_7, KC_8, KC_9, KC_0, + KC_1, KC_2, KC_3, KC_4, KC_5, TO(_PL), XXXXXXX, KC_6, KC_7, KC_8, KC_9, KC_0, 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, KC_LSFT, XXXXXXX, XXXXXXX, KC_DEL, KC_INS, XXXXXXX, XXXXXXX, KC_SLSH, KC_EQL, KC_NUHS, KC_GRV, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX ), - /* Function/cursor - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - */ + /* Function/Cursor (FC) + .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. + | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | | + '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' + */ [_FC] = LAYOUT_planck_grid( KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, XXXXXXX, XXXXXXX, KC_HOME, KC_UP, KC_END, KC_PGUP, XXXXXXX, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, XXXXXXX, _______, XXXXXXX, XXXXXXX, KC_F11, KC_F12, XXXXXXX, XXXXXXX, KC_PSCR, KC_BRK, KC_SLCK, KC_CAPS, XXXXXXX, _______, _______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, XXXXXXX + ), + + /* Plover (PL) + .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. + | # | # | # | # | # | BA | # | # | # | # | # | # | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | S | T | P | H | * | | * | F | P | L | T | D | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | S | K | W | R | * | | * | R | B | G | S | Z | + |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + | | | | A | O | | E | U | | | | | + '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' + */ + [_PL] = LAYOUT_planck_grid( + STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, TO(_BA), STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, STN_NUM, + STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, XXXXXXX, STN_ST1, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR, + STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, XXXXXXX, STN_ST2, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR, + XXXXXXX, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, STN_E, STN_U, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX ) }; - -#ifdef AUDIO_ENABLE - float plover_on[][2] = SONG(PLOVER_SOUND); - float plover_off[][2] = SONG(PLOVER_GOODBYE_SOUND); -#endif - -bool process_record_user(uint16_t keycode, keyrecord_t *record) { - switch (keycode) { - case PL: - if (record->event.pressed) { - #ifdef AUDIO_ENABLE - stop_all_notes(); - PLAY_SONG(plover_on); - #endif - - layer_off(_NP); - layer_off(_FC); - layer_on(_PL); - - if (!eeconfig_is_enabled()) { - eeconfig_init(); - } - - keymap_config.raw = eeconfig_read_keymap(); - keymap_config.nkro = 1; - eeconfig_update_keymap(keymap_config.raw); - } - return false; - case BA: - if (record->event.pressed) { - #ifdef AUDIO_ENABLE - PLAY_SONG(plover_off); - #endif - - layer_off(_NP); - layer_off(_PL); - layer_off(_FC); - } - return false; - } - return true; -} - void matrix_init_user() { steno_set_mode(STENO_MODE_GEMINI); } - 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 @@ -# Overview - -* Base layer uses the Balance Twelve layout ([reference](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/)) -* Plover layer uses the same home position as the base layer ([reference](http://www.openstenoproject.org/)) - -## To build - -``` -make planck/rev6:yttyx -``` - -## To build and flash - -``` -make planck/rev6:yttyx:dfu-util -``` - -## Layers - -### Base - - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | P | L | C | D | W | | | U | O | Y | K | Q | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | N | R | S | T | M | | BS | A | E | I | H | V | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Z Sft | J | F | G | B | | Ent | ' @ | , < | . > | X Sft | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | NP | Spc | Esc/FC | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - -### Plover - - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | # | # | # | # | # | BA | # | # | # | # | # | # | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | S | T | P | H | * | | * | F | P | L | T | D | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | S | K | W | R | * | | * | R | B | G | S | Z | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | | | | A | O | | E | U | | | | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - -### Numeric/Punctuation - - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | 1 ! | 2 " | 3 £ | 4 $ | 5 % | PL | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | BS | [ { | ] } | - _ | ; : | \ | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Sft | | | Del | Ins | | | / ? | = + | # ~ | ` | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | NP | Spc | | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - -### Function - - .--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------.--------. - | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | PgUp | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | F6 | F7 | F8 | F9 | F10 | | | Left | Down | Right | PgDn | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Sft | | | F11 | F12 | | | PScr | Break | ScLk | Caps | | - |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| - | Ctl | Alt | Sup | | Spc | | Sft | Sft | Sup | Alt | Ctl | | - '--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------'--------' - - 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 @@ # Build Options -AUDIO_ENABLE = yes +AUDIO_ENABLE = no CONSOLE_ENABLE = no EXTRAKEY_ENABLE = no MIDI_ENABLE = no -- cgit v1.2.3