diff options
Diffstat (limited to 'keyboards/planck/keymaps/circuit')
| -rw-r--r-- | keyboards/planck/keymaps/circuit/Readme.md | 46 | ||||
| -rw-r--r-- | keyboards/planck/keymaps/circuit/config.h | 26 | ||||
| -rw-r--r-- | keyboards/planck/keymaps/circuit/keymap.c | 245 | ||||
| -rw-r--r-- | keyboards/planck/keymaps/circuit/rules.mk | 22 |
4 files changed, 0 insertions, 339 deletions
diff --git a/keyboards/planck/keymaps/circuit/Readme.md b/keyboards/planck/keymaps/circuit/Readme.md deleted file mode 100644 index 58ea0140fd..0000000000 --- a/keyboards/planck/keymaps/circuit/Readme.md +++ /dev/null @@ -1,46 +0,0 @@ -##Design goals: -1. Arrow keys always available. -2. As close to a to my US layout 107-key QWERTY keyboard as I could manage, (i.e. as few arbitrary decisions as possible). -3. Togglable DVORAK keyboard. -4. most frequently used things in the easiest to reach places. -5. Ability to game on it, just for fun. - -My layout differs from most in the placement the ARROW keys, `ESC`, VOL keys, use of double-tap `CAPS`, and the GAME LOCK function. - -I put the layer buttons in the usual spots. I originally wanted only function/symbols layer, but that proved detrimental. I use some timed press actions to save some space, but this has been accounted for, (see GAME LOCK below). I'm not fully satisfied with the current product (see NOTES below), so it may change in the future. - -##Effective layers: -* Default later is obviously your letters and modifiers. -* Lower layer [NUMBER] is your numbers and punctuation. -* Upper layer [ACTION] is your symbols and actions. -* Function layer is the infrequently used function keys, layout toggle, game lock, and reset. - -There is also a toggle for the DVORAK/QWERTY layers, but in normal typing this is not of concern. - -###Special keys: -* `RSHFT` and `ENTER` are combined. Tap once for `ENTER` and hold for `RSHFT`. `ENTER` will be registered on release if released within 200 ms, else `RSHFT` is registered starting at 201 ms until release. -* If for some reason, this interferes with the normal usage of the `ENTER` key in any way, (some problem that may never happen), I have added a regular non-modified `ENTER` key on the same key in the [ACTION] layer. -* `LSHFT` and `CAPS` are also combined. The key works like a normal `LSHFT` unless double-tapped, in which case it counts as `CAPS`. This functionality unfortunately delays all key presses by at most 200 ms, but I have added ways to disable this both temporarily or permanently, described below. -* A failsafe `CAPS` key is on the same key in the [ACTION] layer. -* There are `UNDO`, `CUT`, `COPY`, and `PASTE` keys. This was intended to be a universal way to use these commands since in macOS cut is `⌘ + C` but in Windows it is `⌃ + C`. Unfortunately these special keys only work in Windows. ¯\\\_(ツ)\_/¯ - -##Game lock: -**TL;DR** the game lock toggle disables the double-tap `CAPS`, and disables `GUI` keys (WINDOWS key). - -I wished for this keyboard to be fully usable in the most demanding of games. The most demanding game I know of is ARMA 3 which has a binding to practically every individual key of a 107-key keyboard. This means I need to have pretty much every key possible somewhere. I also wanted the keyboard to be responsive in games for every critical keypress. This means having a way to disable features that introduce an inherent delay to registering keys, such as double-tap. - -I do not expect to see this used by the pros, but I enjoyed making it. As for use in ARMA 3, I got a little ways into the APEX campaign, but I found a few flaws. For Example, I cannot enable my HUD GPS since that requires `RCTRL`+`M` but `RCTRL` is not bound. The obvious fix is to rebind the action to a new key, but I still take this as a shortcoming of my layout. - -###If you wish to disable double-tap -####Disable it temporarily -Turn on the game lock. While on, it registers as normal `LSHFT` and has no delay. Whether in game mode or not, `CAPS` is on the same key in the [ACTION] layer. - -####Disable it permanently -Open the `Makefile` and set `TAP_DANCE_ENABLE = no`. I wrote the layout to compensate for this change, and no further changes to the code should be necessary. Whether or not it's disabled, `CAPS` is on the same key in the [ACTION] layer. - -##Notes: -* `ALT` and `GUI` are reversed compared to the normal US layout. I will also be using my Planck on my mac, and that's the standard in the Apple ecosystem. I may add a special compiler flag in the future to swap the two. -* The DVORAK `Z` key is to the right of the `S` key instead of under it as part of a compromise I made to keep the ARROW keys available on the default layer. I prioritize the ARROW keys, so the DVORAK layout is the one to suffer. -* I also support the little tones that the default Planck layout features, identical to them too, (minus those for layouts I don't support). To enable it, open the `Makefile` and set `AUDIO_ENABLE = yes`. - - diff --git a/keyboards/planck/keymaps/circuit/config.h b/keyboards/planck/keymaps/circuit/config.h deleted file mode 100644 index 2bebf48a1c..0000000000 --- a/keyboards/planck/keymaps/circuit/config.h +++ /dev/null @@ -1,26 +0,0 @@ -#ifndef CONFIG_USER_H -#define CONFIG_USER_H - -#include "../../config.h" - -/* - * MIDI options - */ - -/* 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
\ No newline at end of file diff --git a/keyboards/planck/keymaps/circuit/keymap.c b/keyboards/planck/keymaps/circuit/keymap.c deleted file mode 100644 index 805ebd7fd3..0000000000 --- a/keyboards/planck/keymaps/circuit/keymap.c +++ /dev/null @@ -1,245 +0,0 @@ -// Layout picture at http://www.keyboard-layout-editor.com/#/gists/125febfad6960add078e6f14256539b6 - -#include QMK_KEYBOARD_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 _DVORAK 1 -#define _LOCKED 2 -#define _NUMBER 3 -#define _ACTION 4 -#define _FUNCTN 5 - -enum planck_keycodes { - QWERTY = SAFE_RANGE, - DVORAK, - NUMBER, - ACTION -}; - -// Key code names -#define SFT_ENT MT(MOD_RSFT, KC_ENT) // Tap for enter, hold for right shift -#define LOCK TG(_LOCKED) -#define KC_PSTE KC_PASTE - -#ifdef TAP_DANCE_ENABLE -#define SFT_CAP TD(0) // Left shift, double tap for caps -#endif -#ifndef TAP_DANCE_ENABLE -#define SFT_CAP KC_LSFT // Regular left shift -#endif - -// Tap Dance Definitions -#ifdef TAP_DANCE_ENABLE -qk_tap_dance_action_t tap_dance_actions[] = { - [0] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS) -}; -#endif - -// Layout definitions -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 | , | . | Up |SftEnt| - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | Ctrl | Alt | Cmd | Vol- | ACTN | Space | NUMS | Vol+ | Left | Down | Left | - * `-----------------------------------------------------------------------------------' - */ -[_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, - SFT_CAP, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, SFT_ENT, - KC_LCTL, KC_LALT, KC_LGUI, KC_VOLD, ACTION, KC_SPC, KC_SPC, NUMBER, KC_VOLU, KC_LEFT, KC_DOWN, KC_RGHT -), - -/* DVORAK - * ,-----------------------------------------------------------------------------------. - * | | ' | , | . | P | Y | F | G | C | R | L | | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | A | O | E | U | I | D | H | T | N | S | Z | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | ; | Q | J | K | X | B | M | W | V | | | - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | | | | | | | | | | | | - * `-----------------------------------------------------------------------------------' - */ -[_DVORAK] = LAYOUT_planck_grid( - _______, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, _______, - _______, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_Z , - _______, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, _______, _______, - _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ -), - -/* LOCK - * ,-----------------------------------------------------------------------------------. - * | | | | | | | | | | | | | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | | | | | | | | | | | | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | Shift| | | | | | | | | | | | - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | | | NULL | | | | | | | | | - * `-----------------------------------------------------------------------------------' - */ -[_LOCKED] = LAYOUT_planck_grid( - _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, - _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, - KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, - _______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, _______, _______ -), - -/* NUMBERS - * ,-----------------------------------------------------------------------------------. - * | | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | ~ | NULL | NULL | NULL | | | _ | + | { | } | ? | / | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | ` | NULL | NULL | NULL | \ | - | = | [ | ] | | | - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | | | | | | NULL | | | | | | - * `-----------------------------------------------------------------------------------' - */ -[_NUMBER] = LAYOUT_planck_grid( - _______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______, - _______, KC_TILD, XXXXXXX, XXXXXXX, XXXXXXX, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_QUES, KC_SLSH, - _______, KC_GRV, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSLS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, _______, _______, - _______, _______, _______, _______, _______, XXXXXXX, XXXXXXX, _______, _______, _______, _______, _______ -), - -/* ACTIONS - * ,-----------------------------------------------------------------------------------. - * | | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | CAPS | Undo | Cut | Copy | Paste| NULL | NULL | NULL | NULL | NULL | PgUp | Enter| - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | | | | Mute | | NULL | | NULL | Home | PgDn | End | - * `-----------------------------------------------------------------------------------' - */ -[_ACTION] = LAYOUT_planck_grid( - _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL , - _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - KC_CAPS, KC_UNDO, KC_CUT, KC_COPY, KC_PSTE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PGUP, KC_ENT , - _______, _______, _______, KC_MUTE, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, KC_HOME, KC_PGDN, KC_END -), - -/* FUNCTIONS - * ,-----------------------------------------------------------------------------------. - * | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 | F21 | F22 | F23 | F24 | - * |------+------+------+------+------+------+------+------+------+------+------+------| - * | NULL | NULL | NULL | NULL | NULL |QWERTY|DVORAK| NULL | NULL | NULL | NULL | NULL | - * |------+------+------+------+------+-------------+------+------+------+------+------| - * | Reset| NULL | Lock | NULL | | NULL | | NULL | NULL | NULL | NULL | - * `-----------------------------------------------------------------------------------' - */ -[_FUNCTN] = LAYOUT_planck_grid( - 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_F13, KC_F14, KC_F15, KC_F16, KC_F17, KC_F18, KC_F19, KC_F20, KC_F21, KC_F22, KC_F23, KC_F24 , - XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QWERTY, DVORAK, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - RESET, XXXXXXX, LOCK, XXXXXXX, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX -) - -}; - -#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 music_scale[][2] = SONG(MUSIC_SCALE_SOUND); -float tone_goodbye[][2] = SONG(GOODBYE_SOUND); -#endif - - -bool process_record_user(uint16_t keycode, keyrecord_t *record) { - switch (keycode) { - case QWERTY: - if (record->event.pressed) { - if (IS_LAYER_ON(_DVORAK)) { -#ifdef AUDIO_ENABLE - PLAY_SONG(tone_qwerty); -#endif - layer_off(_DVORAK); - } - } - return false; - break; - case DVORAK: - if (record->event.pressed) { - if (!IS_LAYER_ON(_DVORAK)) { -#ifdef AUDIO_ENABLE - PLAY_SONG(tone_dvorak); -#endif - layer_on(_DVORAK); - } - } - return false; - break; - case NUMBER: - if (record->event.pressed) { - layer_on(_NUMBER); - update_tri_layer(_NUMBER, _ACTION, _FUNCTN); - } else { - layer_off(_NUMBER); - update_tri_layer(_NUMBER, _ACTION, _FUNCTN); - } - return false; - break; - case ACTION: - if (record->event.pressed) { - layer_on(_ACTION); - update_tri_layer(_NUMBER, _ACTION, _FUNCTN); - } else { - layer_off(_ACTION); - update_tri_layer(_NUMBER, _ACTION, _FUNCTN); - } - 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_SONG(tone_startup); -} - -void shutdown_user() -{ - PLAY_SONG(tone_goodbye); - _delay_ms(150); - stop_all_notes(); -} - -void music_on_user(void) -{ - music_scale_user(); -} - -void music_scale_user(void) -{ - PLAY_SONG(music_scale); -} - -#endif diff --git a/keyboards/planck/keymaps/circuit/rules.mk b/keyboards/planck/keymaps/circuit/rules.mk deleted file mode 100644 index 14247d1a5c..0000000000 --- a/keyboards/planck/keymaps/circuit/rules.mk +++ /dev/null @@ -1,22 +0,0 @@ - -# Build Options -# change to "no" to disable the options, or define them in the makefile.mk in -# the appropriate keymap folder that will get included automatically -# -BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite -MOUSEKEY_ENABLE = no # 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 = 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. -TAP_DANCE_ENABLE = yes # Enables the double-tap functionality of keys - -# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE -SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend - |