summaryrefslogtreecommitdiff
path: root/keyboards/pluckey
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-10-16 02:02:07 +0000
committerQMK Bot <hello@qmk.fm>2021-10-16 02:02:07 +0000
commita1191495132e924cad12533f11c19ba4b8288b0d (patch)
tree8b7fe8472fbc0d7229883a93ef91b26129ddc60b /keyboards/pluckey
parent36fc46ead7e9c3231b1223eb7945152aab705993 (diff)
parent40badc4413d97226398302fb7a84c83c5c4f03a8 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/pluckey')
-rw-r--r--keyboards/pluckey/config.h90
-rw-r--r--keyboards/pluckey/info.json149
-rw-r--r--keyboards/pluckey/keymaps/default/keymap.c77
-rw-r--r--keyboards/pluckey/keymaps/default/readme.md4
-rw-r--r--keyboards/pluckey/pluckey.c38
-rw-r--r--keyboards/pluckey/pluckey.h46
-rw-r--r--keyboards/pluckey/readme.md19
-rw-r--r--keyboards/pluckey/rules.mk23
8 files changed, 446 insertions, 0 deletions
diff --git a/keyboards/pluckey/config.h b/keyboards/pluckey/config.h
new file mode 100644
index 0000000000..295fe93a85
--- /dev/null
+++ b/keyboards/pluckey/config.h
@@ -0,0 +1,90 @@
+/*
+Copyright 2021 floookay
+
+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 0xF100
+#define PRODUCT_ID 0x91CE
+#define DEVICE_VER 0x0001
+#define MANUFACTURER floookay
+#define PRODUCT pluckey
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 7
+
+/*
+ * 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 { B4, F5, F6, B6, B5 }
+#define MATRIX_COL_PINS { D1, D0, D4, C6, D7, E6, F7 }
+#define UNUSED_PINS { F4, B1 }
+#define DIODE_DIRECTION COL2ROW
+
+/* encoder support */
+#define ENCODERS_PAD_A { B3 }
+#define ENCODERS_PAD_B { B2 }
+#define ENCODER_RESOLUTION 2
+#define ENCODERS_PAD_A_RIGHT { B2 }
+#define ENCODERS_PAD_B_RIGHT { B3 }
+#define ENCODER_RESOLUTION_RIGHT 2
+
+/* communication between sides */
+#define USE_SERIAL
+#define SOFT_SERIAL_PIN D2
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not 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
+
+/*
+ * Feature disable options
+ * These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+//#define BOOTMAGIC_LITE_ROW 0
+//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/pluckey/info.json b/keyboards/pluckey/info.json
new file mode 100644
index 0000000000..0a6bd1832d
--- /dev/null
+++ b/keyboards/pluckey/info.json
@@ -0,0 +1,149 @@
+{
+ "keyboard_name": "pluckey",
+ "url": "https://github.com/floookay/pluckey",
+ "maintainer": "floookay",
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"x":3.5, "y":0},
+ {"x":15, "y":0},
+ {"x":2.5, "y":0.125},
+ {"x":4.5, "y":0.125},
+ {"x":14, "y":0.125},
+ {"x":16, "y":0.125},
+ {"x":5.5, "y":0.25},
+ {"x":6.5, "y":0.25},
+ {"x":12, "y":0.25},
+ {"x":13, "y":0.25},
+ {"x":0, "y":0.625, "w":1.5},
+ {"x":1.5, "y":0.625},
+ {"x":17, "y":0.625},
+ {"x":18, "y":0.625, "w":1.5},
+ {"x":3.5, "y":1.0},
+ {"x":15, "y":1.0},
+ {"x":2.5, "y":1.125},
+ {"x":4.5, "y":1.125},
+ {"x":14, "y":1.125},
+ {"x":16, "y":1.125},
+ {"x":5.5, "y":1.25},
+ {"x":6.5, "y":1.25},
+ {"x":12, "y":1.25},
+ {"x":13, "y":1.25},
+ {"x":0, "y":1.625, "w":1.5},
+ {"x":1.5, "y":1.625},
+ {"x":17, "y":1.625},
+ {"x":18, "y":1.625, "w":1.5},
+ {"x":3.5, "y":2},
+ {"x":15, "y":2},
+ {"x":2.5, "y":2.125},
+ {"x":4.5, "y":2.125},
+ {"x":14, "y":2.125},
+ {"x":16, "y":2.125},
+ {"x":5.5, "y":2.25},
+ {"x":6.5, "y":2.25},
+ {"x":12, "y":2.25},
+ {"x":13, "y":2.25},
+ {"x":0, "y":2.625, "w":1.5},
+ {"x":1.5, "y":2.625},
+ {"x":17, "y":2.625},
+ {"x":18, "y":2.625, "w":1.5},
+ {"x":6.5, "y":3.25},
+ {"x":12, "y":3.25},
+ {"x":3.5, "y":3},
+ {"x":15, "y":3},
+ {"x":2.5, "y":3.125},
+ {"x":4.5, "y":3.125},
+ {"x":14, "y":3.125},
+ {"x":16, "y":3.125},
+ {"x":5.5, "y":3.25},
+ {"x":13, "y":3.25},
+ {"x":0, "y":3.625, "w":1.5},
+ {"x":1.5, "y":3.625},
+ {"x":17, "y":3.625},
+ {"x":18, "y":3.625, "w":1.5},
+ {"x":7.5, "y":3.75},
+ {"x":11, "y":3.75},
+ {"x":3.5, "y":4},
+ {"x":15, "y":4},
+ {"x":2.5, "y":4.125},
+ {"x":4.5, "y":4.125},
+ {"x":14, "y":4.125},
+ {"x":16, "y":4.125},
+ {"x":5.75, "y":4.5, "w":1.5},
+ {"x":12.25, "y":4.5, "w":1.5},
+ {"x":7.25, "y":4.75},
+ {"x":11.25, "y":4.75}
+ ]
+ },
+ "LAYOUT_ergo": {
+ "layout": [
+ {"x":3.5, "y":0},
+ {"x":15, "y":0},
+ {"x":2.5, "y":0.125},
+ {"x":4.5, "y":0.125},
+ {"x":14, "y":0.125},
+ {"x":16, "y":0.125},
+ {"x":5.5, "y":0.25},
+ {"x":6.5, "y":0.25},
+ {"x":12, "y":0.25},
+ {"x":13, "y":0.25},
+ {"x":0, "y":0.625, "w":1.5},
+ {"x":1.5, "y":0.625},
+ {"x":17, "y":0.625},
+ {"x":18, "y":0.625, "w":1.5},
+ {"x":3.5, "y":1.0},
+ {"x":15, "y":1.0},
+ {"x":2.5, "y":1.125},
+ {"x":4.5, "y":1.125},
+ {"x":14, "y":1.125},
+ {"x":16, "y":1.125},
+ {"x":5.5, "y":1.25},
+ {"x":6.5, "y":1.25, "h":1.5},
+ {"x":12, "y":1.25, "h":1.5},
+ {"x":13, "y":1.25},
+ {"x":0, "y":1.625, "w":1.5},
+ {"x":1.5, "y":1.625},
+ {"x":17, "y":1.625},
+ {"x":18, "y":1.625, "w":1.5},
+ {"x":3.5, "y":2},
+ {"x":15, "y":2},
+ {"x":2.5, "y":2.125},
+ {"x":4.5, "y":2.125},
+ {"x":14, "y":2.125},
+ {"x":16, "y":2.125},
+ {"x":5.5, "y":2.25},
+ {"x":13, "y":2.25},
+ {"x":0, "y":2.625, "w":1.5},
+ {"x":1.5, "y":2.625},
+ {"x":17, "y":2.625},
+ {"x":18, "y":2.625, "w":1.5},
+ {"x":6.5, "y":2.75, "h":1.5},
+ {"x":12, "y":2.75, "h":1.5},
+ {"x":3.5, "y":3},
+ {"x":15, "y":3},
+ {"x":2.5, "y":3.125},
+ {"x":4.5, "y":3.125},
+ {"x":14, "y":3.125},
+ {"x":16, "y":3.125},
+ {"x":5.5, "y":3.25},
+ {"x":13, "y":3.25},
+ {"x":0, "y":3.625, "w":1.5},
+ {"x":1.5, "y":3.625},
+ {"x":17, "y":3.625},
+ {"x":18, "y":3.625, "w":1.5},
+ {"x":7.5, "y":3.75},
+ {"x":11, "y":3.75},
+ {"x":3.5, "y":4},
+ {"x":15, "y":4},
+ {"x":2.5, "y":4.125},
+ {"x":4.5, "y":4.125},
+ {"x":14, "y":4.125},
+ {"x":16, "y":4.125},
+ {"x":5.75, "y":4.5, "w":1.5},
+ {"x":12.25, "y":4.5, "w":1.5},
+ {"x":7.25, "y":4.75},
+ {"x":11.25, "y":4.75}
+ ]
+ }
+ }
+}
diff --git a/keyboards/pluckey/keymaps/default/keymap.c b/keyboards/pluckey/keymaps/default/keymap.c
new file mode 100644
index 0000000000..31042fc692
--- /dev/null
+++ b/keyboards/pluckey/keymaps/default/keymap.c
@@ -0,0 +1,77 @@
+/* Copyright 2021 floookay
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _LOWER,
+ _RAISE,
+ _ADJUST
+};
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+ M_ARROW
+};
+
+#define MO_LOW MO(_LOWER)
+#define MO_RAIS MO(_RAISE)
+#define MO_ADJU MO(_ADJUST)
+#define MO_CURR _______
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_MINS, KC_EQL, 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_LBRC, KC_RBRC, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
+ KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_LPRN, KC_RPRN, 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_LCBR, KC_HOME, KC_END, KC_RCBR, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
+ KC_LGUI, KC_LALT, MO_LOW, KC_SPC, KC_BSPC, KC_ENT, KC_SPC, MO_RAIS, KC_RALT, KC_MEH
+ ),
+ [_LOWER] = LAYOUT(
+ _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F11, KC_F12, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_PSCR,
+ _______, _______, _______, _______, KC_PIPE, KC_UNDS, KC_LPRN, KC_RPRN, KC_PLUS, KC_PIPE, _______, _______, _______, _______,
+ _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_LPRN, KC_RPRN, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
+ _______, _______, _______, _______, _______, _______, M_ARROW, KC_PGUP, KC_PGDN, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, MO_CURR, _______, KC_DEL, _______, _______, MO_ADJU, _______, _______
+ ),
+ [_RAISE] = LAYOUT(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PGUP, _______, _______, _______,
+ _______, _______, _______, KC_VOLU, _______, _______, KC_LPRN, KC_RPRN, _______, KC_BTN4, KC_UP, KC_BTN5, _______, _______,
+ _______, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, KC_LPRN, KC_RPRN, KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, KC_END, _______,
+ _______, _______, _______, KC_VOLD, _______, _______, M_ARROW, KC_PGUP, KC_PGDN, _______, _______, _______, KC_PGDN, _______, _______, _______,
+ _______, _______, MO_ADJU, _______, KC_DEL, _______, _______, MO_CURR, _______, _______
+ ),
+ [_ADJUST] = LAYOUT(
+ KC_SLEP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_WH_U, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_WH_L, KC_WH_D, KC_WH_R, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, KC_CLR, _______, _______, _______, _______, _______
+ )
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case M_ARROW:
+ if (record->event.pressed) {
+ SEND_STRING("->");
+ }
+ break;
+ }
+ return true;
+}
diff --git a/keyboards/pluckey/keymaps/default/readme.md b/keyboards/pluckey/keymaps/default/readme.md
new file mode 100644
index 0000000000..d94d03e588
--- /dev/null
+++ b/keyboards/pluckey/keymaps/default/readme.md
@@ -0,0 +1,4 @@
+# Default keymap
+
+![keymap](https://gist.githubusercontent.com/floookay/ea7313862e407c9b5aaea3d6ed3ce233/raw/0a37fe682f76bbaa55cbc56527e4666bedbf5761/layout.png)
+[Keyboard-Layout-Editor](http://www.keyboard-layout-editor.com/#/gists/13c9d00bd0c0c9e3fe3b3d8d98672ef9) [(raw)](https://gist.github.com/floookay/13c9d00bd0c0c9e3fe3b3d8d98672ef9)
diff --git a/keyboards/pluckey/pluckey.c b/keyboards/pluckey/pluckey.c
new file mode 100644
index 0000000000..d9025726fd
--- /dev/null
+++ b/keyboards/pluckey/pluckey.c
@@ -0,0 +1,38 @@
+/* Copyright 2021 floookay
+ *
+ * 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 "pluckey.h"
+
+#ifdef ENCODER_ENABLE
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+ if (!encoder_update_user(index, clockwise)) { return false; }
+ if (index == 0) {
+ if (clockwise) {
+ tap_code_delay(KC_VOLU, 10);
+ } else {
+ tap_code_delay(KC_VOLD, 10);
+ }
+ }
+ else if (index == 1) {
+ if (clockwise) {
+ tap_code(KC_WH_U);
+ } else {
+ tap_code(KC_WH_D);
+ }
+ }
+ return true;
+}
+#endif
diff --git a/keyboards/pluckey/pluckey.h b/keyboards/pluckey/pluckey.h
new file mode 100644
index 0000000000..628a89baa9
--- /dev/null
+++ b/keyboards/pluckey/pluckey.h
@@ -0,0 +1,46 @@
+/* Copyright 2021 floookay
+ *
+ * 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 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( \
+ l00, l01, l02, l03, l04, l05, l06, r00, r01, r02, r03, r04, r05, r06, \
+ l10, l11, l12, l13, l14, l15, l16, r10, r11, r12, r13, r14, r15, r16, \
+ l20, l21, l22, l23, l24, l25, l26, r20, r21, r22, r23, r24, r25, r26, \
+ l30, l31, l32, l33, l34, l35, l36, l41, r45, r30, r31, r32, r33, r34, r35, r36, \
+ l42, l43, l44, l45, l46, r40, r41, r42, r43, r44 \
+){ \
+ { l00, l01, l02, l03, l04, l05, l06 }, \
+ { l10, l11, l12, l13, l14, l15, l16 }, \
+ { l20, l21, l22, l23, l24, l25, l26 }, \
+ { l30, l31, l32, l33, l34, l35, l36 }, \
+ { KC_NO, l41, l42, l43, l44, l45, l46 }, \
+ { r06, r05, r04, r03, r02, r01, r00 }, \
+ { r16, r15, r14, r13, r12, r11, r10 }, \
+ { r26, r25, r24, r23, r22, r21, r20 }, \
+ { r36, r35, r34, r33, r32, r31, r30 }, \
+ { KC_NO, r45, r44, r43, r42, r41, r40 } \
+}
diff --git a/keyboards/pluckey/readme.md b/keyboards/pluckey/readme.md
new file mode 100644
index 0000000000..b0a1af99b8
--- /dev/null
+++ b/keyboards/pluckey/readme.md
@@ -0,0 +1,19 @@
+# Pluckey
+
+![pluckey](https://gist.githubusercontent.com/floookay/ea7313862e407c9b5aaea3d6ed3ce233/raw/1757078b1adf7ac4d51d74f445107bdb46e013a3/sandwich%2520angle.jpg)
+
+The pluckey is an ergodox like split keyboard with moderate columnal stagger and a horizontal space key.
+
+* Keyboard Maintainer: [floookay](https://github.com/floookay)
+* Hardware Supported: pluckey pcbs with pro micro controllers
+* Hardware Availability: [pcb &amp; case files](https://github.com/floookay/pluckey)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make pluckey:default
+
+Flashing example for this keyboard:
+
+ make pluckey: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).
diff --git a/keyboards/pluckey/rules.mk b/keyboards/pluckey/rules.mk
new file mode 100644
index 0000000000..4f4954434b
--- /dev/null
+++ b/keyboards/pluckey/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 = 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
+# 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
+ENCODER_ENABLE = yes
+SPLIT_KEYBOARD = yes