commit
						b25dbc484d
					
				@ -0,0 +1,25 @@
 | 
				
			||||
 | 
				
			||||
 | 
				
			||||
# Build Options
 | 
				
			||||
#   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)
 | 
				
			||||
EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 | 
				
			||||
CONSOLE_ENABLE = no         # Console for debug(+400)
 | 
				
			||||
COMMAND_ENABLE = yes        # Commands for debug and configuration
 | 
				
			||||
NKRO_ENABLE = yes            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
				
			||||
BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
 | 
				
			||||
MIDI_ENABLE = no            # MIDI controls
 | 
				
			||||
AUDIO_ENABLE = yes           # Audio output on port C6
 | 
				
			||||
UNICODE_ENABLE = no         # Unicode
 | 
				
			||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
				
			||||
RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
 | 
				
			||||
 | 
				
			||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 | 
				
			||||
SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
 | 
				
			||||
 | 
				
			||||
ifndef QUANTUM_DIR
 | 
				
			||||
	include ../../../../Makefile
 | 
				
			||||
endif
 | 
				
			||||
@ -0,0 +1,364 @@
 | 
				
			||||
// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
 | 
				
			||||
// this is the style you want to emulate.
 | 
				
			||||
 | 
				
			||||
#include "planck.h"
 | 
				
			||||
#include "action_layer.h"
 | 
				
			||||
#ifdef AUDIO_ENABLE
 | 
				
			||||
  #include "audio.h"
 | 
				
			||||
#endif
 | 
				
			||||
#include "eeconfig.h"
 | 
				
			||||
 | 
				
			||||
extern keymap_config_t keymap_config;
 | 
				
			||||
 | 
				
			||||
// Each layer gets a name for readability, which is then used in the keymap matrix below.
 | 
				
			||||
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
 | 
				
			||||
// Layer names don't all need to be of the same length, obviously, and you can also skip them
 | 
				
			||||
// entirely and just use numbers.
 | 
				
			||||
#define _QWERTY 0
 | 
				
			||||
#define _COLEMAK 1
 | 
				
			||||
#define _DVORAK 2
 | 
				
			||||
#define _LOWER 3
 | 
				
			||||
#define _RAISE 4
 | 
				
			||||
#define _PLOVER 5
 | 
				
			||||
#define _TOUCHCURSOR 6
 | 
				
			||||
#define _MOUSE 7
 | 
				
			||||
#define _ADJUST 16
 | 
				
			||||
 | 
				
			||||
enum planck_keycodes {
 | 
				
			||||
  QWERTY = SAFE_RANGE,
 | 
				
			||||
  COLEMAK,
 | 
				
			||||
  DVORAK,
 | 
				
			||||
  PLOVER,
 | 
				
			||||
  LOWER,
 | 
				
			||||
  RAISE,
 | 
				
			||||
  BACKLIT,
 | 
				
			||||
  EXT_PLV
 | 
				
			||||
};
 | 
				
			||||
 | 
				
			||||
// Fillers to make layering more clear
 | 
				
			||||
#define _______ KC_TRNS
 | 
				
			||||
#define XXXXXXX KC_NO
 | 
				
			||||
 | 
				
			||||
// Custom macros
 | 
				
			||||
#define CTL_ESC     CTL_T(KC_ESC)               // Tap for Esc, hold for Ctrl
 | 
				
			||||
#define LT_TC       LT(_TOUCHCURSOR, KC_SPC)    // L-ayer T-ap T-ouch C-ursor
 | 
				
			||||
//                  ^-- Requires KC_TRNS / _______ for the trigger key in the destination layer
 | 
				
			||||
#define SFT_ENT     SFT_T(KC_ENT)               // Tap for Enter, hold for Shift
 | 
				
			||||
#define LT_ML       LT(_MOUSE, KC_A)            // L-ayer T-ap M-ouse C-ursor (on A)
 | 
				
			||||
 | 
				
			||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
				
			||||
 | 
				
			||||
/* Qwerty
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------------.
 | 
				
			||||
 * | Tab      |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  |  Bksp  |
 | 
				
			||||
 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
 | 
				
			||||
 * | Ctrl/Esc | ML/A |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   "    |
 | 
				
			||||
 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
 | 
				
			||||
 * | Shift    |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Sft/Ent |
 | 
				
			||||
 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
 | 
				
			||||
 * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_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},
 | 
				
			||||
  {CTL_ESC, LT_ML,   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, SFT_ENT},
 | 
				
			||||
  {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Colemak
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------------.
 | 
				
			||||
 * | Tab      |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  Bksp  |
 | 
				
			||||
 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
 | 
				
			||||
 * | Ctrl/Esc | ML/A |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |   "    |
 | 
				
			||||
 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
 | 
				
			||||
 * | Shift    |   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Sft/Ent |
 | 
				
			||||
 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
 | 
				
			||||
 * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_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},
 | 
				
			||||
  {CTL_ESC, LT_ML,   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, SFT_ENT},
 | 
				
			||||
  {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Dvorak
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------------.
 | 
				
			||||
 * | Tab      |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  |  Bksp  |
 | 
				
			||||
 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
 | 
				
			||||
 * | Ctrl/Esc | ML/A |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |   /    |
 | 
				
			||||
 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
 | 
				
			||||
 * | Shift    |   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Sft/Ent |
 | 
				
			||||
 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
 | 
				
			||||
 * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_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},
 | 
				
			||||
  {CTL_ESC, LT_ML,   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,    SFT_ENT},
 | 
				
			||||
  {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Lower
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |   [  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |   ]  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_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_LBRC, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 | 
				
			||||
  {KC_RBRC, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 | 
				
			||||
  {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Raise
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |   $  |   4  |   5  |   6  |   .  |   +  |   *  |   4  |   5  |   6  |   -  |  |   |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |   =  |   7  |   8  |   9  |   0  |   -  |   /  |   1  |   2  |   3  |   .  |  \   |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_RAISE] = {
 | 
				
			||||
  {KC_0,    KC_1,    KC_2,    KC_3,    KC_4,   KC_5,     KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 | 
				
			||||
  {KC_DLR,  KC_4,    KC_5,    KC_6,    KC_DOT, KC_PLUS,  KC_ASTR, KC_4,    KC_5,    KC_6,    KC_MINS, KC_PIPE},
 | 
				
			||||
  {KC_EQL,  KC_7,    KC_8,    KC_9,    KC_0,   KC_MINS,  KC_SLSH, KC_1,    KC_2,    KC_3,    KC_DOT,  KC_BSLS},
 | 
				
			||||
  {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |      |      |      |Shift | GUI  |  ~   |Insert| Home |  Up  | End  | Bksp |      |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |      | Alt  |Space |      | Find |Again | PgUp | Left | Down |Right |      |      |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |      | Undo | Cut  | Copy |Paste |  `   | PgDn | Del  |      |      |      |      |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      |      |      |             |      |      |      |      |      |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 *
 | 
				
			||||
 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
 | 
				
			||||
 * seem to work on Mac. Presumably they'll work under Windows.
 | 
				
			||||
 */
 | 
				
			||||
 | 
				
			||||
[_TOUCHCURSOR] = {
 | 
				
			||||
  {_______, _______, _______, KC_LSFT, KC_LGUI, KC_TILD, KC_INS,  KC_HOME, KC_UP,   KC_END,  KC_BSPC, _______},
 | 
				
			||||
  {_______, KC_LALT, KC_SPC,  _______, KC_FIND,KC_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 | 
				
			||||
  {_______, KC_UNDO, KC_CUT,  KC_COPY, KC_PASTE,KC_GRV,  KC_PGDN, KC_DEL,  _______, _______, _______, _______},
 | 
				
			||||
  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Mouse Layer
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |      |      |ACCL0 |ACCL1 |ACCL2 |ACCL2 |      |WHL_L |  Up  |WHL_R | BTN2 |      |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right |      |      |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      |      | BTN2 | BTN5 |WHL_Dn| BTN1 |      |      |      |      |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      |      |      |             |      |      |      |      |      |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
 | 
				
			||||
[_MOUSE] = {
 | 
				
			||||
  {_______, _______, KC_ACL0, KC_ACL1, KC_ACL2, KC_ACL2, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
 | 
				
			||||
  {_______, _______, _______, KC_BTN3, KC_BTN1, KC_BTN4, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______},
 | 
				
			||||
  {_______, _______, _______, _______, KC_BTN2, KC_BTN5, KC_WH_D, KC_BTN1, _______, _______, _______, _______},
 | 
				
			||||
  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Plover layer (http://opensteno.org)
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
 | 
				
			||||
[_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   },
 | 
				
			||||
  {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 | 
				
			||||
  {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 | 
				
			||||
  {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 | 
				
			||||
},
 | 
				
			||||
 | 
				
			||||
/* Adjust (Lower + Raise)
 | 
				
			||||
 * ,-----------------------------------------------------------------------------------.
 | 
				
			||||
 * |      |      |      |      |      |      |      |      |      |      |      |  Del |
 | 
				
			||||
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 | 
				
			||||
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
 * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 | 
				
			||||
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
 * |      |      |      |      |      |             |      |      |      |      |Reset |
 | 
				
			||||
 * `-----------------------------------------------------------------------------------'
 | 
				
			||||
 */
 | 
				
			||||
[_ADJUST] = {
 | 
				
			||||
  {_______, _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 | 
				
			||||
  {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 | 
				
			||||
  {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 | 
				
			||||
  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   RESET}
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
 | 
				
			||||
};
 | 
				
			||||
 | 
				
			||||
#ifdef AUDIO_ENABLE
 | 
				
			||||
 | 
				
			||||
float tone_startup[][2]    = SONG(STARTUP_SOUND);
 | 
				
			||||
float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 | 
				
			||||
float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 | 
				
			||||
float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 | 
				
			||||
float tone_plover[][2]     = SONG(PLOVER_SOUND);
 | 
				
			||||
float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 | 
				
			||||
float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 | 
				
			||||
 | 
				
			||||
float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 | 
				
			||||
#endif
 | 
				
			||||
 | 
				
			||||
 | 
				
			||||
void persistant_default_layer_set(uint16_t default_layer) {
 | 
				
			||||
  eeconfig_update_default_layer(default_layer);
 | 
				
			||||
  default_layer_set(default_layer);
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 | 
				
			||||
  switch (keycode) {
 | 
				
			||||
    case QWERTY:
 | 
				
			||||
      if (record->event.pressed) {
 | 
				
			||||
        #ifdef AUDIO_ENABLE
 | 
				
			||||
          PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 | 
				
			||||
        #endif
 | 
				
			||||
        default_layer_set(1UL<<_QWERTY);
 | 
				
			||||
      }
 | 
				
			||||
      return false;
 | 
				
			||||
      break;
 | 
				
			||||
    case COLEMAK:
 | 
				
			||||
      if (record->event.pressed) {
 | 
				
			||||
        #ifdef AUDIO_ENABLE
 | 
				
			||||
          PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 | 
				
			||||
        #endif
 | 
				
			||||
        default_layer_set(1UL<<_COLEMAK);
 | 
				
			||||
      }
 | 
				
			||||
      return false;
 | 
				
			||||
      break;
 | 
				
			||||
    case DVORAK:
 | 
				
			||||
      if (record->event.pressed) {
 | 
				
			||||
        #ifdef AUDIO_ENABLE
 | 
				
			||||
          PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 | 
				
			||||
        #endif
 | 
				
			||||
        default_layer_set(1UL<<_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_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);
 | 
				
			||||
      }
 | 
				
			||||
      return false;
 | 
				
			||||
      break;
 | 
				
			||||
    case EXT_PLV:
 | 
				
			||||
      if (record->event.pressed) {
 | 
				
			||||
        #ifdef AUDIO_ENABLE
 | 
				
			||||
          PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 | 
				
			||||
        #endif
 | 
				
			||||
        layer_off(_PLOVER);
 | 
				
			||||
      }
 | 
				
			||||
      return false;
 | 
				
			||||
      break;
 | 
				
			||||
  }
 | 
				
			||||
  return true;
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
void matrix_init_user(void) {
 | 
				
			||||
    #ifdef AUDIO_ENABLE
 | 
				
			||||
        startup_user();
 | 
				
			||||
    #endif
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
#ifdef AUDIO_ENABLE
 | 
				
			||||
 | 
				
			||||
void startup_user()
 | 
				
			||||
{
 | 
				
			||||
    _delay_ms(20); // gets rid of tick
 | 
				
			||||
    PLAY_NOTE_ARRAY(tone_startup, false, 0);
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
void shutdown_user()
 | 
				
			||||
{
 | 
				
			||||
    PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 | 
				
			||||
    _delay_ms(150);
 | 
				
			||||
    stop_all_notes();
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
void music_on_user(void)
 | 
				
			||||
{
 | 
				
			||||
    music_scale_user();
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
void music_scale_user(void)
 | 
				
			||||
{
 | 
				
			||||
    PLAY_NOTE_ARRAY(music_scale, false, 0);
 | 
				
			||||
}
 | 
				
			||||
 | 
				
			||||
#endif
 | 
				
			||||
@ -0,0 +1,107 @@
 | 
				
			||||
jeebak's layout
 | 
				
			||||
=======================
 | 
				
			||||
This WIP keymap attempts to minimize fingers straying away from the home row.
 | 
				
			||||
To aid in this endeavor, when additional modifyer keys to switch layers are
 | 
				
			||||
needed, they will be mapped to home row keys. The `keymap.c` file will contain
 | 
				
			||||
the exact changes. The diagrams in this README shows the highlights of the
 | 
				
			||||
changes from the default mappings.
 | 
				
			||||
 | 
				
			||||
I also decided to change all calls to `persistant_default_layer_set()` to
 | 
				
			||||
`update_tri_layer()` since this is my personal perference.
 | 
				
			||||
 | 
				
			||||
## Base Layers (Qwerty/Colemak/Dvorak)
 | 
				
			||||
These base layers are mostly the same as the default mappings. The interesting
 | 
				
			||||
changes are shown below. The `Ctrl/Esc`, mapped using `CTL_T(KC_ESC)` will emit
 | 
				
			||||
an `Escape` when tapped, and act as a `Control` key when held. A `TODO` item is
 | 
				
			||||
to see if it can also act as a `CapsLock` when double-tapped. The right shift
 | 
				
			||||
key acts as `Enter` when tapped, and as a `Shift` key when held. The arrow
 | 
				
			||||
keys, which have been moved to the
 | 
				
			||||
[TouchCursor](http://martin-stone.github.io/touchcursor/) layer, have been
 | 
				
			||||
replaced with the Media keys as shown. The `ML/A` key activates the Mouse layer
 | 
				
			||||
when held, and emits an `A` when tapped.
 | 
				
			||||
```
 | 
				
			||||
  ,-----------------------------------------------------------------------------------------.
 | 
				
			||||
  |          |      |      |      |      |      |      |      |      |      |      |        |
 | 
				
			||||
  |----------+------+------+------+------+-------------+------+------+------+------+--------|
 | 
				
			||||
  | Ctrl/Esc | ML/A |      |      |      |      |      |      |      |      |      |        |
 | 
				
			||||
  |----------+------+------+------+------+------|------+------+------+------+------+--------|
 | 
				
			||||
  |          |      |      |      |      |      |      |      |      |      |      |Sft/Ent |
 | 
				
			||||
  |----------+------+------+------+------+------+------+------+------+------+------+--------|
 | 
				
			||||
  | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
 | 
				
			||||
  `-----------------------------------------------------------------------------------------'
 | 
				
			||||
``` 
 | 
				
			||||
  
 | 
				
			||||
## Lower Layer (Symbols and Function Keys)
 | 
				
			||||
The symbols and functions keys are essentially the same as the default mapping.
 | 
				
			||||
The most notable changes are that the symbol keys from the `RAISE` layer have
 | 
				
			||||
been moved here. The remaining Media keys replace those that are now on the
 | 
				
			||||
base layers. The `BACKLIT` key has also been moved here.
 | 
				
			||||
``` 
 | 
				
			||||
  ,-----------------------------------------------------------------------------------.
 | 
				
			||||
  |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 | 
				
			||||
  |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
  |   [  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 | 
				
			||||
  |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
  |   ]  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
 | 
				
			||||
  |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
  |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 | 
				
			||||
  `-----------------------------------------------------------------------------------'
 | 
				
			||||
``` 
 | 
				
			||||
  
 | 
				
			||||
## Raise Layer (Numbers and Arithmetic Operators)
 | 
				
			||||
All of the numbers and arithmetic operators are available on this layer. Some
 | 
				
			||||
keys are duplicated for the convenience of their positions. The `0` and `$`
 | 
				
			||||
keys at the far left are for quick access to beginning and end of line in vim.
 | 
				
			||||
``` 
 | 
				
			||||
  ,-----------------------------------------------------------------------------------.
 | 
				
			||||
  |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 | 
				
			||||
  |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
  |   $  |   4  |   5  |   6  |   .  |   +  |   *  |   4  |   5  |   6  |   -  |  |   |
 | 
				
			||||
  |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
  |   =  |   7  |   8  |   9  |   0  |   -  |   /  |   1  |   2  |   3  |   .  |  \   |
 | 
				
			||||
  |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
  |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 | 
				
			||||
  `-----------------------------------------------------------------------------------'
 | 
				
			||||
``` 
 | 
				
			||||
  
 | 
				
			||||
## TouchCursor layer plus personal customizations
 | 
				
			||||
[TouchCursor](http://martin-stone.github.io/touchcursor/) uses the `Space` key
 | 
				
			||||
as the modifier, with the `IJKL` home row keys representing the inverted-T of
 | 
				
			||||
the arrow keys. All of the default TouchCursor keymappings for the right hand
 | 
				
			||||
are represented below. My personalizations include all of the keys shown for
 | 
				
			||||
the left hand. Having the `Alt` and `Shift` keys readily accessible from the
 | 
				
			||||
home row allows quick word jumps and highlighting when used in conjunction with
 | 
				
			||||
the arrow keys. The `KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND,` and
 | 
				
			||||
`KC_AGAIN` keycodes have been mapped but they don't seem to work on Mac.
 | 
				
			||||
Presumably they'll work under Windows.
 | 
				
			||||
``` 
 | 
				
			||||
  ,-----------------------------------------------------------------------------------.
 | 
				
			||||
  |      |      |      |Shift | GUI  |  ~   |Insert| Home |  Up  | End  | Bksp |      |
 | 
				
			||||
  |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
  |      | Alt  |Space |      | Find |Again | PgUp | Left | Down |Right |      |      |
 | 
				
			||||
  |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
  |      | Undo | Cut  | Copy |Paste |  `   | PgDn | Del  |      |      |      |      |
 | 
				
			||||
  |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
  |      |      |      |      |      |             |      |      |      |      |      |
 | 
				
			||||
  `-----------------------------------------------------------------------------------'
 | 
				
			||||
``` 
 | 
				
			||||
 | 
				
			||||
## Mouse Layer
 | 
				
			||||
The Mouse layer, closely mimics the layout/behaviour of the TouchCursor layer.
 | 
				
			||||
The `A` key is used to activate this layer. All 16 keycodes for the mouse from
 | 
				
			||||
the `doc/keycode.txt` file are represented, and logically located, IMHO. The
 | 
				
			||||
left and right click buttons are duplicated; on the right hand side, for a
 | 
				
			||||
quick click here and there, and again on the left hand side for when the
 | 
				
			||||
buttons need to be held for dragging things or highlighting text, thus allowing
 | 
				
			||||
the right hand to be free to use the up/down/left/right actions.
 | 
				
			||||
``` 
 | 
				
			||||
  ,-----------------------------------------------------------------------------------.
 | 
				
			||||
  |      |      |ACCL0 |ACCL1 |ACCL2 |ACCL2 |      |WHL_L |  Up  |WHL_R | BTN2 |      |
 | 
				
			||||
  |------+------+------+------+------+-------------+------+------+------+------+------|
 | 
				
			||||
  |      |      |      | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right |      |      |
 | 
				
			||||
  |------+------+------+------+------+------|------+------+------+------+------+------|
 | 
				
			||||
  |      |      |      |      | BTN2 | BTN5 |WHL_Dn| BTN1 |      |      |      |      |
 | 
				
			||||
  |------+------+------+------+------+------+------+------+------+------+------+------|
 | 
				
			||||
  |      |      |      |      |      |             |      |      |      |      |      |
 | 
				
			||||
  `-----------------------------------------------------------------------------------'
 | 
				
			||||
``` 
 | 
				
			||||
					Loading…
					
					
				
		Reference in new issue