Skip to content

Commit

Permalink
[Keyboard] add Pluckey (qmk#14672)
Browse files Browse the repository at this point in the history 
Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>
  • Loading branch information
@floookay @drashna
@fauxpark @0xcharly
3 people authored and 0xcharly committed Oct 25, 2021
1 parent 0130505 commit dd20a27
Show file tree
Hide file tree
Showing 8 changed files with 446 additions and 0 deletions.
90 changes: 90 additions & 0 deletions keyboards/pluckey/config.h
View file
Original file line number Diff line number Diff line change
@@ -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
149 changes: 149 additions & 0 deletions keyboards/pluckey/info.json
View file
Original file line number Diff line number Diff line change
@@ -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}
]
}
}
}
77 changes: 77 additions & 0 deletions keyboards/pluckey/keymaps/default/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -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;
}
4 changes: 4 additions & 0 deletions keyboards/pluckey/keymaps/default/readme.md
View file
Original file line number Diff line number Diff line change
@@ -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)
38 changes: 38 additions & 0 deletions keyboards/pluckey/pluckey.c
View file
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit dd20a27

Please sign in to comment.