new keyboard: edinburgh41 (#19569)

* added edinburgh41

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: jack <0x6a73@protonmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
This commit is contained in:
schwarzer-geiger 2023-01-26 11:34:27 -05:00 committed by GitHub
parent fa132baa43
commit 3823046712
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 615 additions and 0 deletions

View file

@ -0,0 +1,42 @@
// Copyright 2022 L. Mistry (@schwarzer-geiger)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "config_common.h"
#define MATRIX_ROW_PINS \
{ F4, F5, F6, F7, B1, B3, B2 }
#define MATRIX_COL_PINS \
{ D1, D4, C6, D7, E6, B4 }
#define DIODE_DIRECTION COL2ROW
#define DEBOUNCE 5
// Underglow LED settings
#define RGB_DI_PIN D0
#define RGBLED_NUM 10
// Thumbstick settings
#define ANALOG_JOYSTICK_X_AXIS_PIN B5
#define ANALOG_JOYSTICK_Y_AXIS_PIN B6
// Thumbstick defaults
#ifndef SCROLLING_LAYER
#define SCROLLING_LAYER 1
#endif
#ifndef TAPPING_LAYER
#define TAPPING_LAYER 2
#endif
#ifndef CURSOR_SPEED
#define CURSOR_SPEED 70
#endif
#ifndef SCROLL_SPEED
#define SCROLL_SPEED 25
#endif
#ifndef SCROLL_DELAY_MS
#define SCROLL_DELAY_MS 70
#endif

View file

@ -0,0 +1,16 @@
/* Copyright 2022 schwarzer-geiger
*
* 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 "edinburgh41.h"

View file

@ -0,0 +1,42 @@
/* Copyright 2022 schwarzer-geiger
*
* 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"
/* This a shortcut to help you visually see your layout.
*
* The first section contains all of the arguments representing the physical
* layout of the board and position of the keys.
*
* The second converts the arguments into a two-dimensional array which
* represents the switch matrix.
*/
#define LAYOUT( \
K00, K01, K02, K03, K04, K05, K30, K31, K32, K33, K34, K35, \
K10, K11, K12, K13, K14, K15, K40, K41, K42, K43, K44, K45, \
K20, K21, K22, K23, K24, K25, K50, K51, K52, K53, K54, K55, \
K60, K61, K62, K63, K64 \
) \
{ \
{ K00, K01, K02, K03, K04, K05 }, \
{ K10, K11, K12, K13, K14, K15 }, \
{ K20, K21, K22, K23, K24, K25 }, \
{ K30, K31, K32, K33, K34, K35 }, \
{ K40, K41, K42, K43, K44, K45 }, \
{ K50, K51, K52, K53, K54, K55 }, \
{ K60, K61, K62, K63, K64, KC_NO } \
}

View file

@ -0,0 +1,66 @@
{
"manufacturer": "L. Mistry",
"keyboard_name": "edinburgh41",
"maintainer": "schwarzer-geiger",
"bootloader": "atmel-dfu",
"processor": "atmega32u4",
"url": "https://github.com/schwarzer-geiger/Edinburgh41",
"usb": {
"device_version": "1.0.0",
"pid": "0x0000",
"vid": "0xFEED"
},
"layouts": {
"LAYOUT": {
"layout": [
{"label":"K00", "x":0, "y":0.54},
{"label":"K01", "x":1, "y":0.36},
{"label":"K02", "x":2, "y":0.18},
{"label":"K03", "x":3, "y":0},
{"label":"K04", "x":4, "y":0.18},
{"label":"K05", "x":5, "y":0.36},
{"label":"K30", "x":7, "y":0.36},
{"label":"K31", "x":8, "y":0.18},
{"label":"K32", "x":9, "y":0},
{"label":"K33", "x":10, "y":0.18},
{"label":"K34", "x":11, "y":0.36},
{"label":"K35", "x":12, "y":0.54},
{"label":"K10", "x":0, "y":1.54},
{"label":"K11", "x":1, "y":1.36},
{"label":"K12", "x":2, "y":1.18},
{"label":"K13", "x":3, "y":1},
{"label":"K14", "x":4, "y":1.18},
{"label":"K15", "x":5, "y":1.36},
{"label":"K40", "x":7, "y":1.36},
{"label":"K41", "x":8, "y":1.18},
{"label":"K42", "x":9, "y":1},
{"label":"K43", "x":10, "y":1.18},
{"label":"K44", "x":11, "y":1.36},
{"label":"K45", "x":12, "y":1.54},
{"label":"K20", "x":0, "y":2.54},
{"label":"K21", "x":1, "y":2.36},
{"label":"K22", "x":2, "y":2.18},
{"label":"K23", "x":3, "y":2},
{"label":"K24", "x":4, "y":2.18},
{"label":"K25", "x":5, "y":2.36},
{"label":"K50", "x":7, "y":2.36},
{"label":"K51", "x":8, "y":2.18},
{"label":"K52", "x":9, "y":2},
{"label":"K53", "x":10, "y":2.18},
{"label":"K54", "x":11, "y":2.36},
{"label":"K55", "x":12, "y":2.54},
{"label":"K60", "x":2.875, "y":3.54, "w":1.25},
{"label":"K61", "x":4.125, "y":3.54, "w":1.25},
{"label":"K62", "x":5.375, "y":3.54, "w":2.25},
{"label":"K63", "x":7.625, "y":3.54, "w":1.25},
{"label":"K64", "x":8.875, "y":3.54, "w":1.25}
]
}
}
}

View file

@ -0,0 +1,167 @@
/* Copyright 2022 schwarzer-geiger
*
* 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 layer_names {
_BASE,
_LOWER,
_RAISE,
_ADJUST
};
#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define ADJUST MO(_ADJUST)
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_BASE] = LAYOUT(
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_LCTL, 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, RSFT_T(KC_ENT),
KC_LALT, LOWER, KC_SPC, RAISE, KC_RGUI
),
[_LOWER] = LAYOUT(
_______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
_______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_GRV, KC_TILD,
_______, KC_ESC, KC_LGUI, KC_LALT, KC_CAPS, KC_DQUO, KC_HOME, KC_END, KC_PGUP, KC_PGDN, KC_PSCR, RSFT_T(KC_SPC),
_______, _______, KC_ENT, _______, _______
),
[_RAISE] = LAYOUT(
_______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
_______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
_______, KC_ESC, KC_RGUI, KC_RALT, KC_CAPS, KC_QUOT, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
_______, _______, KC_BSPC, _______, _______
),
[_ADJUST] = LAYOUT(
RGB_VAI, RGB_SAI, RGB_HUI, RGB_MOD, XXXXXXX, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
RGB_VAD, RGB_SAD, RGB_HUD, RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
_______, _______, XXXXXXX, _______, _______
),
};
// Thumbstick keymap, change KC_XXX to whatever you need
#define THUMBSTICK_RIGHT_TAP KC_RIGHT
#define THUMBSTICK_LEFT_TAP KC_LEFT
#define THUMBSTICK_UP_TAP KC_UP
#define THUMBSTICK_DOWN_TAP KC_DOWN
// Thumbstick code, no customisation needed
bool cursor_mode = false;
bool scrolling_mode = false;
bool tapping_mode = false;
// tracks if thumbstick was released
bool returned_to_zero = true;
// tracks how many times mouse_report.x/y have been read zero in succession
uint16_t zero_reads = 0;
// set mode depending on layer
layer_state_t layer_state_set_user(layer_state_t state) {
state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
switch (get_highest_layer(state)) {
case SCROLLING_LAYER:
if (scrolling_mode == false) {
scrolling_mode = true;
}
if (tapping_mode) {
tapping_mode = false;
}
if (cursor_mode) {
cursor_mode = false;
}
break;
case TAPPING_LAYER:
if (tapping_mode == false) {
tapping_mode = true;
}
if (cursor_mode) {
cursor_mode = false;
}
if (scrolling_mode) {
scrolling_mode = false;
}
break;
default:
if (scrolling_mode) {
scrolling_mode = false;
}
if (tapping_mode) {
tapping_mode = false;
}
if (cursor_mode == false) {
cursor_mode = true;
}
break;
}
return state;
}
// manipulate mouse report based on current mode
report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
if (cursor_mode) {
mouse_report.x = CURSOR_SPEED * mouse_report.x/100;
mouse_report.y = CURSOR_SPEED * mouse_report.y/100;
}
if (scrolling_mode) {
mouse_report.h = SCROLL_SPEED * mouse_report.x/100;
mouse_report.v = SCROLL_SPEED * mouse_report.y/100;
mouse_report.x = 0;
mouse_report.y = 0;
if ((mouse_report.h != 0) | (mouse_report.v != 0)) {
_delay_ms(SCROLL_DELAY_MS);
}
} else if (tapping_mode) {
if ((mouse_report.x || mouse_report.y) != 0) {
if (returned_to_zero) {
if (mouse_report.x > 0) {
tap_code16(THUMBSTICK_RIGHT_TAP);
}
if (mouse_report.x < 0) {
tap_code16(THUMBSTICK_LEFT_TAP);
}
if (mouse_report.y > 0) {
tap_code16(THUMBSTICK_DOWN_TAP);
}
if (mouse_report.y < 0) {
tap_code16(THUMBSTICK_UP_TAP);
}
returned_to_zero = false;
}
zero_reads = 0;
} else if (zero_reads < 20) {
zero_reads++;
}
if (zero_reads >= 20) {
if (returned_to_zero == false) {
returned_to_zero = true;
}
}
mouse_report.x = 0;
mouse_report.y = 0;
}
return mouse_report;
}

View file

@ -0,0 +1,19 @@
// Copyright 2022 L. Mistry (@schwarzer-geiger)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
// Underglow LED settings
#define RGBLIGHT_SLEEP
// Thumbstick settings
#undef CURSOR_SPEED
#define CURSOR_SPEED 95
#undef SCROLL_SPEED
#define SCROLL_SPEED 20
// tap dance settings
#define TAPPING_TERM 155

View file

@ -0,0 +1,220 @@
/* Copyright 2022 schwarzer-geiger
*
* 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 layer_names {
_BASE,
_LOWER,
_RAISE,
_ADJUST
};
#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define ADJUST MO(_ADJUST)
enum custom_keycodes {
AE_UMLAUT = SAFE_RANGE,
UE_UMLAUT,
OE_UMLAUT,
SS_UMLAUT
};
enum {
TD_J_QUOTE,
TD_H_DQT,
};
// Tap Dance definitions
qk_tap_dance_action_t tap_dance_actions[] = {
// Tap once for J, twice for Semicolon
[TD_J_QUOTE] = ACTION_TAP_DANCE_DOUBLE(KC_J, KC_QUOTE),
// Tap once for K, twice for Colon
[TD_H_DQT] = ACTION_TAP_DANCE_DOUBLE(KC_H, KC_DOUBLE_QUOTE),
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_BASE] = LAYOUT(
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Z, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
LT(RAISE, KC_TAB), KC_A, KC_S, KC_D, KC_F, KC_G, TD(TD_H_DQT), TD(TD_J_QUOTE), KC_K, KC_L, KC_MS_BTN1, KC_ENTER,
LGUI(KC_TAB), KC_Y, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_SCLN,
KC_LCTL, KC_LSFT, KC_NO, KC_SPC, LOWER
),
[_LOWER] = LAYOUT(
RGB_TOG, KC_NO, KC_LBRC, KC_RBRC, KC_NO, KC_NO, KC_NO, LGUI(KC_SPC), KC_MINUS, LSFT(KC_EQUAL), KC_NO, LGUI(LSFT(KC_4)),
_______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
_______, KC_NO, LSFT(KC_LBRC), LSFT(KC_RBRC), KC_NO, KC_NO, KC_NO, KC_EQUAL, KC_BSLS, KC_GRAVE, KC_NO, KC_NO,
_______, _______, KC_NO, _______, _______
),
[_RAISE] = LAYOUT(
_______, KC_NO, KC_UP, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
_______, KC_LEFT, KC_DOWN, KC_RIGHT, KC_NO, KC_NO, KC_NO, UE_UMLAUT, OE_UMLAUT, AE_UMLAUT, SS_UMLAUT, KC_NO,
_______, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
_______, _______, KC_NO, _______, _______
),
[_ADJUST] = LAYOUT(
RGB_VAI, RGB_SAI, RGB_HUI, RGB_MOD, XXXXXXX, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
RGB_VAD, RGB_SAD, RGB_HUD, RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
_______, _______, XXXXXXX, _______, _______
),
};
// German Umlaute macro for Mac US keyboard
bool process_record_user(uint16_t keycode, keyrecord_t* record) {
switch (keycode) {
case AE_UMLAUT:
if (record->event.pressed) {
// when keycode AE_UMLAUT is pressed
SEND_STRING(SS_LALT("u") "a");
} else {
// when keycode AE_UMLAUT is released
}
break;
case UE_UMLAUT:
if (record->event.pressed) {
SEND_STRING(SS_LALT("u") "u");
} else {
}
break;
case OE_UMLAUT:
if (record->event.pressed) {
SEND_STRING(SS_LALT("u") "o");
} else {
}
break;
case SS_UMLAUT:
if (record->event.pressed) {
SEND_STRING(SS_LALT("s"));
} else {
}
break;
}
return true;
};
// Thumbstick keymap, change KC_XXX to whatever you need
#define THUMBSTICK_RIGHT_TAP KC_RIGHT
#define THUMBSTICK_LEFT_TAP KC_LEFT
#define THUMBSTICK_UP_TAP KC_UP
#define THUMBSTICK_DOWN_TAP KC_DOWN
// Thumbstick code, no customisation needed
bool cursor_mode = false;
bool scrolling_mode = false;
bool tapping_mode = false;
// tracks if thumbstick was released
bool returned_to_zero = true;
// tracks how many times mouse_report.x/y have been read zero in succession
uint16_t zero_reads = 0;
// set mode depending on layer
layer_state_t layer_state_set_user(layer_state_t state) {
switch (get_highest_layer(state)) {
case SCROLLING_LAYER:
if (scrolling_mode == false) {
scrolling_mode = true;
}
if (tapping_mode) {
tapping_mode = false;
}
if (cursor_mode) {
cursor_mode = false;
}
break;
case TAPPING_LAYER:
if (tapping_mode == false) {
tapping_mode = true;
}
if (cursor_mode) {
cursor_mode = false;
}
if (scrolling_mode) {
scrolling_mode = false;
}
break;
default:
if (scrolling_mode) {
scrolling_mode = false;
}
if (tapping_mode) {
tapping_mode = false;
}
if (cursor_mode == false) {
cursor_mode = true;
}
break;
}
return state;
}
// manipulate mouse report based on current mode
report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
if (cursor_mode) {
mouse_report.x = CURSOR_SPEED * mouse_report.x/100;
mouse_report.y = CURSOR_SPEED * mouse_report.y/100;
}
if (scrolling_mode) {
mouse_report.h = SCROLL_SPEED * mouse_report.x/100;
mouse_report.v = SCROLL_SPEED * mouse_report.y/100;
mouse_report.x = 0;
mouse_report.y = 0;
if ((mouse_report.h != 0) | (mouse_report.v != 0)) {
_delay_ms(SCROLL_DELAY_MS);
}
} else if (tapping_mode) {
if ((mouse_report.x || mouse_report.y) != 0) {
if (returned_to_zero) {
if (mouse_report.x > 0) {
tap_code16(THUMBSTICK_RIGHT_TAP);
}
if (mouse_report.x < 0) {
tap_code16(THUMBSTICK_LEFT_TAP);
}
if (mouse_report.y > 0) {
tap_code16(THUMBSTICK_DOWN_TAP);
}
if (mouse_report.y < 0) {
tap_code16(THUMBSTICK_UP_TAP);
}
returned_to_zero = false;
}
zero_reads = 0;
} else if (zero_reads < 20) {
zero_reads++;
}
if (zero_reads >= 20) {
if (returned_to_zero == false) {
returned_to_zero = true;
}
}
mouse_report.x = 0;
mouse_report.y = 0;
}
return mouse_report;
}

View file

@ -0,0 +1 @@
TAP_DANCE_ENABLE = yes

View file

@ -0,0 +1,27 @@
# edinburgh41
![edinburgh41](https://i.imgur.com/Lrjyp6nh.png)
A small 40% board based on gtip's reviung41. The gasket mounted edinburgh41 features joystick with versatile functionality and rgb underglow.
* Keyboard Maintainer: [Lalit Mistry](https://github.com/schwarzer-geiger)
* Hardware Supported: edinburgh41 pcb with pro micro or wired equivalent
* Hardware Availability: Contact me, lalitmistry1407@gmail.com
Make example for this keyboard (after setting up your build environment):
make edinburgh41:default
Flashing example for this keyboard:
make edinburgh41: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 top left key while plugging keyboard into computer
* **Physical reset button**: Short RST and GND pins
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

View file

@ -0,0 +1,15 @@
# Build Options
# change yes to no to disable
#
BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = no # Commands for debug and configuration
NKRO_ENABLE = yes # Enable N-Key Rollover
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
AUDIO_ENABLE = no # Audio output
POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = analog_joystick