summaryrefslogtreecommitdiff
path: root/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-09-19 16:25:58 -0700
committerDrashna Jaelre <drashna@live.com>2018-09-19 16:25:58 -0700
commit5b4bcfa7f2530ad12ef801101933aba6ac46acb2 (patch)
tree6bce2b91589acb5e3939aae28d48bd361fb3d12b /keyboards/bpiphany/frosty_flake/keymaps/QFR_JM
parent14be5258a6784829b6931f348fc20d64e1a5f2a7 (diff)
Keyboard: Move Bathroom Epiphany boards into its own directory (#3936)
* make bpiphany directory with simple readme file * move unloved_bastard to bpiphany directory * move frosty_flake to bpiphany directory * move pegasushoof to bpiphany directory * move tiger_lily to bpiphany directory * add a little more info to readme * move kitten_paw to bpiphany directory * update make instructions * update intro text * add missing routines to matrix.c of unloved_bastard * add missing routines
Diffstat (limited to 'keyboards/bpiphany/frosty_flake/keymaps/QFR_JM')
-rw-r--r--keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/config.h11
-rw-r--r--keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/keymap.c132
-rw-r--r--keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/readme.md86
-rw-r--r--keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/rules.mk17
4 files changed, 246 insertions, 0 deletions
diff --git a/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/config.h b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/config.h
new file mode 100644
index 0000000000..b25194014b
--- /dev/null
+++ b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/config.h
@@ -0,0 +1,11 @@
+
+#define TAPPING_TERM 150 //reduce time required to register a held key
+
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+// place overrides here
+
+#endif
diff --git a/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/keymap.c b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/keymap.c
new file mode 100644
index 0000000000..81899396af
--- /dev/null
+++ b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/keymap.c
@@ -0,0 +1,132 @@
+#include "frosty_flake.h"
+#include "action_layer.h"
+#ifdef AUDIO_ENABLE
+ #include "audio.h"
+#endif
+#include "eeconfig.h"
+
+enum QFR_layers {
+ _COLEMAK,
+ _QWERTY,
+ _DVORAK,
+ _LOWER,
+ _MOUSE
+};
+
+enum QFR_keycodes {
+ COLEMAK = SAFE_RANGE,
+ QWERTY,
+ DVORAK,
+ LOWER,
+ MOUSE
+};
+
+enum custom_macros {
+ R_PIPE,
+ R_POINT
+};
+
+ const uint16_t PROGMEM fn_actions[] = { //ACTION_LAYER_TAP_TOGGLE requires that number of taps be defined in *config.h* - default set to 5
+ [0] = ACTION_LAYER_TAP_KEY(_LOWER, KC_SPC), //Hold for momentary Lower layer, Tap for Space,
+ [1] = ACTION_LAYER_MOMENTARY(_MOUSE) //Hold for momentary MOUSE
+
+ };
+
+#define SPC_LW FUNC(0)
+#define MSE FUNC(1)
+#define PIPE M(R_PIPE)
+#define POINT M(R_POINT)
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+[_COLEMAK] = KEYMAP_TKL(\
+ KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR,KC_SLCK,KC_PAUS, \
+ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME,KC_PGUP, \
+ KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_LBRC, KC_RBRC,KC_BSLS, KC_DEL, KC_END, KC_PGDN, \
+ KC_BSPC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT, KC_ENT , \
+ KC_LSPO,KC_NUBS,KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSPC, KC_UP, \
+ KC_LCTL,KC_LGUI, KC_LALT, SPC_LW, MSE, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT,KC_DOWN,KC_RGHT
+ ),
+
+[_QWERTY] = KEYMAP_TKL(\
+ KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_SLCK, KC_PAUS, \
+ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME, KC_PGUP, \
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_END, KC_PGDN, \
+ KC_CAPS,KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN,KC_QUOT, KC_ENT, \
+ KC_LSFT,KC_NUBS,KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT, KC_UP, \
+ KC_LCTL,KC_LGUI,KC_LALT, SPC_LW, MSE, KC_RGUI , KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+[_DVORAK] = KEYMAP_TKL(\
+ KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_SLCK, KC_PAUS, \
+ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME, KC_PGUP, \
+ KC_TAB, KC_QUOT,KC_COMM,KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_END, KC_PGDN, \
+ KC_BSPC,KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_QUOT, KC_ENT, \
+ KC_LSFT,KC_NUBS,KC_SCLN,KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_RSFT, KC_UP, \
+ KC_LCTL,KC_LGUI,KC_LALT, SPC_LW, MSE, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+[_LOWER] = KEYMAP_TKL(\
+ RESET, _______, _______, _______, _______, KC_MPLY, KC_MSTP, KC_MPRV, KC_MNXT, _______, KC_MUTE, KC_VOLD, KC_VOLU, QWERTY, COLEMAK,DVORAK, \
+ KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LBRC, KC_RBRC, KC_UNDS, KC_PLUS, KC_BSPC, _______,_______,_______, \
+ KC_TAB, KC_PGUP, KC_HOME, KC_UP, KC_END, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LCBR, KC_RCBR, KC_PIPE, _______,_______,_______, \
+ KC_CAPS, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, _______, \
+ _______,XXXXXXX,POINT,PIPE, KC_LCBR, KC_LBRC, KC_GRV, KC_PIPE, KC_RBRC, KC_RCBR, _______, _______, _______, _______, \
+ _______, _______, _______, _______, KC_RALT, _______, _______, _______, _______,_______,_______ \
+ ),
+
+[_MOUSE] = KEYMAP_TKL(\
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,_______,_______, \
+ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_DEL, _______,_______,_______, \
+ KC_TAB, KC_WH_U, KC_WH_L, KC_MS_U, KC_WH_R, XXXXXXX, XXXXXXX, KC_BTN3, KC_BTN4, KC_BTN5, XXXXXXX, KC_LBRC, KC_RBRC, KC_BSLS, _______,_______,_______, \
+ KC_BSPC, KC_WH_D, KC_MS_L, KC_MS_D, KC_MS_R, XXXXXXX, XXXXXXX, KC_BTN1, KC_BTN2, XXXXXXX, XXXXXXX, XXXXXXX, _______, \
+ _______,XXXXXXX,PIPE,POINT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, _______, _______, _______, _______, \
+ _______, _______, _______, KC_ACL2, MSE, _______, _______, _______, _______,_______,_______ \
+ )
+};
+
+// Macros to send R pointer & dplyr pipe
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+ switch(id) {
+ case R_POINT:
+ if (record->event.pressed) { // pointer
+ SEND_STRING("<- ");
+// return MACRO(D(LSFT), T(COMM), U(LSFT), T(MINS), END);
+ }
+ break;
+ case R_PIPE:
+ if (record->event.pressed) { // dplyr pipe
+ SEND_STRING("%>% ");
+// return MACRO(D(LSFT), T(5), T(DOT), T(5), U(LSFT), END);
+ }
+ break;
+ }
+ return MACRO_NONE;
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case QWERTY:
+ if (record->event.pressed) {
+ set_single_persistent_default_layer(_QWERTY);
+ }
+ return false;
+ break;
+ case COLEMAK:
+ if (record->event.pressed) {
+ set_single_persistent_default_layer(_COLEMAK);
+ }
+ return false;
+ break;
+ case DVORAK:
+ if (record->event.pressed) {
+ set_single_persistent_default_layer(_DVORAK);
+ }
+ return false;
+ break;
+ }
+ return true;
+} \ No newline at end of file
diff --git a/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/readme.md b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/readme.md
new file mode 100644
index 0000000000..f12a0ffba1
--- /dev/null
+++ b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/readme.md
@@ -0,0 +1,86 @@
+
+# TKL keymap for frosty\_flake
+```
+make frosty_flake:QFR_JM
+
+dfu-programmer atmega32u2 erase
+dfu-programmer atmega32u2 flash frosty_flake_QFR_JM.hex
+dfu-programmer atmega32u2 start
+```
+
+##Layers
+```
+ ,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
+ |ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
+ '----' '-------------------' '-------------------' '-------------------' '--------------'
+ ,-------------------------------------------------------------------------. ,--------------.
+ | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Bspc | | Ins|Home|PgUp|
+ |-------------------------------------------------------------------------| |--------------|
+ | Tab | Q | W | F | P | G | J | L | U | Y | ; | [ | ] | \ | | Del|End |PgDn|
+ |-------------------------------------------------------------------------| '--------------'
+ | Bspc | A | R | S | T | D | H | N | E | I | O | ' | Enter |
+ |-------------------------------------------------------------------------| ,----.
+ | LSPO | Z | X | C | V | B | K | M | , | . | / | RSPC | | Up |
+ |-------------------------------------------------------------------------| ,--------------.
+ |Ctrl|LGUI|LAlt| Space/Lower |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
+ '-------------------------------------------------------------------------' '--------------'
+
+```
+### Base Layer - Colemak
+The base layout is Colemak by default, but this can be changed to QWERTY via the *LOWER* layer.
+* I've implemented COLEMAK = SAFE\_RANGE when enumerating the custom\_keycodes, but I don't actually know what this does...
+
+* Space cadet is implemented in the shift keys (hold for shift, tap for respective parentheses)
+
+#### Layer Shifting
+* The spacebar is a **TAP_KEY** macro - Hold for momentary *LOWER* layer, Tap for Space.
+* The Right hand ALT key is a **TAP_TOGGLE** macro for the *MOUSE* layer (RAlt is accessible through LOWER, if you want...)
+
+### LOWER
+```
+ ,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
+ |ESC | | F1 | F2 | F3 | F4 | |>/|||Stop| << | >> | | F9 |MUTE|Vol-|Vol+| |QWTY|CLMK|PsBk|
+ '----' '-------------------' '-------------------' '-------------------' '--------------'
+ ,-------------------------------------------------------------------------. ,--------------.
+ | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | _ | + | Bspc | | Ins|Home|PgUp|
+ |-------------------------------------------------------------------------| |--------------|
+ | Tab |PgUp|Home| Up | End| | | | | | | { | } | | | | Del|End |PgDn|
+ |-------------------------------------------------------------------------| '--------------'
+ | Bckspc|PgDn|Left|Down|Rght| | | | | | | ' | Enter |
+ |-------------------------------------------------------------------------| ,----.
+ | LSPO | <- |%>% | { | [ | ` | | | ] | } | . | / | RSPC | | Up |
+ |-------------------------------------------------------------------------| ,--------------.
+ |Ctrl|LGUI|LAlt| |RAlt|RGUI|Menu|Ctrl| |Left|Down|Rght|
+ '-------------------------------------------------------------------------' '--------------'
+```
+The *LOWER* layer contains a navigation cluster on the left hand. This layer is momentary when the spacebar or LOWER (RAlt) key is held and toggled on/off when the LOWER key is tapped.
+
+* 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.
+
+* 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.
+
+* The base layer can be switched to QWERTY or COLEMAK by pressing the Pause Break or Scroll Lock keys respectively
+
+### MOUSE
+```
+ ,----. ,-------------------. ,-------------------. ,-------------------. ,--------------.
+ |ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 |F10 |F11 |F12 | |PrSc|ScLk|PsBk|
+ '----' '-------------------' '-------------------' '-------------------' '--------------'
+ ,-------------------------------------------------------------------------. ,--------------.
+ | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Del | | Ins|Home|PgUp|
+ |-------------------------------------------------------------------------| |--------------|
+ | Tab | WhU| WhL| MsU| WhR| | | M3 | M4 | M5 | | [ | ] | \ | | Del|End |PgDn|
+ |-------------------------------------------------------------------------| '--------------'
+ | BSPC | WhD| MsL| MsD| MsR| | |LClk |RClk | | | ' | Enter |
+ |-------------------------------------------------------------------------| ,----.
+ | LSPO | Z | X | C | V | | | | , | . | / | RSPC | | Up |
+ |-------------------------------------------------------------------------| ,--------------.
+ |Ctrl|LGUI|LAlt| Accel ++ |MSE |RGUI|Menu|Ctrl| |Left|Down|Rght|
+ '-------------------------------------------------------------------------' '--------------'
+```
+The *MOUSE* layer contains keys replicating functions found on the mouse.
+
+* 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 & Downkeys.
+* The primary click (right & left) buttons are on the right home row (index & middle fingers)
+* Secondary click buttons are above the standard keys (M3/Wheel click, M4, M5) but I do not use this function.
+
diff --git a/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/rules.mk b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/rules.mk
new file mode 100644
index 0000000000..0ae0b96462
--- /dev/null
+++ b/keyboards/bpiphany/frosty_flake/keymaps/QFR_JM/rules.mk
@@ -0,0 +1,17 @@
+# 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 = yes # Console for debug(+400)
+COMMAND_ENABLE = yes # Commands for debug and configuration
+NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+MIDI_ENABLE = no # MIDI controls
+AUDIO_ENABLE = no # 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.
+SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend