Add TX Bolt protocol support for Stenography

Requires virtser; Allows QMK to speak the TX BOlt protocol used by stenography machines and software (such as Plover). The upside is that Plover can be configured to listen only to TX Bolt allow the keyboard to switch layers without need to enable/disable the Plover software, or to have a second non-Steno keyboard work concurrently.
author: Joe Wasson <jwasson+github@gmail.com> 2017-07-26 14:41:39 -0700
committer: Jack Humbert <jack.humb@gmail.com> 2017-07-27 16:10:36 -0400
commit: 5987f67989c1b8f5fbd108d4dae21a227bc2f99c (patch)
tree: 32bee84bf7265d0fce7c924db38021b08ea5cbb2 /keyboards
parent: cefc09ae7dd88cd6b92412881888404da1abdfcb (diff)
download: qmk_firmware-5987f67989c1b8f5fbd108d4dae21a227bc2f99c.tar.gz
qmk_firmware-5987f67989c1b8f5fbd108d4dae21a227bc2f99c.zip
7 files changed, 321 insertions, 19 deletions
diff --git a/keyboards/planck/keymaps/experimental/Makefile b/keyboards/planck/keymaps/experimental/Makefile
index 3a8250a9b..29108e522 100644
--- a/keyboards/planck/keymaps/experimental/Makefile
+++ b/keyboards/planck/keymaps/experimental/Makefile
@@ -1,11 +1,11 @@
 # Build Options
-#   change to "no" to disable the options, or define them in the Makefile in 
+#   change to "no" to disable the options, or define them in the Makefile in
 #   the appropriate keymap folder that will get included automatically
 #
 BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
-MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
 EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 CONSOLE_ENABLE = no         # Console for debug(+400)
 COMMAND_ENABLE = yes        # Commands for debug and configuration
@@ -17,6 +17,7 @@ UNICODE_ENABLE = no         # Unicode
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = yes        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
 ONEHAND_ENABLE = yes        # Enable one-hand typing
+STENO_ENABLE = yes                                      # Enable TX Bolt protocol for Stenography, requires VIRTSER and may not work with mouse keys
 # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
diff --git a/keyboards/planck/keymaps/experimental/config.h b/keyboards/planck/keymaps/experimental/config.h
index 492490ca1..0864b5fbc 100644
--- a/keyboards/planck/keymaps/experimental/config.h
+++ b/keyboards/planck/keymaps/experimental/config.h
@@ -5,6 +5,7 @@
 #define LEADER_TIMEOUT 300
 #define BACKLIGHT_BREATHING
+#define PREVENT_STUCK_MODIFIERS
 /* ws2812 RGB LED */
diff --git a/keyboards/planck/keymaps/experimental/keymap.c b/keyboards/planck/keymaps/experimental/keymap.c
index 17fad784e..2d648b211 100644
--- a/keyboards/planck/keymaps/experimental/keymap.c
+++ b/keyboards/planck/keymaps/experimental/keymap.c
@@ -3,6 +3,7 @@
 #include "planck.h"
 #include "action_layer.h"
+#include "keymap_steno.h"
 #ifdef AUDIO_ENABLE
  #include "audio.h"
 #endif
@@ -49,7 +50,7 @@ enum planck_keycodes {
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 [0] = {
-  {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
+  {QWERTY, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL}
@@ -158,10 +159,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 */
 [_PLOVER] = {
-  {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
+  {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
-  {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
+  {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
-  {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
-  {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
+  {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
 },
 /* Adjust (Lower + Raise)
@@ -279,21 +280,12 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
        break;
      return false;
        case PLOVER:
-          if (record->event.pressed) {
+          if (!record->event.pressed) {
            #ifdef AUDIO_ENABLE
              stop_all_notes();
              PLAY_NOTE_ARRAY(tone_plover, false, 0);
            #endif
-            layer_off(_RAISE);
-            layer_off(_LOWER);
-            layer_off(_ADJUST);
            layer_on(_PLOVER);
-            if (!eeconfig_is_enabled()) {
-                eeconfig_init();
-            }
-            keymap_config.raw = eeconfig_read_keymap();
-            keymap_config.nkro = 1;
-            eeconfig_update_keymap(keymap_config.raw);
          }
        break;
      return false;
@@ -397,9 +389,9 @@ void music_scale_user(void)
 LEADER_EXTERNS();
 void matrix_scan_user(void) {
-  LEADER_DICTIONARY() { 
+  LEADER_DICTIONARY() {
    leading = false;
-    leader_end(); 
+    leader_end();
    SEQ_ONE_KEY (KC_R) {
      tap_random_base64();
diff --git a/keyboards/planck/keymaps/steno/Makefile b/keyboards/planck/keymaps/steno/Makefile
new file mode 100644
index 000000000..3ed9d2db4
--- /dev/null
+++ b/keyboards/planck/keymaps/steno/Makefile
@@ -0,0 +1,7 @@
+ifndef QUANTUM_DIR
+        include ../../../../Makefile
+endif
+MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
+STENO_ENABLE = yes                                      # Enable TX Bolt protocol for Stenography, requires VIRTSER and may not work with mouse keys
diff --git a/keyboards/planck/keymaps/steno/config.h b/keyboards/planck/keymaps/steno/config.h
new file mode 100644
index 000000000..1879ab007
--- /dev/null
+++ b/keyboards/planck/keymaps/steno/config.h
@@ -0,0 +1,44 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+#include "../../config.h"
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PLANCK_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+#define MUSIC_MASK (keycode != KC_NO)
+#define PREVENT_STUCK_MODIFIERS
+/*
+ * MIDI options
+ */
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+#define MIDI_BASIC
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 2
+#endif
+\ No newline at end of file
diff --git a/keyboards/planck/keymaps/steno/keymap.c b/keyboards/planck/keymaps/steno/keymap.c
new file mode 100644
index 000000000..b4e30169f
--- /dev/null
+++ b/keyboards/planck/keymaps/steno/keymap.c
@@ -0,0 +1,253 @@
+/* Copyright 2015-2017 Jack Humbert
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include "planck.h"
+#include "action_layer.h"
+#include "keymap_steno.h"
+extern keymap_config_t keymap_config;
+enum planck_layers {
+  _QWERTY,
+  _COLEMAK,
+  _DVORAK,
+  _LOWER,
+  _RAISE,
+  _PLOVER,
+  _ADJUST
+};
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  DVORAK,
+  PLOVER,
+  LOWER,
+  RAISE,
+  BACKLIT,
+  EXT_PLV
+};
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
+  {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
+  {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+/* Colemak
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_COLEMAK] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
+  {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
+  {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+/* Dvorak
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_DVORAK] = {
+  {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
+  {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
+  {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
+  {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = {
+  {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY}
+},
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = {
+  {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
+},
+/* Plover layer (http://opensteno.org)
+ * ,-----------------------------------------------------------------------------------.
+ * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |  FN  |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Exit |      |      |   A  |   O  |             |   E  |   U  |  PWR | RES1 | RES2 |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_PLOVER] = {
+  {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
+  {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
+  {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
+  {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
+},
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |TXBOLT|GEM RP|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = {
+  {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
+  {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
+  {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
+}
+};
+#ifdef AUDIO_ENABLE
+  float plover_song[][2]     = SONG(PLOVER_SOUND);
+  float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
+#endif
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+      break;
+    case COLEMAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_COLEMAK);
+      }
+      return false;
+      break;
+    case DVORAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_DVORAK);
+      }
+      return false;
+      break;
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case BACKLIT:
+      if (record->event.pressed) {
+        register_code(KC_RSFT);
+        #ifdef BACKLIGHT_ENABLE
+          backlight_step();
+        #endif
+      } else {
+        unregister_code(KC_RSFT);
+      }
+      return false;
+      break;
+    case PLOVER:
+      if (!record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          stop_all_notes();
+          PLAY_SONG(plover_song);
+        #endif
+        layer_on(_PLOVER);
+      }
+      return false;
+      break;
+    case EXT_PLV:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_gb_song);
+        #endif
+        layer_off(_PLOVER);
+      }
+      return false;
+      break;
+  }
+  return true;
+}
+\ No newline at end of file
diff --git a/keyboards/planck/keymaps/steno/readme.md b/keyboards/planck/keymaps/steno/readme.md
new file mode 100644
index 000000000..e8ffd9756
--- /dev/null
+++ b/keyboards/planck/keymaps/steno/readme.md
@@ -0,0 +1,4 @@
+# The Default Planck Layout with TX Bolt for the Plover Layer
+To use set Plover to TX Bolt and select the COM port that represents your keyboard.
author	Joe Wasson <jwasson+github@gmail.com>	2017-07-26 14:41:39 -0700
committer	Jack Humbert <jack.humb@gmail.com>	2017-07-27 16:10:36 -0400
commit	5987f67989c1b8f5fbd108d4dae21a227bc2f99c (patch)
tree	32bee84bf7265d0fce7c924db38021b08ea5cbb2 /keyboards
parent	cefc09ae7dd88cd6b92412881888404da1abdfcb (diff)
download	qmk_firmware-5987f67989c1b8f5fbd108d4dae21a227bc2f99c.tar.gz qmk_firmware-5987f67989c1b8f5fbd108d4dae21a227bc2f99c.zip

diff --git a/keyboards/planck/keymaps/experimental/Makefile b/keyboards/planck/keymaps/experimental/Makefile index 3a8250a9b..29108e522 100644 --- a/keyboards/planck/keymaps/experimental/Makefile +++ b/keyboards/planck/keymaps/experimental/Makefile
@@ -1,11 +1,11 @@
1		1
2		2
3	# Build Options	3	# Build Options
4	# change to "no" to disable the options, or define them in the Makefile in	4	# change to "no" to disable the options, or define them in the Makefile in
5	# the appropriate keymap folder that will get included automatically	5	# the appropriate keymap folder that will get included automatically
6	#	6	#
7	BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)	7	BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
8	MOUSEKEY_ENABLE = yes # Mouse keys(+4700)	8	MOUSEKEY_ENABLE = no # Mouse keys(+4700)
9	EXTRAKEY_ENABLE = yes # Audio control and System control(+450)	9	EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
10	CONSOLE_ENABLE = no # Console for debug(+400)	10	CONSOLE_ENABLE = no # Console for debug(+400)
11	COMMAND_ENABLE = yes # Commands for debug and configuration	11	COMMAND_ENABLE = yes # Commands for debug and configuration
@@ -17,6 +17,7 @@ UNICODE_ENABLE = no # Unicode
17	BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID	17	BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
18	RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight. Do not enable this with audio at the same time.	18	RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight. Do not enable this with audio at the same time.
19	ONEHAND_ENABLE = yes # Enable one-hand typing	19	ONEHAND_ENABLE = yes # Enable one-hand typing
		20	STENO_ENABLE = yes # Enable TX Bolt protocol for Stenography, requires VIRTSER and may not work with mouse keys
20		21
21	# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE	22	# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
22	SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend	23	SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend


diff --git a/keyboards/planck/keymaps/experimental/config.h b/keyboards/planck/keymaps/experimental/config.h index 492490ca1..0864b5fbc 100644 --- a/keyboards/planck/keymaps/experimental/config.h +++ b/keyboards/planck/keymaps/experimental/config.h
@@ -5,6 +5,7 @@
5		5
6	#define LEADER_TIMEOUT 300	6	#define LEADER_TIMEOUT 300
7	#define BACKLIGHT_BREATHING	7	#define BACKLIGHT_BREATHING
		8	#define PREVENT_STUCK_MODIFIERS
8		9
9		10
10	/* ws2812 RGB LED */	11	/* ws2812 RGB LED */


diff --git a/keyboards/planck/keymaps/experimental/keymap.c b/keyboards/planck/keymaps/experimental/keymap.c index 17fad784e..2d648b211 100644 --- a/keyboards/planck/keymaps/experimental/keymap.c +++ b/keyboards/planck/keymaps/experimental/keymap.c
@@ -3,6 +3,7 @@
3		3
4	#include "planck.h"	4	#include "planck.h"
5	#include "action_layer.h"	5	#include "action_layer.h"
		6	#include "keymap_steno.h"
6	#ifdef AUDIO_ENABLE	7	#ifdef AUDIO_ENABLE
7	#include "audio.h"	8	#include "audio.h"
8	#endif	9	#endif
@@ -49,7 +50,7 @@ enum planck_keycodes {
49		50
50	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {	51	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
51	[0] = {	52	[0] = {
52	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},	53	{QWERTY, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
53	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},	54	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
54	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},	55	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
55	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL}	56	{KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL}
@@ -158,10 +159,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
158	*/	159	*/
159		160
160	[_PLOVER] = {	161	[_PLOVER] = {
161	{KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },	162	{STN_N1, STN_N2, STN_N3, STN_N4, STN_N5, STN_N6, STN_N7, STN_N8, STN_N9, STN_NA, STN_NB, STN_NC },
162	{XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},	163	{STN_FN, STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, STN_ST3, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR },
163	{XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},	164	{XXXXXXX, STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, STN_ST4, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR },
164	{EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}	165	{EXT_PLV, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, XXXXXXX, STN_E, STN_U, STN_PWR, STN_RE1, STN_RE2}
165	},	166	},
166		167
167	/* Adjust (Lower + Raise)	168	/* Adjust (Lower + Raise)
@@ -279,21 +280,12 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
279	break;	280	break;
280	return false;	281	return false;
281	case PLOVER:	282	case PLOVER:
282	if (record->event.pressed) {	283	if (!record->event.pressed) {
283	#ifdef AUDIO_ENABLE	284	#ifdef AUDIO_ENABLE
284	stop_all_notes();	285	stop_all_notes();
285	PLAY_NOTE_ARRAY(tone_plover, false, 0);	286	PLAY_NOTE_ARRAY(tone_plover, false, 0);
286	#endif	287	#endif
287	layer_off(_RAISE);
288	layer_off(_LOWER);
289	layer_off(_ADJUST);
290	layer_on(_PLOVER);	288	layer_on(_PLOVER);
291	if (!eeconfig_is_enabled()) {
292	eeconfig_init();
293	}
294	keymap_config.raw = eeconfig_read_keymap();
295	keymap_config.nkro = 1;
296	eeconfig_update_keymap(keymap_config.raw);
297	}	289	}
298	break;	290	break;
299	return false;	291	return false;
@@ -397,9 +389,9 @@ void music_scale_user(void)
397	LEADER_EXTERNS();	389	LEADER_EXTERNS();
398		390
399	void matrix_scan_user(void) {	391	void matrix_scan_user(void) {
400	LEADER_DICTIONARY() {	392	LEADER_DICTIONARY() {
401	leading = false;	393	leading = false;
402	leader_end();	394	leader_end();
403		395
404	SEQ_ONE_KEY (KC_R) {	396	SEQ_ONE_KEY (KC_R) {
405	tap_random_base64();	397	tap_random_base64();


diff --git a/keyboards/planck/keymaps/steno/Makefile b/keyboards/planck/keymaps/steno/Makefile new file mode 100644 index 000000000..3ed9d2db4 --- /dev/null +++ b/keyboards/planck/keymaps/steno/Makefile
@@ -0,0 +1,7 @@
		1	ifndef QUANTUM_DIR
		2	include ../../../../Makefile
		3	endif
		4
		5	MOUSEKEY_ENABLE = no # Mouse keys(+4700)
		6	STENO_ENABLE = yes # Enable TX Bolt protocol for Stenography, requires VIRTSER and may not work with mouse keys
		7


diff --git a/keyboards/planck/keymaps/steno/config.h b/keyboards/planck/keymaps/steno/config.h new file mode 100644 index 000000000..1879ab007 --- /dev/null +++ b/keyboards/planck/keymaps/steno/config.h
@@ -0,0 +1,44 @@
		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	#define PREVENT_STUCK_MODIFIERS
		19
		20	/*
		21	* MIDI options
		22	*/
		23
		24	/* Prevent use of disabled MIDI features in the keymap */
		25	//#define MIDI_ENABLE_STRICT 1
		26
		27	/* enable basic MIDI features:
		28	- MIDI notes can be sent when in Music mode is on
		29	*/
		30
		31	#define MIDI_BASIC
		32
		33	/* enable advanced MIDI features:
		34	- MIDI notes can be added to the keymap
		35	- Octave shift and transpose
		36	- Virtual sustain, portamento, and modulation wheel
		37	- etc.
		38	*/
		39	//#define MIDI_ADVANCED
		40
		41	/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
		42	//#define MIDI_TONE_KEYCODE_OCTAVES 2
		43
		44	#endif \ No newline at end of file


diff --git a/keyboards/planck/keymaps/steno/keymap.c b/keyboards/planck/keymaps/steno/keymap.c new file mode 100644 index 000000000..b4e30169f --- /dev/null +++ b/keyboards/planck/keymaps/steno/keymap.c
@@ -0,0 +1,253 @@
		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	#include "keymap_steno.h"
		20
		21	extern keymap_config_t keymap_config;
		22
		23	enum planck_layers {
		24	_QWERTY,
		25	_COLEMAK,
		26	_DVORAK,
		27	_LOWER,
		28	_RAISE,
		29	_PLOVER,
		30	_ADJUST
		31	};
		32
		33	enum planck_keycodes {
		34	QWERTY = SAFE_RANGE,
		35	COLEMAK,
		36	DVORAK,
		37	PLOVER,
		38	LOWER,
		39	RAISE,
		40	BACKLIT,
		41	EXT_PLV
		42	};
		43
		44	const 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] = {
		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] = {
		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] = {
		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	* \| ~ \| ! \| @ \| # \| $ \| % \| ^ \| & \| * \| ( \| ) \| Bksp \|
		103	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
		104	* \| Del \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| _ \| + \| { \| } \| \| \|
		105	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
		106	* \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|ISO ~ \|ISO \| \| Home \| End \| \|
		107	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
		108	* \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
		109	* `-----------------------------------------------------------------------------------'
		110	*/
		111	[_LOWER] = {
		112	{KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
		113	{KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
		114	{_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______},
		115	{_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
		116	},
		117
		118	/* Raise
		119	* ,-----------------------------------------------------------------------------------.
		120	* \| ` \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 0 \| Bksp \|
		121	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
		122	* \| Del \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| - \| = \| [ \| ] \| \ \|
		123	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
		124	* \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|ISO # \|ISO / \|Pg Up \|Pg Dn \| \|
		125	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
		126	* \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
		127	* `-----------------------------------------------------------------------------------'
		128	*/
		129	[_RAISE] = {
		130	{KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
		131	{KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
		132	{_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
		133	{_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
		134	},
		135
		136	/* Plover layer (http://opensteno.org)
		137	* ,-----------------------------------------------------------------------------------.
		138	* \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \|
		139	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
		140	* \| FN \| 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 \| PWR \| RES1 \| RES2 \|
		145	* `-----------------------------------------------------------------------------------'
		146	*/
		147
		148	[_PLOVER] = {
		149	{STN_N1, STN_N2, STN_N3, STN_N4, STN_N5, STN_N6, STN_N7, STN_N8, STN_N9, STN_NA, STN_NB, STN_NC },
		150	{STN_FN, STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, STN_ST3, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR },
		151	{XXXXXXX, STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, STN_ST4, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR },
		152	{EXT_PLV, XXXXXXX, XXXXXXX, STN_A, STN_O, XXXXXXX, XXXXXXX, STN_E, STN_U, STN_PWR, STN_RE1, STN_RE2}
		153	},
		154
		155	/* Adjust (Lower + Raise)
		156	* ,-----------------------------------------------------------------------------------.
		157	* \| \| Reset\| \| \| \| \| \| \| \| \| \| Del \|
		158	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
		159	* \| \| \| \|Aud on\|Audoff\|AGnorm\|AGswap\|Qwerty\|Colemk\|Dvorak\|Plover\| \|
		160	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
		161	* \| \|Voice-\|Voice+\|Mus on\|Musoff\|MIDIon\|MIDIof\| \| \| \|TXBOLT\|GEM RP\|
		162	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
		163	* \| \| \| \| \| \| \| \| \| \| \| \|
		164	* `-----------------------------------------------------------------------------------'
		165	*/
		166	[_ADJUST] = {
		167	{_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, 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, _______, _______, _______, _______, _______},
		170	{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
		171	}
		172
		173
		174	};
		175
		176	#ifdef AUDIO_ENABLE
		177	float plover_song[][2] = SONG(PLOVER_SOUND);
		178	float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
		179	#endif
		180
		181	bool process_record_user(uint16_t keycode, keyrecord_t *record) {
		182	switch (keycode) {
		183	case QWERTY:
		184	if (record->event.pressed) {
		185	set_single_persistent_default_layer(_QWERTY);
		186	}
		187	return false;
		188	break;
		189	case COLEMAK:
		190	if (record->event.pressed) {
		191	set_single_persistent_default_layer(_COLEMAK);
		192	}
		193	return false;
		194	break;
		195	case DVORAK:
		196	if (record->event.pressed) {
		197	set_single_persistent_default_layer(_DVORAK);
		198	}
		199	return false;
		200	break;
		201	case LOWER:
		202	if (record->event.pressed) {
		203	layer_on(_LOWER);
		204	update_tri_layer(_LOWER, _RAISE, _ADJUST);
		205	} else {
		206	layer_off(_LOWER);
		207	update_tri_layer(_LOWER, _RAISE, _ADJUST);
		208	}
		209	return false;
		210	break;
		211	case RAISE:
		212	if (record->event.pressed) {
		213	layer_on(_RAISE);
		214	update_tri_layer(_LOWER, _RAISE, _ADJUST);
		215	} else {
		216	layer_off(_RAISE);
		217	update_tri_layer(_LOWER, _RAISE, _ADJUST);
		218	}
		219	return false;
		220	break;
		221	case BACKLIT:
		222	if (record->event.pressed) {
		223	register_code(KC_RSFT);
		224	#ifdef BACKLIGHT_ENABLE
		225	backlight_step();
		226	#endif
		227	} else {
		228	unregister_code(KC_RSFT);
		229	}
		230	return false;
		231	break;
		232	case PLOVER:
		233	if (!record->event.pressed) {
		234	#ifdef AUDIO_ENABLE
		235	stop_all_notes();
		236	PLAY_SONG(plover_song);
		237	#endif
		238	layer_on(_PLOVER);
		239	}
		240	return false;
		241	break;
		242	case EXT_PLV:
		243	if (record->event.pressed) {
		244	#ifdef AUDIO_ENABLE
		245	PLAY_SONG(plover_gb_song);
		246	#endif
		247	layer_off(_PLOVER);
		248	}
		249	return false;
		250	break;
		251	}
		252	return true;
		253	} \ No newline at end of file


diff --git a/keyboards/planck/keymaps/steno/readme.md b/keyboards/planck/keymaps/steno/readme.md new file mode 100644 index 000000000..e8ffd9756 --- /dev/null +++ b/keyboards/planck/keymaps/steno/readme.md
@@ -0,0 +1,4 @@
		1	# The Default Planck Layout with TX Bolt for the Plover Layer
		2
		3	To use set Plover to TX Bolt and select the COM port that represents your keyboard.
		4