Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add keaboard keyboard #19816

Merged
merged 31 commits into from
Feb 14, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
a210a6d
Core config done
keawade Sep 8, 2020
ab91e06
Update image
keawade Sep 8, 2020
5485ff0
Mapping finally working
keawade Sep 9, 2020
3f00384
Implement layers
keawade Sep 9, 2020
5e9d1fd
Improve formatting
keawade Sep 9, 2020
d72f000
Add keawade layout
keawade Sep 9, 2020
bfa460b
Update info.json labels
keawade Sep 9, 2020
2e860c4
Add license headers, update keymap
keawade Sep 9, 2020
cfc45cb
Merge branch 'qmk:master' into keaboard
keawade Feb 11, 2023
9c9ec67
Update keaboard config
keawade Feb 11, 2023
f50d9f1
Update keaboard documentation
keawade Feb 11, 2023
23b1fb2
Update keaboard documentation
keawade Feb 12, 2023
86460d9
Clarify bootloader instructions
keawade Feb 12, 2023
ba65892
Move more config options to info.json
keawade Feb 12, 2023
1261bed
Remove schema ref
keawade Feb 12, 2023
3a74573
Apply requested changes
keawade Feb 12, 2023
21354e6
Merge branch 'qmk:master' into keaboard
keawade Feb 12, 2023
a961053
Move more config options to info.json features
keawade Feb 12, 2023
d927165
Drop unneeded build options.
keawade Feb 12, 2023
2256563
Remove base rule.mk with default folder and instead require direct ta…
keawade Feb 12, 2023
7cbad03
Convert to info.json layout matrix definition
keawade Feb 13, 2023
f90fa61
Work in progress
keawade Feb 13, 2023
161ab0c
Working data-driven matrix :crossed_fingers:
keawade Feb 13, 2023
33465f9
Remove config.h
keawade Feb 13, 2023
7270ddc
Fix layout key order for configurator
keawade Feb 13, 2023
0f3690f
Apply suggestions from code review
keawade Feb 14, 2023
18b7960
Align keymap L39
keawade Feb 14, 2023
47dc15f
Update keyboards/keaboard/info.json
keawade Feb 14, 2023
91d86f6
Add rev1/config.h
keawade Feb 14, 2023
859ecf2
Update keyboards/keaboard/readme.md
waffle87 Feb 14, 2023
154bb09
Update keyboards/keaboard/readme.md
waffle87 Feb 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions keyboards/keaboard/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"keyboard_name": "keaboard",
"manufacturer": "You",
keawade marked this conversation as resolved.
Show resolved Hide resolved
"url": "https://github.com/keawade/keaboard",
"maintainer": "keawade",

"usb": {
"vid": "0xFEED",
"pid": "0x9090",
"device_version": "1.0.0"
},

"diode_direction": "COL2ROW",
"matrix_pins": {
"rows": ["D7", "E6", "B4", "B5"],
"cols": ["F5", "F6", "F7", "B1", "B3", "B2", "B6"]
},
"bootloader": "caterina",
"processor": "atmega32u4",

"split": {
"enabled": true,
"soft_serial_pin": "D0"
},
"features": {
"mousekey": true
keawade marked this conversation as resolved.
Show resolved Hide resolved
},

"layouts": {
"LAYOUT": {
"layout": [
{ "label": "L01", "x": 0, "y": 0.375 },
{ "label": "L05", "x": 1, "y": 0.25 },
{ "label": "L09", "x": 2, "y": 0.125 },
{ "label": "L13", "x": 3, "y": 0 },
{ "label": "L17", "x": 4, "y": 0.125 },
{ "label": "L21", "x": 5, "y": 0.25 },
{ "label": "R21", "x": 10, "y": 0.25 },
{ "label": "R17", "x": 11, "y": 0.125 },
{ "label": "R13", "x": 12, "y": 0 },
{ "label": "R09", "x": 13, "y": 0.125 },
{ "label": "R05", "x": 14, "y": 0.25 },
{ "label": "R01", "x": 15, "y": 0.375 },
{ "label": "L02", "x": 0, "y": 1.375 },
{ "label": "L06", "x": 1, "y": 1.25 },
{ "label": "L10", "x": 2, "y": 1.125 },
{ "label": "L14", "x": 3, "y": 1 },
{ "label": "L18", "x": 4, "y": 1.125 },
{ "label": "L22", "x": 5, "y": 1.25 },
{ "label": "R22", "x": 10, "y": 1.25 },
{ "label": "R18", "x": 11, "y": 1.125 },
{ "label": "R14", "x": 12, "y": 1 },
{ "label": "R10", "x": 13, "y": 1.125 },
{ "label": "R06", "x": 14, "y": 1.25 },
{ "label": "R02", "x": 15, "y": 1.375 },
{ "label": "L03", "x": 0, "y": 2.375 },
{ "label": "L07", "x": 1, "y": 2.25 },
{ "label": "L11", "x": 2, "y": 2.125 },
{ "label": "L15", "x": 3, "y": 2 },
{ "label": "L19", "x": 4, "y": 2.125 },
{ "label": "L23", "x": 5, "y": 2.25 },
{ "label": "L24", "x": 6.5, "y": 3 },
{ "label": "R24", "x": 8.5, "y": 3 },
{ "label": "R23", "x": 10, "y": 2.25 },
{ "label": "R19", "x": 11, "y": 2.125 },
{ "label": "R15", "x": 12, "y": 2 },
{ "label": "R11", "x": 13, "y": 2.125 },
{ "label": "R07", "x": 14, "y": 2.25 },
{ "label": "R03", "x": 15, "y": 2.375 },
{ "label": "L04", "x": 0, "y": 3.375 },
{ "label": "L08", "x": 1, "y": 3.25 },
{ "label": "L12", "x": 2, "y": 3.125 },
{ "label": "L16", "x": 3, "y": 3 },
{ "label": "L20", "x": 5.5, "y": 4 },
{ "label": "L25", "x": 6.5, "y": 4 },
{ "label": "R25", "x": 8.5, "y": 4 },
{ "label": "R20", "x": 9.5, "y": 4 },
{ "label": "R16", "x": 12, "y": 3 },
{ "label": "R12", "x": 13, "y": 3.125 },
{ "label": "R08", "x": 14, "y": 3.25 },
{ "label": "R04", "x": 15, "y": 3.375 }
]
}
}
}
18 changes: 18 additions & 0 deletions keyboards/keaboard/keaboard.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
Copyright 2023 Keith Wade <https://github.com/keawade>

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 "keaboard.h"
22 changes: 22 additions & 0 deletions keyboards/keaboard/keaboard.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
Copyright 2023 Keith Wade <https://github.com/keawade>

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

#ifdef KEYBOARD_keaboard_rev1
#include "rev1.h"
#endif
67 changes: 67 additions & 0 deletions keyboards/keaboard/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
Copyright 2023 Keith Wade <https://github.com/keawade>

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 layers {
_QWERTY,
_LOWER,
_RAISE
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_QWERTY] = LAYOUT(
//,--------+--------+--------+--------+--------+--------+--------. ,--------+--------+--------+--------+--------+--------+--------.
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_ESC, 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_F2, KC_F12, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_BSLS,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_DEL, KC_LALT, KC_LCTL, KC_LGUI, LOWER, KC_ENT, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
keawade marked this conversation as resolved.
Show resolved Hide resolved
//`--------+--------+--------+--------+--------+--------+--------/ \--------+--------+--------+--------+--------+--------+--------'
),

[_RAISE] = LAYOUT(
//,--------+--------+--------+--------+--------+--------+--------. ,--------+--------+--------+--------+--------+--------+--------.
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_TRNS,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_TRNS,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
keawade marked this conversation as resolved.
Show resolved Hide resolved
//`--------+--------+--------+--------+--------+--------+--------/ \--------+--------+--------+--------+--------+--------+--------'
),

[_LOWER] = LAYOUT(
//,--------+--------+--------+--------+--------+--------+--------. ,--------+--------+--------+--------+--------+--------+--------.
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_TRNS,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_DQUO,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_TRNS, KC_TRNS, KC_F12, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PIPE,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_HOME, KC_PGDN, KC_PGUP, KC_END
keawade marked this conversation as resolved.
Show resolved Hide resolved
//`--------+--------+--------+--------+--------+--------+--------/ \--------+--------+--------+--------+--------+--------+--------'
)

};
21 changes: 21 additions & 0 deletions keyboards/keaboard/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# keaboard

A split columnular stagger 4x6 keyboard with 3 thumb keys designed by [Keith Wade](https://github.com/keawade). [More info on the GitHub Repo](https://github.com/keawade/keaboard).

* Keyboard Maintainer: [Keith Wade](https://github.com/keawade)
* Hardware Supported: Pro Micro and clones
* Hardware Availability: Open source. You can order your own from a PCB manufacturer.

Make example for this keyboard (after setting up your build environment):

make keaboard/rev1:default

Flashing example for this keyboard:

make keaboard/rev1:default:flash
waffle87 marked this conversation as resolved.
Show resolved Hide resolved

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).

## Bootloader

Enter the bootloader by holding tapping reset button on the top edge of the board.
18 changes: 18 additions & 0 deletions keyboards/keaboard/rev1/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
fauxpark marked this conversation as resolved.
Show resolved Hide resolved
Copyright 2023 Keith Wade <https://github.com/keawade>

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
18 changes: 18 additions & 0 deletions keyboards/keaboard/rev1/rev1.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
Copyright 2023 Keith Wade <https://github.com/keawade>

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 "rev1.h"
35 changes: 35 additions & 0 deletions keyboards/keaboard/rev1/rev1.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
fauxpark marked this conversation as resolved.
Show resolved Hide resolved
Copyright 2023 Keith Wade <https://github.com/keawade>

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 "quantum.h"

#define LAYOUT( \
L01, L05, L09, L13, L17, L21, R21, R17, R13, R09, R05, R01, \
L02, L06, L10, L14, L18, L22, R22, R18, R14, R10, R06, R02, \
L03, L07, L11, L15, L19, L23, L24, R24, R23, R19, R15, R11, R07, R03, \
L04, L08, L12, L16, L20, L25, R25, R20, R16, R12, R08, R04 \
) \
{ \
{ L01, L05, L09, L13, L17, L21, KC_NO }, \
{ L02, L06, L10, L14, L18, L22, KC_NO }, \
{ L03, L07, L11, L15, L19, L23, L24 }, \
{ L04, L08, L12, L16, L20, KC_NO, L25 }, \
{ R01, R05, R09, R13, R17, R21, KC_NO }, \
{ R02, R06, R10, R14, R18, R22, KC_NO }, \
{ R03, R07, R11, R15, R19, R23, R24 }, \
{ R04, R08, R12, R16, R20, KC_NO, R25 } \
}
1 change: 1 addition & 0 deletions keyboards/keaboard/rev1/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This file intentionally left blank
19 changes: 19 additions & 0 deletions keyboards/keaboard/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Build Options
# change to "no" to disable the options, or define them in the Makefile in
# the appropriate keymap folder that will get included automatically
#
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = yes # Commands for debug and configuration
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
MIDI_ENABLE = no # MIDI controls
AUDIO_ENABLE = no # Audio output on port C6
UNICODE_ENABLE = yes # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend

keawade marked this conversation as resolved.
Show resolved Hide resolved
DEFAULT_FOLDER = keaboard/rev1
keawade marked this conversation as resolved.
Show resolved Hide resolved