Renaming planck/cbbrowne in keeping with recent naming conventions (#405)

* More documentation

* Saving crontab for user  on host

* Restructuring in keeping with recent changes to conventions

* Simplify submitting my fave cbbrowne keystroke by using SEND_STRING()

* Local change, not apropos to have in this repo

* Simplify logic; no need to return so much
master
Christopher Browne 2016-06-13 19:06:32 -04:00 committed by Jack Humbert
parent 25d4772754
commit 498455403e
7 changed files with 89 additions and 1501 deletions

View File

@ -19,4 +19,5 @@ When adding your keymap to this list, keep it organised alphabetically (select l
# List of Planck keymaps # List of Planck keymaps
* **default** default Planck layout * **default** default Planck layout
* **cbbrowne** cbbrowne's Planck layout

View File

@ -0,0 +1 @@
compiled.hex

View File

@ -1,16 +0,0 @@
cbbrowne custom keyboard
==============================
Due to cbbrowne@acm.org
Christopher Browne
This was originally based on the default keyboard map, but I have been
doing sundry experimentation:
* To figure things out about the toolset
* I'm an Emacs guy, so will be needing a fair bit of tuning
* It made sense to mess around some with keyboard maps.
- I added Workman alongside Dvorak and Colemak
- Boy, oh boy, these don't help
- I have done 30 years of learning of Emacs key mappings, and these alternative keyboards massively mess me up
- I added a keypad, originally based on keymaps/numpad.c, but mighty substantially revised, as that one seems to be rotated 90 degrees from usual conventions for number pads

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,7 @@
/* cbbrowne user configuration */
#define randadd 53
#define randmul 181
#define randmod 167

View File

@ -2,6 +2,8 @@
#ifdef BACKLIGHT_ENABLE #ifdef BACKLIGHT_ENABLE
#include "backlight.h" #include "backlight.h"
#endif #endif
#include "config_user.h"
#include "quantum.h"
/* Each layer is given a name to aid in readability, which is then /* Each layer is given a name to aid in readability, which is then
used in the keymap matrix below. The underscores do not denote used in the keymap matrix below. The underscores do not denote
@ -19,26 +21,25 @@
/* Things I did not like about the default mapping /* Things I did not like about the default mapping
- I find control too hard to get to. I think I'll want it on a - I found control too hard to get to. I use it more than Tab, so
left finger. Gonna need to lose something to do that... switched it there.
- Almost certainly, KC_LCTL should be on [2][1] - Having dash on [lower-j] is a bit nonintuitive, but may be OK
- having dash on [lower-j] is a bit nonintuitive, but may be OK
- I'll bet I should switch ESC/TAB - I'll bet I should switch ESC/TAB
- I'm suspicious that I want to shift M(0) from [4][1] to [4][2], - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
and shift ESC off the first column so KC_LCTL and KC_LALT can and shift ESC off the first column so KC_LCTL and KC_LALT can
be on the first column. be on the first column.
- I think I wanna swap ' and ENTER - I needed to swap ' and ENTER
- All of the above are done :-) - All of the above are done :-)
- I'm keeping Colemak and Dvorak around for reference, and added - Dropped out support for Dvorak and friends. They aren't
Workman just for fun. They're useless to me, though. improvements to me
*/ */
/* Some interesting things implemented /* Some interesting things implemented
- There is a macro that writes out "cbbrowne" just because I could - There is a macro that writes out "cbbrowne" to show that I could
- There is a (somewhat cruddy) linear congruential random number - There is a (somewhat cruddy) linear congruential random number
generator. generator.
- I would like to be seeding it with clock info to make it look - I would like to be seeding it with clock info to make it look
@ -50,16 +51,15 @@
of the random number generator of the random number generator
- in both, note the use of register_code()/unregister_code() - in both, note the use of register_code()/unregister_code()
to indicate the desired key to indicate the desired key
- I do indeed want a sweet number pad!
*/ */
/* Other things to do... /* Other things to do...
- Need to think about what zsh and readline actions I use lots - Need to think about what zsh and readline actions I use lots
- Wanna figure out macros, so I can put in a "cbbrowne" macro
- Ought to ensure that Control-Alt-Delete is convenient enough - Ought to ensure that Control-Alt-Delete is convenient enough
- How about Alt-F1 thru Alt-F8? - How about Alt-F1 thru Alt-F8?
- What's the keystroke to get from X to console these days? - What's the keystroke to get from X to console these days?
- I do indeed want a sweet number pad!
- A layer for doing console switching would not be a bad idea - A layer for doing console switching would not be a bad idea
*/ */
@ -99,10 +99,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
{KC_TRNS, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY} {KC_TRNS, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
}, },
[_KP] = { /* Key Pad */ [_KP] = { /* Key Pad */
{KC_ESC, M(M_USERNAME), KC_W, KC_E, KC_R, KC_T, KC_Y, KC_KP_ENTER, KC_KP_PLUS, KC_KP_PLUS, KC_KP_ENTER, KC_BSPC}, {KC_ESC, M(M_USERNAME), KC_F9, KC_F10, KC_F11, KC_F12, KC_PGUP, KC_KP_ENTER, KC_7, KC_8, KC_9, KC_BSPC},
{KC_LCTL, M(M_RANDDIGIT), KC_S, KC_D, KC_F, KC_G, KC_H, KC_KP_MINUS, KC_7, KC_8, KC_9, KC_ENT}, {KC_LCTL, M(M_RANDDIGIT), KC_F5, KC_F6, KC_F7, KC_F8, KC_PGDN, KC_KP_MINUS, KC_4, KC_5, KC_6, KC_PIPE},
{KC_LSFT, M(M_RANDLETTER), KC_X, KC_C, KC_V, KC_B, KC_N, KC_KP_PLUS, KC_4, KC_5, KC_6, KC_DOT}, {KC_LSFT, M(M_RANDLETTER), KC_F1, KC_F2, KC_F3, KC_F4, KC_DEL, KC_KP_PLUS, KC_1, KC_2, KC_3, KC_ENTER},
{BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC, KC_SPC, DF(_QW), KC_1, KC_2, KC_3, KC_0} {BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC, KC_SPC, DF(_QW), KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT}
} }
}; };
@ -110,11 +110,8 @@ const uint16_t PROGMEM fn_actions[] = {
}; };
/* This bit of logic seeds a wee linear congruential random number generator */ /* This bit of logic seeds a wee linear congruential random number generator */
/* lots of prime numbers everywhere... */
static uint16_t random_value = 157; static uint16_t random_value = 157;
#define randadd 53
#define randmul 181
#define randmod 167
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
{ {
@ -135,9 +132,7 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
break; break;
case M_USERNAME: case M_USERNAME:
if (record->event.pressed) { if (record->event.pressed) {
return MACRO( I(1), T(C), T(B), T(B), T(R), T(O), T(W), T(N), T(E)); SEND_STRING("cbbrowne");
} else {
return MACRO_NONE ;
} }
break; break;
case M_RANDDIGIT: case M_RANDDIGIT:

View File

@ -0,0 +1,63 @@
cbbrowne custom keyboard
==============================
Due to cbbrowne@acm.org
Christopher Browne
This was originally based on the default keyboard map, but I have been
doing sundry experimentation:
1. Experiments
----------------------------------------
* To figure things out about the toolset
* I'm an Emacs guy, so will be needing a fair bit of tuning
* It made sense to mess around some with keyboard maps.
- I tried added Workman alongside Dvorak and Colemak
- Boy, oh boy, these don't help!!!
- I have done 30 years of learning of Emacs key mappings, and
these alternative keyboards massively mess me up
- I added a keypad, originally based on keymaps/numpad.c, but
mighty substantially revised, as that one seems to be rotated 90
degrees from usual conventions for number pads
* The keypad layer also includes some sample "hacks" of cool things,
all using actions attached in using the function action_get_macro()
- Key [1][2] aka "q" types out my name, cbbrowne, as a fun example
of a key generating a bunch of keystrokes. The keystroke is
sufficiently inconvenient that it isn't terribly practical for me
to use it, but hey, it shows how others might use this facility
in a more useful context.
- Key [2][2] aka "a" uses a random number generator to select a digit 0-9 at random
- Key [3][2] aka "z" uses a random number generator to select a letter a-z at random
2. Some code structure ideas
---------------------------------------------------
Each layer is given a name to aid in readability, which is then
used in the keymap matrix below. The underscores do not denote
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 could also skip them entirely and just use numbers, though that
means needing to manage the numbers.
It is preferable to keep the symbols short so that a line worth of
key mappings fits compactly onto a line of code. It might be an
interesting idea to express the maps rotated 90%, so that you
only need to fit 4 symbols onto each line, rather than 12.
I used enums to manage layer IDs and macro IDs so that I don't need
to care (beyond "start at 0", and arguably that's not needed) about
their values.
3. Things I did not like about the default mapping
---------------------------------------------------------
* I found control too hard to get to. I use it more than Tab, so
switched it there.
* Having dash on [lower-j] is a bit nonintuitive, but may be OK
* I switched ESC/TAB/M(0) around
* I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
and shift ESC off the first column so KC_LCTL and KC_LALT can
be on the first column.
* I needed to swap ' and ENTER