summaryrefslogtreecommitdiff
path: root/layouts/community/ortho_4x12
diff options
context:
space:
mode:
authorJosh <josh@visionistinc.com>2018-09-09 22:09:53 -0400
committerDrashna Jaelre <drashna@live.com>2018-09-09 19:09:53 -0700
commit17fffc3a51f0a1abb1576de2badb67303165e0ae (patch)
tree340fa139ffba1966e903df53fe3cbdd26bac9a75 /layouts/community/ortho_4x12
parente68c8f2ac6cb2db1192591059c91bc6757ccbe47 (diff)
downloadqmk_firmware-17fffc3a51f0a1abb1576de2badb67303165e0ae.tar.gz
qmk_firmware-17fffc3a51f0a1abb1576de2badb67303165e0ae.zip
Keymap: Initial PR for contributing my ortho_4x12 community layout. (#3853)
* Initial keymap with no BL and with Ctrl and Enter on the home row. * Removing alternative layouts (Dvorak etc.). * Putting Enter back in the default position, moving Esc next to Alt. * Replacing grave with del. * Adding a numpad layer. * Adding operators and a triple zero to the numpad layer. * Swapping Alt and Win. * Updating to use new audio macros. * Removing numpad layer and changing left space to MOD_HYPR on hold. * Adding configurable 'clicky keys' feature. * Cleaning up clicky conditional logic. * Turning on backlight support and mapping backlight keys in the adjust layer. * Enabling backlight functionality. * Adding Adventure time theme song; increasing fake clicky randomness. * Cleaning up layer constants in my Planck keymap. * Initial implementation of porting my Planck keymap to a Let's Split. * Updating keyboards/planck/keymaps/josh to use declarations from new work on master. * Updating keyboards/lets_split/keymaps/josh to use declarations from new work on master. * Work in progress migrating Planck and Let's Split keymaps to a community keymap. Everything is working but Planck backlight. * Fixing rules.mk to enable backlight & audio correctly on Planck PCBs. Cleanup. * Tweaks to get Let's Split working with my community layout. * Switching to use EE_HANDS in my Let's Split build. * Adding vitamins_included makefile options to my ortho_4x12 layout. * Fixing planck/rev6 build -- backlight must be disabled. * Removing I2C from my rules.mk and addressing it in the config.h instead. * Moving community layout directory to my reddit username. :D * Adding a test encoder function; making lower left a media key and moving esc to a mod tap on ctrl. * Commenting out -flto in the compiler flags for the vitamins_included keyboard (couldn't figure out how else to turn it off). * Changing rotary encoder to control media volume. * Changing backlight and clicky defaults to max brightness no breathing and a low pitch click. * Initial implementation of backlight flickering. * Updating my README.md * Adding LINK_TIME_OPTIMIZATION to the vitamins_included/rev1 as a rules.mk feature. * Reverting keyboards/vitamins_included/rules.mk to master and using 'filter_out' in my layout instead. * Adding tested boards to the readme for my layout. * Per drashna, removing redundant clicky implementation and cleaning up headers. * Removing an extra include from my keymap.
Diffstat (limited to 'layouts/community/ortho_4x12')
-rw-r--r--layouts/community/ortho_4x12/mindsound/config.h33
-rw-r--r--layouts/community/ortho_4x12/mindsound/flicker.h5
-rw-r--r--layouts/community/ortho_4x12/mindsound/keymap.c230
-rw-r--r--layouts/community/ortho_4x12/mindsound/readme.md19
-rw-r--r--layouts/community/ortho_4x12/mindsound/rules.mk26
5 files changed, 313 insertions, 0 deletions
diff --git a/layouts/community/ortho_4x12/mindsound/config.h b/layouts/community/ortho_4x12/mindsound/config.h
new file mode 100644
index 0000000000..76e7da2049
--- /dev/null
+++ b/layouts/community/ortho_4x12/mindsound/config.h
@@ -0,0 +1,33 @@
+#pragma once
+
+#define ADVENTURE_TIME \
+ H__NOTE(_F5), \
+ Q__NOTE(_F5), \
+ H__NOTE(_F5), \
+ H__NOTE(_G5), \
+ H__NOTE(_E5), \
+ H__NOTE(_E5), \
+ H__NOTE(_D5), \
+ H__NOTE(_C5), \
+ HD_NOTE(_C6),
+
+#ifdef AUDIO_ENABLE
+ #define STARTUP_SONG SONG(ADVENTURE_TIME)
+ #define AUDIO_CLICKY
+ #define AUDIO_CLICKY_ON
+ #define AUDIO_CLICKY_FREQ_MAX 2500.0f
+ #define AUDIO_CLICKY_FREQ_RANDOMNESS 0.2f
+ #define AUDIO_CLICKY_FREQ_DEFAULT 110.0f
+#endif
+
+// for some reason the LSvi rev1 disables action tapping...
+#ifdef NO_ACTION_TAPPING
+ #undef NO_ACTION_TAPPING
+#endif
+
+#undef BACKLIGHT_LEVELS
+#define BACKLIGHT_LEVELS 15
+
+// let's split configuration:
+#define USE_I2C
+#define EE_HANDS
diff --git a/layouts/community/ortho_4x12/mindsound/flicker.h b/layouts/community/ortho_4x12/mindsound/flicker.h
new file mode 100644
index 0000000000..a982f19aed
--- /dev/null
+++ b/layouts/community/ortho_4x12/mindsound/flicker.h
@@ -0,0 +1,5 @@
+#pragma once
+
+void flicker_toggle(void);
+void flicker_keydown(void);
+void flicker_keyup(void);
diff --git a/layouts/community/ortho_4x12/mindsound/keymap.c b/layouts/community/ortho_4x12/mindsound/keymap.c
new file mode 100644
index 0000000000..2c9ceaf690
--- /dev/null
+++ b/layouts/community/ortho_4x12/mindsound/keymap.c
@@ -0,0 +1,230 @@
+#include QMK_KEYBOARD_H
+
+#ifdef BACKLIGHT_ENABLE
+#include "flicker.h"
+#endif
+
+extern keymap_config_t keymap_config;
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean 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 can also skip them
+// entirely and just use numbers.
+
+enum planck_layers {
+ _QWERTY,
+ _LOWER,
+ _RAISE,
+ _ADJUST
+};
+
+// keycodes custom to this keymap:
+enum planck_keycodes {
+ QWERTY = SAFE_RANGE,
+ BL_FLICKER
+};
+
+// flicker state:
+#ifdef BACKLIGHT_ENABLE
+bool flicker_enable = true;
+bool flicker_isdown = false;
+const uint8_t flicker_min_levels = 2;
+const uint8_t flicker_max_levels = 7;
+uint8_t flicker_restore_level = 0;
+#endif
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+
+// mod tap definitions:
+#define CTRL_ESC MT(MOD_LCTL, KC_ESC)
+#define HYPR_SPC MT(MOD_HYPR, KC_SPC)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Ctrl | A | S | D | F | G | H | J | K | L | ; | ' |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Esc | Del | GUI | Alt |Lower |HyprSp|Space |Raise | Left | Down | Up |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = LAYOUT_ortho_4x12(
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, \
+ CTRL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , \
+ KC_MPLY, KC_DEL, KC_LGUI, KC_LALT, LOWER, HYPR_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT \
+),
+
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = LAYOUT_ortho_4x12(
+ 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_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
+ _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______, \
+ _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
+),
+
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = LAYOUT_ortho_4x12(
+ 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_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, \
+ _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______, \
+ _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
+),
+
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * | | Reset| | | | | | | | | | Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | | |Aud on|Audoff|AGnorm|AGswap| | | | | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | |Clicky|ClkDn |ClkUp |ClkRst|
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = LAYOUT_ortho_4x12(
+ _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
+ _______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, _______, _______, _______, _______, _______, \
+ _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, BL_TOGG, BL_DEC, BL_INC, BL_FLICKER, \
+ _______, _______, _______, _______, _______, _______, _______, _______, CLICKY_TOGGLE, CLICKY_DOWN, CLICKY_UP, CLICKY_RESET \
+),
+
+}; // end keymaps
+
+// if backlighting is enabled, configure it on boot
+#ifdef BACKLIGHT_ENABLE
+void matrix_init_user(void) {
+ // set to max
+ backlight_level(BACKLIGHT_LEVELS);
+ flicker_restore_level = get_backlight_level();
+
+ // if breathing happens to be compiled in, turn it off
+#ifdef BACKLIGHT_BREATHING
+ breathing_disable();
+#endif
+}
+#endif
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+ return MACRO_NONE;
+};
+
+void persistant_default_layer_set(uint16_t default_layer) {
+ eeconfig_update_default_layer(default_layer);
+ default_layer_set(default_layer);
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+
+ // handle the _ADJUST layer and custom keycodes:
+ switch (keycode) {
+ case LOWER:
+ if (record->event.pressed) {
+ layer_on(_LOWER);
+ update_tri_layer(_LOWER, _RAISE, _ADJUST);
+ } else {
+ layer_off(_LOWER);
+ update_tri_layer(_LOWER, _RAISE, _ADJUST);
+ }
+ return false;
+ break;
+ case RAISE:
+ if (record->event.pressed) {
+ layer_on(_RAISE);
+ update_tri_layer(_LOWER, _RAISE, _ADJUST);
+ } else {
+ layer_off(_RAISE);
+ update_tri_layer(_LOWER, _RAISE, _ADJUST);
+ }
+ return false;
+ break;
+#ifdef BACKLIGHT_ENABLE
+ case BL_FLICKER:
+ if (record->event.pressed) {
+ flicker_toggle();
+ }
+ return false;
+ break;
+#endif
+ } // end switch case over custom keycodes
+
+#ifdef BACKLIGHT_ENABLE
+ if (flicker_enable) {
+ if (record->event.pressed) {
+ flicker_keydown();
+ } else {
+ flicker_keyup();
+ }
+ }
+#endif
+
+ return true;
+}
+
+void encoder_update(bool clockwise) {
+ if (clockwise) {
+ register_code(KC_VOLU);
+ unregister_code(KC_VOLU);
+ } else {
+ register_code(KC_VOLD);
+ unregister_code(KC_VOLD);
+ }
+}
+
+// flicker implementation:
+#ifdef BACKLIGHT_ENABLE
+void flicker_toggle(void) {
+ flicker_enable = !flicker_enable;
+}
+
+void flicker_keydown(void) {
+ // guard condition: only set the level to restore if the flicker is NOT already down
+ if (!flicker_isdown) {
+ flicker_restore_level = get_backlight_level();
+ flicker_isdown = true;
+ }
+
+ // calculate a random flicker level between min and max
+ uint8_t flicker_level = (rand() % (flicker_max_levels - flicker_min_levels)) + flicker_min_levels;
+ uint8_t level_to_set = flicker_level <= flicker_restore_level ? flicker_restore_level - flicker_level : 0;
+ backlight_level(level_to_set);
+}
+
+void flicker_keyup(void) {
+ backlight_level(flicker_restore_level);
+ flicker_isdown = false;
+}
+#endif
diff --git a/layouts/community/ortho_4x12/mindsound/readme.md b/layouts/community/ortho_4x12/mindsound/readme.md
new file mode 100644
index 0000000000..e9db480494
--- /dev/null
+++ b/layouts/community/ortho_4x12/mindsound/readme.md
@@ -0,0 +1,19 @@
+# Josh's 4x12 layout
+
+Notable features:
+
+* Esc is Ctrl on hold
+* Left space is `MOD_HYPER` on hold
+* Backspace is still backspace on `RAISE` and `LOWER`
+* Faux clicky controls are on the arrow keys on the `ADJUST` layer, and the backlight controls are directly above that
+* Backlight breathing is disabled; backlight flickering is implemented instead
+* Colemak and other layouts are thoroughly disabled
+* Rotary encoder controls media volume on base layer
+
+This layout has been tested on:
+
+* Let's Split (rev 2)
+* Let's Split Vitamins Included (rev 1)
+* Planck (rev 4)
+
+It builds for the Planck rev 6 but has not been tested yet.
diff --git a/layouts/community/ortho_4x12/mindsound/rules.mk b/layouts/community/ortho_4x12/mindsound/rules.mk
new file mode 100644
index 0000000000..c01a1ddb58
--- /dev/null
+++ b/layouts/community/ortho_4x12/mindsound/rules.mk
@@ -0,0 +1,26 @@
+# none of my keyboards need LTO and it screws up I2C on my LSVI:
+EXTRAFLAGS:=$(filter-out -flto,$(EXTRAFLAGS))
+
+# turning off backlighting and audio for the split keebs
+ifneq (,$(findstring lets_split,$(KEYBOARD)))
+ BACKLIGHT_ENABLE = no
+ BACKLIGHT_BREATHING = no
+ AUDIO_ENABLE = no
+endif
+ifneq (,$(findstring vitamins_included,$(KEYBOARD)))
+ BACKLIGHT_ENABLE = no
+ BACKLIGHT_BREATHING = no
+ AUDIO_ENABLE = no
+endif
+
+# both my plancks use audio but only the rev4 has backlighting
+ifneq (,$(findstring planck,$(KEYBOARD)))
+ ifneq (,$(findstring rev4,$(KEYBOARD)))
+ BACKLIGHT_ENABLE = yes
+ BACKLIGHT_BREATHING = no
+ else
+ BACKLIGHT_ENABLE = no
+ BACKLIGHT_BREATHING = no
+ endif
+ AUDIO_ENABLE = yes
+endif