drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Keymap] Add issmirnov {user, ergodox, levinson} files. (#7239)

Browse source 
* Add issmirnov {user, ergodox, levinson} files.

There are enough interesting QMK tricks in these layouts that it seems
worth it to share with the broader community. Big thanks to Drashna for
inspiration, as well as all the wonderful creators of QMK documentation.

Some highlights:
- Common layout shared between levinson and ergodox_ez
- TAP_TOG macro for fast layer switching
- Autogenerated keymaps ascii art with git hooks

I will do my best to do periodic rolls here, but the source of truth
will always be https://github.com/issmirnov/qmk-keebs

* Incorporate review feedback.

- Remove CLEAR_EEPROM in favor of built in EEP_RST
- Remove custom handlers for audio on bootup and shutdown
- Remove plethora of unneeded includes
- Remove deprecated and dupliated config options

HUGE thanks to drashna for the review!

* Apply suggestions from code review

Huge thanks to drashna@ for a very thorough review and the very useful suggestions.

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Remove unclear optimization

This was an artifact from some other keymap I saw.
This commit is contained in:
Ivan Smirnov 2019-11-08 19:17:21 -08:00 • committed by James Young
parent 5414ff709f
commit 2b30776dd0
25 changed files with 1023 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

49
layouts/community/ergodox/issmirnov/README.md Normal file
View file

@ -0,0 +1,49 @@
# Ivan's Ergodox Config
## Details about the layout
- Shift and Cmd are One Shot Modifiers, so tapping them once will apply them to the next key. When tapped twice they will lock, until tapped again to clear.
- When switching to other layers, any stuck modifiers are cleared in order to avoid unintended key combos
- There are a few leader key combinations. Right now, `KC_LEAD` + `s` will open my wiki homepage.
- All transparent keys have been replaced with noops to avoid layer bleeding.
## Initial Setup
### QMK
```
brew tap osx-cross/avr
brew tap PX4/homebrew-px4
brew update
brew install avr-gcc
brew install dfu-programmer
brew install gcc-arm-none-eabi
brew install avrdude
git clone https://github.com/qmk/qmk_firmware.git
git clone https://github.com/issmirnov/ergodox-layout.git \
layouts/community/ergodox/ismirnov
```
### Teensy utils
Download and add both of these to $PATH
- [hid_listen](https://www.pjrc.com/teensy/hid_listen.html)
- [teensy loader cli](https://www.pjrc.com/teensy/loader_cli.html)
## Flashing
```
make ergodox_ez:ismirnov
teensy_loader_cli -mmcu=atmega32u4 -w -v ergodox_ez_ismirnov.hex
# or just
make ergodox_ez:ismirnov:flash
```
## Gotchas
- If you get error: `dyld: Library not loaded: /usr/local/opt/isl/lib/libisl.15.dylib` then do `brew reinstall avr-gcc`
- If `hid_listen` just prints out a ton of dots, update makefile with `CONSOLE_ENABLE = yes`

95
layouts/community/ergodox/issmirnov/asci-keymap.txt Normal file
View file

@ -0,0 +1,95 @@
Qwerty
,--------------------------------------------. ,--------------------------------------------.
| Escape | 1 | 2 | 3 | 4 | 5 | ! | | = | 6 | 7 | 8 | 9 | 0 | Escape |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
|Lctl(Spa| Q | W | E | R | T | * | | + | Y | U | I | O | P |Lgui(Spa|
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| Tab | A | S | D | F | G |-----| |-----| H | J | K | L |TapTo|Mo(Navi)|
|--------+-----+-----+-----+-----+-----| / | | - |-----+-----+-----+-----+-----+--------|
|Osm(ModL| Z | X | C | V | B | | | | N | M | . |Comma|Tg(Nu| ' |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
|Ctrl |Lsft(|Lsft(| Alt | Mod | |Escap| : | % | |Lgui(|
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| | | | ← | → |
,-----|-----|-----| |-----+-----+-----.
| | | | | ↑ | | |
| ⎵ | ⌫ |-----| |-----| Tab |Enter|
| | | Del | | ↓ | | |
`-----------------' `-----------------'
Symb
,--------------------------------------------. ,--------------------------------------------.
| Escape | F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 | |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
| | - | @ | { | } | ` | * | | + | * | ! | | | % | + |Mo(Navi)|
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| Tab | ^ | _ | ( | ) | $ |-----| |-----| # | = | : | ; |TapTo| Dquo |
|--------+-----+-----+-----+-----+-----| / | | - |-----+-----+-----+-----+-----+--------|
| Lshift | < | > | [ | ] | ~ | | | | & | ? | / | \ |Tg(Nu| ' |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
|Ctrl |Lsft(|Lsft(| Alt |WkspL| |Escap| : | % | | |
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| | | | ← | → |
,-----|-----|-----| |-----+-----+-----.
| | | | | ↑ | | |
|WkspR| ⌫ |-----| |-----| Tab |Enter|
| | | Del | | ↓ | | |
`-----------------' `-----------------'
Nump
,--------------------------------------------. ,--------------------------------------------.
| | | | | | | | | = | | | | | | Reset |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
| | No | No |Lgui(| | | * | | + | , | 7 | 8 | 9 | | |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| Tab | |Lgui(|Lgui(|Lgui(| |-----| |-----| 0 | 4 | 5 | 6 |To(Sy| |
|--------+-----+-----+-----+-----+-----| / | | - |-----+-----+-----+-----+-----+--------|
| | | | |Audio|Audio| | | | . | 1 | 2 | 3 |To(Qw| |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
|To(0)| | | | | | 0 | | |To(3)| |
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| | | | ← | → |
,-----|-----|-----| |-----+-----+-----.
| | | | | ↑ | | |
| ⎵ | ⌫ |-----| |-----| Alt |Shift|
| | | Del | | ↓ | | |
`-----------------' `-----------------'
Overwatch
,--------------------------------------------. ,--------------------------------------------.
| Escape | 1 | 2 | 3 | 4 | 5 |To(0)| | | | | | | | |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
| Tab | Q | W | E | R | T | | | | | | | | | |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| Ctrl | A | S | D | F | P |-----| |-----| | | | | | |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| Lshift | Z | X | C | V |Grave| | | | | | | | | |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
|Ctrl | F9 |Pscre| H | R | | | | | | |
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| | | | | |
,-----|-----|-----| |-----+-----+-----.
| | | | | | | |
| ⎵ | |-----| |-----| | |
| | | | | | | |
`-----------------' `-----------------'
Navi
,--------------------------------------------. ,--------------------------------------------.
| Escape | 1 | 2 | 3 | 4 | 5 | 6 | | | | | | | | |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
| | | | ↑ | | | | | | | | | | | |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| | | ← | ↓ | → | |-----| |-----| |Ctrl | | | | |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| | | | | | | | | | | | | | | |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
| | | | |WkspL| | ⌘⇧ | | | | |
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| | | | | |
,-----|-----|-----| |-----+-----+-----.
| | | | | | | |
|WkspR| |-----| |-----| | Mod |
| | | | | | | |
`-----------------' `-----------------'

2
layouts/community/ergodox/issmirnov/build.sh Executable file
View file

@ -0,0 +1,2 @@
#!/bin/bash
make ergodox_ez:issmirnov

3
layouts/community/ergodox/issmirnov/config.h Normal file
View file

@ -0,0 +1,3 @@
// Reference: https://beta.docs.qmk.fm/reference/config-options
// and https://github.com/qmk/qmk_firmware/blob/master/docs/config_options.md
#include QMK_KEYBOARD_CONFIG_H

250
layouts/community/ergodox/issmirnov/keymap.c Normal file
View file

@ -0,0 +1,250 @@
#include QMK_KEYBOARD_H
// Custom user includes
#include "issmirnov.h"
#include "tap_tog.h"
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_QWERTY] = LAYOUT_ergodox_wrapper(
KC_ESCAPE, KC_1, KC_2, KC_3, KC_4, KC_5, KC_EXLM,
LCTL(KC_SPACE), _________________QWERTY_L1_________________, KC_ASTR,
KC_TAB, _________________QWERTY_L2_________________,
OSM(MOD_LSFT), _________________QWERTY_L3_________________, KC_SLASH,
KC_LCTL, LSFT(KC_LGUI), LSFT(KC_LALT), KC_LALT, KC_LGUI,
XXXXXXX, XXXXXXX,
XXXXXXX,
KC_SPACE, KC_BSPACE, KC_DEL,
KC_EQL , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_ESCAPE ,
KC_PLUS , _________________QWERTY_R1_________________ , LGUI(KC_SPACE) ,
_________________QWERTY_R2_________________ , MO(_NAVI) ,
KC_MINS , _________________QWERTY_R3_________________ , KC_QUOTE ,
KC_ESCAPE , KC_COLN , KC_PERC , XXXXXXX , LGUI(KC_L) ,
KC_LEFT, KC_RGHT,
KC_UP,
KC_DOWN, KC_TAB, KC_ENTER
),
// layer 1
[_SYMB] = LAYOUT_ergodox_wrapper(
KC_ESCAPE , KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 ,
XXXXXXX , _________________SYMB_L1___________________ ,KC_ASTR ,
KC_TAB , _________________SYMB_L2___________________,
KC_LSHIFT , _________________SYMB_L3___________________, KC_SLASH ,
KC_LCTL , LSFT(KC_LGUI) , LSFT(KC_LALT) , KC_LALT , WKSP_LEFT ,
XXXXXXX, XXXXXXX,
XXXXXXX,
WKSP_RIGHT, KC_BSPACE, KC_DEL,
KC_F7 , KC_F8 , KC_F9 , KC_F10 , KC_F11 , KC_F12 , XXXXXXX ,
KC_PLUS , _________________SYMB_R1___________________ , MO(_NAVI) ,
_________________SYMB_R2___________________ , KC_DQUO ,
KC_MINS , _________________SYMB_R3___________________ , KC_QUOTE ,
KC_ESCAPE , KC_COLN , KC_PERC , XXXXXXX , XXXXXXX ,
KC_LEFT, KC_RGHT,
KC_UP,
KC_DOWN, KC_TAB, KC_ENTER
),
// layer 2
[_NUMP] = LAYOUT_ergodox_wrapper(
XXXXXXX , ___________________XXXXX___________________, XXXXXXX ,
XXXXXXX , _________________NUMP_L1___________________ , KC_ASTR ,
KC_TAB , _________________NUMP_L2___________________ ,
XXXXXXX , _________________NUMP_L3___________________ , KC_SLASH ,
TO(0) , XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
XXXXXXX , XXXXXXX ,
XXXXXXX ,
KC_SPACE , KC_BSPACE , KC_DEL ,
KC_EQL , ___________________XXXXX___________________ , RESET ,
KC_PLUS , _________________NUMP_R1___________________ , XXXXXXX ,
_________________NUMP_R2___________________ , XXXXXXX ,
KC_MINS , _________________NUMP_R3___________________ , XXXXXXX ,
KC_0 , XXXXXXX , XXXXXXX , TO(3) , XXXXXXX ,
KC_LEFT, KC_RGHT,
KC_UP,
KC_DOWN, KC_LALT, KC_LSFT
),
// layer 3
[_OVERWATCH] = LAYOUT_ergodox_wrapper(
KC_ESCAPE, KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , TO(0) ,
______________OVERWATCH_L1_________________ , XXXXXXX ,
______________OVERWATCH_L2_________________ ,
______________OVERWATCH_L3_________________ , XXXXXXX ,
______________OVERWATCH_L4_________________ ,
XXXXXXX , XXXXXXX ,
XXXXXXX ,
KC_SPACE , XXXXXXX , XXXXXXX ,
_______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______,
_______, _______,
_______,
_______, _______, _______
),
// layer 4
[_NAVI] = LAYOUT_ergodox_wrapper(
KC_ESCAPE, KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 ,
XXXXXXX, _________________NAVI_L1___________________ , XXXXXXX ,
XXXXXXX, _________________NAVI_L2___________________ ,
XXXXXXX, _________________NAVI_L3___________________ , XXXXXXX ,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, WKSP_LEFT,
XXXXXXX , XXXXXXX ,
XXXXXXX ,
WKSP_RIGHT , XXXXXXX , XXXXXXX ,
_______, _______, _______, _______, _______, _______, _______,
_______, _________________NAVI_R1___________________, _______,
_________________NAVI_R2___________________, _______,
_______, _________________NAVI_R3___________________, _______,
MODSFT, _______, _______, _______, _______,
_______, _______,
_______,
_______, _______, KC_LGUI
),
};
// called by QMK during key processing before the actual key event is handled. Useful for macros.
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
uint8_t layer = biton32(layer_state);
switch (keycode) {
case TAP_TOG_LAYER:
process_tap_tog(_SYMB,record);
return false;
break;
case WKSP_LEFT:
// Only if TAP_TOG_LAYER is being held right now do we want to do actions.
if (record->event.pressed && (!tap_tog_layer_toggled_on || layer == _NAVI)) {
tap_code16(LGUI(LSFT(KC_Z)));
tap_tog_layer_other_key_pressed = true; // Add flag so layer resets
}
break;
case WKSP_RIGHT:
// Only if TAP_TOG_LAYER is being held right now do we want to do actions.
if (record->event.pressed && (!tap_tog_layer_toggled_on || layer == _NAVI)) {
tap_code16(LGUI(LSFT(KC_X)));
tap_tog_layer_other_key_pressed = true; // Add flag so layer resets
}
break;
default:
tap_tog_count = 0; // reset counter.
tap_tog_layer_other_key_pressed = true; // always set this to true, TAP_TOG_LAYER handlers will handle interpreting this
break;
}
return true;
}
// Runs constantly in the background, in a loop every 100ms or so.
// Best used for LED status output triggered when user isn't actively typing.
void matrix_scan_user(void) {
uint8_t layer = biton32(layer_state);
if (layer == 0) {
// Set up LED indicators for stuck modifier keys.
// https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/report.h#L118
switch (keyboard_report->mods) {
case MOD_BIT(KC_LSFT): // LSHIFT
ergodox_right_led_1_set (LED_BRIGHTNESS_LO);
ergodox_right_led_1_on ();
ergodox_right_led_2_set (LED_BRIGHTNESS_LO);
ergodox_right_led_2_on ();
ergodox_right_led_3_set (LED_BRIGHTNESS_HI);
ergodox_right_led_3_off ();
break;
case MOD_BIT(KC_LGUI): // LGUI
ergodox_right_led_1_set (LED_BRIGHTNESS_HI);
ergodox_right_led_1_off ();
ergodox_right_led_2_set (LED_BRIGHTNESS_LO);
ergodox_right_led_2_on ();
ergodox_right_led_3_set (LED_BRIGHTNESS_LO);
ergodox_right_led_3_on ();
break;
case MOD_BIT(KC_LSFT) ^ MOD_BIT(KC_LGUI):
ergodox_right_led_1_set (70);
ergodox_right_led_1_on ();
ergodox_right_led_2_set (70);
ergodox_right_led_2_on ();
ergodox_right_led_3_set (70);
ergodox_right_led_3_on ();
break;
default: // reset leds
ergodox_right_led_1_set (LED_BRIGHTNESS_HI);
ergodox_right_led_1_off ();
ergodox_right_led_2_set (LED_BRIGHTNESS_HI);
ergodox_right_led_2_off ();
ergodox_right_led_3_set (LED_BRIGHTNESS_HI);
ergodox_right_led_3_off ();
}
}
}
// only runs when when the layer is changed, good for updating LED's and clearing sticky state
uint32_t layer_state_set_user(uint32_t state) {
uint8_t layer = biton32(state);
ergodox_board_led_off();
ergodox_right_led_1_off();
ergodox_right_led_2_off();
ergodox_right_led_3_off();
combo_enable(); // by default, enable combos.
switch (layer) {
case 0:
break;
case 1:
clear_mods();
ergodox_right_led_1_on();
break;
case 2:
clear_mods();
ergodox_right_led_2_on();
break;
case _OVERWATCH:
clear_mods();
combo_disable(); // We don't want combos in overwatch
ergodox_right_led_3_on();
break;
case 4:
ergodox_right_led_1_on();
ergodox_right_led_2_on();
break;
case 5:
ergodox_right_led_1_on();
ergodox_right_led_3_on();
break;
case 6:
ergodox_right_led_2_on();
ergodox_right_led_3_on();
break;
case 7:
ergodox_right_led_1_on();
ergodox_right_led_2_on();
ergodox_right_led_3_on();
break;
default:
break;
}
return state;
};

2
layouts/community/ergodox/issmirnov/push.sh Executable file
View file

@ -0,0 +1,2 @@
#!/bin/bash
make ergodox_ez:issmirnov:teensy

17
layouts/community/ergodox/issmirnov/template.txt Normal file
View file

@ -0,0 +1,17 @@
,--------------------------------------------. ,--------------------------------------------.
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | | 38 | 39 | 40 | 41 | 42 | 43 | 44 |
|--------+-----+-----+-----+-----+-----+-----| |-----+-----+-----+-----+-----+-----+--------|
| 7 | 8 | 9 | 10 | 11 | 12 | 13 | | 45 | 46 | 47 | 48 | 49 | 50 | 51 |
|--------+-----+-----+-----+-----+-----| | | |-----+-----+-----+-----+-----+--------|
| 14 | 15 | 16 | 17 | 18 | 19 |-----| |-----| 52 | 53 | 54 | 55 | 56 | 57 |
|--------+-----+-----+-----+-----+-----| 26 | | 58 |-----+-----+-----+-----+-----+--------|
| 20 | 21 | 22 | 23 | 24 | 25 | | | | 59 | 60 | 61 | 62 | 63 | 64 |
`--------+-----+-----+-----+-----+-----------' `-----------+-----+-----+-----+-----+--------'
| 27 | 28 | 29 | 30 | 31 | | 65 | 66 | 67 | 68 | 69 |
`-----------------------------' ,-----------. ,-----------. `-----------------------------'
| 32 | 33 | | 70 | 71 |
,-----|-----|-----| |-----+-----+-----.
| | | 34 | | 72 | | |
| 35 | 36 |-----| |-----| 74 | 75 |
| | | 37 | | 73 | | |
`-----------------' `-----------------'