[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / aviator / keymap.c

/* Copyright 2017 John Ramsay
 * Aviator Keymap v1.0
 *
 * Designed for aeronautical data entry on the OLKB Planck.
 */

#include QMK_KEYBOARD_H

 extern keymap_config_t keymap_config;

 enum planck_layers {
   _QWERTY,
   _DATA,
   _LOWER,
   _RAISE,
   _ADJUST
 };

 enum planck_keycodes {
   QWERTY = SAFE_RANGE,
   DATA,
   LOWER,
   RAISE,
   BACKLIT
 };

#define ___x___ KC_NO

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

/* Qwerty
 * ,-----------------------------------------------------------------------------------.
 * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Tab  |   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] = LAYOUT_planck_grid(
  KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
  KC_TAB,  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
),

/* Data
 * ,-----------------------------------------------------------------------------------.
 * | Esc  | Home |  Up  | End  |      |      |   N  |   S  |   7  |   8  |   9  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Tab  | Left | Down | Right|      |      |   E  |   W  |   4  |   5  |   6  | Tab  |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * | Shift|   Z  |   X  |   C  |   V  |      |   +  |   -  |   1  |   2  |   3  |Enter |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |   0  |   .  |Shift |Enter |
 * `-----------------------------------------------------------------------------------'
 */
[_DATA] = LAYOUT_planck_grid(
  KC_ESC,  KC_HOME, KC_UP,   KC_END,   ___x___, ___x___, KC_N,    KC_S,    KC_7, KC_8,   KC_9,    KC_BSPC,
  KC_TAB,  KC_LEFT, KC_DOWN, KC_RIGHT, ___x___, ___x___, KC_E,    KC_W,    KC_4, KC_5,   KC_6,    KC_TAB,
  KC_LSFT, KC_Z,    KC_X,    KC_C,     KC_V,    ___x___, KC_PLUS, KC_MINS, KC_1, KC_2,   KC_3,    KC_ENT,
  BACKLIT, KC_LCTL, KC_LALT, KC_LGUI,  LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_0, KC_DOT, KC_RSFT, KC_ENT
),

/* Lower
 * ,-----------------------------------------------------------------------------------.
 * | Del  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * |      |   ~  |   `  |      |      |      |      |   _  |   +  |   {  |   }  |  \   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |      |      |      |      |      |      |   -  |   =  |   [  |   ]  |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      | Home |Pg Dn |Pg Up | End  |
 * `-----------------------------------------------------------------------------------'
 */
[_LOWER] = LAYOUT_planck_grid(
  KC_DEL,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
  _______, KC_TILD, KC_GRV,  ___x___, ___x___, ___x___, ___x___, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_BSLS,
  _______, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______,
  _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
),

/* Raise
 * ,-----------------------------------------------------------------------------------.
 * | Del  |  F1  |  F2  |  F3  |  F4  |      |   N  |   S  |   7  |   8  |   9  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * |      |  F5  |  F6  |  F7  |  F8  |      |   E  |   W  |   4  |   5  |   6  | Tab  |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |  F9  |  F10 |  F11 |  F12 |      |   +  |   -  |   1  |   2  |   3  |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      |   0  |   .  |Shift |Enter |
 * `-----------------------------------------------------------------------------------'
 */
[_RAISE] = LAYOUT_planck_grid(
  KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   ___x___, KC_N,    KC_S,    KC_7, KC_8,   KC_9,    KC_BSPC,
  _______, KC_F5,   KC_F6,   KC_F7,   KC_F8,   ___x___, KC_E,    KC_W,    KC_4, KC_5,   KC_6,    KC_TAB,
  _______, KC_F9,   KC_F10,  KC_F11,  KC_F12,  ___x___, KC_PLUS, KC_MINS, KC_1, KC_2,   KC_3,    _______,
  _______, _______, _______, _______, _______, _______, _______, _______, KC_0, KC_DOT, KC_RSFT, KC_ENT
),

/* Adjust (Lower + Raise)
 * ,-----------------------------------------------------------------------------------.
 * | Esc  | Reset| Debug|      |      |      |      |      |      |      |      |  Del |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty| Data |      |      |      |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      |      |      |      |      |
 * `-----------------------------------------------------------------------------------'
 */
[_ADJUST] = LAYOUT_planck_grid(
  KC_ESC,  RESET,   DEBUG,   ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, KC_DEL,
  _______, ___x___, ___x___, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  DATA,    ___x___, ___x___, _______,
  _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  ___x___, ___x___, ___x___, ___x___, _______,
  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
)
};

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
    case QWERTY:
      if (record->event.pressed) {
        set_single_persistent_default_layer(_QWERTY);
        #ifdef BACKLIGHT_BREATHING
          breathing_self_disable();
        #endif
      }
      return false;
      break;
    case DATA:
      if (record->event.pressed) {
        set_single_persistent_default_layer(_DATA);
        #ifdef BACKLIGHT_BREATHING
          breathing_enable();
        #endif
      }
      return false;
      break;
    case LOWER:
      if (record->event.pressed) {
        layer_on(_LOWER);
        uint8_t default_layer = biton32(default_layer_state);
        if (default_layer == _QWERTY) {
          #ifdef BACKLIGHT_BREATHING
            breathing_enable();
          #endif
        }
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      } else {
        layer_off(_LOWER);
        uint8_t default_layer = biton32(default_layer_state);
        if (default_layer == _QWERTY) {
          #ifdef BACKLIGHT_BREATHING
            breathing_self_disable();
          #endif
        }
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      }
      return false;
      break;
    case RAISE:
      if (record->event.pressed) {
        layer_on(_RAISE);
        uint8_t default_layer = biton32(default_layer_state);
        if (default_layer == _QWERTY) {
          #ifdef BACKLIGHT_BREATHING
            breathing_enable();
          #endif
        }
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      } else {
        layer_off(_RAISE);
        uint8_t default_layer = biton32(default_layer_state);
        if (default_layer == _QWERTY) {
          #ifdef BACKLIGHT_BREATHING
            breathing_self_disable();
          #endif
        }
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      }
      return false;
      break;
    case BACKLIT:
      if (record->event.pressed) {
        register_code(KC_RSFT);
        #ifdef BACKLIGHT_BREATHING
          backlight_step();
        #endif
      } else {
        unregister_code(KC_RSFT);
      }
      return false;
      break;
  }
  return true;
}
Commit	Line	Data
d6215ad6 JR	1	/* Copyright 2017 John Ramsay
	2	* Aviator Keymap v1.0
	3	*
	4	* Designed for aeronautical data entry on the OLKB Planck.
	5	*/
	6
26eef35f	7	#include QMK_KEYBOARD_H
d6215ad6 JR	8
	9	extern keymap_config_t keymap_config;
	10
	11	enum planck_layers {
	12	_QWERTY,
	13	_DATA,
	14	_LOWER,
	15	_RAISE,
	16	_ADJUST
	17	};
	18
	19	enum planck_keycodes {
	20	QWERTY = SAFE_RANGE,
	21	DATA,
	22	LOWER,
	23	RAISE,
	24	BACKLIT
	25	};
	26
d6215ad6 JR	27	#define ___x___ KC_NO
	28
	29	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	30
	31	/* Qwerty
	32	* ,-----------------------------------------------------------------------------------.
	33	* \| Esc \| Q \| W \| E \| R \| T \| Y \| U \| I \| O \| P \| Bksp \|
	34	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	35	* \| Tab \| A \| S \| D \| F \| G \| H \| J \| K \| L \| ; \| " \|
	36	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	37	* \| Shift\| Z \| X \| C \| V \| B \| N \| M \| , \| . \| / \|Enter \|
	38	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	39	* \| Brite\| Ctrl \| Alt \| GUI \|Lower \| Space \|Raise \| Left \| Down \| Up \|Right \|
	40	* `-----------------------------------------------------------------------------------'
	41	*/
26eef35f JY	42	[_QWERTY] = LAYOUT_planck_grid(
	43	KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
	44	KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
	45	KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
	46	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
	47	),
d6215ad6 JR	48
	49	/* Data
	50	* ,-----------------------------------------------------------------------------------.
	51	* \| Esc \| Home \| Up \| End \| \| \| N \| S \| 7 \| 8 \| 9 \| Bksp \|
	52	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	53	* \| Tab \| Left \| Down \| Right\| \| \| E \| W \| 4 \| 5 \| 6 \| Tab \|
	54	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	55	* \| Shift\| Z \| X \| C \| V \| \| + \| - \| 1 \| 2 \| 3 \|Enter \|
	56	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	57	* \| Brite\| Ctrl \| Alt \| GUI \|Lower \| Space \|Raise \| 0 \| . \|Shift \|Enter \|
	58	* `-----------------------------------------------------------------------------------'
	59	*/
26eef35f JY	60	[_DATA] = LAYOUT_planck_grid(
	61	KC_ESC, KC_HOME, KC_UP, KC_END, ___x___, ___x___, KC_N, KC_S, KC_7, KC_8, KC_9, KC_BSPC,
	62	KC_TAB, KC_LEFT, KC_DOWN, KC_RIGHT, ___x___, ___x___, KC_E, KC_W, KC_4, KC_5, KC_6, KC_TAB,
	63	KC_LSFT, KC_Z, KC_X, KC_C, KC_V, ___x___, KC_PLUS, KC_MINS, KC_1, KC_2, KC_3, KC_ENT,
	64	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_0, KC_DOT, KC_RSFT, KC_ENT
	65	),
d6215ad6 JR	66
	67	/* Lower
	68	* ,-----------------------------------------------------------------------------------.
	69	* \| Del \| ! \| @ \| # \| $ \| % \| ^ \| & \| * \| ( \| ) \| Bksp \|
	70	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	71	* \| \| ~ \| ` \| \| \| \| \| _ \| + \| { \| } \| \ \|
	72	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	73	* \| \| \| \| \| \| \| \| - \| = \| [ \| ] \| \|
	74	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	75	* \| \| \| \| \| \| \| \| Home \|Pg Dn \|Pg Up \| End \|
	76	* `-----------------------------------------------------------------------------------'
	77	*/
26eef35f JY	78	[_LOWER] = LAYOUT_planck_grid(
	79	KC_DEL, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
	80	_______, KC_TILD, KC_GRV, ___x___, ___x___, ___x___, ___x___, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_BSLS,
	81	_______, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, _______,
	82	_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
	83	),
d6215ad6 JR	84
	85	/* Raise
	86	* ,-----------------------------------------------------------------------------------.
	87	* \| Del \| F1 \| F2 \| F3 \| F4 \| \| N \| S \| 7 \| 8 \| 9 \| Bksp \|
	88	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	89	* \| \| F5 \| F6 \| F7 \| F8 \| \| E \| W \| 4 \| 5 \| 6 \| Tab \|
	90	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	91	* \| \| F9 \| F10 \| F11 \| F12 \| \| + \| - \| 1 \| 2 \| 3 \| \|
	92	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	93	* \| \| \| \| \| \| \| \| 0 \| . \|Shift \|Enter \|
	94	* `-----------------------------------------------------------------------------------'
	95	*/
26eef35f JY	96	[_RAISE] = LAYOUT_planck_grid(
	97	KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, ___x___, KC_N, KC_S, KC_7, KC_8, KC_9, KC_BSPC,
	98	_______, KC_F5, KC_F6, KC_F7, KC_F8, ___x___, KC_E, KC_W, KC_4, KC_5, KC_6, KC_TAB,
	99	_______, KC_F9, KC_F10, KC_F11, KC_F12, ___x___, KC_PLUS, KC_MINS, KC_1, KC_2, KC_3, _______,
	100	_______, _______, _______, _______, _______, _______, _______, _______, KC_0, KC_DOT, KC_RSFT, KC_ENT
	101	),
d6215ad6 JR	102
	103	/* Adjust (Lower + Raise)
	104	* ,-----------------------------------------------------------------------------------.
	105	* \| Esc \| Reset\| Debug\| \| \| \| \| \| \| \| \| Del \|
	106	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	107	* \| \| \| \|Aud on\|Audoff\|AGnorm\|AGswap\|Qwerty\| Data \| \| \| \|
	108	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	109	* \| \|Voice-\|Voice+\|Mus on\|Musoff\|MIDIon\|MIDIof\| \| \| \| \| \|
	110	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	111	* \| \| \| \| \| \| \| \| \| \| \| \|
	112	* `-----------------------------------------------------------------------------------'
	113	*/
26eef35f JY	114	[_ADJUST] = LAYOUT_planck_grid(
	115	KC_ESC, RESET, DEBUG, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, KC_DEL,
	116	_______, ___x___, ___x___, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, DATA, ___x___, ___x___, _______,
	117	_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, ___x___, ___x___, ___x___, ___x___, _______,
	118	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
	119	)
d6215ad6 JR	120	};
	121
	122	bool process_record_user(uint16_t keycode, keyrecord_t *record) {
	123	switch (keycode) {
	124	case QWERTY:
	125	if (record->event.pressed) {
	126	set_single_persistent_default_layer(_QWERTY);
4464d90f BC	127	#ifdef BACKLIGHT_BREATHING
	128	breathing_self_disable();
	129	#endif
d6215ad6 JR	130	}
	131	return false;
	132	break;
	133	case DATA:
	134	if (record->event.pressed) {
	135	set_single_persistent_default_layer(_DATA);
4464d90f	136	#ifdef BACKLIGHT_BREATHING
d6215ad6 JR	137	breathing_enable();
	138	#endif
	139	}
	140	return false;
	141	break;
	142	case LOWER:
	143	if (record->event.pressed) {
	144	layer_on(_LOWER);
	145	uint8_t default_layer = biton32(default_layer_state);
	146	if (default_layer == _QWERTY) {
4464d90f	147	#ifdef BACKLIGHT_BREATHING
d6215ad6 JR	148	breathing_enable();
	149	#endif
	150	}
	151	update_tri_layer(_LOWER, _RAISE, _ADJUST);
	152	} else {
	153	layer_off(_LOWER);
	154	uint8_t default_layer = biton32(default_layer_state);
	155	if (default_layer == _QWERTY) {
4464d90f BC	156	#ifdef BACKLIGHT_BREATHING
	157	breathing_self_disable();
	158	#endif
d6215ad6 JR	159	}
	160	update_tri_layer(_LOWER, _RAISE, _ADJUST);
	161	}
	162	return false;
	163	break;
	164	case RAISE:
	165	if (record->event.pressed) {
	166	layer_on(_RAISE);
	167	uint8_t default_layer = biton32(default_layer_state);
	168	if (default_layer == _QWERTY) {
4464d90f	169	#ifdef BACKLIGHT_BREATHING
d6215ad6 JR	170	breathing_enable();
	171	#endif
	172	}
	173	update_tri_layer(_LOWER, _RAISE, _ADJUST);
	174	} else {
	175	layer_off(_RAISE);
	176	uint8_t default_layer = biton32(default_layer_state);
	177	if (default_layer == _QWERTY) {
4464d90f BC	178	#ifdef BACKLIGHT_BREATHING
	179	breathing_self_disable();
	180	#endif
d6215ad6 JR	181	}
	182	update_tri_layer(_LOWER, _RAISE, _ADJUST);
	183	}
	184	return false;
	185	break;
	186	case BACKLIT:
	187	if (record->event.pressed) {
	188	register_code(KC_RSFT);
4464d90f	189	#ifdef BACKLIGHT_BREATHING
d6215ad6 JR	190	backlight_step();
	191	#endif
	192	} else {
	193	unregister_code(KC_RSFT);
	194	}
	195	return false;
	196	break;
	197	}
	198	return true;
	199	}