From c2b8a47604106af17b37fbe54d7dac02493bba68 Mon Sep 17 00:00:00 2001 From: James <32029516+broken-username@users.noreply.github.com> Date: Mon, 23 Oct 2017 12:26:52 -0600 Subject: Some finishing touches on space_oddity (#1892) * Add verbose comments, ASCII layout pictures, and re-word readme.md * Fix omission of F(2) on the third layer. --- .../space_oddity/keymaps/default/keymap.c | 87 +++++++++++++++++++++- keyboards/handwired/space_oddity/readme.md | 6 +- 2 files changed, 87 insertions(+), 6 deletions(-) (limited to 'keyboards/handwired/space_oddity') diff --git a/keyboards/handwired/space_oddity/keymaps/default/keymap.c b/keyboards/handwired/space_oddity/keymaps/default/keymap.c index 26be16fbd..4230cdf8d 100644 --- a/keyboards/handwired/space_oddity/keymaps/default/keymap.c +++ b/keyboards/handwired/space_oddity/keymaps/default/keymap.c @@ -17,7 +17,7 @@ #include "space_oddity.h" -// Planck keycodes needed for dynamic macros +// Planck keycodes needed for dynamic macros. enum planck_keycodes { QWERTY = SAFE_RANGE, @@ -25,7 +25,7 @@ enum planck_keycodes { }; -// Tap Dance +// Tap Dance initializer. enum { SFT_CAPS = 0, @@ -36,12 +36,14 @@ enum { #define MOUSE_LAYER 2 +// Toggle MOUSE_LAYER. Additional layers can be added for additional layouts or other special functions. const uint16_t PROGMEM fn_actions[] = { [2] = ACTION_LAYER_TOGGLE(MOUSE_LAYER), }; +// Tap dance actions - double tap for Caps Lock. qk_tap_dance_action_t tap_dance_actions[] = { [SFT_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS), @@ -50,6 +52,29 @@ qk_tap_dance_action_t tap_dance_actions[] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Here is an ASCII version of the base layout. Note that Dynamic Macros 1 and 2 are considered Macro 5 and Macro 6. + + ___________________________________________________________________________________ + | | | | | | Dynamic | Dynamic | + | Macro 0 | Macro 1 | Macro 2 | Macro 3 | Macro 4 | Macro 1 | Macro 2 | + |___________|___________|___________|___________|___________|___________|___________| + | | | | | | | | | | | | | + | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | BKSP | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | TAB | Q | W | E | R | T | Y | U | I | O | P | - | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + |ESC (CTL_T)| A | S | D | F | G | H | J | K | L | ; | ' | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | SHFT | Z | X | C | V | B | N | M | , | . | / |SHFT(ENT)| + |_________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_________| + | | | | | | | ALT | HYP | LT 1| LT 2| + | M2 | M1 | GUI | ALT | CTRL | SPC |(LFT)|(RGT)| (UP)|(DWN)| + |_____|_____|_____|_____|___________|___________|_____|_____|_____|_____| + */ + KEYMAP( M(0), M(1), M(2), M(3), M(4), DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, @@ -57,6 +82,31 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { CTL_T(KC_ESC), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, TD(SFT_CAPS), KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT), MO(2), MO(1), KC_LGUI, KC_RALT, KC_LCTRL, KC_SPC, ALT_T(KC_LEFT), ALL_T(KC_RGHT), LT(1, KC_UP), LT(2, KC_DOWN)), + + /* Function layer. + Blank keys correspond to the KC_TRNS keycode. + + ___________________________________________________________________________________ + | | | | | | DYN REC | DYN REC | + | Macro 7 | | | | | 1 | 2 | + |___________|___________|___________|___________|___________|___________|___________| + | DYN REC | | | | | | | | | | | | + | STOP | F1 | F2 | F3 | F4 | F5 | [ | 7 | 8 | 9 | * | DEL | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | | F6 | F7 | F8 | F9 | F10 | ] | 4 | 5 | 6 | + | = | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | \ | F11 | F12 | F13 | F14 | F15 | { | 1 | 2 | 3 | - | | | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | | F16 | F17 | F18 | F19 | F20 | } | 0 | , | . | / | | + |_________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_________| + | | | | | | | | | | | + | | | | | | | | | | | + |_____|_____|_____|_____|___________|___________|_____|_____|_____|_____| + + */ KEYMAP( M(7), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, DYN_REC_START1, DYN_REC_START2, @@ -65,6 +115,30 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { KC_BSLS, KC_F11, KC_F12, KC_F13, KC_F14, KC_F15, KC_LCBR, KC_P1, KC_P2, KC_P3, KC_MINS, KC_PIPE, KC_TRNS, KC_F16, KC_F17, KC_F18, KC_F19, KC_F20, KC_RCBR, KC_P0, KC_COMM, KC_DOT, KC_SLSH, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS), + + /* Mouse layer. + + ___________________________________________________________________________________ + | | | | | | | | + | | | | | | | | + |___________|___________|___________|___________|___________|___________|___________| + | | | | MS | | | | | | | | | + | | | | UP | | | | | | | | | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | MS | MS | MS | | | | | | | | + | | | LFT | DWN | RGT | | | MS1 | MS3 | MS2 | | | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | | | | | | | | | | | | | + |___________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|___________| + | | | | | | | | | | | | | + | |RESET| | | | | | | | | | | + |_________|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_________| + | | | | | | | | | | | + | | | | | | | | | | F(2)| + |_____|_____|_____|_____|___________|___________|_____|_____|_____|_____| + + */ KEYMAP( KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, @@ -75,6 +149,12 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, F(2)) }; +// Simple macro ideas follow. Each of them is designed to give you a quick way to create pairs of +// delimiters and then position the cursor between them, much like Emacs' ParEdit does. This way, +// you can have some convenient coding "helpers" even when not using Emacs. It is also nice for +// LaTeX editing. +// +// Customize to your heart's content! const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { switch (id) { @@ -95,7 +175,8 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { SEND_STRING("{}"SS_TAP(X_LEFT)); } break; - + + // Probably something only Lisp users will appreciate... case 7: if (record->event.pressed) { SEND_STRING("(lambda ())"SS_TAP(X_LEFT)SS_TAP(X_LEFT)); diff --git a/keyboards/handwired/space_oddity/readme.md b/keyboards/handwired/space_oddity/readme.md index 1dadcb8a9..07ec957fa 100644 --- a/keyboards/handwired/space_oddity/readme.md +++ b/keyboards/handwired/space_oddity/readme.md @@ -5,7 +5,7 @@ This firmware is for an Emacs-focused handwired custom keyboard using an Arduino As originally designed, the top row consists of 2u keys which are used for user-defined macros. The keys for Shift and Enter are 1.75u. -Some simple example macros are included. To add your own, simply add the number of the macro you want in the appropriate section. +Some simple example macros are included. To add your own, just add the number of the macro you want in the appropriate section. A picture of the finished product can be found here: https://imgur.com/dE9Y4XK @@ -17,9 +17,9 @@ The following pins are used: ## Compiling and loading the firmware -To build the firmware, run `make handwired/space-oddity` from the toplevel directory. +To build the firmware, run `make handwired/space_oddity` from the toplevel directory. On GNU/Linux, you can flash the default layout onto the microcontroller by using `avrdude -p atmega32u4 -P /dev/ttyACM0 -c avr109 -U flash:w:handwired_space_oddity_default.hex`. Note that the device name under `/dev` may be different. -This design was conceived by James Taylor. Any requests for further information and/or tips for building your own are welcome! \ No newline at end of file +This design was conceived by James Taylor. Any requests for further information, suggestions, and/or tips for building your own are welcome! \ No newline at end of file -- cgit v1.2.3-24-g4f1b