~ruther/qmk_firmware

6c507afcf212165dd5f3c3f6c026b517295c5090 — SmollChungus 3 years ago db0d2a5
[Keyboard] add Lefty keyboard (#14898)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/lefty/config.h => keyboards/lefty/config.h +44 -0
@@ 0,0 1,44 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#pragma once

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID       0x5363 // Sc for Smollchungus
#define PRODUCT_ID      0x0001
#define DEVICE_VER      0x0001
#define MANUFACTURER    SmollChungus
#define PRODUCT         Lefty

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 8

/* key matrix pins are in subfolders v1/v2 */

/* Diode direction   */
#define DIODE_DIRECTION COL2ROW

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5

/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
#define LOCKING_SUPPORT_ENABLE

/* Locking resynchronize hack */
#define LOCKING_RESYNC_ENABLE

A keyboards/lefty/info.json => keyboards/lefty/info.json +43 -0
@@ 0,0 1,43 @@
{
  "keyboard_name": "lefty",
  "url": "https://github.com/smollchungus",
  "maintainer": "smollchungus",
  "layouts": {
    "LAYOUT_all": {
        "layout": [
          {"label":"F1", "x":0.5, "y":0},
          {"label":"Escape", "x":2, "y":0},
          {"label":"1", "x":3, "y":0},
          {"label":"2", "x":4, "y":0},
          {"label":"3", "x":5, "y":0},
          {"label":"4", "x":6, "y":0},
          {"label":"5", "x":7, "y":0},
          {"label":"6", "x":8, "y":0},
          {"label":"F2", "x":0.25, "y":1},
          {"label":"Tab", "x":1.75, "y":1, "w":1.5},
          {"label":"Q", "x":3.25, "y":1},
          {"label":"W", "x":4.25, "y":1},
          {"label":"E", "x":5.25, "y":1},
          {"label":"R", "x":6.25, "y":1},
          {"label":"T", "x":7.25, "y":1},
          {"label":"F3", "x":0, "y":2},
          {"label":"Caps Lock", "x":1.5, "y":2, "w":1.75},
          {"label":"A", "x":3.25, "y":2},
          {"label":"S", "x":4.25, "y":2},
          {"label":"D", "x":5.25, "y":2},
          {"label":"F", "x":6.25, "y":2},
          {"label":"G", "x":7.25, "y":2},
          {"label":"Shift", "x":1.25, "y":3, "w":2.25},
          {"label":"Z", "x":3.5, "y":3},
          {"label":"X", "x":4.5, "y":3},
          {"label":"C", "x":5.5, "y":3},
          {"label":"V", "x":6.5, "y":3},
          {"label":"B", "x":7.5, "y":3},
          {"label":"Control", "x":1.25, "y":4, "w":1.25},
          {"label":"Alt", "x":4.5, "y":4, "w":1.25},
          {"label":"Layer2", "x":5.75, "y":4, "w":2},
          {"label":"Layer3", "x":7.75, "y":4, "w":1.25}
      ]
    }
  }
}

A keyboards/lefty/keymaps/default/keymap.c => keyboards/lefty/keymaps/default/keymap.c +65 -0
@@ 0,0 1,65 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#include QMK_KEYBOARD_H

enum layers {
    _QWERTY,
    _LOWER,
    _RAISE,
    _SPECIAL,
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define SPECIAL MO(_SPECIAL)


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_QWERTY] = LAYOUT_all(
		KC_UP,    KC_ESC,   KC_1,    KC_2,    KC_3,  KC_4,  KC_5, KC_6,
		KC_DOWN,  KC_TAB,   KC_Q,    KC_W,    KC_E,  KC_R,  KC_T,
		KC_RGHT,  LOWER,    KC_A,    KC_S,    KC_D,  KC_F,  KC_G,
		          KC_LSFT,  KC_Z,    KC_X,    KC_C,  KC_V,  KC_B,
		          KC_LCTL,           KC_LALT, RAISE,        SPECIAL
),

[_LOWER] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
),

[_RAISE] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
),

[_SPECIAL] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
)
};


A keyboards/lefty/keymaps/via/keymap.c => keyboards/lefty/keymaps/via/keymap.c +65 -0
@@ 0,0 1,65 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#include QMK_KEYBOARD_H


enum layers {
    _QWERTY,
    _LOWER,
    _RAISE,
    _SPECIAL,
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define SPECIAL MO(_SPECIAL)


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_QWERTY] = LAYOUT_all(
		KC_UP,    KC_ESC,   KC_1,    KC_2,     KC_3,   KC_4,   KC_5, KC_6,
		KC_DOWN,  KC_TAB,   KC_Q,    KC_W,     KC_E,   KC_R,   KC_T,
		KC_RGHT,  LOWER,    KC_A,    KC_S,     KC_D,   KC_F,   KC_G,
		          KC_LSFT,  KC_Z,    KC_X,     KC_C,   KC_V,   KC_B,
		          KC_LCTL,           KC_LALT,  RAISE,          SPECIAL
),

[_LOWER] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
),

[_RAISE] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
),

[_SPECIAL] = LAYOUT_all(
		____, ____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		____, ____, ____, ____, ____, ____, ____,
		      ____, ____, ____, ____, ____, ____,
		      ____,       ____, ____,       ____
)
};

A keyboards/lefty/keymaps/via/rules.mk => keyboards/lefty/keymaps/via/rules.mk +1 -0
@@ 0,0 1,1 @@
VIA_ENABLE = yes

A keyboards/lefty/lefty.c => keyboards/lefty/lefty.c +43 -0
@@ 0,0 1,43 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#include "lefty.h"

#ifdef OLED_ENABLE
__attribute__((weak)) void oled_task_user(void) {
    // Host Keyboard Layer Status
    oled_write_P(PSTR("Layer: "), false);

    switch (get_highest_layer(layer_state)) {
        case 0:
            oled_write_P(PSTR("Default\n"), false);
            break;
        case 1:
            oled_write_P(PSTR("LOWER\n"), false);
            break;
        case 2:
            oled_write_P(PSTR("RAISE\n"), false);
            break;
        case 3:
            oled_write_P(PSTR("SPECIAL\n"), false);
            break;
        default:
            // Or use the write_ln shortcut over adding '\n' to the end of your string
            oled_write_ln_P(PSTR("Undefined"), false);
    }

}
#endif

A keyboards/lefty/lefty.h => keyboards/lefty/lefty.h +37 -0
@@ 0,0 1,37 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#pragma once

#include "quantum.h"

// keymap
#define LAYOUT_all( \
	K00, K01, K02, K03, K04, K05, K06, K07, \
	K10, K11, K12, K13, K14, K15, K16,      \
	K20, K21, K22, K23, K24, K25, K26,      \
	     K31, K32, K33, K34, K35, K36,      \
	     K41,      K43, K44,      K46  \
) \
{ \
	{ K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07 }, \
	{ K10,   K11,   K12,   K13,   K14,   K15,   K16,   KC_NO }, \
	{ K20,   K21,   K22,   K23,   K24,   K25,   K26,   KC_NO }, \
	{ KC_NO, K31,   K32,   K33,   K34,   K35,   K36,   KC_NO }, \
	{ KC_NO, K41,   KC_NO, K43,   K44,   KC_NO, K46,   KC_NO }  \
}

#define LAYOUT LAYOUT

A keyboards/lefty/readme.md => keyboards/lefty/readme.md +27 -0
@@ 0,0 1,27 @@
# lefty

![lefty](https://i.imgur.com/nMmJCJMh.jpeg)

Half an alice used as a macropad.

* Keyboard Maintainer: [SmollChungus](https://github.com/smollchungus/)

* Hardware Supported: Lefty PCB rev1 and rev2

Make example for this keyboard (after setting up your build environment):

    make lefty:default

Flashing example for this keyboard:

    make lefty:default:flash

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

# Bootloader
Enter the bootloader in 3 ways:

Bootmagic reset: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
Physical reset button: Briefly press the button on the back of the PCB - some may have pads you must short instead
Keycode in layout: Press the key mapped to RESET if it is available

A keyboards/lefty/rev1/config.h => keyboards/lefty/rev1/config.h +22 -0
@@ 0,0 1,22 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#pragma once

/* key matrix pins */

#define MATRIX_ROW_PINS { F0, F1, C7, D5, B7 }
#define MATRIX_COL_PINS { D4, B5, F5, F6, F7, B1, B3, F4 }

A keyboards/lefty/rev1/rev1.c => keyboards/lefty/rev1/rev1.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#include "lefty.h"

A keyboards/lefty/rev2/config.h => keyboards/lefty/rev2/config.h +21 -0
@@ 0,0 1,21 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#pragma once

/* key matrix pins */
#define MATRIX_ROW_PINS { B2, B6, D7, E6, B4 }
#define MATRIX_COL_PINS { D4, B5, F5, F6, F7, B1, B3, F4 }

A keyboards/lefty/rev2/rev2.c => keyboards/lefty/rev2/rev2.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 Smoll Chungus (@smollchungus)
*
* 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 <http://www.gnu.org/licenses/>.
*/

#include "lefty.h"

A keyboards/lefty/rules.mk => keyboards/lefty/rules.mk +27 -0
@@ 0,0 1,27 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
MOUSEKEY_ENABLE = no        # Mouse keys
EXTRAKEY_ENABLE = yes       # Audio control and System control
CONSOLE_ENABLE = no         # Console for debug
COMMAND_ENABLE = no         # Commands for debug and configuration
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
NKRO_ENABLE = no            # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output
LTO_ENABLE = yes

OLED_ENABLE = yes
OLED_DRIVER = SSD1306

DEFAULT_FOLDER = lefty/rev2