mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-10 10:39:09 +00:00
Merge pull request #123 from cbbrowne/master
README notes and cbbrowne layout
This commit is contained in:
Jack Humbert
commit
2ce9c19478
4 changed files with 183 additions and 0 deletions
|
|
@ -3,6 +3,7 @@
|
|||
## Setting up the environment
|
||||
|
||||
### Windows
|
||||
|
||||
1. Install [WinAVR Tools](http://sourceforge.net/projects/winavr/) for AVR GCC compiler.
|
||||
2. Install [DFU-Programmer][dfu-prog] (the -win one).
|
||||
3. Start DFU bootloader on the chip first time you will see 'Found New Hardware Wizard' to install driver. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you will need to update its driver on 'Device Manager' to the `dfu-programmer` driver.
|
||||
|
|
@ -24,6 +25,9 @@ Otherwise, these instructions will work:
|
|||
1. Install AVR GCC with your favorite package manager.
|
||||
2. Install [DFU-Programmer][dfu-prog].
|
||||
|
||||
Note that, since it will be directly accessing USB hardware, the
|
||||
`dfu-programmer` program needs to be run as root.
|
||||
|
||||
## Verify Your Installation
|
||||
1. Clone the following repository: https://github.com/jackhumbert/qmk_firmware
|
||||
2. Open a Terminal and `cd` into `qmk_firmware/keyboard/planck`
|
||||
|
|
|
|||
|
|
@ -171,6 +171,27 @@ Depending on which keymap you would like to use, you will have to compile slight
|
|||
### Default
|
||||
To build with the default keymap, simply run `make`.
|
||||
|
||||
## Safety Considerations
|
||||
|
||||
You probably don't want to "brick" your keyboard, making it impossible
|
||||
to rewrite firmware onto it. Here are some of the parameters to show
|
||||
what things are (and likely aren't) too risky.
|
||||
|
||||
- If a keyboard map does not include RESET, then, to get into DFU
|
||||
mode, you will need to press the reset button on the PCB, which
|
||||
requires unscrewing some bits.
|
||||
- Messing with tmk_core / common files might make the keyboard
|
||||
inoperable
|
||||
- Too large a .hex file is trouble; `make dfu` will erase the block,
|
||||
test the size (oops, wrong order!), which errors out, failing to
|
||||
flash the keyboard
|
||||
- DFU tools do /not/ allow you to write into the bootloader (unless
|
||||
you throw in extra fruitsalad of options), so there is little risk
|
||||
there.
|
||||
- EEPROM has around a 100000 write cycle. You shouldn't rewrite the
|
||||
firmware repeatedly and continually; that'll burn the EEPROM
|
||||
eventually.
|
||||
|
||||
### Other Keymaps
|
||||
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
|
||||
|
||||
|
|
|
|||
16
keyboard/planck/keymaps/cbbrowne/README.md
Normal file
16
keyboard/planck/keymaps/cbbrowne/README.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
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
|
||||
142
keyboard/planck/keymaps/cbbrowne/keymap.c
Normal file
142
keyboard/planck/keymaps/cbbrowne/keymap.c
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
#include "planck.h"
|
||||
#ifdef BACKLIGHT_ENABLE
|
||||
#include "backlight.h"
|
||||
#endif
|
||||
|
||||
/* 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. */
|
||||
|
||||
/* This was originally based on planck/keymaps/default/default.c, and
|
||||
then cbbrowne has revised things */
|
||||
|
||||
/* 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
|
||||
left finger. Gonna need to lose something to do that...
|
||||
- Almost certainly, KC_LCTL should be on [2][1]
|
||||
- having dash on [lower-j] is a bit nonintuitive, but may be OK
|
||||
- I'll bet I should switch ESC/TAB
|
||||
- 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 think I wanna swap ' and ENTER
|
||||
|
||||
- All of the above are done :-)
|
||||
|
||||
- I'm keeping Colemak and Dvorak around for reference, and added
|
||||
Workman just for fun. They're useless to me, though.
|
||||
*/
|
||||
|
||||
/* Other things to do...
|
||||
|
||||
- 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
|
||||
- How about Alt-F1 thru Alt-F8?
|
||||
- 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
|
||||
*/
|
||||
|
||||
enum layers {
|
||||
_QW = 0, /* Qwerty mapping */
|
||||
_CM, /* Colemak */
|
||||
_DV, /* Dvorak */
|
||||
_WK, /* Workman */
|
||||
_LW, /* Lower layer, where top line has symbols !@#$%^&*() */
|
||||
_RS, /* Raised layer, where top line has digits 1234567890 */
|
||||
_KP, /* Key pad */
|
||||
};
|
||||
|
||||
/* Note that Planck has dimensions 4 rows x 12 columns */
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
[_QW] = { /* Qwerty */
|
||||
{KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
|
||||
{KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT},
|
||||
{KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_QUOT },
|
||||
{KC_TAB, M(0), KC_LALT, KC_LGUI, MO(_LW), KC_SPC, KC_SPC, MO(_RS), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
|
||||
},
|
||||
[_CM] = { /* Colemak */
|
||||
{KC_ESC, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
|
||||
{KC_LCTL, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_ENT},
|
||||
{KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_QUOT },
|
||||
{KC_TAB, M(0), KC_LALT, KC_LGUI, MO(_LW), KC_SPC, KC_SPC, MO(_RS), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
|
||||
},
|
||||
[_DV] = { /* Dvorak */
|
||||
{KC_ESC, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
|
||||
{KC_LCTL, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
|
||||
{KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
|
||||
{KC_TAB, M(0), KC_LALT, KC_LGUI, MO(_LW), KC_SPC, KC_SPC, MO(_RS), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
|
||||
},
|
||||
[_WK] = { /* Workman */
|
||||
{KC_ESC, KC_Q, KC_D, KC_R, KC_W, KC_B, KC_J, KC_F, KC_U, KC_P, KC_SCLN, KC_BSPC},
|
||||
{KC_LCTL, KC_A, KC_S, KC_H, KC_T, KC_G, KC_Y, KC_N, KC_E, KC_O, KC_I, KC_ENT},
|
||||
{KC_LSFT, KC_Z, KC_X, KC_M, KC_C, KC_V, KC_K, KC_L, KC_COMM, KC_DOT, KC_SLSH, KC_QUOT },
|
||||
{KC_TAB, M(0), KC_LALT, KC_LGUI, MO(_LW), KC_SPC, KC_SPC, MO(_RS), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
|
||||
},
|
||||
[_RS] = { /* RAISE */
|
||||
{KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
|
||||
{KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
|
||||
{KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, DF(_QW), DF(_CM), DF(_WK), RESET, KC_TRNS},
|
||||
{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
|
||||
},
|
||||
[_LW] = { /* LOWER */
|
||||
{KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
|
||||
{KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
|
||||
{KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, DF(_QW), DF(_CM), DF(_WK), RESET, KC_TRNS},
|
||||
{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 */
|
||||
{KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_KP_ENTER, KC_KP_PLUS, KC_KP_PLUS, KC_KP_ENTER, KC_KP_ENTER},
|
||||
{KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_KP_MINUS, KC_7, KC_8, KC_9, KC_KP_DOT},
|
||||
{KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_KP_PLUS, KC_4, KC_5, KC_6, KC_0},
|
||||
{BL_STEP, M(0), KC_LALT, KC_LGUI, KC_NO, KC_SPC, KC_SPC, DF(_QW), KC_1, KC_2, KC_3, KC_0}
|
||||
}
|
||||
};
|
||||
|
||||
/* I'm planning to use this to set up some macros, including one to
|
||||
expand into "cbbrowne", more to prove it can be done than anything
|
||||
else.
|
||||
*/
|
||||
|
||||
enum macro_id {
|
||||
M_P0,
|
||||
M_P1,
|
||||
M_P2,
|
||||
M_P3,
|
||||
M_P4,
|
||||
M_P5,
|
||||
M_USERNAME
|
||||
};
|
||||
|
||||
|
||||
const uint16_t PROGMEM fn_actions[] = {
|
||||
|
||||
};
|
||||
|
||||
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
|
||||
{
|
||||
// MACRODOWN only works in this function
|
||||
switch(id) {
|
||||
case 0:
|
||||
if (record->event.pressed) {
|
||||
register_code(KC_RSFT);
|
||||
#ifdef BACKLIGHT_ENABLE
|
||||
backlight_step();
|
||||
#endif
|
||||
} else {
|
||||
unregister_code(KC_RSFT);
|
||||
}
|
||||
break;
|
||||
}
|
||||
return MACRO_NONE;
|
||||
};
|
||||
Loading…
Reference in a new issue