From 53b35052eefc8a341cbc68d3d9aba52dfbf59f35 Mon Sep 17 00:00:00 2001 From: james sa <188772+jamessa@users.noreply.github.com> Date: Sat, 30 Jan 2021 11:24:42 +0800 Subject: [PATCH] [Keyboard] A symmetric stagger keyboard: Angel (#11501) * New symmetric stagger keyboard: Angel * mac layout * layout simplify * Update keyboards/angel/info.json Co-authored-by: Ryan * Update keyboards/angel/keymaps/default/keymap.c Co-authored-by: Ryan * Update keyboards/angel/config.h Co-authored-by: Ryan * Update keyboards/angel/readme.md Co-authored-by: Ryan * Update keyboards/angel/rules.mk Co-authored-by: Ryan * tab lang switch * move to handwired and fix build instructions. Co-authored-by: Ryan --- keyboards/handwired/angel/angel.h | 40 ++++++++++ keyboards/handwired/angel/config.h | 55 ++++++++++++++ keyboards/handwired/angel/info.json | 13 ++++ .../handwired/angel/keymaps/default/keymap.c | 74 +++++++++++++++++++ .../handwired/angel/keymaps/default/readme.md | 7 ++ keyboards/handwired/angel/readme.md | 19 +++++ keyboards/handwired/angel/rules.mk | 22 ++++++ 7 files changed, 230 insertions(+) create mode 100644 keyboards/handwired/angel/angel.h create mode 100644 keyboards/handwired/angel/config.h create mode 100644 keyboards/handwired/angel/info.json create mode 100644 keyboards/handwired/angel/keymaps/default/keymap.c create mode 100644 keyboards/handwired/angel/keymaps/default/readme.md create mode 100644 keyboards/handwired/angel/readme.md create mode 100644 keyboards/handwired/angel/rules.mk diff --git a/keyboards/handwired/angel/angel.h b/keyboards/handwired/angel/angel.h new file mode 100644 index 00000000000..f39fac97d6d --- /dev/null +++ b/keyboards/handwired/angel/angel.h @@ -0,0 +1,40 @@ +/* Copyright 2021 James Sa + * + * 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 + +#include "quantum.h" + +/* This is 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( \ + k11 , k12 , k13 , k14 , k15 , k16 , k17 , k18 , k19 , k1a , k1b ,\ + k21 , k22 , k23 , k24 , k25 , k26 , k27 , k28 , k29 , k2a , k2b , k2c ,\ + k31 , k32 , k33 , k34 , k35 , k36 , k37 , k38 , k39 , k3a , k3b , k3c , k3d ,\ + k41 , k42 , k43 , k44 , k45 , k46 , k47 , k48 , k49 , k4a , k4b \ +) \ +{ \ + { k11, k12, k13, k14, k15,KC_NO,KC_NO, k16, k17, k18, k19, k1a, k1b }, \ + { k21, k22, k23, k24, k25, k26, KC_NO, k27, k28, k29, k2a, k2b, k2c }, \ + { k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d }, \ + { KC_NO,k41,k42, k43, k44, k45, k46, k47, k48, k49, k4a, k4b, KC_NO} \ +} diff --git a/keyboards/handwired/angel/config.h b/keyboards/handwired/angel/config.h new file mode 100644 index 00000000000..e2472a1a272 --- /dev/null +++ b/keyboards/handwired/angel/config.h @@ -0,0 +1,55 @@ +/* +Copyright 2021 James Sa + +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 + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0x0805 + +#define MANUFACTURER JSA +#define PRODUCT Angel +/* USB Version in Binary-coded decimal: 0xJJMN where + * JJ is the major number, M is minor, N is sub minor. */ +#define DEVICE_VER 0x0100 // Version 1.00: hand-wire + + +/* key matrix size */ +#define MATRIX_ROWS 4 +#define MATRIX_COLS 13 + +/* + * Keyboard Matrix Assignments + * COLS: AVR pins used for columns, left to right + * ROWS: AVR pins used for rows, top to bottom + * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) + * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) + */ +#define MATRIX_ROW_PINS { B6, B2, B5, B4 } +#define MATRIX_COL_PINS { D3, D2, D1, D0, D4, C6, D7, E6, B3, B1, F7, F6, F5 } +#define UNUSED_PINS +#define DIODE_DIRECTION COL2ROW + +// https://docs.qmk.fm/using-qmk/software-features/tap_hold +#define TAPPING_TERM 200 +#define IGNORE_MOD_TAP_INTERRUPT + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCE 5 + +/* define if matrix has ghost (lacks anti-ghosting diodes) */ +#define MATRIX_HAS_GHOST diff --git a/keyboards/handwired/angel/info.json b/keyboards/handwired/angel/info.json new file mode 100644 index 00000000000..3d57c8afc4a --- /dev/null +++ b/keyboards/handwired/angel/info.json @@ -0,0 +1,13 @@ +{ + "keyboard_name": "Angel", + "keyboard_folder": "angel", + "url": "https://github.com/jamessa/Angel", + "maintainer": "jamessa", + "width": 13, + "height": 4, + "layouts": { + "LAYOUT": { + "layout": [{"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":6, "y":0}, {"x":7, "y":0}, {"x":8, "y":0}, {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":0.5, "y":1}, {"x":1.5, "y":1}, {"x":2.5, "y":1}, {"x":3.5, "y":1}, {"x":4.5, "y":1}, {"x":5.5, "y":1}, {"x":6.5, "y":1}, {"x":7.5, "y":1}, {"x":8.5, "y":1}, {"x":9.5, "y":1}, {"x":10.5, "y":1}, {"x":11.5, "y":1}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2}, {"x":5, "y":2}, {"x":6, "y":2}, {"x":7, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2}, {"x":12, "y":2}, {"x":0.5, "y":3}, {"x":1.5, "y":3}, {"x":2.5, "y":3}, {"x":3.5, "y":3}, {"x":4.5, "y":3, "w":1.25}, {"x":5.75, "y":3, "w":1.5}, {"x":7.25, "y":3, "w":1.25}, {"x":8.5, "y":3}, {"x":9.5, "y":3}, {"x":10.5, "y":3}, {"x":11.5, "y":3}] + } + } +} diff --git a/keyboards/handwired/angel/keymaps/default/keymap.c b/keyboards/handwired/angel/keymaps/default/keymap.c new file mode 100644 index 00000000000..23fd6d524b0 --- /dev/null +++ b/keyboards/handwired/angel/keymaps/default/keymap.c @@ -0,0 +1,74 @@ +/* Copyright 2021 James Sa + * + * 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 + +// Defines names for use in layer keycodes and the keymap +enum layer_names { + _BASE, // Colemak mod DH + _KAI, // beginner, no modifier on home row + _PUNC, // puncuation + _FN // function +}; + +#define _C(X) CTL_T(X) +#define _A(X) ALT_T(X) +#define _S(X) SFT_T(X) +#define _G(X) GUI_T(X) +#define FN_TAB LT(_FN, KC_TAB) +#define PN_BS LT(_PUNC, KC_BSPC) +// macOS shortcut +#define _MSNCTL C(KC_UP) +#define _APPWIN C(KC_DOWN) +#define WKSPLF C(KC_LEFT) +#define WKSPRT C(KC_RGHT) +#define COPY G(KC_C) +#define PSTE G(KC_V) +#define CUT G(KC_X) +#define UNDO G(KC_Z) +#define REDO G(S(KC_Z)) +#define SCNSHOT S(G(KC_4)) +// window management utility +#define DIVVY G(KC_G) +// puncuation +#define KC_DQOT S(KC_QUOT) // " + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] LAYOUT( + KC_Q, KC_W, KC_F, KC_P, KC_B, KC_QUOT, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, + _C(KC_A),_A(KC_R),_S(KC_S),_G(KC_T),KC_G, KC_LBRC, KC_RBRC, KC_M, _G(KC_N),_S(KC_E),_A(KC_I),_C(KC_O), + KC_Z, KC_X, KC_C, KC_D, KC_V, KC_MINS, KC_GRV, KC_EQL, KC_K, KC_H, KC_COMM, KC_DOT, KC_SLSH, + KC_ESC, KC_UP, KC_DOWN, PN_BS, FN_TAB, KC_ENT, KC_CAPS, KC_SPC, KC_LEFT, KC_RGHT, KC_BSLS + ), + [_KAI] LAYOUT( + KC_Q, KC_W, KC_F, KC_P, KC_B, KC_QUOT, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, + KC_A, KC_R, KC_S, KC_T, KC_G, KC_LBRC, KC_RBRC, KC_M, KC_N, KC_E, KC_I, KC_O, + _S(KC_Z),KC_X, KC_C, KC_D, KC_V, KC_MINS,TO(_BASE),KC_EQL, KC_K, KC_H, KC_COMM, KC_DOT, KC_SLSH, + _C(KC_ESC), _A(KC_UP), _G(KC_DOWN), PN_BS, FN_TAB, KC_ENT, KC_CAPS, KC_SPC, KC_LEFT, KC_RGHT, KC_BSLS + ), + [_PUNC] LAYOUT( + KC_PERC, KC_CIRC, KC_AMPR, KC_DLR, _______, _______, _______, KC_7, KC_8, KC_9, KC_PLUS, + KC_EXLM, KC_AT, KC_HASH, KC_DQOT, KC_LPRN, _______, _______, KC_RPRN, KC_4, KC_5, KC_6, KC_MINS, + _______, _______, _______, KC_QUOT, _______, _______, _______, _______, _______, KC_1, KC_2, KC_3, KC_ASTR, + _______, _______, _______, _______, _______, _______, _______, KC_0, KC_COMM, KC_DOT, KC_SLSH + ), + [_FN] LAYOUT( + _______, SCNSHOT, DIVVY, _______, _______, _______, _______, _______, KC_UP, KC_VOLD, KC_VOLU, + UNDO, CUT, COPY, PSTE, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, + REDO, WKSPLF, _MSNCTL, WKSPRT, _______, _______,TO(_KAI), _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ) +}; diff --git a/keyboards/handwired/angel/keymaps/default/readme.md b/keyboards/handwired/angel/keymaps/default/readme.md new file mode 100644 index 00000000000..6425306b0e4 --- /dev/null +++ b/keyboards/handwired/angel/keymaps/default/readme.md @@ -0,0 +1,7 @@ +# Hand-wire Angel + +![Angel Layout Image](https://raw.githubusercontent.com/jamessa/Angel/master/attachments/handwire.jpeg) + +The default layout for hand-wire Angel is Colemak-DHM with modifiers on the home row. I'd love to see how we can improve it. + +The most enjoyable part besides soldering is poking the QMK configurations and test it on keybr.com. It's so much fun. \ No newline at end of file diff --git a/keyboards/handwired/angel/readme.md b/keyboards/handwired/angel/readme.md new file mode 100644 index 00000000000..d3b2ddd6436 --- /dev/null +++ b/keyboards/handwired/angel/readme.md @@ -0,0 +1,19 @@ +# Angel + +![Angel](https://raw.githubusercontent.com/jamessa/Angel/master/attachments/handwire.jpeg) + +Angel is a minimalist symmetrical stagger keyboard with thumb position in mind. Layout and hand wire guide is on [Github](https://github.com/jamessa/Angel). + +* Keyboard Maintainer: [James Sa](https://github.com/jamessa) +* Hardware Supported: Hand wired +* Hardware Availability: You can follow the build guide here. https://github.com/jamessa/Angel + +Make example for this keyboard (after setting up your build environment): + + make handwired/angel:default + +Flashing example for this keyboard: + + make handwired/angel:default:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools), the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide), and the [hand-wiring guide](https://docs.qmk.fm/#/hand_wire) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/angel/rules.mk b/keyboards/handwired/angel/rules.mk new file mode 100644 index 00000000000..8a411ac604a --- /dev/null +++ b/keyboards/handwired/angel/rules.mk @@ -0,0 +1,22 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = full # Virtual DIP switch configuration +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 +# 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 = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output