From 2bccb7132da24fa9d3a3a74a6c9e578b6d1960c8 Mon Sep 17 00:00:00 2001 From: Brandon Claveria <48102030+swiftrax@users.noreply.github.com> Date: Tue, 20 Apr 2021 10:50:06 -0700 Subject: [PATCH] [Keyboard] Siris (#12415) Co-authored-by: Ryan Co-authored-by: Swiftrax --- keyboards/ffkeebs/siris/config.h | 48 +++ keyboards/ffkeebs/siris/info.json | 293 ++++++++++++++++++ .../ffkeebs/siris/keymaps/default/keymap.c | 61 ++++ keyboards/ffkeebs/siris/keymaps/via/keymap.c | 61 ++++ keyboards/ffkeebs/siris/keymaps/via/rules.mk | 1 + keyboards/ffkeebs/siris/readme.md | 13 + keyboards/ffkeebs/siris/rules.mk | 23 ++ keyboards/ffkeebs/siris/siris.c | 17 + keyboards/ffkeebs/siris/siris.h | 37 +++ 9 files changed, 554 insertions(+) create mode 100644 keyboards/ffkeebs/siris/config.h create mode 100644 keyboards/ffkeebs/siris/info.json create mode 100644 keyboards/ffkeebs/siris/keymaps/default/keymap.c create mode 100644 keyboards/ffkeebs/siris/keymaps/via/keymap.c create mode 100644 keyboards/ffkeebs/siris/keymaps/via/rules.mk create mode 100644 keyboards/ffkeebs/siris/readme.md create mode 100644 keyboards/ffkeebs/siris/rules.mk create mode 100644 keyboards/ffkeebs/siris/siris.c create mode 100644 keyboards/ffkeebs/siris/siris.h diff --git a/keyboards/ffkeebs/siris/config.h b/keyboards/ffkeebs/siris/config.h new file mode 100644 index 000000000..6b7733b36 --- /dev/null +++ b/keyboards/ffkeebs/siris/config.h @@ -0,0 +1,48 @@ +/* +Copyright 2021 Swiftrax + +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 "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0x04D8 +#define PRODUCT_ID 0xE96C +#define DEVICE_VER 0x0001 +#define MANUFACTURER Swiftrax +#define PRODUCT Siris + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 12 + +// ROWS: Top to bottom, COLS: Left to right + +#define MATRIX_ROW_PINS { B5, B4, D7, D6, D4 } +#define MATRIX_COL_PINS { D2, D1, D0, B7, B3, B2, F0, F1, F4, F5, F6, F7 } + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* define if matrix has ghost */ +//#define MATRIX_HAS_GHOST + +#define ENCODERS_PAD_A { D3, C6 } +#define ENCODERS_PAD_B { D5, B6 } + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCE 5 diff --git a/keyboards/ffkeebs/siris/info.json b/keyboards/ffkeebs/siris/info.json new file mode 100644 index 000000000..f81d216ad --- /dev/null +++ b/keyboards/ffkeebs/siris/info.json @@ -0,0 +1,293 @@ +{ + "keyboard_name":"Siris", + "url":"https://github.com/swiftrax", + "maintainer":"Swiftrax", + "width":17.75, + "height":5.5, + "layouts":{ + "LAYOUT":{ + "layout":[ + { + "label":"0,3", + "x":3.5, + "y":0 + }, + { + "label":"0,8", + "x":13.75, + "y":0 + }, + { + "label":"0,2", + "x":2.5, + "y":0.125 + }, + { + "label":"0,4", + "x":4.5, + "y":0.125 + }, + { + "label":"0,7", + "x":12.75, + "y":0.13 + }, + { + "label":"0,9", + "x":14.75, + "y":0.13 + }, + { + "label":"0,5", + "x":5.5, + "y":0.25 + }, + { + "label":"0,6", + "x":11.75, + "y":0.25 + }, + { + "label":"0,1", + "x":1.5, + "y":0.375 + }, + { + "label":"0,0", + "x":0.5, + "y":0.38 + }, + { + "label":"0,10", + "x":15.75, + "y":0.38 + }, + { + "label":"0,11", + "x":16.75, + "y":0.38 + }, + { + "label":"1,3", + "x":3.5, + "y":1.0 + }, + { + "label":"1,8", + "x":13.75, + "y":1.0 + }, + { + "label":"1,2", + "x":2.5, + "y":1.125 + }, + { + "label":"1,4", + "x":4.5, + "y":1.125 + }, + { + "label":"1,7", + "x":12.75, + "y":1.13 + }, + { + "label":"1,9", + "x":14.75, + "y":1.13 + }, + { + "label":"1,5", + "x":5.5, + "y":1.25 + }, + { + "label":"1,6", + "x":11.75, + "y":1.25 + }, + { + "label":"1,1", + "x":1.5, + "y":1.375 + }, + { + "label":"1,0", + "x":0.5, + "y":1.38 + }, + { + "label":"1,10", + "x":15.75, + "y":1.38 + }, + { + "label":"1,11", + "x":16.75, + "y":1.38 + }, + { + "label":"2,3", + "x":3.5, + "y":2 + }, + { + "label":"2,8", + "x":13.75, + "y":2 + }, + { + "label":"2,2", + "x":2.5, + "y":2.125 + }, + { + "label":"2,4", + "x":4.5, + "y":2.125 + }, + { + "label":"2,7", + "x":12.75, + "y":2.13 + }, + { + "label":"2,9", + "x":14.75, + "y":2.13 + }, + { + "label":"2,5", + "x":5.5, + "y":2.25 + }, + { + "label":"2,6", + "x":11.75, + "y":2.25 + }, + { + "label":"2,1", + "x":1.5, + "y":2.375 + }, + { + "label":"2,0", + "x":0.5, + "y":2.38 + }, + { + "label":"2,10", + "x":15.75, + "y":2.38 + }, + { + "label":"2,11", + "x":16.75, + "y":2.38 + }, + { + "label":"4,5", + "x":6.75, + "y":2.63 + }, + { + "label":"4,6", + "x":10.5, + "y":2.63 + }, + { + "label":"3,3", + "x":3.5, + "y":3 + }, + { + "label":"3,8", + "x":13.75, + "y":3 + }, + { + "label":"3,2", + "x":2.5, + "y":3.125 + }, + { + "label":"3,4", + "x":4.5, + "y":3.125 + }, + { + "label":"3,7", + "x":12.75, + "y":3.13 + }, + { + "label":"3,9", + "x":14.75, + "y":3.13 + }, + { + "label":"3,5", + "x":5.5, + "y":3.25 + }, + { + "label":"3,6", + "x":11.75, + "y":3.25 + }, + { + "label":"3,1", + "x":1.5, + "y":3.375 + }, + { + "label":"3,0", + "x":0.5, + "y":3.38 + }, + { + "label":"3,10", + "x":15.75, + "y":3.38 + }, + { + "label":"3,11", + "x":16.75, + "y":3.38 + }, + { + "label":"4,2", + "x":4.25, + "y":4.15 + }, + { + "label":"4,0", + "x":13, + "y":4.15 + }, + { + "label":"4,3", + "x":5.25, + "y":4.25 + }, + { + "label":"4,8", + "x":12, + "y":4.25 + }, + { + "x":6.5, + "y":4.5, + "w":1.5 + }, + { + "x":10.25, + "y":4.5, + "w":1.5 + } + ] + } + } +} diff --git a/keyboards/ffkeebs/siris/keymaps/default/keymap.c b/keyboards/ffkeebs/siris/keymaps/default/keymap.c new file mode 100644 index 000000000..2096f812b --- /dev/null +++ b/keyboards/ffkeebs/siris/keymaps/default/keymap.c @@ -0,0 +1,61 @@ +/* +Copyright 2021 Swiftrax + +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 + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +[0] = LAYOUT( + KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, 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_MINS, + 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, KC_BSLS, + KC_LGUI, MO(1), KC_SPC, KC_LBRC, KC_RBRC, KC_ENT, MO(2), KC_BSPC), +[1] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +[2] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +[3] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +}; + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { /* First encoder */ + if (clockwise) { + tap_code(KC_PGDN); + } else { + tap_code(KC_PGUP); + } + } else if (index == 1) { /* Second encoder */ + if (clockwise) { + tap_code(KC_DOWN); + } else { + tap_code(KC_UP); + } + } +} \ No newline at end of file diff --git a/keyboards/ffkeebs/siris/keymaps/via/keymap.c b/keyboards/ffkeebs/siris/keymaps/via/keymap.c new file mode 100644 index 000000000..2096f812b --- /dev/null +++ b/keyboards/ffkeebs/siris/keymaps/via/keymap.c @@ -0,0 +1,61 @@ +/* +Copyright 2021 Swiftrax + +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 + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +[0] = LAYOUT( + KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, 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_MINS, + 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, KC_BSLS, + KC_LGUI, MO(1), KC_SPC, KC_LBRC, KC_RBRC, KC_ENT, MO(2), KC_BSPC), +[1] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +[2] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +[3] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______), +}; + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { /* First encoder */ + if (clockwise) { + tap_code(KC_PGDN); + } else { + tap_code(KC_PGUP); + } + } else if (index == 1) { /* Second encoder */ + if (clockwise) { + tap_code(KC_DOWN); + } else { + tap_code(KC_UP); + } + } +} \ No newline at end of file diff --git a/keyboards/ffkeebs/siris/keymaps/via/rules.mk b/keyboards/ffkeebs/siris/keymaps/via/rules.mk new file mode 100644 index 000000000..036bd6d1c --- /dev/null +++ b/keyboards/ffkeebs/siris/keymaps/via/rules.mk @@ -0,0 +1 @@ +VIA_ENABLE = yes \ No newline at end of file diff --git a/keyboards/ffkeebs/siris/readme.md b/keyboards/ffkeebs/siris/readme.md new file mode 100644 index 000000000..355dc591a --- /dev/null +++ b/keyboards/ffkeebs/siris/readme.md @@ -0,0 +1,13 @@ +# Siris + +Hotswap fixed split keyboard + +* Keyboard Maintainer: Swiftrax +* Hardware Supported: Siris +* Hardware Availability: https://ffkeebs.com/ + +Make example for this keyboard (after setting up your build environment): + + make ffkeebs/siris:default + +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). diff --git a/keyboards/ffkeebs/siris/rules.mk b/keyboards/ffkeebs/siris/rules.mk new file mode 100644 index 000000000..912413f26 --- /dev/null +++ b/keyboards/ffkeebs/siris/rules.mk @@ -0,0 +1,23 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = atmel-dfu + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = lite # 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 = no # 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 +ENCODER_ENABLE = yes # Rotary Encoder \ No newline at end of file diff --git a/keyboards/ffkeebs/siris/siris.c b/keyboards/ffkeebs/siris/siris.c new file mode 100644 index 000000000..cfd505773 --- /dev/null +++ b/keyboards/ffkeebs/siris/siris.c @@ -0,0 +1,17 @@ +/* +Copyright 2021 Swiftrax + +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 "siris.h" diff --git a/keyboards/ffkeebs/siris/siris.h b/keyboards/ffkeebs/siris/siris.h new file mode 100644 index 000000000..1c355e8a5 --- /dev/null +++ b/keyboards/ffkeebs/siris/siris.h @@ -0,0 +1,37 @@ +/* +Copyright 2021 Swiftrax + +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" + +// readability +#define XXX KC_NO + +#define LAYOUT( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, \ + K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, \ + K42, K43, K44, K45, K46, K47, K48, K49 \ +) { \ + { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B }, \ + { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B }, \ + { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B }, \ + { XXX, XXX, K42, K43, K44, K45, K46, K47, K48, K49, XXX, XXX } \ +}