keyboards/ergodox/ez/keymaps/steno/readme.md

   1 # ErgoDox EZ Steno Configuration
   2
   3 This layout has a layer that uses the TxBolt Stenograph protocol over a Virtual Serial port. It requires something like Plover in order to function.
   4
   5 In Plover, you can select TX Bolt as the Stenotype Machine, and find the COM port that was assigned. In this way, your regular keyboard will still function normally, and you can switch back and forth between the Steno and Keyboard layers.
   6
   7 <pre><code>
   8 /* Keymap 0: Basic layer
   9  *
  10  * ,--------------------------------------------------.           ,--------------------------------------------------.
  11  * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
  12  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  13  * | Del    |   Q  |   W  |   E  |   R  |   T  |  L1  |           |  TX  |   Y  |   U  |   I  |   O  |   P  |   \    |
  14  * |--------+------+------+------+------+------|      |           | BOLT |------+------+------+------+------+--------|
  15  * | BkSp   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |; / L2|' / Cmd |
  16  * |--------+------+------+------+------+------| Hyper|           | Meh  |------+------+------+------+------+--------|
  17  * | LShift |Z/Ctrl|   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |//Ctrl| RShift |
  18  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  19  *   |Grv/L1|  '"  |AltShf| Left | Right|                                       |  Up  | Down |   [  |   ]  | ~L1  |
  20  *   `----------------------------------'                                       `----------------------------------'
  21  *                                        ,-------------.       ,-------------.
  22  *                                        | App  | LGui |       | Alt  |Ctrl/Esc|
  23  *                                 ,------|------|------|       |------+--------+------.
  24  *                                 |      |      | Home |       | PgUp |        |      |
  25  *                                 | Space|Backsp|------|       |------|  Tab   |Enter |
  26  *                                 |      |ace   | End  |       | PgDn |        |      |
  27  *                                 `--------------------'       `----------------------'
  28  */
  29 /* Keymap 1: Symbol Layer
  30  *
  31  * ,--------------------------------------------------.           ,--------------------------------------------------.
  32  * |Version |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
  33  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  34  * |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
  35  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  36  * |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
  37  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  38  * |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
  39  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  40  *   |      |      |      |      |      |                                       |      |    . |   0  |   =  |      |
  41  *   `----------------------------------'                                       `----------------------------------'
  42  *                                        ,-------------.       ,-------------.
  43  *                                        |      |      |       |      |      |
  44  *                                 ,------|------|------|       |------+------+------.
  45  *                                 |      |      |      |       |      |      |      |
  46  *                                 |      |      |------|       |------|      |      |
  47  *                                 |      |      |      |       |      |      |      |
  48  *                                 `--------------------'       `--------------------'
  49  */
  50 /* Keymap 2: Media keys
  51  *
  52  * ,--------------------------------------------------.           ,--------------------------------------------------.
  53  * | RESET  |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  54  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  55  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  56  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  57  * |        |      |      |      |      |      |------|           |------|      |      |      |      |      |  Play  |
  58  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  59  * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
  60  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  61  *   |      |      |      |      |      |                                       |VolUp |VolDn | Mute |      |      |
  62  *   `----------------------------------'                                       `----------------------------------'
  63  *                                        ,-------------.       ,-------------.
  64  *                                        |      |      |       |      |      |
  65  *                                 ,------|------|------|       |------+------+------.
  66  *                                 |      |      |      |       |      |      |Brwser|
  67  *                                 |      |      |------|       |------|      |Back  |
  68  *                                 |      |      |      |       |      |      |      |
  69  *                                 `--------------------'       `--------------------'
  70  */
  71 /* Keymap 3: TxBolt (Serial)
  72  *
  73  * ,--------------------------------------------------.           ,--------------------------------------------------.
  74  * | BKSPC  |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  75  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  76  * |        |   #  |   #  |   #  |   #  |   #  |      |           |      |   #  |   #  |   #  |   #  |   #  |   #    |
  77  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  78  * |        |   S  |   T  |   P  |   H  |   *  |------|           |------|   *  |   F  |   P  |   L  |   T  |   D    |
  79  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  80  * |        |   S  |   K  |   W  |   R  |   *  |      |           |      |   *  |   R  |   B  |   G  |   S  |   Z    |
  81  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  82  *   |      |      |      |      |      |                                       |      |      |      |      |      |
  83  *   `----------------------------------'                                       `----------------------------------'
  84  *                                        ,-------------.       ,-------------.
  85  *                                        |      |      |       |      |      |
  86  *                                 ,------|------|------|       |------+------+------.
  87  *                                 |      |      |      |       |      |      |      |
  88  *                                 |   A  |   O  |------|       |------|   E  |   U  |
  89  *                                 |      |      |      |       |      |      |      |
  90  *                                 `--------------------'       `--------------------'
  91  */
  92 </code></pre>