lunny/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[planck] Adds Sean Hunter keymap(#1706)

Browse Source 
* Sean Hunter initial keymap

* Update old map to sync it up with new one

* Add TODO
fix a few minor things

* small doc fixes

* Minor fixups
This commit is contained in:
Sean Hunter
2017-09-13 22:47:48 +01:00
committed by Jack Humbert
parent 63028dde82
commit cf001300b3
6 changed files with 599 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
keyboards/planck/keymaps/sean/Makefile Normal file
View File

@ -0,0 +1,4 @@
ifndef QUANTUM_DIR
include ../../../../Makefile
endif
MOUSEKEY_ENABLE = yes

29
keyboards/planck/keymaps/sean/config.h Normal file
View File

@ -0,0 +1,29 @@
#ifndef CONFIG_USER_H
#define CONFIG_USER_H
#include "../../config.h"
/*
* 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

306
keyboards/planck/keymaps/sean/keymap.c Normal file
View File

File diff suppressed because it is too large Load Diff

39
keyboards/planck/keymaps/sean/mymappings.h Normal file
View File

@ -0,0 +1,39 @@
//Defines etc for Sean Hunter's keymap.
#include "keymap_extras/keymap_dvorak.h"
#define PERMISSIVE_HOLD
//Special hammerspoon keys
#define HMENU LCTL(LSFT(KC_BSLS))
#define HRESET LCTL(LSFT(KC_EQL))
#define HRVL LCTL(LSFT(KC_SLSH))
//Make virtual desktops a little easier on i3 (otherwise on this keyboard they're awkward
#define GUI_1 LGUI(KC_1)
#define GUI_2 LGUI(KC_2)
#define GUI_3 LGUI(KC_3)
#define GUI_4 LGUI(KC_4)
#define GUI_5 LGUI(KC_5)
#define GUI_6 LGUI(KC_6)
#define GUI_7 LGUI(KC_7)
#define GUI_8 LGUI(KC_8)
#define GUI_9 LGUI(KC_9)
#define GUI_10 LGUI(KC_0)
//Abbreviations for mouse keys
#define KC_MUP KC_MS_UP
#define KC_MDN KC_MS_DOWN
#define KC_MLFT KC_MS_LEFT
#define KC_MRGT KC_MS_RIGHT
#define KC_MB1 KC_MS_BTN1
#define KC_MB2 KC_MS_BTN2
#define KC_MB3 KC_MS_BTN3
#define KC_MB4 KC_MS_BTN4
#define KC_MB5 KC_MS_BTN5
#define KC_MWUP KC_MS_WH_UP
#define KC_MWDN KC_MS_WH_DOWN
// Fillers to make layering more clear
#define _______ KC_TRNS
#define XXXXXXX KC_NO

130
keyboards/planck/keymaps/sean/readme.md Normal file
View File

@ -0,0 +1,130 @@
# Sean Hunter's Planck Layout
## Main layout
Inspired by my old typematrix dvorak keyboard, with escape, tab, enter and
backspace in the middle.
```
,-----------------------------------------------------------------------------------.
| " | , | . | P | Y | / | = | F | G | C | R | L |
|------+------+------+------+------+------+------+------+------+------+------+------|
| A | O | E | U | I | ESC | BSPC | D | H | T | N | S |
|------+------+------+------+------+------+------+------+------+------+------+------|
| ; | Q | J | K | X | TAB | ENT | B | M | W | V | Z |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Sft | Ctl | Alt | Gui |Lower | Space |Raise | < | v | ^ | > |
`-----------------------------------------------------------------------------------'
```
## Lower
With Lower, the numbers are on the home row. Brackets and braces are down the
centre of the keyboard when holding lower, and most other special characters,
can be found on the row below home. One row up are the main function keys.
The arrow keys become `Home`, `End` and `Page Up` and `Page Down`.
```
,-----------------------------------------------------------------------------------.
| F1 | F2 | F3 | F4 | F5 | { | } | F6 | F7 | F8 | F9 | F10 |
|------+------+------+------+------+-------------+------+------+------+------+------|
| 1 | 2 | 3 | 4 | 5 | [ | ] | 6 | 7 | 8 | 9 | 0 |
|------+------+------+------+------+------|------+------+------+------+------+------|
| ~ | | | ` | - | _ | INS | DEL | ( | ) | + | = | \ |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Sft | Ctl | Alt | Gui |Lower | |Raise | Home | PgDn | PgUp | End |
`-----------------------------------------------------------------------------------'
```
## Raise
With Raise, the middle row functions as though we are holding shift and typing
numbers. This makes it a little easier than trying to hold lower and shift at
the same time. The row below home is a set of keys mapped from `Gui-1` to
`Gui-0`. I use these to change virtual desktops on [i3](https://i3wm.org/). I
also include 'right' versions of the modifier keys on here.
```
,-----------------------------------------------------------------------------------.
| F11 | F12 | F13 | F14 | F15 | | | F16 | F17 | F18 | F19 | F20 |
|------+------+------+------+------+-------------+------+------+------+------+------|
| ! | @ | # | $ | % |Sleep | Wake | ^ | & | * | ( | ) |
|------+------+------+------+------+-------------+------+------+------+------+------|
| GUI1 | GUI2 | GUI3 | GUI4 | GUI5 | | | GUI6 | GUI7 | GUI8 | GUI9 |GUI10 |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Sft | Ctl | Alt | Gui |Lower | |Raise | Gui | Alt | Ctl | Sft |
`-----------------------------------------------------------------------------------'
```
## Adjust
Raise and lower at the same time give an adjustment layer, which allows
changing to the numpad and movement layer, and adjusting the backlights
(assuming you have them - I don't yet). I have also added various media keys
and the all-important `Reset` key for programming the keyboard. I've got the
ability to swap `Alt` and `Gui` in hardware and three special keys set up for
[hammerspoon]( http://www.hammerspoon.org/) on mac. If I ever start using this
keyboard seriously on mac again (I'm using it mainly on Windows and Linux atm)
I'll write a special Mac mode and redo all my hammerspoon config to be more
like i3 on Linux.
```
Adjust (Lower + Raise)
,-----------------------------------------------------------------------------------.
| | Reset| | | |AGnorm|AGswap| | |HRevl |HReset|HMenu |
|------+------+------+------+------+-------------+------+------+------+------+------|
| PWR | EJCT | CUT | COPY |PASTE |PrScr |SysReq| CAPS | << | >> | Mute | Stop |
|------+------+------+------+------+------|------+------+------+------+------+------|
|DVORAK|NUMPAD| MVMT | SDRK | | | | | Next | Vol- | Vol+ | Play |
|------+------+------+------+------+------+------+------+------+------+------+------|
|Brite |BToggl| | | | | | Gui | Alt | Ctl | Sft |
`-----------------------------------------------------------------------------------'
```
## Numpad
I have added a numpad, although this is a little annoying at the moment as you
have to first press `NumLock` to use. I guess I could make a macro so as soon as
you go into numpad mode it turns `NumLock` on.
```
,-----------------------------------------------------------------------------------.
| | | | | | | |NumLck| 7 | 8 | 9 | / |
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | | |Enter | 4 | 5 | 6 | * |
|------+------+------+------+------+------+------+------+------+------+------+------|
|DVORAK|NUMPAD| MVMT | SDRK | | | | | 3 | 2 | 1 | - |
|------+------+------+------+------+-------------+------+------+------+------+------|
| | | | | | | | | 0 | . | + |
`-----------------------------------------------------------------------------------'
```
## Movement
I have added a movement layer but at present I seldom use it.
```
,-----------------------------------------------------------------------------------.
|MsBut2|MsWhDn|MsWhUp|MsBut1|MsBut3| | | | Home | PgDn | PgUp | End |
+------+------+------+------+------+------+------+------+------+------+------+------+
|Ms Lft|Ms Dn |Ms Up |Ms Rht| | | | | Left | Down | Up | Right|
|------+------+------+------+------+------+------+------+------+------+------+------|
|DVORAK|NUMPAD| MVMT | SDRK | | | | | | | | |
|------+------+------+------+------+-------------+------+------+------+------+------|
| Sft | Ctl | Alt | Gui | | | | Gui | Alt | Ctl | Sft |
`-----------------------------------------------------------------------------------'
```
## Software Dvorak mode
I have implemented a version of the main, lower and raise maps that works if
the computer itself is in dvorak mode at the os level. This allows me to work
well on my laptop when I have to take it with me (eg to go to a meeting) and
don't want the keyboard with me. I simply set it in dvorak mode in the os and
then put the keyboard into this mode.
## TODO
1. Actually learn to use the media keys

131
keyboards/planck/old_keymap_files/common_keymaps/keymap_sean.c
View File

@ -1,53 +1,104 @@
#include "keymap.h"
#define KC_RESET 0x5000
#include "keymap_common.h"
enum planck_layers {
_DVRK,
_LOWER,
_RAISE,
_ADJUST
};
const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = KEYMAP( /* Matrix Dvorak */
/* Dvorak
* ,-----------------------------------------------------------------------------------.
* | " | , | . | P | Y | / | = | F | G | C | R | L |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | A | O | E | U | I | ESC | BSPC | D | H | T | N | S |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | ; | Q | J | K | X | TAB | ENT | B | M | W | V | Z |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Sft | Ctl | Alt | Gui |Lower | Space |Raise | < | v | ^ | > |
* `-----------------------------------------------------------------------------------'
*/
[_DVRK] = KEYMAP(
QUOT, COMM, DOT, P, Y, SLSH, EQL, F, G, C, R, L,
A, O, E, U, I, ESC, BSPC, D, H, T, N, S,
SCLN, Q, J, K, X, TAB, ENT, B, M, W, V, Z,
LSFT, LCTL, LALT, LGUI, FN1, SPC, FN2, LEFT, DOWN, UP, RGHT),
[1] = KEYMAP( /* Matrix Qwerty */
Q, W, E, R, T, QUOT, EQL, Y, U, I, O, P,
A, S, D, F, G, ESC, BSPC, H, J, K, L, SCLN,
Z, X, C, V, B, TAB, ENT, N, M, COMM, DOT, SLSH,
LSFT, LCTL, LALT, LGUI, FN1, SPC, FN2, LEFT, DOWN, UP, RGHT),
[2] = KEYMAP( /* fn1 lower */
F1, F2, F3, F4, F5, NO, NO, F6, F7, F8, F9, F10,
1, 2, 3, 4, 5, F18, DEL, 6, 7, 8, 9, 0,
FN3, FN4, FN28, GRV, MINS, TRNS, INS, BSLS, LBRC, RBRC, TRNS, TRNS,
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, HOME, PGDN, PGUP, END),
/* Lower
* ,-----------------------------------------------------------------------------------.
* | F1 | F2 | F3 | F4 | F5 | { | } | F6 | F7 | F8 | F9 | F10 |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | 1 | 2 | 3 | 4 | 5 | [ | ] | 6 | 7 | 8 | 9 | 0 |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | ~ | | | ` | - | _ | INS | DEL | ( | ) | + | = | \ |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Sft | Ctl | Alt | Gui |Lower | Space |Raise | | PgDn | PgUp | End |
* `-----------------------------------------------------------------------------------'
*/
[_LOWER] = KEYMAP( /* fn1 lower */
F1, F2, F3, F4, F5, FN26, FN27, F6, F7, F8, F9, F10,
1, 2, 3, 4, 5, LBRC, RBRC, 6, 7, 8, 9, 0,
FN23, FN25, GRV,MINS, FN24, INS, DEL, FN19, FN20, FN22, EQL, BSLS,
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, FN4, HOME, PGDN, PGUP, END),
[3] = KEYMAP( /* fn2 raise */
MRWD, MPLY, MFFD, NO, NO, FN21, FN22, EJCT, PWR, LSFT,PAUSE, RSFT,
FN11, FN12, FN13, FN14, FN15, F18, DEL, FN16, FN17, FN18, FN19, FN20,
FN3, FN4, FN28, FN23, FN24, TRNS, INS, FN25, FN26, FN27, MPRV, MNXT,
TRNS, TRNS, TRNS, TRNS, FN1, TRNS, FN2, NO, VOLD, VOLU, MUTE),
/* Raise
* ,-----------------------------------------------------------------------------------.
* | F11 | F12 | F13 | F14 | F15 | - | _ | F16 | F17 | F18 | F19 | F20 |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | ! | @ | # | $ | % | | | ^ | & | * | ( | ) |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | | | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | CAPS | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_RAISE] = KEYMAP( /* fn2 raise */
F11, F12, F13, F14, F15,MINS, FN24, F16, F17, F18, F19, F20,
FN11, FN12, FN13, FN14, FN15, NO, NO, FN16, FN17, FN18, FN19, FN20,
PWR, EJCT, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO,
CAPS, TRNS, TRNS, TRNS, FN4, TRNS, FN2, NO, NO, NO, NO),
/* Adjust (Lower + Raise or SLower + SRaise)
* ,-----------------------------------------------------------------------------------.
* | | Reset| | | | | | | | | | |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | PWR | EJCT | | | | | | CAPS | | | | |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* |DVORAK| | | | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_ADJUST] = KEYMAP(
NO, RESET, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO,
PWR, EJCT, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO,
CAPS, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO,
NO, NO, NO, NO, NO, NO, NO, NO, NO, NO, NO),
};
const uint16_t PROGMEM fn_actions[] = {
[1] = ACTION_LAYER_MOMENTARY(2), // to Fn overlay LOWER
[2] = ACTION_LAYER_MOMENTARY(3), // to Fn overlay RAISE
[3] = ACTION_DEFAULT_LAYER_SET(0),
[4] = ACTION_DEFAULT_LAYER_SET(1),
[11] = ACTION_MODS_KEY(MOD_LSFT, KC_1),
[12] = ACTION_MODS_KEY(MOD_LSFT, KC_2),
[13] = ACTION_MODS_KEY(MOD_LSFT, KC_3),
[14] = ACTION_MODS_KEY(MOD_LSFT, KC_4),
[15] = ACTION_MODS_KEY(MOD_LSFT, KC_5),
[16] = ACTION_MODS_KEY(MOD_LSFT, KC_6),
[17] = ACTION_MODS_KEY(MOD_LSFT, KC_7),
[18] = ACTION_MODS_KEY(MOD_LSFT, KC_8),
[19] = ACTION_MODS_KEY(MOD_LSFT, KC_9),
[20] = ACTION_MODS_KEY(MOD_LSFT, KC_0),
[21] = ACTION_MODS_KEY(MOD_LSFT, KC_SLSH),
[22] = ACTION_MODS_KEY(MOD_LSFT, KC_EQL),
[23] = ACTION_MODS_KEY(MOD_LSFT, KC_GRV),
[24] = ACTION_MODS_KEY(MOD_LSFT, KC_MINS),
[25] = ACTION_MODS_KEY(MOD_LSFT, KC_BSLS),
[26] = ACTION_MODS_KEY(MOD_LSFT, KC_LBRC),
[27] = ACTION_MODS_KEY(MOD_LSFT, KC_RBRC),
[1] = ACTION_LAYER_MOMENTARY(_LOWER), // to Fn overlay LOWER
[2] = ACTION_LAYER_MOMENTARY(_RAISE), // to Fn overlay RAISE
[3] = ACTION_DEFAULT_LAYER_SET(_DVRK),
[4] = ACTION_LAYER_MOMENTARY(_ADJUST), // RAISE + LOWER
[11] = ACTION_MODS_KEY(MOD_LSFT, KC_1), //!
[12] = ACTION_MODS_KEY(MOD_LSFT, KC_2), //@
[13] = ACTION_MODS_KEY(MOD_LSFT, KC_3), //#
[14] = ACTION_MODS_KEY(MOD_LSFT, KC_4), //$
[15] = ACTION_MODS_KEY(MOD_LSFT, KC_5), //%
[16] = ACTION_MODS_KEY(MOD_LSFT, KC_6), //^
[17] = ACTION_MODS_KEY(MOD_LSFT, KC_7), //&
[18] = ACTION_MODS_KEY(MOD_LSFT, KC_8), //*
[19] = ACTION_MODS_KEY(MOD_LSFT, KC_9), //(
[20] = ACTION_MODS_KEY(MOD_LSFT, KC_0), //)
[21] = ACTION_MODS_KEY(MOD_LSFT, KC_SLSH), //?
[22] = ACTION_MODS_KEY(MOD_LSFT, KC_EQL), //+
[23] = ACTION_MODS_KEY(MOD_LSFT, KC_GRV), //~
[24] = ACTION_MODS_KEY(MOD_LSFT, KC_MINS), //_
[25] = ACTION_MODS_KEY(MOD_LSFT, KC_BSLS), //|
[26] = ACTION_MODS_KEY(MOD_LSFT, KC_LBRC), //{
[27] = ACTION_MODS_KEY(MOD_LSFT, KC_RBRC), //}
[28] = ACTION_MODS_KEY(MOD_LSFT | MOD_RSFT, KC_PAUSE),
};