[Keyboard] Add Ky01 (#12844)

Co-authored-by: KnoblesseOblige <knoblesseoblige-github@gla.sr>
master
Maxime Coirault 2021-05-13 20:22:08 +03:00 committed by GitHub
parent 737fe8d763
commit 10a3e3a341
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 785 additions and 0 deletions

View File

@ -0,0 +1,146 @@
/*
Copyright 2020 KnoblesseOblige
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 0x4B4F /* "KO" */
#define PRODUCT_ID 0x4B59 /* "KY" */
#define DEVICE_VER 0x0001
#define MANUFACTURER KnoblesseOblige
#define PRODUCT KY-01
/* key matrix size */
#define MATRIX_ROWS 6
#define MATRIX_COLS 16
/*
* Keyboard Matrix Assignments
*
* Change this to how you wired your keyboard
* 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 { E6, B5, B4, D7, D4, D6 }
#define MATRIX_COL_PINS { B3, B7, D0, D1, D2, D3, D5, F0, F1, F4, F5, F6, F7, C7, C6, B6 }
#define UNUSED_PINS
/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW
/*
* Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
*/
// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
// #define BACKLIGHT_PIN B7
// #define BACKLIGHT_BREATHING
// #define BACKLIGHT_LEVELS 3
// #define RGB_DI_PIN E2
// #ifdef RGB_DI_PIN
// #define RGBLED_NUM 16
// #define RGBLIGHT_HUE_STEP 8
// #define RGBLIGHT_SAT_STEP 8
// #define RGBLIGHT_VAL_STEP 8
// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
// /*== all animations enable ==*/
// #define RGBLIGHT_ANIMATIONS
// /*== or choose animations ==*/
// #define RGBLIGHT_EFFECT_BREATHING
// #define RGBLIGHT_EFFECT_RAINBOW_MOOD
// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
// #define RGBLIGHT_EFFECT_SNAKE
// #define RGBLIGHT_EFFECT_KNIGHT
// #define RGBLIGHT_EFFECT_CHRISTMAS
// #define RGBLIGHT_EFFECT_STATIC_GRADIENT
// #define RGBLIGHT_EFFECT_RGB_TEST
// #define RGBLIGHT_EFFECT_ALTERNATING
// /*== customize breathing effect ==*/
// /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
// #define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
// /*==== use exp() and sin() ====*/
// #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
// #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
// #endif
/* 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
/* 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
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
* This is userful for the Windows task manager shortcut (ctrl+shift+esc).
*/
// #define GRAVE_ESC_CTRL_OVERRIDE
/*
* Force NKRO
*
* Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
* state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
* makefile for this to work.)
*
* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
* until the next keyboard reset.
*
* NKRO may prevent your keystrokes from being detected in the BIOS, but it is
* fully operational during normal computer usage.
*
* For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
* or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
* bootmagic, NKRO mode will always be enabled until it is toggled again during a
* power-up.
*
*/
//#define FORCE_NKRO
/*
* 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

View File

@ -0,0 +1,437 @@
{
"keyboard_name": "ky01",
"url": "https://geekhack.org/index.php?topic=107809.0",
"maintainer": "KnoblesseOblige",
"width": 16.25,
"height": 6.5,
"layouts": {
"LAYOUT": {
"layout": [
{
"label": "Esc",
"x": 0,
"y": 0
},
{
"label": "F1",
"x": 2,
"y": 0
},
{
"label": "F2",
"x": 3,
"y": 0
},
{
"label": "F3",
"x": 4,
"y": 0
},
{
"label": "F4",
"x": 5,
"y": 0
},
{
"label": "F5",
"x": 6.5,
"y": 0
},
{
"label": "F6",
"x": 7.5,
"y": 0
},
{
"label": "F7",
"x": 8.5,
"y": 0
},
{
"label": "F8",
"x": 9.5,
"y": 0
},
{
"label": "F9",
"x": 11,
"y": 0
},
{
"label": "F10",
"x": 12,
"y": 0
},
{
"label": "F11",
"x": 13,
"y": 0
},
{
"label": "F12",
"x": 14,
"y": 0
},
{
"label": "PrtSc",
"x": 15.25,
"y": 0
},
{
"label": "\\u00ac",
"x": 0,
"y": 1.5
},
{
"label": "!",
"x": 1,
"y": 1.5
},
{
"label": "\"",
"x": 2,
"y": 1.5
},
{
"label": "\\u00a3",
"x": 3,
"y": 1.5
},
{
"label": "$",
"x": 4,
"y": 1.5
},
{
"label": "%",
"x": 5,
"y": 1.5
},
{
"label": "^",
"x": 6,
"y": 1.5
},
{
"label": "&",
"x": 7,
"y": 1.5
},
{
"label": "*",
"x": 8,
"y": 1.5
},
{
"label": "(",
"x": 9,
"y": 1.5
},
{
"label": ")",
"x": 10,
"y": 1.5
},
{
"label": "_",
"x": 11,
"y": 1.5
},
{
"label": "+",
"x": 12,
"y": 1.5
},
{
"label": "Backspace",
"x": 13,
"y": 1.5
},
{
"label": "Delete",
"x": 14,
"y": 1.5
},
{
"label": "Insert",
"x": 15.25,
"y": 1.5
},
{
"label": "Tab",
"x": 0,
"y": 2.5,
"w": 1.5
},
{
"label": "Q",
"x": 1.5,
"y": 2.5
},
{
"label": "W",
"x": 2.5,
"y": 2.5
},
{
"label": "E",
"x": 3.5,
"y": 2.5
},
{
"label": "R",
"x": 4.5,
"y": 2.5
},
{
"label": "T",
"x": 5.5,
"y": 2.5
},
{
"label": "Y",
"x": 6.5,
"y": 2.5
},
{
"label": "U",
"x": 7.5,
"y": 2.5
},
{
"label": "I",
"x": 8.5,
"y": 2.5
},
{
"label": "O",
"x": 9.5,
"y": 2.5
},
{
"label": "P",
"x": 10.5,
"y": 2.5
},
{
"label": "{",
"x": 11.5,
"y": 2.5
},
{
"label": "}",
"x": 12.5,
"y": 2.5
},
{
"label": "Enter",
"x": 13.75,
"y": 2.5,
"w": 1.25,
"h": 2
},
{
"label": "Delete",
"x": 15.25,
"y": 2.5
},
{
"label": "Caps Lock",
"x": 0,
"y": 3.5,
"w": 1.75
},
{
"label": "A",
"x": 1.75,
"y": 3.5
},
{
"label": "S",
"x": 2.75,
"y": 3.5
},
{
"label": "D",
"x": 3.75,
"y": 3.5
},
{
"label": "F",
"x": 4.75,
"y": 3.5
},
{
"label": "G",
"x": 5.75,
"y": 3.5
},
{
"label": "H",
"x": 6.75,
"y": 3.5
},
{
"label": "J",
"x": 7.75,
"y": 3.5
},
{
"label": "K",
"x": 8.75,
"y": 3.5
},
{
"label": "L",
"x": 9.75,
"y": 3.5
},
{
"label": ":",
"x": 10.75,
"y": 3.5
},
{
"label": "@",
"x": 11.75,
"y": 3.5
},
{
"label": "~",
"x": 12.75,
"y": 3.5
},
{
"label": "PgDn",
"x": 15.25,
"y": 3.5
},
{
"label": "Shift",
"x": 0,
"y": 4.5,
"w": 1.25
},
{
"label": "|",
"x": 1.25,
"y": 4.5
},
{
"label": "Z",
"x": 2.25,
"y": 4.5
},
{
"label": "X",
"x": 3.25,
"y": 4.5
},
{
"label": "C",
"x": 4.25,
"y": 4.5
},
{
"label": "V",
"x": 5.25,
"y": 4.5
},
{
"label": "B",
"x": 6.25,
"y": 4.5
},
{
"label": "N",
"x": 7.25,
"y": 4.5
},
{
"label": "M",
"x": 8.25,
"y": 4.5
},
{
"label": "<",
"x": 9.25,
"y": 4.5
},
{
"label": ">",
"x": 10.25,
"y": 4.5
},
{
"label": "?",
"x": 11.25,
"y": 4.5
},
{
"label": "Shift",
"x": 12.25,
"y": 4.5,
"w": 1.75
},
{
"label": "\\u2191",
"x": 14.25,
"y": 4.5
},
{
"label": "Ctrl",
"x": 0,
"y": 5.5,
"w": 1.25
},
{
"label": "Win",
"x": 1.25,
"y": 5.5,
"w": 1.25
},
{
"label": "Alt",
"x": 2.5,
"y": 5.5,
"w": 1.25
},
{
"x": 3.75,
"y": 5.5,
"w": 6.25
},
{
"label": "AltGr",
"x": 10,
"y": 5.5
},
{
"label": "Win",
"x": 11,
"y": 5.5
},
{
"label": "Ctrl",
"x": 12,
"y": 5.5
},
{
"label": "\\u2190",
"x": 13.25,
"y": 5.5
},
{
"label": "\\u2193",
"x": 14.25,
"y": 5.5
},
{
"label": "\\u2192",
"x": 15.25,
"y": 5.5
}
]
}
}
}

View File

@ -0,0 +1,41 @@
/* Copyright 2020 KnoblesseOblige
*
* 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 {
QWERTY,
L1
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base */
[QWERTY] = LAYOUT(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, LT(L1, KC_PSCR),
KC_GRAVE, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINUS, KC_EQUAL, KC_BSPC, KC_DELETE, KC_INS,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DELETE,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_NUHS, KC_ENTER, KC_PGDN,
KC_LSFT, KC_NUBS, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPACE, KC_RGUI, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RIGHT
),
[L1] = LAYOUT(
RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
)
};

View File

@ -0,0 +1,60 @@
/* Copyright 2020 KnoblesseOblige
*
* 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 {
QWERTY,
L1,
L2,
L3
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base */
[QWERTY] = LAYOUT(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR,
KC_GRAVE, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINUS, KC_EQUAL, KC_BSPC, KC_DELETE, KC_INS,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DELETE,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_NUHS, KC_ENTER, KC_PGDN,
KC_LSFT, KC_NUBS, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPACE, KC_RGUI, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RIGHT
),
[L1] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[L2] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[L3] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
)
};

View File

@ -0,0 +1,2 @@
VIA_ENABLE = yes
LTO_ENABLE = yes

View File

@ -0,0 +1,17 @@
/* Copyright 2020 KnoblesseOblige
*
* 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 "ky01.h"

View File

@ -0,0 +1,38 @@
/* Copyright 2020 KnoblesseOblige
*
* 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"
#define XXX KC_NO
#define LAYOUT( \
k00, k02, k03, k04, k05, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, k0f, \
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, k1e, k1f, \
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2f, \
k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3f, \
k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4a, k4b, k4c, k4d, \
k50, k51, k52, k56, k59, k5a, k5b, k5c, k5d, k5e \
) \
{ \
{ k00, XXX, k02, k03, k04, k05, XXX, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, k0f }, \
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, k1e, k1f }, \
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, XXX, k2f }, \
{ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, XXX, k3f }, \
{ k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4a, k4b, k4c, k4d, XXX, XXX }, \
{ k50, k51, k52, XXX, XXX, XXX, k56, XXX, XXX, k59, k5a, k5b, k5c, k5d, k5e, XXX } \
}

View File

@ -0,0 +1,22 @@
# ky01
![ky01](https://i.imgur.com/Un24BUs.png)
A 75% Top-Mount Keyboard By KCK.
* Keyboard Maintainer: [KnoblesseOblige](https://github.com/KnoblesseOblige)
* Hardware Supported: KY01
* Hardware Availability: limited [Group Buy](https://geekhack.org/index.php?topic=107809.0) finished
Make example for this keyboard (after setting up your build environment):
make ky01: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).
# How to enter bootloader
* hold left shift + right shift + B
* OR hold escape + F13 (top right most key)
* OR short the reset pins on the pcb, then plug the usb
* OR (if you already flashed via) hold escape and then plug the usb

View File

@ -0,0 +1,22 @@
# MCU name
MCU = atmega32u4
# Bootloader selection
BOOTLOADER = atmel-dfu
# Build Options
# change yes to no to disable
#
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = yes # Console for debug
COMMAND_ENABLE = yes # 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