From ef4abfeb3105e03f752d9d1c7b0ad4edecbef75a Mon Sep 17 00:00:00 2001 From: Kaleb Elwert Date: Fri, 16 Jun 2017 10:57:53 -0700 Subject: [PATCH] ergodox: initial addition of belak theme Imported from external repo https://github.com/belak/ergodox-layout at commit 233008ad8c46a85cb118fca0be093c3e751075b0 --- keyboards/ergodox/keymaps/belak/LICENSE | 21 ++ keyboards/ergodox/keymaps/belak/Makefile | 6 + keyboards/ergodox/keymaps/belak/README.md | 79 ++++ keyboards/ergodox/keymaps/belak/keymap.c | 367 +++++++++++++++++++ keyboards/ergodox/keymaps/belak/visualizer.c | 49 +++ 5 files changed, 522 insertions(+) create mode 100644 keyboards/ergodox/keymaps/belak/LICENSE create mode 100644 keyboards/ergodox/keymaps/belak/Makefile create mode 100644 keyboards/ergodox/keymaps/belak/README.md create mode 100644 keyboards/ergodox/keymaps/belak/keymap.c create mode 100644 keyboards/ergodox/keymaps/belak/visualizer.c diff --git a/keyboards/ergodox/keymaps/belak/LICENSE b/keyboards/ergodox/keymaps/belak/LICENSE new file mode 100644 index 0000000000..b462ba30e5 --- /dev/null +++ b/keyboards/ergodox/keymaps/belak/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016 Kaleb Elwert + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/keyboards/ergodox/keymaps/belak/Makefile b/keyboards/ergodox/keymaps/belak/Makefile new file mode 100644 index 0000000000..8a6beea591 --- /dev/null +++ b/keyboards/ergodox/keymaps/belak/Makefile @@ -0,0 +1,6 @@ +TAP_DANCE_ENABLE=yes +UNICODE_ENABLE=yes + +ifndef QUANTUM_DIR + include ../../../../Makefile +endif diff --git a/keyboards/ergodox/keymaps/belak/README.md b/keyboards/ergodox/keymaps/belak/README.md new file mode 100644 index 0000000000..30484e6e20 --- /dev/null +++ b/keyboards/ergodox/keymaps/belak/README.md @@ -0,0 +1,79 @@ +# Belak's Ergodox Layout + +This has been based off of [emacs\_osx\_dk](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/emacs_osx_dk) +from the main qmk repo. However, I've taken some of the ideas for the thumbs +from [dvorak\_emacs](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/dvorak_emacs) +and tweaked it a bit based on the keycaps I have. + +This keyboard is intended for use in emacs (one of the main reasons for easy +access to modifiers) but it could be useful in other instances as well. + +The main repo is used as a testbed, so sometimes the layout may be in a strange +state. The qmk version should be relatively stable. + +## Instructions + +This is currently being used on a regular ergodox, but it should work fine on +the infinity as well. Though, you may have to modify the commands to build and +flash the firmware to match the separate halves as defined in the infinity +documentation. + +If you are using this keymap in the qmk repo, you should be able to just run +`make ergodox-belak-teensy`. If you're using this externally (I sometimes make +changes before syncing them to qmk), use the following instructions: + +1. Clone the main qmk repo +2. Clone this to `$QMK/keyboards/ergodox/keymaps/belak-external` +3. Run `make ergodox-belak-external-teensy` from the root of the qmk repo. + +## Changelog + +Fifth Revision + +* Change layer keys to tap-dance keys which cycle through additional layers +* Add a few emoji keys (in preparation for an emoji layer) + +Fourth Revision + +* Remove media layer +* Add a layer which swaps control and gui on the thumb keys. +* Add some basic code to save settings to the eeprom +* Save the state of the keys swapped in the thumb in the eeprom + +Third Revision + +* Add numpad layer and remove numpad from symbols layer +* Disable media layer +* Add arrow keys on ijkl to the symbols layer +* Replace ALT on held enter and held delete with GUI (for better OSX + compatibility, as there's already an ALT key relatively close) +* Replace keys above enter and delete with temporary layer switch buttons not + matching the other layer switch for that hand. +* Reindent and space out most of the layer definitions + +Second Revision + +* Clean up definitions to make differences between layers easier to see +* Remove old LCD code +* Add new LCD code based on fredizzimo's branch + +First Revision + +* Reverse grave and escape + +Initial Version + +* Copy from emacs\_osx\_dk +* "Fix" right alt +* Change thumb keys to match default layout (backspace, delete, enter, space) +* Add modifiers to thumb keys (ctrl to backspace and space, alt to delete and + enter) +* Replace the RAlt below the brackets with LGui and RGui +* Remove LCtrl and RCtrl from the keys above shift +* Add browser forward, and move browser back +* "Fix" the order of volume keys + +## Repository + +The original code for this is kept at https://github.com/belak/ergodox-layout and +is synced to qmk every few main revisions. diff --git a/keyboards/ergodox/keymaps/belak/keymap.c b/keyboards/ergodox/keymaps/belak/keymap.c new file mode 100644 index 0000000000..d10567a783 --- /dev/null +++ b/keyboards/ergodox/keymaps/belak/keymap.c @@ -0,0 +1,367 @@ +#include "ergodox.h" +#include "debug.h" +#include "action_layer.h" +#include "eeconfig.h" + +#define LAYER_ON(pos) ((layer_state) & (1<<(pos))) +#define _______ KC_TRNS + +#define EECONFIG_BELAK_MAGIC (uint16_t)0xBE42 + +// NOTE: This is just a number that's a bit beyond the end of what's already +// defined. As there is no other define we can base this on, it may need to be +// changed in the future. The initial value here is used as a placeholder with a +// magic word, similar to the normal eeconfig. Note that all the storage being +// used needs to fit inside the 32 bytes of the Ergodox Infinity. +#define EECONFIG_BELAK (uint16_t *)16 + +// The correct way to do this would be how the normal eeconfig handles it and +// use a bitfield. However, the eeprom has a ton of space which isn't being +// used so I don't really care and have a separate byte for every setting. +#define EECONFIG_BELAK_SWAP_GUI_CTRL (uint8_t *)18 + +static uint8_t swap_gui_ctrl = 0; +static uint8_t td_led_override = 0; + +enum belak_keycodes { + // Function codes + BEL_F0 = SAFE_RANGE, + BEL_F1, + + E_SHRUG, + E_TFLIP, + E_TSET, +}; + +inline void tap(uint16_t keycode) { + register_code(keycode); + unregister_code(keycode); +}; + +// TODO: Add LED support to the tap dance by using the advanced macro +#define LTOGGLE TD(TD_LAYER_TOGGLE) + +#define BASE 0 // default layer +#define SYMB 1 // symbols +#define NUMP 2 // numpad +#define SWPH 3 // swap gui/ctrl on the hands + +enum belak_td { + TD_LAYER_TOGGLE = 0, +}; + +void belak_td_each(qk_tap_dance_state_t *state, void *user_data); +void belak_td_finished(qk_tap_dance_state_t *state, void *user_data); +void belak_td_reset(qk_tap_dance_state_t *state, void *user_data); + +qk_tap_dance_action_t tap_dance_actions[] = { + [TD_LAYER_TOGGLE] = ACTION_TAP_DANCE_FN_ADVANCED(belak_td_each, belak_td_finished, belak_td_reset), +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { +/* Keymap 0: Basic layer + * + * ,--------------------------------------------------. ,--------------------------------------------------. + * | Esc | 1 | 2 | 3 | 4 | 5 | L1 | | L2 | 6 | 7 | 8 | 9 | 0 | = | + * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| + * | Tab | Q | W | E | R | T | [ | | ] | Y | U | I | O | P | - | + * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| + * | \ | A | S | D | F | G |------| |------| H | J | K | L | ; | ' | + * |--------+------+------+------+------+------| LGui | | RGui |------+------+------+------+------+--------| + * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift | + * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' + * |Layers| LCtrl| Left | Right| LAlt | | RAlt | Up | Down | RCtrl|Layers| + * `----------------------------------' `----------------------------------' + * ,-------------. ,--------------. + * | ~L2 | Ins | | Grv | ~L1 | + * ,-------|------|------| |------+-------+-------. + * | Back | | Home | | PgUp | | | + * | Space | Del |------| |------| Enter | Space | + * | | | End | | PgDn | | | + * `---------------------' `----------------------' + */ + [BASE] = KEYMAP( // layer 0 : default + // left hand + KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, TG(SYMB), + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_LBRC, + CTL_T(KC_BSLS), KC_A, KC_S, KC_D, KC_F, KC_G, + KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LGUI, + LTOGGLE, KC_LCTRL, KC_LEFT,KC_RGHT,KC_LALT, + MO(NUMP),KC_INS, + KC_HOME, + CTL_T(KC_BSPC),GUI_T(KC_DEL),KC_END, + // right hand + TG(NUMP), KC_6, KC_7, KC_8, KC_9, KC_0, KC_EQL, + KC_RBRC, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_MINS, + KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, + KC_RGUI, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT, + KC_RALT,KC_UP, KC_DOWN,KC_RCTRL, LTOGGLE, + KC_GRV, MO(SYMB), + KC_PGUP, + KC_PGDN, GUI_T(KC_ENT), CTL_T(KC_SPC) + ), +/* Keymap 1: Symbol Layer + * + * ,--------------------------------------------------. ,--------------------------------------------------. + * | | F1 | F2 | F3 | F4 | F5 | | | | F6 | F7 | F8 | F9 | F10 | F11 | + * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| + * | | ! | @ | { | } | | | | | | Up | | Up | | | F12 | + * |--------+------+------+------+------+------| TFLIP| | TSET |------+------+------+------+------+--------| + * | | # | $ | ( | ) | ` |------| |------| Down | Left | Down | Rght | | | + * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| + * | | % | ^ | [ | ] | ~ | SHRUG| | | & | | | | | | + * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' + * |LClear| | | | | | | | | |LClear| + * `----------------------------------' `----------------------------------' + * ,-------------. ,-------------. + * | TOGL | | | | TOGL | + * ,------|------|------| |------+------+------. + * | | | | | | | | + * | | |------| |------| | | + * | | | | | | | | + * `--------------------' `--------------------' + */ + [SYMB] = KEYMAP( + // left hand + _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, E_TFLIP, + _______, KC_EXLM, KC_AT, KC_LCBR, KC_RCBR, KC_PIPE, E_TSET, + _______, KC_HASH, KC_DLR, KC_LPRN, KC_RPRN, KC_GRV, + _______, KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_TILD, E_SHRUG, + BEL_F1, _______, _______, _______, _______, + BEL_F0, _______, + _______, + _______, _______, _______, + // right hand + _______, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, + _______, KC_UP, _______, KC_UP, _______, _______, KC_F12, + KC_DOWN, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, + _______, KC_AMPR, _______, _______, _______, _______, _______, + _______, _______, _______, _______, BEL_F1, + _______, BEL_F0, + _______, + _______, _______, _______ + ), +/* Keymap 2: Numpad Layer + * + * ,--------------------------------------------------. ,--------------------------------------------------. + * | | | | | | | | | | | | | | | | + * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| + * | | | | | | | | | | | 7 | 8 | 9 | * | | + * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| + * | | | | | | |------| |------| | 4 | 5 | 6 | + | | + * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| + * | | | | | | | | | | | 1 | 2 | 3 | \ | | + * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' + * |LClear| | | | | | 0 | 0 | . | = |LClear| + * `----------------------------------' `----------------------------------' + * ,-------------. ,-------------. + * | TOGL | | | | TOGL | + * ,------|------|------| |------+------+------. + * | | | | | | | | + * | | |------| |------| | | + * | | | | | | | | + * `--------------------' `--------------------' + */ + [NUMP] = KEYMAP( + // left hand + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + BEL_F1, _______, _______, _______, _______, + BEL_F0, _______, + _______, + _______, _______, _______, + // right hand + _______, _______, _______, _______, _______, _______, _______, + _______, _______, KC_7, KC_8, KC_9, KC_ASTR, _______, + _______, KC_4, KC_5, KC_6, KC_PLUS, _______, + _______, _______, KC_1, KC_2, KC_3, KC_BSLS, _______, + KC_0, KC_0, KC_DOT, KC_EQL, BEL_F1, + _______, BEL_F0, + _______, + _______, _______, _______ + ), +/* Keymap 3: Swap control and gui on the thumb */ + [SWPH] = KEYMAP( + // left hand + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, + _______, _______, + _______, + GUI_T(KC_BSPC), CTL_T(KC_DEL), _______, + // right hand + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, + _______, _______, + _______, + _______, CTL_T(KC_ENT), GUI_T(KC_SPC) + ), +}; + +// Runs just one time when the keyboard initializes. +void matrix_init_user(void) { + // If our magic word wasn't set properly, we need to zero out the settings. + if (eeprom_read_word(EECONFIG_BELAK) != EECONFIG_BELAK_MAGIC) { + eeprom_update_word(EECONFIG_BELAK, EECONFIG_BELAK_MAGIC); + eeprom_update_byte(EECONFIG_BELAK_SWAP_GUI_CTRL, 0); + } + + if (eeprom_read_byte(EECONFIG_BELAK_SWAP_GUI_CTRL)) { + layer_on(SWPH); + swap_gui_ctrl = 1; + } +}; + +// Runs constantly in the background, in a loop. +void matrix_scan_user(void) { + ergodox_board_led_off(); + ergodox_right_led_1_off(); + ergodox_right_led_2_off(); + ergodox_right_led_3_off(); + + switch (td_led_override) { + case 1: + ergodox_right_led_1_on(); + break; + case 2: + ergodox_right_led_2_on(); + break; + default: + // Layer 1 and 2 are both overlay layers, so they could both be on. This + // means we can't use the lazy check of checking for the first significant + // bit. + if (LAYER_ON(SYMB)) { + ergodox_right_led_1_on(); + } + if (LAYER_ON(NUMP)) { + ergodox_right_led_2_on(); + } + } +}; + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case BEL_F0: + if(record->event.pressed){ + swap_gui_ctrl = !swap_gui_ctrl; + eeprom_update_byte(EECONFIG_BELAK_SWAP_GUI_CTRL, swap_gui_ctrl); + + if (swap_gui_ctrl) { + layer_on(SWPH); + } else { + layer_off(SWPH); + } + + return false; + } + break; + case BEL_F1: + if(record->event.pressed){ + layer_off(SYMB); + layer_off(NUMP); + + return false; + } + break; + case E_SHRUG: // ¯\_(ツ)_/¯ + if (record->event.pressed) { + process_unicode((0x00AF|QK_UNICODE), record); // Hand + tap(KC_BSLS); // Arm + register_code(KC_RSFT); + tap(KC_UNDS); // Arm + tap(KC_LPRN); // Head + unregister_code(KC_RSFT); + process_unicode((0x30C4|QK_UNICODE), record); // Face + register_code(KC_RSFT); + tap(KC_RPRN); // Head + tap(KC_UNDS); // Arm + unregister_code(KC_RSFT); + tap(KC_SLSH); // Arm + process_unicode((0x00AF|QK_UNICODE), record); // Hand + } + return false; + break; + case E_TFLIP: // (╯°□°)╯ ︵ ┻━┻ + if (record->event.pressed) { + register_code(KC_RSFT); + tap(KC_9); + unregister_code(KC_RSFT); + process_unicode((0x256F|QK_UNICODE), record); // Arm + process_unicode((0x00B0|QK_UNICODE), record); // Eye + process_unicode((0x25A1|QK_UNICODE), record); // Mouth + process_unicode((0x00B0|QK_UNICODE), record); // Eye + register_code(KC_RSFT); + tap(KC_0); + unregister_code(KC_RSFT); + process_unicode((0x256F|QK_UNICODE), record); // Arm + tap(KC_SPC); + process_unicode((0x0361|QK_UNICODE), record); // Flippy + tap(KC_SPC); + process_unicode((0x253B|QK_UNICODE), record); // Table + process_unicode((0x2501|QK_UNICODE), record); // Table + process_unicode((0x253B|QK_UNICODE), record); // Table + } + return false; + break; + case E_TSET: // ┬──┬ ノ( ゜-゜ノ) + if (record->event.pressed) { + process_unicode((0x252C|QK_UNICODE), record); // Table + process_unicode((0x2500|QK_UNICODE), record); // Table + process_unicode((0x2500|QK_UNICODE), record); // Table + process_unicode((0x252C|QK_UNICODE), record); // Table + tap(KC_SPC); + process_unicode((0x30CE|QK_UNICODE), record); // Arm + register_code(KC_RSFT); + tap(KC_9); + unregister_code(KC_RSFT); + tap(KC_SPC); + process_unicode((0x309C|QK_UNICODE), record); // Eye + tap(KC_MINS); + process_unicode((0x309C|QK_UNICODE), record); // Eye + process_unicode((0x30CE|QK_UNICODE), record); // Arm + register_code(KC_RSFT); + tap(KC_0); + unregister_code(KC_RSFT); + } + return false; + break; + } + + return true; +} + +void belak_td_each(qk_tap_dance_state_t *state, void *user_data) { + switch (state->count) { + case 1: + td_led_override = 1; + break; + case 2: + td_led_override = 2; + break; + default: + reset_tap_dance(state); + } +} + +void belak_td_finished(qk_tap_dance_state_t *state, void *user_data) { + switch (state->count) { + case 1: + layer_on(SYMB); + break; + case 2: + layer_on(NUMP); + break; + } + td_led_override = 0; +} + +void belak_td_reset(qk_tap_dance_state_t *state, void *user_data) { + td_led_override = 0; +} diff --git a/keyboards/ergodox/keymaps/belak/visualizer.c b/keyboards/ergodox/keymaps/belak/visualizer.c new file mode 100644 index 0000000000..b92890a668 --- /dev/null +++ b/keyboards/ergodox/keymaps/belak/visualizer.c @@ -0,0 +1,49 @@ +/* +Copyright 2017 Fred Sundvik + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +// Currently we are assuming that both the backlight and LCD are enabled +// But it's entirely possible to write a custom visualizer that use only +// one of them +#ifndef LCD_BACKLIGHT_ENABLE +#error This visualizer needs that LCD backlight is enabled +#endif + +#ifndef LCD_ENABLE +#error This visualizer needs that LCD is enabled +#endif + +#include "simple_visualizer.h" + +static void get_visualizer_layer_and_color(visualizer_state_t* state) { + uint8_t saturation = 60; + if (state->status.leds & (1u << USB_LED_CAPS_LOCK)) { + saturation = 255; + } + + if (state->status.layer & 0x4) { + state->target_lcd_color = LCD_COLOR(0, saturation, 0xFF); + state->layer_text = "Media"; + } + else if (state->status.layer & 0x2) { + state->target_lcd_color = LCD_COLOR(168, saturation, 0xFF); + state->layer_text = "Symbols"; + } + else { + state->target_lcd_color = LCD_COLOR(84, saturation, 0xFF); + state->layer_text = "Base"; + } +}