keyboards/nyquist/keymaps/DivergeJM/README.md

   1 Copyright 2017 James Morgan <ja.morgan1@outlook.com>
   2
   3 #MogranJM's nyquist layout
   4
   5         ***NOTE*** - As yet, this keymap has not been tested, I'm waiting on delivery of a plate and base before I assemble the keyboard. Though, the hex file does compile successfully...
   6
   7 This keymap is based on my Terminus_Mini (../../../terminus_mini/default) layout (credit for the names of these layouts goes to UniKeyboard & reddit's /u/blahlicus)
   8
   9 The terminus_mini is a handwired 4x12 ortholinear keyboard with two 2U thumb bar keys. This implementation of the layout converts it to a split 5x12 (two halves, each 5x6) keyboard with a 2U thumb key on the inner bottom corner of each half.
  10
  11 The TERMINUS_MINI layout (../../../terminus_mini/terminus_mini.h) is handwired and the 2U keys are handled using KC_NO to detail that two columns do not have a 4th column. This layout is based on a PCB, so the keymap represents the 2U keys as duplicates of the same 1U key.
  12
  13 >  .----------------------------------------.     .-----------------------------------------. \
  14 >  | Esc |   1  |   2  |   3  |   4  |   5  |     |   6  |   7  |   8  |   9  |   0  | Del  | \
  15 >  |-----+------+------+------+------+------|     |------+------+------+------+------+------| \
  16 >  | Tab |   Q  |   W  |   F  |   P  |   G  |     |   J  |   L  |   U  |   Y  |   ;  |  \\  | \
  17 >  |-----+------+------+------+------+------|     |------+------+------+------+------+------| \
  18 >  | BS  |   A  |   R  |   S  |   T  |   D  |     |   H  |   N  |   E  |   I  |   O  |  '   | \
  19 >  |-----+------+------+------+------+------|     |------+------+------+------+------+------| \
  20 >  | LSPO|   Z  |   X  |   C  |   V  |   B  |     |   K  |   M  |   ,  |  \.  |   /  | RSPC | \
  21 >  |-----+------+------+------+------+------|     |------+------+------+------+------+------| \
  22 >  | Ctrl| LGUI | LAlt | Lower| Space/Lower |     | Enter/Raise |  Fn  | Mouse| Menu | Ctrl | \
  23 >  '----------------------------------------'     '-----------------------------------------' \
  24 \
  25 > [_COLEMAK] = KEYMAP( \
  26 >   KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,   KC_5,         KC_6,   KC_7,    KC_8,      KC_9,    KC_0,    KC_DEL, \
  27 >   KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,   KC_G,         KC_J,   KC_L,    KC_U,      KC_Y,    KC_SCLN, KC_BSLS , \
  28 >   KC_BSPC, KC_A,    KC_R,    KC_S,    KC_T,   KC_D,         KC_H,   KC_N,    KC_E,      KC_I,    KC_O,    KC_QUOT, \
  29 >   KC_LSPO, KC_Z,    KC_X,    KC_C,    KC_V,   KC_B,         KC_K,   KC_M,    KC_COMM,   KC_DOT,  KC_SLSH, KC_RSPC, \
  30 >   KC_LCTL, KC_LGUI, KC_LALT, LWR,   SPC_LW, SPC_LW,       ENT_RS, ENT_RS,    FNC,       MSE,     KC_APP,  KC_RCTL \
  31 >   ),
  32
  33 ##Layers
  34
  35 ### Base Layer - Colemak
  36         * The base layout is Colemak. Since the CapsLock key is replaced with BackSpace, this layout has the delete key in the traditional backspace location.
  37                         * QWERTY and Dvorak layers have been removed from the keymap that was initially developed from the default Planck keymap.
  38                         * I've implemented COLEMAK = SAFE_RANGE when enumerating the custom_keycodes, but I don't actually know what this does...
  39
  40         * Space cadet is implemented in the shift keys (hold for shift, tap for respective parentheses)
  41         * I never find myself using the right-modifiers on a standard keyboard, so I've only implemented LGUI and LALT. I have intentions of improving my use of the ctrl key in correct hand alternation, so CTRL is implemented in both outside corners of the home row.
  42
  43
  44         #### Layer Shifting
  45                 * The 4th key on the bottom row of the left hand PCB is a **TAP_TOGGLE** macro for the *LOWER* layer
  46                 * The left 2U key is a **TAP_KEY** macro - Hold for momentary *LOWER* layer, Tap for Space.
  47                 * The right 2U key is a **TAP_KEY** macro - Hold for momentary *RAISE* layer, Tap for Enter
  48                 * The 2nd key on the bottom row of the right hand PCB is a **LAYER_MOMENTARY** for the *FUNCTION* layer
  49                 * The 3rd key on the bottom row of the right hand PCB is a **TAP_TOGGLE** macro for the *MOUSE* layer
  50
  51 ### LOWER - Numpad & Navigation keys
  52
  53  ,-----------------------------------------.    .-----------------------------------------. \
  54  |  Esc |      |      |      |      |      |    |   =  |   /  |   \* |  \-  |      | Del  | \
  55  |------+------+------+------+------+------|    |------+------+------+------+------+------| \
  56  |  Tab | PgUp | Home |  Up  |  End |      |    |   7  |   8  |   9  |  \+  |      |  \\  | \
  57  |------+------+------+------+------+------|    |------+------+------+------+------+------| \
  58  |  BS  | PgDn | Left | Down |Right |      |    |   4  |   5  |   6  | Enter|      |   '  | \
  59  |------+------+------+------+------+------|    |------+------+------+------+------+------| \
  60  | LSPO |   Z  |   X  |   C  |   V  |      |    |   1  |   2  |   3  | Enter|      | RSPC | \
  61  |------+------+------+------+-------------|    |-------------+------+------+------+------| \
  62  | Ctrl | LGUI | Alt  | LOWER| Space/Lower |    |      0      |  \.  |  Fn  | Menu | Ctrl | \
  63  `-----------------------------------------'    `-----------------------------------------' \
  64
  65         * The *LOWER* layer contains a navigation cluster on the left hand and a numpad on the right. This layer is momentary when the left thumb-bar or LOWER key is held and toggled on/off when the LOWER key is tapped.
  66
  67         * The Navigation cluster is offset to the right compared to the traditional **WASD** nav cluster. With this implementation, you don't need to move your hand from the home position when navigating. Page Up & Down keys are found on the far left of the cluster.
  68
  69         * All unused (blank on the above keymap) keys are locked out using the XXXXXXX filler (KC_NO), all modifiers (edge |_| keys \[except 0, \. & Fn\] on the above keymap) and the ZXCV cluster are transparent (_______) to the Base layer.
  70
  71         - [] TO DO!! - It would be nice to have a **TAP_DANCE_DOUBLE** implementation whereby a double tap of the right 2U key sends KC_PENT
  72                 * Couldn't get this to work in Rev1, produced an error in the Make process.
  73                 * When this is done, I can remove the clunky double Enter on the 4th column of the right hand PCB.
  74
  75 ### RAISE - Symbol Layer
  76
  77  > ,-----------------------------------------.     .-----------------------------------------. \
  78  > |  Esc |   1  |   2  |   3  |   4  |   5  |     |   6  |   7  |   8  |   9  |   0  | Del  | \
  79  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
  80  > |  Tab |      |      |      |      |      |     |      |      |      |      |      |  \\  | \
  81  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
  82  > |  BS  |  \!  |   @  |  \#  |   $  |   %  |     |   ^  |   &  |  \*  |  \-  |  \+  |   '  | \
  83  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
  84  > | LSBO |      |      |  \{  |  \[  |  \`  |     |   |  |  \]  |  \}  |  \.  |   ?  | RSBC | \
  85  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
  86  > | Ctrl | LGUI | Alt  |      | Space/Lower |     | Enter/Raise |  Fn  | Mouse| Menu | Ctrl | \
  87  > '-----------------------------------------'     '-----------------------------------------' \
  88
  89         * The *RAISE* layer contains the symbols. This layer is momentary when the right thumb bar is held.
  90                         * Standard symbols can be found on the home row, in the traditional number row order as they occur on a standard keyboard.
  91                         * Shifted symbols can be found on the second-from bottom row, abovee the bars - these include brackets, braces, grave and pipe keys.
  92                                         * At this stage, you need to shift to get to the Tilde key. I'd like to remove the shift requirement as I've done with the Pipe, but we'll see.
  93                         * The Terminus_Mini implements the symbols on the top row, with numbers implemented on the home row. Implementing a third set of number keys (Base, *LOWER*, *RAISE*) in this keymap is probably overkill, but the current *RAISE* layout replicates the standard number row, so I don't see reason to change it.
  94                         * The bottom row of this layer is a replication of that of the Base layer, except that the **TAP_TOGGLE** *LOWER* key is blocked with **XXXXXXX**.
  95
  96 ### FUNCTION - Function & Media keys
  97
  98  > ,-----------------------------------------.     .-----------------------------------------. \
  99  > |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |     |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 | \
 100  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
 101  > | Esc  | Mute | Vol- | Vol+ |      | RESET|     | POWER|      |      |      |      | Ins  | \
 102  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
 103  > | Caps | Stop | |<<  | >/|| |  >>| |      |     |      |      |      |      |      |PrtSc | \
 104  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
 105  > | LSOB |      |      |      |      |      |     |      |      |      |      |      |ScrLk | \
 106  > |------+------+------+------+------+------|     |------+------+------+------+------+------| \
 107  > | Ctrl | LGUI | Alt  |      | Space/Lower |     | Enter/Raise |  Fn  | Mouse|      |PsBrk | \
 108  > '-----------------------------------------'     '-----------------------------------------' \
 109
 110         * The *FUNCTION* layer contains media keys as well as the F-row. This layer is momentary and requires Fn to be held.
 111                         * The media cluster is based on the nav cluster in the *LOWER* layer, with RW, PP & FF in the Left, Down & Right positions.
 112                         * Mute, and Vol +/- are next to each other in ascending (L->R) volume order, Stop is below Mute.
 113                         * Insert, Print Screen, Scroll Lock & Pause Break are all implemented on the far right column.
 114                                         I don't really use these keys so their position is not optimised.
 115                         * Caps lock is implemented on this layer, in the traditional position, in place of BackSpace on the Base layer.
 116                         * The RESET key will reset the board for flashing and the Power key will initiate a shutdown of the PC. I've placed these in the far-reach index positions so that they are least likely to be pressed on accident. The power key is particularly dangerous, so I've placed it conciously on the right hand so that it becomes very awkward to activate with one hand (Fn needs to be held with the middle finger at the same time)
 117
 118 ### MOUSE - Mouse keys: The functionality of this layer is not as optimal as using a true mouse, generally slower but will work in a pinch.
 119  > ,----------------------------------------.     .----------------------------------------. \
 120  > |  Esc |      |      |      |      |     |     |     |      |      |      |      |  Del | \
 121  > |------+------+------+------+------+-----|     |-----+------+------+------+------+------| \
 122  > |  Tab | WhlU | WhlL | MsUp | WhlR |     |     |     |  M3  |  M4  |  M5  |      |      | \
 123  > |------+------+------+------+------+-----|     |-----+------+------+------+------+------| \
 124  > |      | WhlD | MsL  | MsDn | MsR  |     |     |     |LClick|RClick|      |      |      | \
 125  > |------+------+------+------+------+-----|     |-----+------+------+------+------+------| \
 126  > | LSPO |      |      |      |      |     |     |     |      |      |      |      | RSCB | \
 127  > |------+------+------+------+------+-----|     |-----+------+------+------+------+------| \
 128  > | Ctrl |      |      |      |Sensitivity |     | Sensitivity|      |MOUSE |      | Ctrl | \
 129  > '----------------------------------------'     '----------------------------------------' \
 130
 131         * The *MOUSE* layer contains keys replicating functions found on the mouse.
 132                 * The navigation cluster (Up, Down, Left, Right) is a replication of the Navigation cluster on the *LOWER* layer. The scroll keys are analagous to the Page Up & Down keys.
 133
 134                 *) The primary click (right & left) buttons are on the right home row (index & middle fingers)
 135
 136                 * Secondary click buttons are above the standard keys (M3/Wheel click, M4, M5) but I do not use this function.