feat: add modified contra keyboard with planck layout

This commit is contained in:
Fey Naomi Schrewe 2024-06-01 11:34:13 +02:00
parent 2fd5631776
commit e7102c4936
8 changed files with 466 additions and 0 deletions

20
keyboards/honey/config.h Normal file
View File

@ -0,0 +1,20 @@
// Copyright 2024 Fey Naomi Schrewe (@feylinara)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
/*
* 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

137
keyboards/honey/info.json Normal file
View File

@ -0,0 +1,137 @@
{
"manufacturer": "Fey Industries",
"keyboard_name": "honey",
"maintainer": "feylinara",
"bootloader": "rp2040",
"diode_direction": "COL2ROW",
"features": {
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": true,
"nkro": true
},
"matrix_pins": {
"cols": ["GP29", "GP28", "GP9", "GP8", "GP7", "GP6", "GP5", "GP4", "GP3", "GP2", "GP1", "GP0"],
"rows": ["GP27", "GP20", "GP23", "GP21"]
},
"processor": "RP2040",
"url": "",
"usb": {
"device_version": "1.0.0",
"pid": "0x0000",
"vid": "0xFEED"
},
"layouts": {
"LAYOUT_ortho_4x12": {
"layout": [
{"label": "Tab", "matrix": [0, 0], "x": 0, "y": 0},
{"label": "Q", "matrix": [0, 1], "x": 1, "y": 0},
{"label": "W", "matrix": [0, 2], "x": 2, "y": 0},
{"label": "E", "matrix": [0, 3], "x": 3, "y": 0},
{"label": "R", "matrix": [0, 4], "x": 4, "y": 0},
{"label": "T", "matrix": [0, 5], "x": 5, "y": 0},
{"label": "Y", "matrix": [0, 6], "x": 6, "y": 0},
{"label": "U", "matrix": [0, 7], "x": 7, "y": 0},
{"label": "I", "matrix": [0, 8], "x": 8, "y": 0},
{"label": "O", "matrix": [0, 9], "x": 9, "y": 0},
{"label": "P", "matrix": [0, 10], "x": 10, "y": 0},
{"label": "BackSpace", "matrix": [0, 11], "x": 11, "y": 0},
{"label": "Esc", "matrix": [1, 0], "x": 0, "y": 1},
{"label": "A", "matrix": [1, 1], "x": 1, "y": 1},
{"label": "S", "matrix": [1, 2], "x": 2, "y": 1},
{"label": "D", "matrix": [1, 3], "x": 3, "y": 1},
{"label": "F", "matrix": [1, 4], "x": 4, "y": 1},
{"label": "G", "matrix": [1, 5], "x": 5, "y": 1},
{"label": "H", "matrix": [1, 6], "x": 6, "y": 1},
{"label": "J", "matrix": [1, 7], "x": 7, "y": 1},
{"label": "K", "matrix": [1, 8], "x": 8, "y": 1},
{"label": "L", "matrix": [1, 9], "x": 9, "y": 1},
{"label": ";", "matrix": [1, 10], "x": 10, "y": 1},
{"label": "'", "matrix": [1, 11], "x": 11, "y": 1},
{"label": "Shift", "matrix": [2, 0], "x": 0, "y": 2},
{"label": "Z", "matrix": [2, 1], "x": 1, "y": 2},
{"label": "X", "matrix": [2, 2], "x": 2, "y": 2},
{"label": "C", "matrix": [2, 3], "x": 3, "y": 2},
{"label": "V", "matrix": [2, 4], "x": 4, "y": 2},
{"label": "B", "matrix": [2, 5], "x": 5, "y": 2},
{"label": "N", "matrix": [2, 6], "x": 6, "y": 2},
{"label": "M", "matrix": [2, 7], "x": 7, "y": 2},
{"label": ",", "matrix": [2, 8], "x": 8, "y": 2},
{"label": ".", "matrix": [2, 9], "x": 9, "y": 2},
{"label": "/", "matrix": [2, 10], "x": 10, "y": 2},
{"label": "Return", "matrix": [2, 11], "x": 11, "y": 2},
{"matrix": [3, 0], "x": 0, "y": 3},
{"label": "Ctrl", "matrix": [3, 1], "x": 1, "y": 3},
{"label": "Alt", "matrix": [3, 2], "x": 2, "y": 3},
{"label": "Super", "matrix": [3, 3], "x": 3, "y": 3},
{"label": "⇓", "matrix": [3, 4], "x": 4, "y": 3},
{"matrix": [3, 5], "x": 5, "y": 3},
{"matrix": [3, 6], "x": 6, "y": 3},
{"label": "⇑", "matrix": [3, 7], "x": 7, "y": 3},
{"label": "←", "matrix": [3, 8], "x": 8, "y": 3},
{"label": "↓", "matrix": [3, 9], "x": 9, "y": 3},
{"label": "↑", "matrix": [3, 10], "x": 10, "y": 3},
{"label": "→", "matrix": [3, 11], "x": 11, "y": 3}
]
},
"LAYOUT_planck_mit": {
"layout": [
{"label": "Tab", "matrix": [0, 0], "x": 0, "y": 0},
{"label": "Q", "matrix": [0, 1], "x": 1, "y": 0},
{"label": "W", "matrix": [0, 2], "x": 2, "y": 0},
{"label": "E", "matrix": [0, 3], "x": 3, "y": 0},
{"label": "R", "matrix": [0, 4], "x": 4, "y": 0},
{"label": "T", "matrix": [0, 5], "x": 5, "y": 0},
{"label": "Y", "matrix": [0, 6], "x": 6, "y": 0},
{"label": "U", "matrix": [0, 7], "x": 7, "y": 0},
{"label": "I", "matrix": [0, 8], "x": 8, "y": 0},
{"label": "O", "matrix": [0, 9], "x": 9, "y": 0},
{"label": "P", "matrix": [0, 10], "x": 10, "y": 0},
{"label": "BackSpace", "matrix": [0, 11], "x": 11, "y": 0},
{"label": "Esc", "matrix": [1, 0], "x": 0, "y": 1},
{"label": "A", "matrix": [1, 1], "x": 1, "y": 1},
{"label": "S", "matrix": [1, 2], "x": 2, "y": 1},
{"label": "D", "matrix": [1, 3], "x": 3, "y": 1},
{"label": "F", "matrix": [1, 4], "x": 4, "y": 1},
{"label": "G", "matrix": [1, 5], "x": 5, "y": 1},
{"label": "H", "matrix": [1, 6], "x": 6, "y": 1},
{"label": "J", "matrix": [1, 7], "x": 7, "y": 1},
{"label": "K", "matrix": [1, 8], "x": 8, "y": 1},
{"label": "L", "matrix": [1, 9], "x": 9, "y": 1},
{"label": ";", "matrix": [1, 10], "x": 10, "y": 1},
{"label": "'", "matrix": [1, 11], "x": 11, "y": 1},
{"label": "Shift", "matrix": [2, 0], "x": 0, "y": 2},
{"label": "Z", "matrix": [2, 1], "x": 1, "y": 2},
{"label": "X", "matrix": [2, 2], "x": 2, "y": 2},
{"label": "C", "matrix": [2, 3], "x": 3, "y": 2},
{"label": "V", "matrix": [2, 4], "x": 4, "y": 2},
{"label": "B", "matrix": [2, 5], "x": 5, "y": 2},
{"label": "N", "matrix": [2, 6], "x": 6, "y": 2},
{"label": "M", "matrix": [2, 7], "x": 7, "y": 2},
{"label": ",", "matrix": [2, 8], "x": 8, "y": 2},
{"label": ".", "matrix": [2, 9], "x": 9, "y": 2},
{"label": "/", "matrix": [2, 10], "x": 10, "y": 2},
{"label": "Return", "matrix": [2, 11], "x": 11, "y": 2},
{"matrix": [3, 0], "x": 0, "y": 3},
{"label": "Ctrl", "matrix": [3, 1], "x": 1, "y": 3},
{"label": "Alt", "matrix": [3, 2], "x": 2, "y": 3},
{"label": "Super", "matrix": [3, 3], "x": 3, "y": 3},
{"label": "⇓", "matrix": [3, 4], "x": 4, "y": 3},
{"matrix": [3, 5], "x": 5, "y": 3},
{"label": "⇑", "matrix": [3, 7], "x": 7, "y": 3},
{"label": "←", "matrix": [3, 8], "x": 8, "y": 3},
{"label": "↓", "matrix": [3, 9], "x": 9, "y": 3},
{"label": "↑", "matrix": [3, 10], "x": 10, "y": 3},
{"label": "→", "matrix": [3, 11], "x": 11, "y": 3}
]
}
}
}

View File

@ -0,0 +1,24 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
*
* A B C D E F G H I J K L
*
* A B C D E F G H I J K L
*
* A B C D E F G H I J K L
*
* A B C D E F G H I J K L
*
*/
[0] = LAYOUT_ortho_4x12(
KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G, KC_H, KC_I, KC_J, KC_K, KC_L,
KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G, KC_H, KC_I, KC_J, KC_K, KC_L,
KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G, KC_H, KC_I, KC_J, KC_K, KC_L,
KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G, KC_H, KC_I, KC_J, KC_K, KC_L
)
};

View File

@ -0,0 +1,38 @@
// Copyright QMK Community
// SPDX-License-Identifier: GPL-2.0+
#pragma once
#ifdef AUDIO_ENABLE
#define STARTUP_SONG SONG(PLANCK_SOUND)
// #define STARTUP_SONG SONG(NO_SOUND)
#define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
SONG(COLEMAK_SOUND), \
SONG(DVORAK_SOUND) \
}
#endif
#define MUSIC_MASK (keycode != KC_NO)
/*
* MIDI options
*/
/* enable basic MIDI features:
- MIDI notes can be sent when in Music mode is on
*/
#define MIDI_BASIC
/* enable advanced MIDI features:
- MIDI notes can be added to the keymap
- Octave shift and transpose
- Virtual sustain, portamento, and modulation wheel
- etc.
*/
//#define MIDI_ADVANCED
/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
//#define MIDI_TONE_KEYCODE_OCTAVES 2

View File

@ -0,0 +1,217 @@
/* Copyright 2015-2017 Jack Humbert
*
* 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 planck_layers {
_QWERTY,
_LOWER,
_RAISE,
_PLOVER,
_NUMPAD,
_ADJUST
};
enum planck_keycodes {
PLOVER = SAFE_RANGE,
NUMPAD,
LOWER,
RAISE,
BACKLIT,
EXT_NMP,
EXT_PLV
};
enum td_actions {
TD_RAISE,
TD_LOWER,
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Qwerty
* ,-----------------------------------------------------------------------------------.
* | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Esc | A | S | D | F | G | H | J | K | L | ; | " |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
* `-----------------------------------------------------------------------------------'
*/
[_QWERTY] = LAYOUT_planck_mit(
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_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, RAISE, KC_RALT, _______, _______, PLOVER
),
/* Lower
* ,-----------------------------------------------------------------------------------.
* | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | Next | Vol- | Vol+ | Play |
* `-----------------------------------------------------------------------------------'
*/
[_LOWER] = LAYOUT_planck_mit(
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______,
_______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
),
/* Raise
* ,-----------------------------------------------------------------------------------.
* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | Next | Vol- | Vol+ | Play |
* `-----------------------------------------------------------------------------------'
*/
[_RAISE] = LAYOUT_planck_mit(
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
_______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
),
/* Plover layer (http://opensteno.org)
* ,-----------------------------------------------------------------------------------.
* | # | # | # | # | # | # | # | # | # | # | # | # |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | S | T | P | H | * | * | F | P | L | T | D |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | | S | K | W | R | * | * | R | B | G | S | Z |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Exit | | | A | O | | E | U | | | |
* `-----------------------------------------------------------------------------------'
*/
[_PLOVER] = LAYOUT_planck_mit(
KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
),
/* Adjust (Lower + Raise)
* ,-----------------------------------------------------------------------------------.
* | | Reset| | | | | | | | | | Del |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_ADJUST] = LAYOUT_planck_mit(
_______, QK_BOOT, DB_TOGG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
_______, _______, MU_NEXT, AU_ON, AU_OFF, AG_NORM, AG_SWAP, _______, _______, _______, PLOVER, _______,
_______, AU_PREV, AU_NEXT, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
)
};
tap_dance_action_t tap_dance_actions[] = {
};
#ifdef AUDIO_ENABLE
float plover_song[][2] = SONG(PLOVER_SOUND);
float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
#endif
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case LOWER:
if (record->event.pressed) {
layer_on(_LOWER);
update_tri_layer(_LOWER, _RAISE, _ADJUST);
} else {
layer_off(_LOWER);
update_tri_layer(_LOWER, _RAISE, _ADJUST);
}
return false;
break;
case RAISE:
if (record->event.pressed) {
layer_on(_RAISE);
update_tri_layer(_LOWER, _RAISE, _ADJUST);
} else {
layer_off(_RAISE);
update_tri_layer(_LOWER, _RAISE, _ADJUST);
}
return false;
break;
case BACKLIT:
if (record->event.pressed) {
register_code(KC_RSFT);
#ifdef BACKLIGHT_ENABLE
backlight_step();
#endif
} else {
unregister_code(KC_RSFT);
}
return false;
break;
case PLOVER:
if (record->event.pressed) {
#ifdef AUDIO_ENABLE
stop_all_notes();
PLAY_SONG(plover_song);
#endif
layer_off(_RAISE);
layer_off(_LOWER);
layer_off(_ADJUST);
layer_on(_PLOVER);
if (!eeconfig_is_enabled()) {
eeconfig_init();
}
keymap_config.raw = eeconfig_read_keymap();
keymap_config.nkro = 1;
eeconfig_update_keymap(keymap_config.raw);
}
return false;
break;
case EXT_PLV:
if (record->event.pressed) {
#ifdef AUDIO_ENABLE
PLAY_SONG(plover_gb_song);
#endif
layer_off(_PLOVER);
}
return false;
break;
}
return true;
}
void keyboard_post_init_user(void) {
gpio_set_pin_output(GP17);
gpio_write_pin_high(GP17);
}

View File

@ -0,0 +1,2 @@
# The Default Contra Layout

27
keyboards/honey/readme.md Normal file
View File

@ -0,0 +1,27 @@
# honey
![honey](imgur.com image replace me!)
*A short description of the keyboard/project*
* Keyboard Maintainer: [Fey Naomi Schrewe](https://github.com/feylinara)
* Hardware Supported: *The PCBs, controllers supported*
* Hardware Availability: *Links to where you can find this hardware*
Make example for this keyboard (after setting up your build environment):
make honey:default
Flashing example for this keyboard:
make honey: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).
## Bootloader
Enter the bootloader in 3 ways:
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

1
keyboards/honey/rules.mk Normal file
View File

@ -0,0 +1 @@
TAP_DANCE_ENABLE = yes