sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bastardkb/charybdis: add support for Charybdis (4x6 and 3x5) (#15333)

Browse Source
This commit is contained in:
Charly Delay
2022-01-22 14:55:04 +09:00
committed by GitHub
parent 814821727e
commit ef091d39d2
31 changed files with 2505 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
keyboards/bastardkb/charybdis/4x6/4x6.c Normal file
View File

@@ -0,0 +1,94 @@
/*
* Copyright 2020 Christopher Courtney <drashna@live.com> (@drashna)
* Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Publicw 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 "4x6.h"
// clang-format off
#ifdef RGB_MATRIX_ENABLE
/**
* \brief LEDs index.
*
* ╭────────────────────────╮ ╭────────────────────────╮
* 0 7 8 15 16 20 49 45 44 37 36 29
* ├────────────────────────┤ ├────────────────────────┤
* 1 6 9 14 17 21 50 46 43 38 35 30
* ├────────────────────────┤ ├────────────────────────┤
* 2 5 10 13 18 22 51 47 42 39 34 31
* ├────────────────────────┤ ├────────────────────────┤
* 3 4 11 12 19 23 52 48 41 40 33 32
* ╰────────────────────────╯ ╰────────────────────────╯
* 26 27 28 53 54 XX
* 25 24 55 XX
* ╰────────────╯ ╰────────────╯
*/
led_config_t g_led_config = { {
/* Key Matrix to LED index. */
// Left split.
{ 0, 7, 8, 15, 16, 20 }, // Num row
{ 1, 6, 9, 14, 17, 21 }, // Top row
{ 2, 5, 10, 13, 18, 22 }, // Middle row
{ 3, 4, 11, 12, 19, 23 }, // Bottom row
{ NO_LED, 28, 24, 26, 27, 25 }, // Thumb cluster
// Right split.
{ 29, 36, 37, 44, 45, 49 }, // Num row
{ 30, 35, 38, 43, 46, 50 }, // Top row
{ 31, 34, 39, 42, 47, 51 }, // Middle row
{ 32, 33, 40, 41, 48, 52 }, // Bottom row
{ NO_LED, 53, 55, 54, NO_LED, NO_LED }, // Thumb cluster
}, {
/* LED index to physical position. */
// Left split.
/* index=0 */ { 0, 0 }, { 0, 12 }, { 0, 24 }, { 0, 36 }, // col 1 (left most)
/* index=4 */ { 16, 36 }, { 16, 24 }, { 16, 12 }, { 16, 0 }, // col 2
/* index=8 */ { 32, 0 }, { 32, 12 }, { 32, 24 }, { 32, 36 },
/* index=12 */ { 48, 36 }, { 48, 24 }, { 48, 12 }, { 48, 0 },
/* index=16 */ { 64, 0 }, { 64, 12 }, { 64, 24 }, { 64, 36 },
/* index=20 */ { 80, 0 }, { 80, 12 }, { 80, 24 }, { 80, 36 },
/* index=24 */ { 112, 64 }, { 96, 64 }, { 80, 52 },
/* index=27 */ { 96, 52 }, { 112, 52 },
// Right split.
/* index=29 */ { 224, 0 }, { 224, 12 }, { 224, 24 }, { 224, 36 }, // col 12 (right most)
/* index=33 */ { 208, 36 }, { 208, 24 }, { 208, 12 }, { 208, 0 }, // col 11
/* index=37 */ { 192, 0 }, { 192, 12 }, { 192, 24 }, { 192, 36 },
/* index=41 */ { 176, 36 }, { 176, 24 }, { 176, 12 }, { 176, 0 },
/* index=45 */ { 160, 0 }, { 160, 12 }, { 160, 24 }, { 160, 36 },
/* index=49 */ { 144, 0 }, { 144, 12 }, { 144, 24 }, { 144, 36 },
/* index=53 */ { 112, 52 }, { 128, 64 }, { 112, 64 },
}, {
/* LED index to flag. */
// Left split.
/* index=0 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 1
/* index=4 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 2
/* index=8 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=12 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=16 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=20 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=24 */ LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, // Thumb cluster top
/* index=27 */ LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, // Thumb cluster bottom
// Right split.
/* index=29 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 12
/* index=33 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 11
/* index=37 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=41 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=45 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=49 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
/* index=53 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // Thumb cluster
} };
#endif
// clang-format on

44
keyboards/bastardkb/charybdis/4x6/4x6.h Normal file
View File

@@ -0,0 +1,44 @@
/*
* Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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 "charybdis.h"
// clang-format off
#define LAYOUT_charybdis_4x6( \
k00, k01, k02, k03, k04, k05, k55, k54, k53, k52, k51, k50, \
k10, k11, k12, k13, k14, k15, k65, k64, k63, k62, k61, k60, \
k20, k21, k22, k23, k24, k25, k75, k74, k73, k72, k71, k70, \
k30, k31, k32, k33, k34, k35, k85, k84, k83, k82, k81, k80, \
k43, k44, k41, k91, k93, \
k45, k42, k95 \
) \
{ \
{ k00, k01, k02, k03, k04, k05 }, \
{ k10, k11, k12, k13, k14, k15 }, \
{ k20, k21, k22, k23, k24, k25 }, \
{ k30, k31, k32, k33, k34, k35 }, \
{ KC_NO, k41, k42, k43, k44, k45 }, \
{ k50, k51, k52, k53, k54, k55 }, \
{ k60, k61, k62, k63, k64, k65 }, \
{ k70, k71, k72, k73, k74, k75 }, \
{ k80, k81, k82, k83, k84, k85 }, \
{ KC_NO, k91, KC_NO, k93, KC_NO, k95 }, \
}
// clang-format on

84
keyboards/bastardkb/charybdis/4x6/config.h Normal file
View File

@@ -0,0 +1,84 @@
/*
* Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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
#define VENDOR_ID 0xA8F8
#define PRODUCT_ID 0x1833
#define DEVICE_VER 0x0001
#define MANUFACTURER Bastard Keyboards
#define PRODUCT Charybdis
/* Key matrix configuration. */
// Rows are doubled-up.
#define MATRIX_ROWS 10
#define MATRIX_COLS 6
// Wiring configuration for each half.
#define MATRIX_ROW_PINS \
{ F1, B7, C6, D4, B5 }
#define MATRIX_COL_PINS \
{ D5, C7, F0, D7, E6, B4 }
#define MATRIX_ROW_PINS_RIGHT \
{ D5, F0, C6, D4, B5 }
#define MATRIX_COL_PINS_RIGHT \
{ F1, C7, B7, D7, E6, B4 }
#define DIODE_DIRECTION ROW2COL
#define ROTATIONAL_TRANSFORM_ANGLE -25
/* Handedness. */
#define MASTER_RIGHT
/* Bootmagic Lite configuration. */
#define BOOTMAGIC_LITE_ROW 0
#define BOOTMAGIC_LITE_COLUMN 0
#define BOOTMAGIC_LITE_ROW_RIGHT 5
#define BOOTMAGIC_LITE_COLUMN_RIGHT 0
/* serial.c configuration (for split keyboard) */
#define SOFT_SERIAL_PIN D2
/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5
/* Disable action features. */
#define NO_ACTION_MACRO // Disable old-style macro handling.
#define NO_ACTION_FUNCTION // Disable old-style function handling.
/* PMW3360 settings. */
#define PMW3360_CS_PIN B0
#define RGB_DI_PIN D3
#define RGBLED_NUM 56
#define RGBLED_SPLIT \
{ 29, 27 }
/* RGB matrix support. */
#ifdef RGB_MATRIX_ENABLE
# define SPLIT_TRANSPORT_MIRROR
# define DRIVER_LED_TOTAL RGBLED_NUM
# define RGB_MATRIX_SPLIT RGBLED_SPLIT
# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 50
# define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
# define RGB_DISABLE_WHEN_USB_SUSPENDED
# define RGB_MATRIX_KEYPRESSES
#endif

67
keyboards/bastardkb/charybdis/4x6/info.json Normal file
View File

@@ -0,0 +1,67 @@
{
"keyboard_name": "Charybdis",
"url": "https://www.bastardkb.com",
"maintainer": "Quentin Lebastard",
"layouts": {
"LAYOUT_charybdis_4x6": {
"layout": [
{ "label": "L00", "x": 0, "y": 0 },
{ "label": "L01", "x": 1, "y": 0 },
{ "label": "L02", "x": 2, "y": 0 },
{ "label": "L03", "x": 3, "y": 0 },
{ "label": "L04", "x": 4, "y": 0 },
{ "label": "L05", "x": 5, "y": 0 },
{ "label": "R00", "x": 11, "y": 0 },
{ "label": "R01", "x": 12, "y": 0 },
{ "label": "R02", "x": 13, "y": 0 },
{ "label": "R03", "x": 14, "y": 0 },
{ "label": "R04", "x": 15, "y": 0 },
{ "label": "R05", "x": 16, "y": 0 },
{ "label": "L10", "x": 0, "y": 1 },
{ "label": "L11", "x": 1, "y": 1 },
{ "label": "L12", "x": 2, "y": 1 },
{ "label": "L13", "x": 3, "y": 1 },
{ "label": "L14", "x": 4, "y": 1 },
{ "label": "L15", "x": 5, "y": 1 },
{ "label": "R10", "x": 11, "y": 1 },
{ "label": "R11", "x": 12, "y": 1 },
{ "label": "R12", "x": 13, "y": 1 },
{ "label": "R13", "x": 14, "y": 1 },
{ "label": "R14", "x": 15, "y": 1 },
{ "label": "R15", "x": 16, "y": 1 },
{ "label": "L20", "x": 0, "y": 2 },
{ "label": "L21", "x": 1, "y": 2 },
{ "label": "L22", "x": 2, "y": 2 },
{ "label": "L23", "x": 3, "y": 2 },
{ "label": "L24", "x": 4, "y": 2 },
{ "label": "L25", "x": 5, "y": 2 },
{ "label": "R20", "x": 11, "y": 2 },
{ "label": "R21", "x": 12, "y": 2 },
{ "label": "R22", "x": 13, "y": 2 },
{ "label": "R23", "x": 14, "y": 2 },
{ "label": "R24", "x": 15, "y": 2 },
{ "label": "R25", "x": 16, "y": 2 },
{ "label": "L30", "x": 0, "y": 3 },
{ "label": "L31", "x": 1, "y": 3 },
{ "label": "L32", "x": 2, "y": 3 },
{ "label": "L33", "x": 3, "y": 3 },
{ "label": "L34", "x": 4, "y": 3 },
{ "label": "L35", "x": 5, "y": 3 },
{ "label": "R30", "x": 11, "y": 3 },
{ "label": "R31", "x": 12, "y": 3 },
{ "label": "R32", "x": 13, "y": 3 },
{ "label": "R33", "x": 14, "y": 3 },
{ "label": "R34", "x": 15, "y": 3 },
{ "label": "R35", "x": 16, "y": 3 },
{ "label": "L40", "x": 5, "y": 4 },
{ "label": "L41", "x": 6, "y": 4 },
{ "label": "L42", "x": 7, "y": 4 },
{ "label": "R40", "x": 9, "y": 4 },
{ "label": "R41", "x": 10, "y": 4 },
{ "label": "L50", "x": 6, "y": 5 },
{ "label": "L51", "x": 7, "y": 5 },
{ "label": "R50", "x": 9, "y": 5 }
]
}
}
}

39
keyboards/bastardkb/charybdis/4x6/keymaps/default/config.h Normal file
View File

@@ -0,0 +1,39 @@
/**
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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
/* RGB Matrix. */
#ifdef RGB_MATRIX_ENABLE
// Limit maximum brightness to keep power consumption reasonable, and avoid
// disconnects.
# undef RGB_MATRIX_MAXIMUM_BRIGHTNESS
# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 64
// Rainbow swirl as startup mode.
# define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
# define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_CYCLE_LEFT_RIGHT
// Slow swirl at startup.
# define RGB_MATRIX_STARTUP_SPD 32
// Startup values.
# define RGB_MATRIX_STARTUP_HUE 0
# define RGB_MATRIX_STARTUP_SAT 255
# define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
# define RGB_MATRIX_STARTUP_HSV RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT, RGB_MATRIX_STARTUP_VAL
#endif // RGB_MATRIX_ENABLE

75
keyboards/bastardkb/charybdis/4x6/keymaps/default/keymap.c Normal file
View File

@@ -0,0 +1,75 @@
/**
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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 charybdis_keymap_layers {
LAYER_BASE = 0,
LAYER_LOWER,
LAYER_RAISE,
};
#define LOWER MO(LAYER_LOWER)
#define RAISE MO(LAYER_RAISE)
// clang-format off
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[LAYER_BASE] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_LCTL, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_LALT,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
KC_LGUI, KC_SPC, LOWER, RAISE, KC_ENT,
KC_LALT, KC_BSPC, KC_DEL
// ╰───────────────────────────╯ ╰──────────────────╯
),
[LAYER_LOWER] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_UNDS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_MOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LBRC, KC_P7, KC_P8, KC_P9, KC_RBRC, XXXXXXX,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_TOG, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX, KC_PPLS, KC_P4, KC_P5, KC_P6, KC_PMNS, KC_PEQL,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, EEP_RST, RESET, KC_PAST, KC_P1, KC_P2, KC_P3, KC_PSLS, KC_PDOT,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
XXXXXXX, XXXXXXX, _______, XXXXXXX, _______,
XXXXXXX, XXXXXXX, KC_P0
// ╰───────────────────────────╯ ╰──────────────────╯
),
[LAYER_RAISE] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_F12, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MNXT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLU,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MPLY, KC_LEFT, KC_UP, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, KC_RSFT, KC_RCTL, KC_RALT, KC_RGUI, KC_MUTE,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MPRV, KC_HOME, KC_PGUP, KC_PGDN, KC_END, XXXXXXX, RESET, EEP_RST, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLD,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
_______, _______, XXXXXXX, _______, XXXXXXX,
_______, _______, XXXXXXX
// ╰───────────────────────────╯ ╰──────────────────╯
),
};
// clang-format on

7
keyboards/bastardkb/charybdis/4x6/keymaps/default/readme.md Normal file
View File

@@ -0,0 +1,7 @@
# Charybdis (4x6) default keymap
> :bulb: Have a look at the [`via` keymap](../via) for a more feature-rich layout.
The Charydbis (4x6) default keymap is inspired from the original [Dactyl Manuform](../../../../../handwired/dactyl_manuform) default keymap.
This layout supports RGB matrix. However, due to space constraints on the MCU, only a limited number of effect can be enabled at once. Look at the `config.h` file and enable your favorite effect.

72
keyboards/bastardkb/charybdis/4x6/keymaps/via/config.h Normal file
View File

@@ -0,0 +1,72 @@
/**
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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 VIA_ENABLE
/* VIA configuration. */
# define DYNAMIC_KEYMAP_LAYER_COUNT 4
#endif // VIA_ENABLE
/* Disable unused features. */
#define NO_ACTION_ONESHOT
#ifndef TAPPING_TERM
/**
* \brief Configure the global tapping term (default: 200ms).
*
* If you have a lot of accidental mod activations, crank up the tapping term.
*
* See docs.qmk.fm/using-qmk/software-features/tap_hold#tapping-term
*/
# define TAPPING_TERM 200
#endif // TAPPING_TERM
/* Charybdis-specific features. */
#ifdef POINTING_DEVICE_ENABLE
// Enable pointer acceleration, which increases the speed by ~2x for large
// displacement, while maintaining 1x speed for slow movements.
// - `CHARYBDIS_POINTER_ACCELERATION_FACTOR`
# define CHARYBDIS_POINTER_ACCELERATION_ENABLE
// Automatically enable the pointer layer when moving the trackball. See also:
// - `CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS`
// - `CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD`
// #define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
#endif // POINTING_DEVICE_ENABLE
/* RGB Matrix. */
#ifdef RGB_MATRIX_ENABLE
// Limit maximum brightness to keep power consumption reasonable, and avoid
// disconnects.
# undef RGB_MATRIX_MAXIMUM_BRIGHTNESS
# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 64
// Rainbow swirl as startup mode.
# define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
# define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_CYCLE_LEFT_RIGHT
// Slow swirl at startup.
# define RGB_MATRIX_STARTUP_SPD 32
// Startup values.
# define RGB_MATRIX_STARTUP_HUE 0
# define RGB_MATRIX_STARTUP_SAT 255
# define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
# define RGB_MATRIX_STARTUP_HSV RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT, RGB_MATRIX_STARTUP_VAL
#endif // RGB_MATRIX_ENABLE

166
keyboards/bastardkb/charybdis/4x6/keymaps/via/keymap.c Normal file
View File

@@ -0,0 +1,166 @@
/**
* Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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
#ifdef CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
# include "timer.h"
#endif // CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
enum charybdis_keymap_layers {
LAYER_BASE = 0,
LAYER_LOWER,
LAYER_RAISE,
LAYER_POINTER,
};
/** \brief Automatically enable sniping-mode on the pointer layer. */
#define CHARYBDIS_AUTO_SNIPING_ON_LAYER LAYER_POINTER
#ifdef CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
static uint16_t auto_pointer_layer_timer = 0;
# ifndef CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS
# define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS 1000
# endif // CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS
# ifndef CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD
# define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD 8
# endif // CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD
#endif // CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
#define LOWER MO(LAYER_LOWER)
#define RAISE MO(LAYER_RAISE)
#define PT_Z LT(LAYER_POINTER, KC_Z)
#define PT_SLSH LT(LAYER_POINTER, KC_SLSH)
// clang-format off
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[LAYER_BASE] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_LCTL, PT_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, PT_SLSH, KC_LALT,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
KC_LGUI, KC_SPC, LOWER, RAISE, KC_ENT,
KC_LALT, KC_BSPC, KC_DEL
// ╰───────────────────────────╯ ╰──────────────────╯
),
[LAYER_LOWER] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_UNDS,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_MOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LBRC, KC_P7, KC_P8, KC_P9, KC_RBRC, XXXXXXX,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_TOG, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX, KC_PPLS, KC_P4, KC_P5, KC_P6, KC_PMNS, KC_PEQL,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PAST, KC_P1, KC_P2, KC_P3, KC_PSLS, KC_PDOT,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
XXXXXXX, XXXXXXX, _______, XXXXXXX, _______,
XXXXXXX, XXXXXXX, KC_P0
// ╰───────────────────────────╯ ╰──────────────────╯
),
[LAYER_RAISE] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
KC_F12, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MNXT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLU,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MPLY, KC_LEFT, KC_UP, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, KC_RSFT, KC_RCTL, KC_RALT, KC_RGUI, KC_MUTE,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
KC_MPRV, KC_HOME, KC_PGUP, KC_PGDN, KC_END, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLD,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
_______, _______, XXXXXXX, _______, XXXXXXX,
_______, _______, XXXXXXX
// ╰───────────────────────────╯ ╰──────────────────╯
),
[LAYER_POINTER] = LAYOUT_charybdis_4x6(
// ╭──────────────────────────────────────────────────────╮ ╭──────────────────────────────────────────────────────╮
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, DPI_MOD, S_D_MOD, S_D_MOD, DPI_MOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
XXXXXXX, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX, XXXXXXX, KC_RSFT, KC_RCTL, KC_RALT, KC_RGUI, XXXXXXX,
// ├──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────┤
XXXXXXX, _______, DRGSCRL, SNIPING, EEP_RST, RESET, RESET, EEP_RST, SNIPING, DRGSCRL, _______, XXXXXXX,
// ╰──────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────╯
KC_BTN2, KC_BTN1, KC_BTN3, KC_BTN3, KC_BTN1,
XXXXXXX, KC_BTN2, KC_BTN2
// ╰───────────────────────────╯ ╰──────────────────╯
),
};
// clang-format on
#ifdef POINTING_DEVICE_ENABLE
# ifdef CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
if (abs(mouse_report.x) > CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD || abs(mouse_report.y) > CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD) {
if (auto_pointer_layer_timer == 0) {
layer_on(LAYER_POINTER);
# ifdef RGB_MATRIX_ENABLE
rgb_matrix_mode_noeeprom(RGB_MATRIX_NONE);
rgb_matrix_sethsv_noeeprom(HSV_GREEN);
# endif // RGB_MATRIX_ENABLE
}
auto_pointer_layer_timer = timer_read();
}
return mouse_report;
}
void matrix_scan_kb(void) {
if (auto_pointer_layer_timer != 0 && TIMER_DIFF_16(timer_read(), auto_pointer_layer_timer) >= CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS) {
auto_pointer_layer_timer = 0;
layer_off(LAYER_POINTER);
# ifdef RGB_MATRIX_ENABLE
rgb_matrix_mode_noeeprom(RGB_MATRIX_STARTUP_MODE);
# endif // RGB_MATRIX_ENABLE
}
matrix_scan_user();
}
# endif // CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
# ifdef CHARYBDIS_AUTO_SNIPING_ON_LAYER
layer_state_t layer_state_set_kb(layer_state_t state) {
state = layer_state_set_user(state);
charybdis_set_pointer_sniping_enabled(layer_state_cmp(state, CHARYBDIS_AUTO_SNIPING_ON_LAYER));
return state;
}
# endif // CHARYBDIS_AUTO_SNIPING_ON_LAYER
#endif // POINTING_DEVICE_ENABLE
#ifdef RGB_MATRIX_ENABLE
// Forward-declare this helper function since it is defined in rgb_matrix.c.
void rgb_matrix_update_pwm_buffers(void);
#endif
void shutdown_user(void) {
#ifdef RGBLIGHT_ENABLE
rgblight_enable_noeeprom();
rgblight_mode_noeeprom(1);
rgblight_setrgb_red();
#endif // RGBLIGHT_ENABLE
#ifdef RGB_MATRIX_ENABLE
rgb_matrix_set_color_all(RGB_RED);
rgb_matrix_update_pwm_buffers();
#endif // RGB_MATRIX_ENABLE
}

61
keyboards/bastardkb/charybdis/4x6/keymaps/via/readme.md Normal file
View File

@@ -0,0 +1,61 @@
# Charybdis (4x6) `via` keymap
The Charydbis (4x6) `via` keymap is inspired from the original [Dactyl Manuform](../../../../../handwired/dactyl_manuform) default keymap, with some features and changes specific to the Charybdis.
This layout supports RGB matrix. However, due to space constraints on the MCU, only a limited number of effect can be enabled at once. Look at the `config.h` file and enable your favorite effect.
## Customizing the keymap
### Dynamic DPI scaling
Use the following keycodes to change the default DPI:
- `POINTER_DEFAULT_DPI_FORWARD`: increases the DPI; decreases when shifted;
- `POINTER_DEFAULT_DPI_REVERSE`: decreases the DPI; increases when shifted.
There's a maximum of 16 possible values for the sniping mode DPI. See the [Charybdis documentation](../../README.md) for more information.
Use the following keycodes to change the sniping mode DPI:
- `POINTER_SNIPING_DPI_FORWARD`: increases the DPI; decreases when shifted;
- `POINTER_SNIPING_DPI_REVERSE`: decreases the DPI; increases when shifted.
There's a maximum of 4 possible values for the sniping mode DPI. See the [Charybdis documentation](../../README.md) for more information.
### Drag-scroll
Use the `DRAGSCROLL_MODE` keycode to enable drag-scroll on hold. Use the `DRAGSCROLL_TOGGLE` keycode to enable/disable drag-scroll on key press.
### Sniping
Use the `SNIPING_MODE` keycode to enable sniping mode on hold. Use the `SNIPING_TOGGLE` keycode to enable/disable sniping mode on key press.
Change the value of `CHARYBDIS_AUTO_SNIPING_ON_LAYER` to automatically enable sniping mode on layer change. By default, sniping mode is enabled on the pointer layer:
```c
#define CHARYBDIS_AUTO_SNIPING_ON_LAYER LAYER_POINTER
```
### Auto pointer layer
The pointer layer can be automatically enabled when moving the trackball. To enable or disable this behavior, add or remove the following define:
```c
#define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
```
By default, the layer is turned off 1 second after the last registered trackball movement:
```c
#define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS 1000
```
The trigger sensibility can also be tuned. The lower the value, the more sensible the trigger:
```c
#define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_THRESHOLD 8
```
## Layout
![Keymap layout (generated with keyboard-layout-editor.com)](https://i.imgur.com/qI7phR7.png)

1
keyboards/bastardkb/charybdis/4x6/keymaps/via/rules.mk Normal file
View File

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

15
keyboards/bastardkb/charybdis/4x6/readme.md Normal file
View File

@@ -0,0 +1,15 @@
# Charybdis (4x6)
An ergonomic keyboard with integrated trackball.
The Charybdis is available in 4x6 and 3x5 form factor at [bastardkb.com](https://bastardkb.com).
## Keymaps
### [`default`](keymaps/default)
A simple QWERTY layout with 3 layers.
### [`via`](keymaps/via)
Same as the [default](keymaps/default) keymap, but with VIA support.

37
keyboards/bastardkb/charybdis/4x6/rules.mk Normal file
View File

@@ -0,0 +1,37 @@
# 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 = no # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = no # Commands for debug and configuration
NKRO_ENABLE = no # Enable N-Key Rollover
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
AUDIO_ENABLE = no # Audio output
AUDIO_SUPPORTED = no # Audio is not supported.
RGB_MATRIX_SUPPORTED = yes # RGB matrix is supported and enabled by default.
RGBLIGHT_SUPPORTED = yes # RGB underglow is supported, but not enabled by default.
RGB_MATRIX_ENABLE = yes # Enable keyboard RGB matrix functionality
RGB_MATRIX_DRIVER = WS2812
# Enable link-time optimization by default. The Charybdis packs a lot of
# features (RGB, Via, trackball) in a small atmega32u4 package.
LTO_ENABLE = yes
# Charybdis is a split 4x6 keyboard with a maximum of 5 thumb keys (3 on the
# trackball side).
SPLIT_KEYBOARD = yes
POINTING_DEVICE_ENABLE = yes # Enable trackball
POINTING_DEVICE_DRIVER = pmw3360
# https://qmk.fm/changes/2018-11-16-use-a-single-endpoint-for-hid-reports
MOUSE_SHARED_EP = no # Unify multiple HID interfaces into a single Endpoint