diff --git a/keyboards/planck/keymaps/owodunni/config.h b/keyboards/planck/keymaps/owodunni/config.h new file mode 100644 index 000000000000..464b7b29f8ce --- /dev/null +++ b/keyboards/planck/keymaps/owodunni/config.h @@ -0,0 +1,49 @@ +/* Copyright 2015-2021 Jack Humbert + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#ifdef AUDIO_ENABLE +# define STARTUP_SONG SONG(PLANCK_SOUND) +// #define STARTUP_SONG SONG(NO_SOUND) + +# define DEFAULT_LAYER_SONGS \ + { SONG(QWERTY_SOUND), SONG(COLEMAK_SOUND), SONG(DVORAK_SOUND) } +#endif + +/* + * MIDI options + */ + +/* enable basic MIDI features: + - MIDI notes can be sent when in Music mode is on +*/ + +#define MIDI_BASIC + +/* enable advanced MIDI features: + - MIDI notes can be added to the keymap + - Octave shift and transpose + - Virtual sustain, portamento, and modulation wheel + - etc. +*/ +//#define MIDI_ADVANCED + +/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ +//#define MIDI_TONE_KEYCODE_OCTAVES 2 + +// Most tactile encoders have detents every 4 stages +#define ENCODER_RESOLUTION 4 diff --git a/keyboards/planck/keymaps/owodunni/definitions.h b/keyboards/planck/keymaps/owodunni/definitions.h new file mode 100644 index 000000000000..301e167a4027 --- /dev/null +++ b/keyboards/planck/keymaps/owodunni/definitions.h @@ -0,0 +1,10 @@ +#pragma once + +/** + * Custom defines related to process_records_kb() and process_records_user() + * + * More info: + * https://beta.docs.qmk.fm/using-qmk/guides/custom_quantum_functions + */ +#define RECORD_KEYPRESS_HANDLED false +#define RECORD_KEYPRESS_PASSTHROUGH true \ No newline at end of file diff --git a/keyboards/planck/keymaps/owodunni/keymap.c b/keyboards/planck/keymaps/owodunni/keymap.c new file mode 100644 index 000000000000..a1e7017e66a0 --- /dev/null +++ b/keyboards/planck/keymaps/owodunni/keymap.c @@ -0,0 +1,307 @@ +/* Copyright 2015-2021 Jack Humbert + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include QMK_KEYBOARD_H +#include "muse.h" +#include "definitions.h" + + +enum planck_layers { + _QWERTY, + _COLEMAK, + _LOWER, + _RAISE, + _NUMB, + _NAV, + _ADJUST +}; + +enum planck_keycodes { + QWERTY = SAFE_RANGE, + COLEMAK, + BACKLIT, +}; + +#define LOWER MO(_LOWER) +#define RAISE MO(_RAISE) +#define NUMB MO(_NUMB) +#define NAV MO(_NAV) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +/* Qwerty + * ,-----------------------------------------------------------------------------------. + * | Esc | Q | W | E | R | T | Y | U | I | O | P | Bksp | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Tab | A | S | D | F | G | H | J | K | L | ; [Ö]|Enter | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Shift| Z | X | C | V | B | N | M | , | . | / |Shift | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Ctrl | GUI | Alt | Nav |Lower | Space |Raise | Numb | Numb |Brite | Ctrl | + * `-----------------------------------------------------------------------------------' + */ +[_QWERTY] = LAYOUT_planck_grid( + 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_TAB, 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_RSFT, + KC_LCTL, KC_LGUI, KC_LALT, NAV, LOWER, KC_SPC, KC_SPC, RAISE, NUMB, NUMB, BACKLIT, KC_RCTL +), + +/* Colemak-dh + * ,-----------------------------------------------------------------------------------. + * | Tab | Q | W | F | P | B | J | L | U | Y | ; [ö]| Bksp | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Esc | A | R | S | T | G | M | N | E | I | O |Enter | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Shift| Z | X | C | D | V | K | H | , | . | / |Shift | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | Ctrl | GUI | Alt | Nav |Lower | Space |Raise | Numb | Numb |Brite | Ctrl | + * `-----------------------------------------------------------------------------------' + */ +[_COLEMAK] = LAYOUT_planck_grid( + KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC, + KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_G, KC_M, KC_N, KC_E, KC_I, KC_O, KC_ENT, + KC_LSFT, KC_Z, KC_X, KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT , + KC_LCTL, KC_LGUI, KC_LALT, NAV, LOWER, KC_SPC, KC_SPC, RAISE, NUMB, NUMB, BACKLIT, KC_RCTL +), + + +/* Lower + * ,-----------------------------------------------------------------------------------. + * | | | | | | | ^ | & | * | | | ` | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | | | | - | { | + | } | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | | | | _ |[ [å] | ~ | ] | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | | | | | | | | + * `-----------------------------------------------------------------------------------' + */ +[_LOWER] = LAYOUT_planck_grid( + _______, _______, _______, _______, _______, _______, KC_CIRC, KC_AMPR, KC_ASTR, KC_PIPE, KC_GRV, _______, + _______, _______, _______, _______, _______, _______, _______, KC_MINS, KC_LCBR, KC_PLUS, KC_RCBR, _______, + _______, _______, _______, _______, _______, _______, _______, KC_UNDS, KC_LBRC, KC_TILD, KC_RBRC, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +), + +/* Raise + * ,-----------------------------------------------------------------------------------. + * | | ! | @ | # | $ | % | | F7 | F8 | F9 | F10 | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | \ | ) | = | ( | | | F4 | F5 | F6 | F11 | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | / | | | F1 | F2 | F3 | F12 | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | | | | | | | | + * `-----------------------------------------------------------------------------------' + */ +[_RAISE] = LAYOUT_planck_grid( + _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, _______, KC_F7, KC_F8, KC_F9, KC_F10, _______, + _______, KC_BSLS, KC_RPRN, KC_EQL, KC_LPRN, _______, _______, KC_F4, KC_F5, KC_F6, KC_F11, _______, + _______, _______, _______, _______, KC_SLSH, _______, _______, KC_F1, KC_F2, KC_F3, KC_F12, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +), + + +/* Numbers + * ,-----------------------------------------------------------------------------------. + * | | , | 7 | 8 | 9 | | | | | | | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | 0 | 4 | 5 | 6 | | | | | | | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | . | 1 | 2 | 3 | | | | | | | | + * |------+------+------+------+------+------+------+------+------+------+------+------| + * | | | | | | | | | | | | + * `-----------------------------------------------------------------------------------' + */ +[_NUMB] = LAYOUT_planck_grid( + _______, KC_COMM, KC_7, KC_8, KC_9, _______, _______, _______, _______, _______, _______, _______, + _______, KC_0, KC_4, KC_5, KC_6, _______, _______, _______, _______, _______, _______, _______, + _______, KC_DOT, KC_1, KC_2, KC_3, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +), + +/* Navigation +* ,-----------------------------------------------------------------------------------. +* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del | +* |------+------+------+------+------+------+------+------+------+------+------+------| +* | | | | | | | Left | DOWN | UP |RIGHT | ' [ä]| | +* |------+------+------+------+------+------+------+------+------+------+------+------| +* | | | | | | | " | | | | | | +* |------+------+------+------+------+------+------+------+------+------+------+------| +* | | | | | | | | | | | | +* `-----------------------------------------------------------------------------------' +*/ +[_NAV] = LAYOUT_planck_grid( + KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL, + _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_QUOT, _______, + _______, _______, _______, _______, _______, _______, _______, KC_DQUO, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +), + +/* Adjust (Lower + Raise) + * v------------------------RGB CONTROL--------------------v + * ,------------------------------------------------------------------------------------. + * | | Reset|Debug | RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| Del | + * |------+------+------+------+------+------+------+------+-------+------+------+------| + * | | Brite|MUSmod|Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk | | | | + * |------+------+------+------+------+------+------+------+-------+------+------+------| + * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|TermOn|TermOf | | | | + * |------+------+------+------+------+------+------+------+-------+------+------+------| + * | | | | | | | | | | | | + * `------------------------------------------------------------------------------------' + */ +[_ADJUST] = LAYOUT_planck_grid( + _______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL , + _______, BACKLIT, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, _______, _______, _______, + _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +) + +}; + +layer_state_t layer_state_set_user(layer_state_t state) { + return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); +} + +/** + * process_record_user is called by QMK during key processing before + * the actual key event is handled. + * + * More info: https://beta.docs.qmk.fm/using-qmk/guides/custom_quantum_functions + */ +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case QWERTY: + if (record->event.pressed) { + set_single_persistent_default_layer(_QWERTY); + } + return RECORD_KEYPRESS_HANDLED; + break; + case COLEMAK: + if (record->event.pressed) { + set_single_persistent_default_layer(_COLEMAK); + } + return RECORD_KEYPRESS_HANDLED; + break; + case BACKLIT: + if (record->event.pressed) { + register_code(KC_RSFT); + #ifdef BACKLIGHT_ENABLE + backlight_step(); + #endif + #ifdef KEYBOARD_planck_rev5 + writePinLow(E6); + #endif + } else { + unregister_code(KC_RSFT); + #ifdef KEYBOARD_planck_rev5 + writePinHigh(E6); + #endif + } + return RECORD_KEYPRESS_HANDLED; + break; + } + return RECORD_KEYPRESS_PASSTHROUGH; +} + +bool muse_mode = false; +uint8_t last_muse_note = 0; +uint16_t muse_counter = 0; +uint8_t muse_offset = 70; +uint16_t muse_tempo = 50; + +bool encoder_update_user(uint8_t index, bool clockwise) { + if (muse_mode) { + if (IS_LAYER_ON(_RAISE)) { + if (clockwise) { + muse_offset++; + } else { + muse_offset--; + } + } else { + if (clockwise) { + muse_tempo+=1; + } else { + muse_tempo-=1; + } + } + } else { + if (clockwise) { + #ifdef MOUSEKEY_ENABLE + tap_code(KC_MS_WH_DOWN); + #else + tap_code(KC_PGDN); + #endif + } else { + #ifdef MOUSEKEY_ENABLE + tap_code(KC_MS_WH_UP); + #else + tap_code(KC_PGUP); + #endif + } + } + return true; +} + +bool dip_switch_update_user(uint8_t index, bool active) { + switch (index) { + case 0: { + if (active) { + layer_off(_ADJUST); + } + break; + } + case 1: + if (active) { + muse_mode = true; + } else { + muse_mode = false; + } + } + return true; +} + +void matrix_scan_user(void) { +#ifdef AUDIO_ENABLE + if (muse_mode) { + if (muse_counter == 0) { + uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()]; + if (muse_note != last_muse_note) { + stop_note(compute_freq_for_midi_note(last_muse_note)); + play_note(compute_freq_for_midi_note(muse_note), 0xF); + last_muse_note = muse_note; + } + } + muse_counter = (muse_counter + 1) % muse_tempo; + } else { + if (muse_counter) { + stop_all_notes(); + muse_counter = 0; + } + } +#endif +} + +bool music_mask_user(uint16_t keycode) { + switch (keycode) { + case RAISE: + case LOWER: + return false; + default: + return true; + } +} diff --git a/keyboards/planck/keymaps/owodunni/readme.md b/keyboards/planck/keymaps/owodunni/readme.md new file mode 100644 index 000000000000..03c146948717 --- /dev/null +++ b/keyboards/planck/keymaps/owodunni/readme.md @@ -0,0 +1,39 @@ +# Owodunni planck layout + +By Alexander Poole + +## Main idea + +This is a balanced QWERTY layout that is made for typing and coding. +It is inspired by [BEAKL-27](https://ieants.cc/beakl/layouts.phpq) for +the symbol layers. It keeps [colemak-dh](https://colemakmods.github.io/mod-dh/) +if I ever decide to learn it. + +## Build + +To build: +```cli +qmk compile -kb planck/rev6_drop -km owodunni +``` + +Or first configure QMK: +```cli +qmk config user.keyboard=planck/rev6_drop +``` +```cli +qmk config user.keymap=owodunni +``` +Then you can compile without flags: +```cli +qmk compile +``` + +## Swedish keys + +To write Swedish use the following keys while using a Swedish keymap: + +| SE key | US key | +|--------|--------| +| å | [ | +| ä | ' | +| ö | ; | diff --git a/keyboards/planck/keymaps/owodunni/rules.mk b/keyboards/planck/keymaps/owodunni/rules.mk new file mode 100644 index 000000000000..dcf16bef3994 --- /dev/null +++ b/keyboards/planck/keymaps/owodunni/rules.mk @@ -0,0 +1 @@ +SRC += muse.c