qmk

Unnamed repository; edit this file 'description' to name the repository.
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

commit 0210447c82c9006a740393aed07e944d7ab72df5
parent 7fef5ca24047918e54ac5eac8b5b4f65f80d4f39
Author: FireBazooka <FireBazooka@users.noreply.github.com>
Date:   Fri,  6 Jul 2018 11:13:39 -0400

Adding FireBazooka's Tada68 Keymap (#3322)

* Completed my Tada68 keymap

* Update readme.md

* Update readme.md

* Update keymap.c

* Update readme.md

* Fixed keymap layout spacing

* Update rules.mk

* Removed MAC_TOG from macros, changed to TG(_MAC)

Diffstat:
keyboards/tada68/keymaps/bazooka/config.h | 4++++
keyboards/tada68/keymaps/bazooka/keymap.c | 182+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
keyboards/tada68/keymaps/bazooka/readme.md | 29+++++++++++++++++++++++++++++
keyboards/tada68/keymaps/bazooka/rules.mk | 17+++++++++++++++++
4 files changed, 232 insertions(+), 0 deletions(-)

diff --git a/keyboards/tada68/keymaps/bazooka/config.h b/keyboards/tada68/keymaps/bazooka/config.h @@ -0,0 +1,4 @@ +#include "../../config.h" + +#define GRAVE_ESC_ALT_OVERRIDE +#define GRAVE_ESC_CTRL_OVERRIDE diff --git a/keyboards/tada68/keymaps/bazooka/keymap.c b/keyboards/tada68/keymaps/bazooka/keymap.c @@ -0,0 +1,182 @@ +#include QMK_KEYBOARD_H + +// 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. +#define _BL 0 +#define _MAC 1 +#define _FUNC 2 +#define _MOUSE 3 + +#define _______ KC_TRNS +#define MAC_TOG TG(_MAC) + +enum { + FUN_LAY = SAFE_RANGE, + MOU_TOG, + WIN_LCK, + WIN_KEY, +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Keymap _BL: (Base Layer) Default Layer + * ,----------------------------------------------------------------. + * |Esc`| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |~ ` | + * |----------------------------------------------------------------| + * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \ |Del | + * |----------------------------------------------------------------| + * |CAPS | A| S| D| F| G| H| J| K| L| ;| '|Return |PgUp| + * |----------------------------------------------------------------| + * |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | Up|PgDn| + * |----------------------------------------------------------------| + * |Ctrl|Win |Alt | Space |Alt| FN|Ctrl|Lef|Dow|Rig | + * `----------------------------------------------------------------' + */ +[_BL] = LAYOUT_ansi( + KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0,KC_MINS, KC_EQL,KC_BSPC, KC_GRV, \ + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P,KC_LBRC,KC_RBRC,KC_BSLS, KC_DEL, \ + KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L,KC_SCLN,KC_QUOT, KC_ENT,KC_PGUP, \ + 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_UP,KC_PGDN, \ + KC_LCTL,WIN_KEY,KC_LALT, KC_SPC, KC_RALT,FUN_LAY,KC_RCTL,KC_LEFT,KC_DOWN,KC_RGHT), + + /* Keymap _MAC: Mac Layer + * ,----------------------------------------------------------------. + * | | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * |Win |Alt |Ctrl| |Ctrl| |Win| | | | + * `----------------------------------------------------------------' + */ +[_MAC] = LAYOUT_ansi( + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, _______,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, \ + KC_LGUI,KC_LALT,KC_LCTL, _______, KC_RCTL,_______,KC_RGUI,_______,_______,_______), + + + /* Keymap _FUNC: Function Layer + * ,----------------------------------------------------------------. + * | |F1 |F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12| Del |HPg | + * |----------------------------------------------------------------| + * | | | | | | | | |Mac| |PSc|ScL|PsB| Calc|Ins | + * |----------------------------------------------------------------| + * | | | | | | | | |Stp|Ply|PTr|NTr| |Hme | + * |----------------------------------------------------------------| + * | |BL |Bl-|Bl+| | | |Mou|MUT|VU-|VU+| |PgU|End | + * |----------------------------------------------------------------| + * | |WnLc| | | | | |Hme|PgD|End | + * `----------------------------------------------------------------' + */ +[_FUNC] = LAYOUT_ansi( + _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL,KC_WHOM, \ + _______,_______,_______,_______,_______,_______,_______,_______,MAC_TOG,_______,KC_PSCR,KC_SLCK,KC_PAUS,KC_CALC, KC_INS, \ + _______,_______,_______,_______,_______,_______,_______,_______,KC_MSTP,KC_MPLY,KC_MPRV,KC_MNXT, _______,KC_HOME, \ + _______,BL_TOGG, BL_DEC, BL_INC,_______,_______,_______,MOU_TOG,KC_MUTE,KC_VOLD,KC_VOLU,_______,KC_PGUP,KC_END , \ + _______,WIN_LCK,_______, _______, _______,_______,_______,KC_HOME,KC_PGDN,KC_END), + + /* Keymap _MOUSE: Mouse Navigation Layer + * ,----------------------------------------------------------------. + * | | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | | | | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | | McR | | + * |----------------------------------------------------------------| + * | | | | | | | | | | | | McL |MsU| | + * |----------------------------------------------------------------| + * | | | | | | | |MsL|MsD|MsR | + * `----------------------------------------------------------------' + */ +[_MOUSE] = LAYOUT_ansi( + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, KC_BTN2,_______, \ + _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,KC_BTN1,KC_MS_U,_______, \ + _______,_______,_______, _______, _______,_______,_______,KC_MS_L,KC_MS_D,KC_MS_R), + +}; + +#define SET_BIT(var, pos) (var |= (1UL << pos)) +#define CLEAR_BIT(var, pos) (var &= ~(1UL << pos)) +#define TOGGLE_BIT(var, pos) (var ^= (1UL << pos)) +#define CHECK_BIT(var, pos) (var & (1U << pos)) + +static uint8_t keyboard_state = 0; +// bit 0 = function layer status (on/off) +// bit 1 = mouse navigation layer state +// bit 2 = windows key lock state + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch(keycode) { + // acts like a momentary function layer press + case FUN_LAY: + if (record->event.pressed) { + layer_on(_FUNC); + if (CHECK_BIT(keyboard_state, 1)) { + layer_on(_MOUSE); + } + else { + layer_off(_MOUSE); + } + // turns on function layer status + SET_BIT(keyboard_state, 0); + } + // key released + else { + layer_off(_FUNC); + layer_off(_MOUSE); + // turns off function layer status + CLEAR_BIT(keyboard_state, 0); + } + break; + + case MOU_TOG: + if(record->event.pressed) { + // toggles navigation layer state + TOGGLE_BIT(keyboard_state, 1); + + // if FN is pressed down while hitting this key, the correct layer will be updated, + // so that the FN key doesn't need to be pressed down again to start using the functionality + if (CHECK_BIT(keyboard_state, 0)) { + if (CHECK_BIT(keyboard_state, 1)) { + layer_on(_MOUSE); + } + else { + layer_off(_MOUSE); + } + } + } + break; + + case WIN_LCK: + if (record->event.pressed) { + // toggles windows key lock state + TOGGLE_BIT(keyboard_state, 2); + } + break; + + // uses seperate WIN_KEY so that WIN_LCK does not affect Mac Layer's KC_LGUI + case WIN_KEY: + // checks if windows key lock is off to allow key to be pressed + if (!CHECK_BIT(keyboard_state, 2)) { + if (record->event.pressed) { + SEND_STRING(SS_DOWN(X_LGUI)); + return false; + } + // key released + else { + SEND_STRING(SS_UP(X_LGUI)); + return false; + } + } + break; + } + return true; +}; diff --git a/keyboards/tada68/keymaps/bazooka/readme.md b/keyboards/tada68/keymaps/bazooka/readme.md @@ -0,0 +1,29 @@ +# FireBazooka's TADA68 layout + +This layout follows a layout very similiar to the default, but with added functionality settings. + +* This layout will start with the basic layer and default function layer on start-up +* This means that that FN+Arrow Keys will have Page Up, Page Down, Home, & End on default +* Press FN+M to turn on Mouse Functionality (FN+Arrows Keys to move the mouse, FN+RShift for left click, & FN+Enter for right click) +* Pressing FN+M again will toggle the FN+Arrow Keys back to the default of PgUp, PgDn, Home, & End +* Press FN+I to change the Control, Windows, & Alt keys to a different configuration that I use for Mac (Win, Alt, Ctrl, _SPACE_, Ctrl, FN, Win) +* Pressing FN+I again will revert back to the default Ctrl, Win, Alt setting +* Pressing FN+Win will toggle the Windows Key Lock (Note: will not affect Win in the Mac Layer configuration) + +Coding practices: +Using my limited C knowledge, I essentienally used flags to get certain functionality working (this probably isn't the way QMK should be used, +but I couldn't find/got lazy trying to find the functions used to toggle layers correctly). This means that I used a static unsigned 8-bit integer +called "keyboard_state" to check the current flags that are on and off currently for the keyboard. + +Example: +keyboard_state = B00000101 ++ The FN key is currently pressed down (bit 0) ++ The mouse layer is turned off (bit 1) ++ The Windows Key Lock is turned on (bit 2) + +keyboard_state = B00000010 ++ The FN key is currently NOT being pressed down (bit 0) ++ The mouse layer is turned on (bit 1) ++ The Windows Key Lock is turned off (bit 2) + +This means that certain bitwise functions like CHECK_BIT(...) and SET_BIT(...) are used on "keyboard_state" to manipulate it. diff --git a/keyboards/tada68/keymaps/bazooka/rules.mk b/keyboards/tada68/keymaps/bazooka/rules.mk @@ -0,0 +1,17 @@ +# Build Options +# change to "no" to disable the options, or define them in the Makefile in +# the appropriate keymap folder that will get included automatically +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = yes # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = no # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality +MIDI_ENABLE = no # MIDI controls +AUDIO_ENABLE = no # Audio output on port C6 +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. Do not enable this with audio at the same time. +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend