~ruther/qmk_firmware

d6215ad6aff3857cea8a6877b56a547a76ab13ac — John Ramsay 7 years ago eba4cb7
Aviator Keymap (#2204)

* Create aviator.txt

* Add files via upload

* Delete aviator.txt

* Delete readme.md

* Add files via upload

* Update readme.md

* Update readme.md

* Delete keyboard-layout.png

* Update readme.md

* Update readme.md

* Update readme.md
A keyboards/planck/keymaps/aviator/config.h => keyboards/planck/keymaps/aviator/config.h +44 -0
@@ 0,0 1,44 @@
#ifndef CONFIG_USER_H
#define CONFIG_USER_H

#include "config_common.h"

#define BACKLIGHT_BREATHING

#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)

/*
 * 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

A keyboards/planck/keymaps/aviator/keyboard-layout.json => keyboards/planck/keymaps/aviator/keyboard-layout.json +138 -0
@@ 0,0 1,138 @@
[
  {
    "name": "The Aviator",
    "author": "John Ramsay",
    "notes": "Designed for aeronautical data entry on the OLKB Planck.",
    "switchMount": "cherry",
    "switchBrand": "gateron",
    "switchType": "KS-3-Green",
    "plate": true
  },
  [
    {
      "c": "#ADADAD",
      "t": "#000000\n#3f76d4\n#d67509"
    },
    "\nDel\nDel\n\n\n\n\n\n\nEsc",
    {
      "c": "#CDC1B0"
    },
    "\n!\nF1\n\n\n\n\n\n\nQ",
    "\n@\nF2\n\n\n\n\n\n\nW",
    "\n#\nF3\n\n\n\n\n\n\nE",
    "\n$\nF4\n\n\n\n\n\n\nR",
    "\n%\n\n\n\n\n\n\n\nT",
    "\n^\nN\n\n\n\n\n\n\nY",
    "\n&\nS\n\n\n\n\n\n\nU",
    "\n*\n7\n\n\n\n\n\n\nI",
    "\n(\n8\n\n\n\n\n\n\nO",
    "\n)\n9\n\n\n\n\n\n\nP",
    {
      "c": "#ADADAD",
      "t": "#000000",
      "a": 7
    },
    "Back Space"
  ],
  [
    "Tab",
    {
      "c": "#CDC1B0",
      "t": "#000000\n#3f76d4\n#d67509",
      "a": 4
    },
    "\n~\nF5\n\n\n\n\n\n\nA",
    "\n`\nF6\n\n\n\n\n\n\nS",
    {
      "t": "#000000\n\n#d67509"
    },
    "\n\nF7\n\n\n\n\n\n\nD",
    "\n\nF8\n\n\n\n\n\n\nF",
    {
      "t": "#000000",
      "a": 7
    },
    "G",
    {
      "t": "#000000\n\n#d67509",
      "a": 4
    },
    "\n\nE\n\n\n\n\n\n\nH",
    {
      "t": "#000000\n#3f76d4\n#d67509"
    },
    "\n_\nW\n\n\n\n\n\n\nJ",
    "\n+\n4\n\n\n\n\n\n\nK",
    "\n{\n5\n\n\n\n\n\n\nL",
    "\n}\n6\n\n\n\n\n\n\n:\n;",
    "\n\\\nTab\n\n\n\n\n\n\n\"\n'"
  ],
  [
    {
      "c": "#ADADAD",
      "t": "#000000",
      "a": 7
    },
    "Shift",
    {
      "c": "#CDC1B0",
      "t": "#000000\n\n#d67509",
      "a": 4
    },
    "\n\nF9\n\n\n\n\n\n\nZ",
    "\n\nF10\n\n\n\n\n\n\nX",
    "\n\nF11\n\n\n\n\n\n\nC",
    "\n\nF12\n\n\n\n\n\n\nV",
    {
      "t": "#000000",
      "a": 7
    },
    "B",
    {
      "t": "#000000\n\n#d67509",
      "a": 4
    },
    "\n\n+\n\n\n\n\n\n\nN",
    {
      "t": "#000000\n#3f76d4\n#d67509"
    },
    "\n-\n-\n\n\n\n\n\n\nM",
    "\n=\n1\n\n\n\n\n\n\n<\n,",
    "\n[\n2\n\n\n\n\n\n\n>\n.",
    "\n]\n3\n\n\n\n\n\n\n?\n/",
    {
      "c": "#ADADAD",
      "t": "#000000",
      "a": 7
    },
    "Return"
  ],
  [
    "Fn",
    "Ctrl",
    "Alt",
    "Meta",
    {
      "c": "#9FACBF"
    },
    "&dArr;",
    {
      "c": "#CDC1B0"
    },
    "",
    "",
    {
      "c": "#E5A65B"
    },
    "&uArr;",
    {
      "c": "#ADADAD",
      "t": "#000000\n#3f76d4\n#d67509",
      "a": 4
    },
    "\nHome\n0\n\n\n\n\n\n\n&larr;",
    "\nPDwn\n.\n\n\n\n\n\n\n&darr;",
    "\nPUp\nShift\n\n\n\n\n\n\n&uarr;",
    "\nEnd\nReturn\n\n\n\n\n\n\n&rarr;"
  ]
]
\ No newline at end of file

A keyboards/planck/keymaps/aviator/keymap.c => keyboards/planck/keymaps/aviator/keymap.c +198 -0
@@ 0,0 1,198 @@
/* Copyright 2017 John Ramsay
 * Aviator Keymap v1.0
 *
 * Designed for aeronautical data entry on the OLKB Planck.
 */

 #include "planck.h"
 #include "action_layer.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 _______ KC_TRNS
#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] = {
  {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] = {
  {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] = {
  {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] = {
  {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] = {
  {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);
        breathing_self_disable();
      }
      return false;
      break;
    case DATA:
      if (record->event.pressed) {
        set_single_persistent_default_layer(_DATA);
        #ifdef BACKLIGHT_ENABLE
          breathing_speed_set(3);
          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_ENABLE
            breathing_speed_set(3);
            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) {
          breathing_self_disable();
        }
        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_ENABLE
            breathing_speed_set(3);
            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) {
          breathing_self_disable();
        }
        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;
  }
  return true;
}

A keyboards/planck/keymaps/aviator/readme.md => keyboards/planck/keymaps/aviator/readme.md +68 -0
@@ 0,0 1,68 @@
# The Aviator

Designed for aeronautical data entry on the OLKB Planck.

![Imgur](https://i.imgur.com/lj6uMYI.png)

## Layers

````
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 |
`-----------------------------------------------------------------------------------'

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 |
`-----------------------------------------------------------------------------------'

Lower
,-----------------------------------------------------------------------------------.
| Del  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
|      |   ~  |   `  |      |      |      |      |   _  |   +  |   {  |   }  |  \   |
|------+------+------+------+------+------|------+------+------+------+------+------|
|      |      |      |      |      |      |      |   -  |   =  |   [  |   ]  |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |             |      | Home |Pg Dn |Pg Up | 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 |
`-----------------------------------------------------------------------------------'

Adjust (Lower + Raise)
,-----------------------------------------------------------------------------------.
| Esc  | Reset| Debug|      |      |      |      |      |      |      |      |  Del |
|------+------+------+------+------+-------------+------+------+------+------+------|
|      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty| Data |      |      |      |
|------+------+------+------+------+------|------+------+------+------+------+------|
|      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
|------+------+------+------+------+------+------+------+------+------+------+------|
|      |      |      |      |      |             |      |      |      |      |      |
`-----------------------------------------------------------------------------------'
````

## Notes

Supports LED backlighting.

A keyboards/planck/keymaps/aviator/rules.mk => keyboards/planck/keymaps/aviator/rules.mk +1 -0
@@ 0,0 1,1 @@
BACKLIGHT_ENABLE = yes