~ruther/qmk_firmware

2e5bf25d65bfe3c1ff40046b0787a3c2af43dfcc — Joe Scotto 2 years ago c6a3802
Add ScottoAlp Keyboard (#20937)

A keyboards/handwired/scottokeebs/scottoalp/info.json => keyboards/handwired/scottokeebs/scottoalp/info.json +76 -0
@@ 0,0 1,76 @@
{
    "manufacturer": "ScottoKeebs",
    "keyboard_name": "ScottoAlp",
    "maintainer": "joe-scotto",
    "development_board": "promicro",
    "diode_direction": "COL2ROW",
    "features": {
        "bootmagic": true,
        "command": false,
        "console": false,
        "extrakey": true,
        "mousekey": true,
        "nkro": true
    },
    "matrix_pins": {
        //  4, 5, 6, 7, 8, 9, A3, A2, A1, A0
        "cols": ["D4", "C6", "D7", "E6", "B4", "B5", "F4", "F5", "F6", "F7"],

        // 15, 14, 16, 10
        "rows": ["B1", "B3", "B2", "B6"]
    },
    "url": "https://scottokeebs.com",
    "usb": {
        "device_version": "1.0.0",
        "pid": "0x0007",
        "vid": "0x534B"
    },
    "layouts": {
        "LAYOUT_ortho_3x10_5": {
            "layout": [
                // Row 1
                { "matrix": [0, 0], "x": 0, "y": 0 },
                { "matrix": [0, 1], "x": 1, "y": 0 },
                { "matrix": [0, 2], "x": 2, "y": 0 },
                { "matrix": [0, 3], "x": 3, "y": 0 },
                { "matrix": [0, 4], "x": 4, "y": 0 },
                { "matrix": [0, 5], "x": 5, "y": 0 },
                { "matrix": [0, 6], "x": 6, "y": 0 },
                { "matrix": [0, 7], "x": 7, "y": 0 },
                { "matrix": [0, 8], "x": 8, "y": 0 },
                { "matrix": [0, 9], "x": 9, "y": 0 },

                // Row 2
                { "matrix": [1, 0], "x": 0, "y": 1 },
                { "matrix": [1, 1], "x": 1, "y": 1 },
                { "matrix": [1, 2], "x": 2, "y": 1 },
                { "matrix": [1, 3], "x": 3, "y": 1 },
                { "matrix": [1, 4], "x": 4, "y": 1 },
                { "matrix": [1, 5], "x": 5, "y": 1 },
                { "matrix": [1, 6], "x": 6, "y": 1 },
                { "matrix": [1, 7], "x": 7, "y": 1 },
                { "matrix": [1, 8], "x": 8, "y": 1 },
                { "matrix": [1, 9], "x": 9, "y": 1 },

                // Row 3
                { "matrix": [2, 0], "x": 0, "y": 2 },
                { "matrix": [2, 1], "x": 1, "y": 2 },
                { "matrix": [2, 2], "x": 2, "y": 2 },
                { "matrix": [2, 3], "x": 3, "y": 2 },
                { "matrix": [2, 4], "x": 4, "y": 2 },
                { "matrix": [2, 5], "x": 5, "y": 2 },
                { "matrix": [2, 6], "x": 6, "y": 2 },
                { "matrix": [2, 7], "x": 7, "y": 2 },
                { "matrix": [2, 8], "x": 8, "y": 2 },
                { "matrix": [2, 9], "x": 9, "y": 2 },

                // Row 4
                { "matrix": [3, 1], "x": 1, "y": 3 },
                { "matrix": [3, 2], "x": 2, "y": 3 },
                { "matrix": [3, 4], "x": 4, "y": 3 },
                { "matrix": [3, 6], "x": 6, "y": 3 },
                { "matrix": [3, 7], "x": 7, "y": 3 }
            ]
        }
    }
}

A keyboards/handwired/scottokeebs/scottoalp/keymaps/default/config.h => keyboards/handwired/scottokeebs/scottoalp/keymaps/default/config.h +23 -0
@@ 0,0 1,23 @@
/*
Copyright 2022 Joe Scotto

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

// Define options
#define TAPPING_TERM 135
#define PERMISSIVE_HOLD
#define TAPPING_TERM_PER_KEY

A keyboards/handwired/scottokeebs/scottoalp/keymaps/default/keymap.c => keyboards/handwired/scottokeebs/scottoalp/keymaps/default/keymap.c +45 -0
@@ 0,0 1,45 @@
/*
Copyright 2022 Joe Scotto

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

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT_ortho_3x10_5(
        KC_Q,         KC_W,    KC_E,    KC_R,    KC_T,           KC_Y, KC_U,          KC_I,         KC_O,   KC_P,
        KC_A,         KC_S,    KC_D,    KC_F,    KC_G,           KC_H, KC_J,          KC_K,         KC_L,   KC_BSPC,
        LSFT_T(KC_Z), KC_X,    KC_C,    KC_V,    KC_B,           KC_N, KC_M,          KC_COMMA,     KC_DOT, RSFT_T(KC_SLSH),
                      KC_LGUI, KC_LALT,          LGUI_T(KC_SPC),       LT(1, KC_TAB), LT(2, KC_ENT)
    ),
    [1] = LAYOUT_ortho_3x10_5(
        KC_UNDS,         KC_MINS, KC_PLUS, KC_EQL,  KC_COLN, KC_GRV,   KC_MRWD, KC_MPLY, KC_MFFD, KC_DEL,
        KC_LCBR,         KC_LPRN, KC_RPRN, KC_RCBR, KC_PIPE, KC_ESC,   KC_LEFT, KC_UP,   KC_DOWN, KC_RGHT,
        LSFT_T(KC_LBRC), KC_QUOT, KC_DQUO, KC_RBRC, KC_SCLN, KC_TILDE, KC_VOLD, KC_MUTE, KC_VOLU, RSFT_T(KC_BSLS),
                         KC_TRNS, KC_TRNS,          KC_TRNS,           KC_TRNS, KC_TRNS
    ),
    [2] = LAYOUT_ortho_3x10_5(
        KC_EXLM, KC_AT,   KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_CAPS, KC_BSPC,
        KC_1,    KC_2,    KC_3,    KC_4,   KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,
        KC_LSFT, KC_NO,   KC_NO,   KC_NO,  MO(3),   KC_NO,   KC_NO,   KC_COMM, KC_DOT,  RSFT_T(KC_SLSH),
                 KC_TRNS, KC_TRNS,         KC_TRNS,          KC_TRNS, KC_TRNS
    ),
    [3] = LAYOUT_ortho_3x10_5(
        KC_NO,  KC_NO, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO, KC_NO,   KC_NO, KC_NO, 
        KC_F1,  KC_F2, KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7, KC_F8,   KC_F9, KC_F10,
        KC_F11, KC_NO, KC_NO,   QK_BOOT, KC_TRNS, KC_NO,   KC_NO, KC_NO,   KC_NO, KC_F12,
                       KC_TRNS, KC_TRNS,          KC_TRNS,        KC_TRNS, KC_TRNS
    )
};
\ No newline at end of file

A keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/config.h => keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/config.h +23 -0
@@ 0,0 1,23 @@
/*
Copyright 2022 Joe Scotto

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

// Define options
#define TAPPING_TERM 135
#define PERMISSIVE_HOLD
#define TAPPING_TERM_PER_KEY

A keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/keymap.c => keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/keymap.c +174 -0
@@ 0,0 1,174 @@
/*
Copyright 2022 Joe Scotto

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

// Tap dance declarations
enum {
    TD_LCTL_ESC_SPOTLIGHT_EMOJI,
    TD_LALT_ESC_WINDOWS_EMOJI
};

uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
    switch (keycode) {
        case TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI) :
        case TD(TD_LALT_ESC_WINDOWS_EMOJI) :
        case LGUI_T(KC_SPC) :
        case LT(1, KC_TAB) :
        case LT(2, KC_ENT) :
      return 200;
    default:
      return TAPPING_TERM;
  }
};

// Begin quad TD
typedef enum {
    TD_NONE,
    TD_UNKNOWN,
    TD_SINGLE_HOLD,
    TD_SINGLE_TAP,
    TD_DOUBLE_TAP,
    TD_TRIPLE_TAP
} td_state_t;

typedef struct {
    bool is_press_action;
    td_state_t state;
} td_tap_t;

// Create an instance of 'td_tap_t' for the 'x' tap dance.
static td_tap_t xtap_state = {
    .is_press_action = true,
    .state = TD_NONE
};

td_state_t cur_dance(tap_dance_state_t *state) {
    if (state->count == 1) {
        if (state->interrupted || !state->pressed) {
            return TD_SINGLE_TAP;
        } else {
            return TD_SINGLE_HOLD;
        }
    } else if (state->count == 2) {
        return TD_DOUBLE_TAP;
    } else if (state->count == 3) {
        return TD_TRIPLE_TAP;
    }   

    return TD_UNKNOWN;
}

void td_lctl_esc_spotlight_emoji_finished(tap_dance_state_t *state, void *user_data) {
    xtap_state.state = cur_dance(state);
    switch (xtap_state.state) {
        case TD_SINGLE_TAP: register_code(KC_ESC); break;
        case TD_SINGLE_HOLD: register_code(KC_LCTL); break;
        case TD_DOUBLE_TAP: tap_code16(G(KC_SPC)); break;
        case TD_TRIPLE_TAP: tap_code16(C(G(KC_SPC))); break;
        default: break;
    }
}

void td_lctl_esc_spotlight_emoji_reset(tap_dance_state_t *state, void *user_data) {
    switch (xtap_state.state) {
        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
        case TD_SINGLE_HOLD: unregister_code(KC_LCTL); break;
        default: break;
    }
    xtap_state.state = TD_NONE;
}

void td_lalt_esc_windowr_emoji_finished(tap_dance_state_t *state, void *user_data) {
    xtap_state.state = cur_dance(state);
    switch (xtap_state.state) {
        case TD_SINGLE_TAP: register_code(KC_ESC); break;
        case TD_SINGLE_HOLD: register_code(KC_LALT); break;
        case TD_DOUBLE_TAP: tap_code(KC_LGUI); break;
        case TD_TRIPLE_TAP: tap_code16(G(KC_DOT)); break;
        default: break;
    }
}

void td_lalt_esc_windowr_emoji_reset(tap_dance_state_t *state, void *user_data) {
    switch (xtap_state.state) {
        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
        case TD_SINGLE_HOLD: unregister_code(KC_LALT); break;
        default: break;
    }
    xtap_state.state = TD_NONE;
}

 // Tap Dance definitions
tap_dance_action_t tap_dance_actions[] = {
    [TD_LCTL_ESC_SPOTLIGHT_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_lctl_esc_spotlight_emoji_finished, td_lctl_esc_spotlight_emoji_reset),
    [TD_LALT_ESC_WINDOWS_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_lalt_esc_windowr_emoji_finished, td_lalt_esc_windowr_emoji_reset),
};
// For the x tap dance. Put it here so it can be used in any keymap
void x_finished(tap_dance_state_t *state, void *user_data);
void x_reset(tap_dance_state_t *state, void *user_data);

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT_ortho_3x10_5(
        KC_Q,         KC_W,                            KC_F,    KC_P,    KC_G,           KC_J, KC_L,          KC_U,          KC_Y,   KC_BSPC,
        KC_A,         KC_R,                            KC_S,    KC_T,    KC_D,           KC_H, KC_N,          KC_E,          KC_I,   KC_O,
        LSFT_T(KC_Z), KC_X,                            KC_C,    KC_V,    KC_B,           KC_K, KC_M,          KC_COMMA,      KC_DOT, RSFT_T(KC_SLSH),
                      TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI), KC_LALT,          LGUI_T(KC_SPC),       LT(1, KC_TAB), LT(2, KC_ENT)
    ),
    [1] = LAYOUT_ortho_3x10_5(
        KC_UNDS,         KC_MINS,                         KC_PLUS, KC_EQL,  KC_COLN,        KC_GRV,   KC_MRWD, KC_MPLY, KC_MFFD, KC_DEL,
        KC_LCBR,         KC_LPRN,                         KC_RPRN, KC_RCBR, KC_PIPE,        KC_ESC,   KC_LEFT, KC_UP,   KC_DOWN, KC_RGHT,
        LSFT_T(KC_LBRC), KC_QUOT,                         KC_DQUO, KC_RBRC, KC_SCLN,        KC_TILDE, KC_VOLD, KC_MUTE, KC_VOLU, RSFT_T(KC_BSLS),
                         TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI), KC_LALT,          LGUI_T(KC_SPC),           KC_TRNS, KC_TRNS
    ),
    [2] = LAYOUT_ortho_3x10_5(
        KC_EXLM, KC_AT,                           KC_HASH, KC_DLR,  KC_PERC,        KC_CIRC, KC_AMPR, KC_ASTR, KC_CAPS, KC_BSPC,
        KC_1,    KC_2,                            KC_3,    KC_4,    KC_5,           KC_6,    KC_7,    KC_8,    KC_9,    KC_0,
        KC_LSFT, KC_NO,                           KC_NO,   KC_NO,   MO(3),          KC_NO,   KC_NO,   KC_COMM, KC_DOT,  RSFT_T(KC_SLSH),
                 TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI), KC_LALT,          LGUI_T(KC_SPC),          KC_TRNS, KC_TRNS
    ),
    [3] = LAYOUT_ortho_3x10_5(
        KC_NO,  KC_NO,                           KC_NO,   KC_NO,   KC_NO,          KC_NO, KC_NO,   KC_NO,   KC_NO, TO(4), 
        KC_F1,  KC_F2,                           KC_F3,   KC_F4,   KC_F5,          KC_F6, KC_F7,   KC_F8,   KC_F9, KC_F10,
        KC_F11, KC_NO,                           KC_NO,   QK_BOOT, KC_TRNS,        KC_NO, KC_NO,   KC_NO,   KC_NO, KC_F12,
                TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI), KC_LALT,          LGUI_T(KC_SPC),        KC_TRNS, KC_TRNS
    ),
    [4] = LAYOUT_ortho_3x10_5(
        KC_Q,         KC_W,                          KC_F,    KC_P,    KC_G,   KC_J, KC_L,          KC_U,          KC_Y,   KC_BSPC,
        KC_A,         KC_R,                          KC_S,    KC_T,    KC_D,   KC_H, KC_N,          KC_E,          KC_I,   KC_O,
        LSFT_T(KC_Z), KC_X,                          KC_C,    KC_V,    KC_B,   KC_K, KC_M,          KC_COMMA,      KC_DOT, RSFT_T(KC_SLSH),
                      TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LCTL,          KC_SPC,       LT(5, KC_TAB), LT(6, KC_ENT)
    ),
    [5] = LAYOUT_ortho_3x10_5(
        KC_UNDS,         KC_MINS,                       KC_PLUS, KC_EQL,  KC_COLN, KC_GRV,   KC_MRWD,       KC_MPLY,      KC_MFFD, KC_DEL,
        KC_LCBR,         KC_LPRN,                       KC_RPRN, KC_RCBR, KC_PIPE, KC_ESC,   KC_LEFT,       KC_UP,        KC_DOWN, KC_RGHT,
        LSFT_T(KC_LBRC), KC_QUOT,                       KC_DQUO, KC_RBRC, KC_SCLN, KC_TILDE, KC_VOLD,       KC_MUTE,      KC_VOLU, RSFT_T(KC_BSLS),
                         TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LCTL,          KC_SPC,            LT(5, KC_TAB), LT(6, KC_ENT)
    ),
    [6] = LAYOUT_ortho_3x10_5(
        KC_EXLM, KC_AT,                         KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,       KC_ASTR,      KC_CAPS, KC_BSPC,
        KC_1,    KC_2,                          KC_3,    KC_4,    KC_5,    KC_6,    KC_7,          KC_8,         KC_9,    KC_0,
        KC_LSFT, KC_NO,                         KC_NO,   KC_NO,   MO(7),   KC_NO,   KC_NO,         KC_COMM,      KC_DOT,  RSFT_T(KC_SLSH),
                 TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LCTL,          KC_SPC,           LT(5, KC_TAB), LT(6, KC_ENT)
    ),
    [7] = LAYOUT_ortho_3x10_5(
        KC_NO,  KC_NO,                         KC_NO,   KC_NO,   KC_NO,   KC_NO, KC_NO,         KC_NO,        KC_NO, TO(0), 
        KC_F1,  KC_F2,                         KC_F3,   KC_F4,   KC_F5,   KC_F6, KC_F7,         KC_F8,        KC_F9, KC_F10,
        KC_F11, KC_NO,                         KC_NO,   QK_BOOT, KC_TRNS, KC_NO, KC_NO,         KC_NO,        KC_NO, KC_F12,
                TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LCTL,          KC_SPC,         LT(5, KC_TAB), LT(6, KC_ENT)
    )
};
\ No newline at end of file

A keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/rules.mk => keyboards/handwired/scottokeebs/scottoalp/keymaps/scotto/rules.mk +1 -0
@@ 0,0 1,1 @@
TAP_DANCE_ENABLE = yes

A keyboards/handwired/scottokeebs/scottoalp/readme.md => keyboards/handwired/scottokeebs/scottoalp/readme.md +27 -0
@@ 0,0 1,27 @@
# ScottoAlp

![ScottoAlp](https://i.imgur.com/XKpYcMgh.jpeg)

A 35-key ortholinear keyboard with a 3u spacebar and is compatible with both MX or Alps. Case files available [here](https://github.com/joe-scotto/scottokeebs).

*   Keyboard Maintainer: [Joe Scotto](https://github.com/joe-scotto)
*   Hardware Supported: ATmega32U4
*   Hardware Availability: [Amazon](https://amazon.com)

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

    make handwired/jscotto/scottoalp:default

Flashing example for this keyboard:

    make handwired/jscotto/scottoalp: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 `QK_BOOT` if it is available
\ No newline at end of file

A keyboards/handwired/scottokeebs/scottoalp/rules.mk => keyboards/handwired/scottokeebs/scottoalp/rules.mk +1 -0
@@ 0,0 1,1 @@
# This file intentionally left blank