qmk_firmware/keyboards/planck/keymaps/samuel/README.org

Samuel's Literate QMK Config

• Layers
• Keymap Conversion in Python
• keymap.c
  • Headers
  • Keycodes
  • Import Key table
  • Tap Keys
  • Process User Input
    • Layouts
    • Custom Keys
      • Command Layer One Shot
      • Tap Keys
      • Rise Keys
      • One Shot Keys
      • C-S Arrows
      • Undo, Copy, Cut, Paste
    • Standard inputs interupt tap

This is my qmk firmware for my keyboard. I grew tired of organizing the keycode array in plain text so I made it a literate .org file. I've never done this before, so bear with me.

Layers

-	-	-	-	-	-	-	-	-	-	-	-
-	-	-	-	-	-	-	-	-	-	-	-
-	-	-	-	-	-	-	-	-	-	-	-
-	-	-	-	-	-	-	-	-	-	-	-

This is my "pretty" org mode organized table for my main dvorak layer. If you don't use org mode, it won't be that exciting, but if you enjoy working in org mode, you can edit this table directly, and this file is tangled to the actual keymap. No more organizing spaces or converting to and from comments.

T_LRSE	QUOT	COMM	DOT	P	Y	F	G	C	R	L	T_RRSE
T_LSFT	A	O	E	U	I	D	H	T	N	S	T_RSFT
T_LCTL	SCLN	Q	J	K	X	B	M	W	V	Z	T_RCTL
T_LGUI	T_LALT	UP	DOWN	SPC	EQL	GRAVE	SPC	LEFT	RIGHT	T_RALT	T_RGUI

Tap keys. Used only with the "T_" keys above.

DEL	-	-	-	-	-	-	-	-	-	-	BSPC
TAB	-	-	-	-	-	-	-	-	-	-	ENTER
LBRACKET	-	-	-	-	-	-	-	-	-	-	RBRACKET
SLASH	LPRN	-	-	-	-	-	-	-	-	RPRN	MINS

RISE	-	-	-	-	-	-	-	-	-	-	RISE
LSFT	-	-	-	-	-	-	-	-	-	-	RSFT
LCTL	-	-	-	-	-	-	-	-	-	-	RCTL
LGUI	LALT	-	-	-	-	-	-	-	-	RALT	RGUI

I tried to keep my layout bare bones, just what would be available on a normal keyboard, minus some keys I never used. This one secondary layer should cover a majority of the keys not found on the home layer. The bottom left copies a normal keyboards symbols from shifted numbers, and the rest is placed where convenient, with some considerations for one handed use, hence the shortcuts in the top left.

–	EZUNDO	EZCOPY	EZCUT	EZPSTE	INS	ASTR	7	8	9	–	–
EZSHFT	ESC	CAPS	PGUP	PGDN	HOME	AMPR	4	5	6	0	EZSHFT
EZCTRL	EXLM	AT	HASH	DLR	PERC	CIRC	1	2	3	COM	EZCTRL
EZGUI	EZALT	EZUP	EZDOWN	SPC	PIPE	BSLASH	END	EZLEFT	EZRGHT	EZALT	EZGUI

Basic command layer for one-shot macros and function keys.

–	F1	F2	F3	F4	F5	F6	F7	F8	F9	F10	–
–	F11	F12	F13	F14	F15	F16	F17	F18	F19	F20	–
–	F21	F22	F23	F24	QWERTY	DVORAK	–	–	–	–	–
–	–	–	–	–	–	–	–	–	–	–	–

This qwerty layout is just so normal people can try out the board. Tap keys would need to be customized I think, more on that later. I also put another dvorak key here because I have nightmares of getting trapped in this forsaken layout.

T_LRSE	Q	W	E	R	T	Y	U	I	O	P	T_RRSE
T_LSFT	A	S	D	F	G	H	J	K	L	SCLN	T_RSFT
T_LCTL	Z	X	C	V	B	N	M	COMM	DOT	QUOT	T_RCTL
T_LGUI	T_LALT	UP	DOWN	SPC	EQL	GRAVE	SPC	LEFT	RIGHT	T_RALT	DVORAK

Keymap Conversion in Python

This python can convert that table into the array needed for the keymap file. It simply prepends every key with "KC_". I used to use a dictionary to convert some keys from the table into qmk keycodes, but the double convertion was unneccessary so I just prepended all my macros with KC and moved all the implementation to the `process-user-input` function.

#+NAME:layer-to-array

row = 0
results = ''
while row < len(keys):
  key = 0
  while key < len(keys[row]):
    keyName = str(keys[row][key])
    if keyName == '--':
      keyName = 'TRANSPARENT'
    results += 'KC_' + keyName
    if key != 11:
      results += ', '
    key+=1
  if row != 3:
    results += ','
  results += '\n'
  row+=1
return results

Tap keys are technically defined in the mod_lift function. but this is will implement that function from the org table.

#+NAME:define-tap-key

def getKey(keys, istapkey):
  if istapkey == True:
    keyName = str(keys[row][col])
  else:
    keyName = str(keys[row][col])
  if keyName == '--':
    keyName = 'TRANSPARENT'
  if istapkey == False:
    return 'KC_T_' + keyName, 'KC_' + keyName
  else:
    return 'KC_' + keyName
tapKeyName = getKey(tapkeys, True)
holdKeyMacro, holdKeyName = getKey(holdkeys, False)
return """case %s:
if (record->event.pressed) {
   mod_press(%s, %s, %i);
} else {
   mod_lift(%s, %s, %i);
}
return false;
break;""" % (holdKeyMacro, tapKeyName, holdKeyName, id, tapKeyName, holdKeyName, id)

keymap.c

Now that we laid out our layout, lets lay out our keymap file.

Headers

#include QMK_KEYBOARD_H

extern keymap_config_t keymap_config;

Keycodes

// where the 'T_' communicates how the key does something different when tapped.
enum planck_keycodes {
//DVORAK = SAFE_RANGE,
KC_T_LALT = SAFE_RANGE,
KC_T_RALT,
KC_T_LGUI,
KC_T_RGUI,
KC_T_LCTL,
KC_T_RCTL,
KC_T_LSFT,
KC_T_RSFT,
KC_T_LRSE,
KC_T_RRSE,
KC_EZRGHT,
KC_EZLEFT,
KC_EZUP,
KC_EZDOWN,
KC_EZUNDO,
KC_EZCOPY,
KC_EZCUT,
KC_EZPSTE,
KC_EZSHFT,
KC_EZCTRL,
KC_EZGUI,
KC_EZALT,
KC_DVORAK,
KC_QWERTY,
KC_COM
};

Import Key table

enum planck_layers {
_DVORAK,
_QWERTY,
_RISE,
_COMMAND
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_DVORAK] = LAYOUT_planck_grid(
<<layer-to-array(home-layer)>>
),
[_QWERTY] = LAYOUT_planck_grid(
<<layer-to-array(qwerty-layer)>>
),
[_RISE] = LAYOUT_planck_grid(
<<layer-to-array(secondary-layer)>>
),
[_COMMAND] = LAYOUT_planck_grid(
<<layer-to-array(command-layer)>>
)
};

Tap Keys

I don't like tap keys coming out on release. When modified, I often let go of the modifier too early because the tap button doesn't come out untill release. I guess you could save the state of the board on press and then apply it after the timer, but what I really want is the keys to come out on press when they can and when it is most useful. For me, that is when they are modified a single time. So I kind of "locked" the board into only doing single modifiers, making them faster. Disadvantages are double modified keys must be done with one shot keys (its actually not that bad, it feels like emacs!) and triple modified keys are impossible at the moment.

static uint16_t tap_timer = 0;
char last_mod = 10;

void mod_press(uint16_t tap_code, uint16_t hold_code, int id) {
   /* this first if body makes double modified keys impossible, but stops the */
   /* delay when modifying a tap key which would result in the tap key not */
   /* getting modified. */
   if (last_mod != id && last_mod != 10) {
       tap_code16(tap_code);
       last_mod = 10;
   } else {
       tap_timer = timer_read();
       last_mod = id;
       register_code(hold_code);
   }
}

void mod_lift(uint16_t tap_code, uint16_t hold_code, int id) {
   unregister_code(hold_code);
   if (last_mod == id && timer_elapsed(tap_timer) < TAPPING_TERM) {
       tap_code16(tap_code);
   }
   last_mod = 10;
}

Process User Input

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 switch (keycode) {

Layouts

Set Dvorak layout

case KC_DVORAK:
if (record->event.pressed) {
 set_single_persistent_default_layer(_DVORAK);
}
return true;
break;

Set Qwerty layout.

case KC_QWERTY:
if (record->event.pressed) {
 set_single_persistent_default_layer(_QWERTY);
}
return true;
break;

Custom Keys

Command Layer One Shot

case KC_COM:
if (record->event.pressed) {
 layer_on(_COMMAND);
 set_oneshot_layer(_COMMAND, ONESHOT_START);
 last_mod = 10;
} else {
 clear_oneshot_layer_state (ONESHOT_PRESSED);
}
return false;
break;

Tap Keys

<<define-tap-key(3, 1, 0)>>
<<define-tap-key(3, 10, 1)>>
<<define-tap-key(3, 0, 2)>>
<<define-tap-key(3, 11, 3)>>
<<define-tap-key(2, 0, 4)>>
<<define-tap-key(2, 11, 5)>>
<<define-tap-key(1, 0, 6)>>
<<define-tap-key(1, 11, 7)>>

Rise Keys

case KC_T_LRSE:
if (record->event.pressed) {
 tap_timer = timer_read();
 last_mod = 8;
 layer_on(_RISE);
} else {
 layer_off(_RISE);
 if (last_mod == 8 && timer_elapsed(tap_timer) < TAPPING_TERM) {
     tap_code16(KC_DELETE);
     last_mod = 10;
 }
}
return false;
break;
case KC_T_RRSE:
if (record->event.pressed) {
 tap_timer = timer_read();
 last_mod = 9;
 layer_on(_RISE);
} else {
 layer_off(_RISE);
 if (last_mod == 9 && timer_elapsed(tap_timer) < TAPPING_TERM) {
     tap_code16(KC_BSPACE);
     last_mod = 10;
 }
}
return false;
break;

One Shot Keys

Since I made modified tap keys occur on press instead of release, I need one shot keys to press any key with more than one modifier.

case KC_EZSHFT:
if (record->event.pressed) {
set_oneshot_mods(MOD_LSFT);
last_mod = 10;
}
return false;
break;
case KC_EZCTRL:
if (record->event.pressed) {
set_oneshot_mods(MOD_LCTL);
last_mod = 10;
}
return false;
break;
case KC_EZALT:
if (record->event.pressed) {
set_oneshot_mods(MOD_LALT);
last_mod = 10;
}
return false;
break;
case KC_EZGUI:
if (record->event.pressed) {
set_oneshot_mods(MOD_LGUI);
last_mod = 10;
}
return false;
break;

C-S Arrows

I use ctrl+shift+arrows keys a lot, so when the layer key is pressed they became lazy versions of themselves with control and shift already pressed.

I also added undo, copy, paste, and cut to be easily available with only the left hand like on a qwerty or colemek keyboard.

case KC_EZRGHT:
if (record->event.pressed) {
register_code(KC_LCTL);
tap_code16(S(KC_RGHT));
unregister_code(KC_LCTL);
last_mod = 10;
}
return false;
break;
case KC_EZLEFT:
if (record->event.pressed) {
register_code(KC_LCTL);
tap_code16(S(KC_LEFT));
unregister_code(KC_LCTL);
last_mod = 10;
}
return false;
break;
case KC_EZDOWN:
if (record->event.pressed) {
register_code(KC_LCTL);
tap_code16(S(KC_DOWN));
unregister_code(KC_LCTL);
last_mod = 10;
}
return false;
break;
case KC_EZUP:
if (record->event.pressed) {
register_code(KC_LCTL);
tap_code16(S(KC_UP));
unregister_code(KC_LCTL);
last_mod = 10;
}
return false;
break;

Undo, Copy, Cut, Paste

case KC_EZUNDO:
if (record->event.pressed) {
tap_code16(C(KC_Z));
last_mod = 10;
}
return false;
break;
case KC_EZCOPY:
if (record->event.pressed) {
tap_code16(C(KC_C));
last_mod = 10;
}
return false;
break;
case KC_EZCUT:
if (record->event.pressed) {
tap_code16(C(KC_X));
last_mod = 10;
}
return false;
break;
case KC_EZPSTE:
if (record->event.pressed) {
tap_code16(C(KC_V));
last_mod = 10;
}
return false;
break;

Standard inputs interupt tap

Finally, if just a standard key is tapped, set the interupted flag. Keep this last.

}
last_mod = 10;
return true;
}