@ -0,0 +1,83 @@ | |||
/* | |||
* 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 "3x5.h" | |||
// clang-format off | |||
#ifdef RGB_MATRIX_ENABLE | |||
/** | |||
* \brief LEDs index. | |||
* | |||
* ╭────────────────────╮ ╭────────────────────╮ | |||
* 2 3 8 9 12 30 27 26 21 20 | |||
* ├────────────────────┤ ├────────────────────┤ | |||
* 1 4 7 10 13 31 28 25 22 19 | |||
* ├────────────────────┤ ├────────────────────┤ | |||
* 0 5 6 11 14 32 29 24 23 18 | |||
* ╰────────────────────╯ ╰────────────────────╯ | |||
* 15 16 17 33 34 XX | |||
* ╰────────────╯ ╰────────────╯ | |||
*/ | |||
led_config_t g_led_config = { { | |||
/* Key Matrix to LED index. */ | |||
// Left split. | |||
{ 2, 3, 8, 9, 12 }, // Top row | |||
{ 1, 4, 7, 10, 13 }, // Middle row | |||
{ 0, 5, 6, 11, 14 }, // Bottom row | |||
{ 17, NO_LED, 15, 16, NO_LED }, // Thumb cluster | |||
// Right split. | |||
{ 20, 21, 26, 27, 30 }, // Top row | |||
{ 19, 22, 25, 28, 31 }, // Middle row | |||
{ 18, 23, 24, 29, 32 }, // Bottom row | |||
{ 33, NO_LED, 34, NO_LED, NO_LED }, // Thumb cluster | |||
}, { | |||
/* LED index to physical position. */ | |||
// Left split. | |||
/* index=0 */ { 0, 42 }, { 0, 21 }, { 0, 0 }, // col 1 (left most) | |||
/* index=3 */ { 18, 0 }, { 18, 21 }, { 18, 42 }, // col 2 | |||
/* index=6 */ { 36, 42 }, { 36, 21 }, { 36, 0 }, | |||
/* index=9 */ { 54, 0 }, { 54, 21 }, { 54, 42 }, | |||
/* index=12 */ { 72, 0 }, { 72, 21 }, { 72, 42 }, | |||
/* index=15 */ { 72, 64 }, { 90, 64 }, { 108, 64 }, // Thumb cluster | |||
// Right split. | |||
/* index=18 */ { 224, 42 }, { 224, 21 }, { 224, 0 }, // col 10 (right most) | |||
/* index=21 */ { 206, 0 }, { 206, 21 }, { 206, 42 }, // col 9 | |||
/* index=24 */ { 188, 42 }, { 188, 21 }, { 188, 0 }, | |||
/* index=27 */ { 170, 0 }, { 170, 21 }, { 170, 42 }, | |||
/* index=30 */ { 152, 0 }, { 152, 21 }, { 152, 42 }, | |||
/* index=33 */ { 152, 64 }, { 134, 64 }, | |||
}, { | |||
/* LED index to flag. */ | |||
// Left split. | |||
/* index=0 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 1 | |||
/* index=3 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 2 | |||
/* index=6 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=9 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=12 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=15 */ LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, // Thumb cluster | |||
// Right split. | |||
/* index=18 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 10 | |||
/* index=21 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 9 | |||
/* index=24 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=27 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=30 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, | |||
/* index=33 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // Thumb cluster | |||
} }; | |||
#endif | |||
// clang-format on |
@ -0,0 +1,67 @@ | |||
/* | |||
* 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_3x5( \ | |||
k00, k01, k02, k03, k04, k44, k43, k42, k41, k40, \ | |||
k10, k11, k12, k13, k14, k54, k53, k52, k51, k50, \ | |||
k20, k21, k22, k23, k24, k64, k63, k62, k61, k60, \ | |||
k32, k33, k30, k70, k72 \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04 }, \ | |||
{ k10, k11, k12, k13, k14 }, \ | |||
{ k20, k21, k22, k23, k24 }, \ | |||
{ k30, KC_NO, k32, k33, KC_NO }, \ | |||
{ k40, k41, k42, k43, k44 }, \ | |||
{ k50, k51, k52, k53, k54 }, \ | |||
{ k60, k61, k62, k63, k64 }, \ | |||
{ k70, KC_NO, k72, KC_NO, KC_NO }, \ | |||
} | |||
/** | |||
* \brief Compatibility layout with the split_3x5_3 community layout. | |||
* | |||
* This effectively renders the Charbdis Nano compatible with existing layout | |||
* implementations relying on the `split_3x5_3` layout, which includes, among | |||
* others, Manna-Harbour's (@manna_harbour) Miryoku layout. | |||
* | |||
* The last key on the layout is ignored, to transform the input 36-keys layout | |||
* into the Charybdis Nano's 35-keys layout. | |||
*/ | |||
#define LAYOUT_split_3x5_3( \ | |||
k00, k01, k02, k03, k04, k44, k43, k42, k41, k40, \ | |||
k10, k11, k12, k13, k14, k54, k53, k52, k51, k50, \ | |||
k20, k21, k22, k23, k24, k64, k63, k62, k61, k60, \ | |||
k32, k33, k30, k70, k72, ___ \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04 }, \ | |||
{ k10, k11, k12, k13, k14 }, \ | |||
{ k20, k21, k22, k23, k24 }, \ | |||
{ k30, KC_NO, k32, k33, KC_NO }, \ | |||
{ k40, k41, k42, k43, k44 }, \ | |||
{ k50, k51, k52, k53, k54 }, \ | |||
{ k60, k61, k62, k63, k64 }, \ | |||
{ k70, KC_NO, k72, KC_NO, KC_NO }, \ | |||
} | |||
// clang-format on |
@ -0,0 +1,87 @@ | |||
/* | |||
* 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 0x1832 | |||
#define DEVICE_VER 0x0001 | |||
#define MANUFACTURER Bastard Keyboards | |||
#define PRODUCT Charybdis Nano | |||
/* Key matrix configuration. */ | |||
// Rows are doubled-up. | |||
#define MATRIX_ROWS 8 | |||
#define MATRIX_COLS 5 | |||
// Wiring configuration for each half. | |||
#define MATRIX_ROW_PINS \ | |||
{ B7, C6, D4, B5 } | |||
#define MATRIX_COL_PINS \ | |||
{ C7, F0, D7, E6, B4 } | |||
#define MATRIX_ROW_PINS_RIGHT \ | |||
{ F0, C6, D4, B5 } | |||
#define MATRIX_COL_PINS_RIGHT \ | |||
{ C7, B7, D7, E6, B4 } | |||
#define DIODE_DIRECTION ROW2COL | |||
/* Handedness. */ | |||
#define MASTER_RIGHT | |||
/* Bootmagic Lite configuration. */ | |||
#define BOOTMAGIC_LITE_ROW 0 | |||
#define BOOTMAGIC_LITE_COLUMN 0 | |||
#define BOOTMAGIC_LITE_ROW_RIGHT 4 | |||
#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 | |||
// Trackball angle adjustment. | |||
#define ROTATIONAL_TRANSFORM_ANGLE -25 | |||
/* RGB settings. */ | |||
#define RGB_DI_PIN D3 | |||
#define RGBLED_NUM 35 | |||
#define RGBLED_SPLIT \ | |||
{ 18, 17 } | |||
/* 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 |
@ -0,0 +1,86 @@ | |||
{ | |||
"keyboard_name": "Charybdis Nano", | |||
"url": "https://www.bastardkb.com", | |||
"maintainer": "Quentin Lebastard", | |||
"layouts": { | |||
"LAYOUT_charybdis_3x5": { | |||
"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": "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": "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": "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": "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": "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": "L30", "x": 4, "y": 3 }, | |||
{ "label": "L31", "x": 5, "y": 3 }, | |||
{ "label": "L32", "x": 6, "y": 3 }, | |||
{ "label": "R30", "x": 9, "y": 3 }, | |||
{ "label": "R31", "x": 10, "y": 3 } | |||
] | |||
}, | |||
"LAYOUT_split_3x5_3": { | |||
"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": "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": "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": "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": "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": "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": "L30", "x": 4, "y": 3 }, | |||
{ "label": "L31", "x": 5, "y": 3 }, | |||
{ "label": "L32", "x": 6, "y": 3 }, | |||
{ "label": "R30", "x": 9, "y": 3 }, | |||
{ "label": "R31", "x": 10, "y": 3 }, | |||
{ "label": "R32", "x": 11, "y": 3 } | |||
] | |||
} | |||
} | |||
} |
@ -0,0 +1,54 @@ | |||
/** | |||
* 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 | |||
#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 | |||
/* RGB Matrix. */ | |||
#ifdef RGB_MATRIX_ENABLE | |||
// Disable control of RGB matrix by keycodes (must use firmware implementation | |||
// to control the feature). | |||
# define RGB_MATRIX_DISABLE_KEYCODES | |||
// 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 |
@ -0,0 +1,70 @@ | |||
/** | |||
* 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) | |||
#define CTL_BSP CTL_T(KC_BSPC) | |||
#define SFT_SPC SFT_T(KC_SPC) | |||
#define GUI_ENT GUI_T(KC_ENT) | |||
// clang-format off | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[LAYER_BASE] = LAYOUT_charybdis_3x5( | |||
// ╭─────────────────────────────────────────────╮ ╭─────────────────────────────────────────────╮ | |||
KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, | |||
// ╰─────────────────────────────────────────────┤ ├─────────────────────────────────────────────╯ | |||
CTL_BSP, SFT_SPC, LOWER, RAISE, GUI_ENT | |||
// ╰───────────────────────────╯ ╰──────────────────╯ | |||
), | |||
[LAYER_LOWER] = LAYOUT_charybdis_3x5( | |||
// ╭─────────────────────────────────────────────╮ ╭─────────────────────────────────────────────╮ | |||
RGB_TOG, KC_MNXT, KC_MPLY, KC_MPRV, XXXXXXX, KC_LBRC, KC_7, KC_8, KC_9, KC_RBRC, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX, KC_PPLS, KC_4, KC_5, KC_6, KC_PMNS, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
XXXXXXX, XXXXXXX, XXXXXXX, EEP_RST, RESET, KC_PAST, KC_1, KC_2, KC_3, KC_PSLS, | |||
// ╰─────────────────────────────────────────────┤ ├─────────────────────────────────────────────╯ | |||
XXXXXXX, XXXXXXX, _______, XXXXXXX, _______ | |||
// ╰───────────────────────────╯ ╰──────────────────╯ | |||
), | |||
[LAYER_RAISE] = LAYOUT_charybdis_3x5( | |||
// ╭─────────────────────────────────────────────╮ ╭─────────────────────────────────────────────╮ | |||
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLU, KC_MUTE, KC_VOLD, XXXXXXX, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
KC_LEFT, KC_UP, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, KC_RSFT, KC_RCTL, KC_RALT, KC_RGUI, | |||
// ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤ | |||
KC_HOME, KC_PGUP, KC_PGDN, KC_END, XXXXXXX, RESET, EEP_RST, XXXXXXX, XXXXXXX, XXXXXXX, | |||
// ╰─────────────────────────────────────────────┤ ├─────────────────────────────────────────────╯ | |||
_______, _______, XXXXXXX, _______, XXXXXXX | |||
// ╰───────────────────────────╯ ╰──────────────────╯ | |||
), | |||
}; | |||
// clang-format on |
@ -0,0 +1,7 @@ | |||
# Charybdis (3x5) default keymap | |||
> :bulb: Have a look at the [`via` keymap](../via) for a more feature-rich layout. | |||
The Charydbis (3x5) 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. |
@ -0,0 +1,118 @@ | |||
/** | |||
* 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 7 | |||
#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 | |||
/** | |||
* \brief Enable rapid switch from tap to hold. | |||
* | |||
* Note that a side-effect of this setting is to disable auto-repeat when | |||
* pressing key twice, except for one-shot keys. | |||
* | |||
* See docs.qmk.fm/using-qmk/software-features/tap_hold#tapping-force-hold | |||
*/ | |||
#define TAPPING_FORCE_HOLD | |||
/* | |||
* Tap-or-Hold decision modes. | |||
* | |||
* Note that the following flags behave differently when combined (ie. when 2 or | |||
* more are enabled). | |||
* | |||
* See bit.ly/tap-or-hold for a visual explanation of the following tap-or-hold | |||
* decision modes. | |||
*/ | |||
/** | |||
* \brief Faster tap-hold trigger. | |||
* | |||
* Without `PERMISSIVE_HOLD`, within `TAPPING_TERM`: | |||
* Mod(a)🠗 e🠗 e🠕 Mod(a)🠕 ➞ ae | |||
* With `PERMISSIVE_HOLD`, within `TAPPING_TERM`: | |||
* Mod(a)🠗 e🠗 e🠕 Mod(a)🠕 ➞ Mod+e | |||
* | |||
* See docs.qmk.fm/using-qmk/software-features/tap_hold#permissive-hold | |||
*/ | |||
#define PERMISSIVE_HOLD | |||
/** | |||
* \brief Prevent normal rollover on alphas from accidentally triggering mods. | |||
* | |||
* Ignores key presses that interrupt a mod-tap. Must-have for Home Row mod. | |||
* | |||
* Without `IGNORE_MOD_TAP_INTERRUPT`, within `TAPPING_TERM`: | |||
* Mod(a)🠗 e🠗 Mod(a)🠕 e🠕 ➞ Mod+e | |||
* With `IGNORE_MOD_TAP_INTERRUPT`, within `TAPPING_TERM`: | |||
* Mod(a)🠗 e🠗 Mod(a)🠕 e🠕 ➞ ae | |||
* | |||
* See docs.qmk.fm/using-qmk/software-features/tap_hold#ignore-mod-tap-interrupt | |||
*/ | |||
#define IGNORE_MOD_TAP_INTERRUPT | |||
/* 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. See also: | |||
// - `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 |
@ -0,0 +1,263 @@ | |||
/** | |||
* 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_FUNCTION, | |||
LAYER_NAVIGATION, | |||
LAYER_MEDIA, | |||
LAYER_POINTER, | |||
LAYER_NUMERAL, | |||
LAYER_SYMBOLS, | |||
}; | |||
// 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 ESC_MED LT(LAYER_MEDIA, KC_ESC) | |||
#define SPC_NAV LT(LAYER_NAVIGATION, KC_SPC) | |||
#define TAB_FUN LT(LAYER_FUNCTION, KC_TAB) | |||
#define ENT_SYM LT(LAYER_SYMBOLS, KC_ENT) | |||
#define BSP_NUM LT(LAYER_NUMERAL, KC_BSPC) | |||
#define _L_PTR(KC) LT(LAYER_POINTER, KC) | |||
// clang-format off | |||
/** \brief QWERTY layout (3 rows, 10 columns). */ | |||
#define LAYOUT_LAYER_BASE \ | |||
KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, \ | |||
KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, \ | |||
KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, \ | |||
ESC_MED, SPC_NAV, TAB_FUN, ENT_SYM, BSP_NUM | |||
/** Convenience row shorthands. */ | |||
#define _______________DEAD_HALF_ROW_______________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX | |||
#define ______________HOME_ROW_GACS_L______________ KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX | |||
#define ______________HOME_ROW_GACS_R______________ XXXXXXX, KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI | |||
/* | |||
* Layers used on the Charybdis Nano. | |||
* | |||
* These layers started off heavily inspired by the Miryoku layout, but trimmed | |||
* down and tailored for a stock experience that is meant to be fundation for | |||
* further personalization. | |||
* | |||
* See https://github.com/manna-harbour/miryoku for the original layout. | |||
*/ | |||
/** | |||
* \brief Function layer. | |||
* | |||
* Secondary right-hand layer has function keys mirroring the numerals on the | |||
* primary layer with extras on the pinkie column, plus system keys on the inner | |||
* column. App is on the tertiary thumb key and other thumb keys are duplicated | |||
* from the base layer to enable auto-repeat. | |||
*/ | |||
#define LAYOUT_LAYER_FUNCTION \ | |||
_______________DEAD_HALF_ROW_______________, KC_PSCR, KC_F7, KC_F8, KC_F9, KC_F12, \ | |||
______________HOME_ROW_GACS_L______________, KC_SLCK, KC_F4, KC_F5, KC_F6, KC_F11, \ | |||
_______________DEAD_HALF_ROW_______________, KC_PAUS, KC_F1, KC_F2, KC_F3, KC_F10, \ | |||
XXXXXXX, XXXXXXX, _______, XXXXXXX, XXXXXXX | |||
/** | |||
* \brief Media layer. | |||
* | |||
* Tertiary left- and right-hand layer is media and RGB control. This layer is | |||
* symmetrical to accomodate the left- and right-hand trackball. | |||
*/ | |||
#define LAYOUT_LAYER_MEDIA \ | |||
XXXXXXX,RGB_RMOD, RGB_TOG, RGB_MOD, XXXXXXX, XXXXXXX,RGB_RMOD, RGB_TOG, RGB_MOD, XXXXXXX, \ | |||
KC_MPRV, KC_VOLD, KC_MUTE, KC_VOLU, KC_MNXT, KC_MPRV, KC_VOLD, KC_MUTE, KC_VOLU, KC_MNXT, \ | |||
XXXXXXX, XXXXXXX, XXXXXXX, EEP_RST, RESET, RESET, EEP_RST, XXXXXXX, XXXXXXX, XXXXXXX, \ | |||
_______, KC_MPLY, KC_MSTP, KC_MSTP, KC_MPLY | |||
/** \brief Mouse emulation and pointer functions. */ | |||
#define LAYOUT_LAYER_POINTER \ | |||
XXXXXXX, XXXXXXX, XXXXXXX, DPI_MOD, S_D_MOD, S_D_MOD, DPI_MOD, XXXXXXX, XXXXXXX, XXXXXXX, \ | |||
______________HOME_ROW_GACS_L______________, ______________HOME_ROW_GACS_R______________, \ | |||
_______, DRGSCRL, SNIPING, EEP_RST, RESET, RESET, EEP_RST, SNIPING, DRGSCRL, _______, \ | |||
KC_BTN2, KC_BTN1, KC_BTN3, KC_BTN3, KC_BTN1 | |||
/** | |||
* \brief Navigation layer. | |||
* | |||
* Primary right-hand layer (left home thumb) is navigation and editing. Cursor | |||
* keys are on the home position, line and page movement below, clipboard above, | |||
* caps lock and insert on the inner column. Thumb keys are duplicated from the | |||
* base layer to avoid having to layer change mid edit and to enable auto-repeat. | |||
*/ | |||
#define LAYOUT_LAYER_NAVIGATION \ | |||
_______________DEAD_HALF_ROW_______________, _______________DEAD_HALF_ROW_______________, \ | |||
______________HOME_ROW_GACS_L______________, KC_CLCK, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, \ | |||
_______________DEAD_HALF_ROW_______________, KC_INS, KC_HOME, KC_PGDN, KC_PGUP, KC_END, \ | |||
XXXXXXX, _______, XXXXXXX, KC_ENT, KC_BSPC | |||
/** | |||
* \brief Numeral layout. | |||
* | |||
* Primary left-hand layer (right home thumb) is numerals and symbols. Numerals | |||
* are in the standard numpad locations with symbols in the remaining positions. | |||
* `KC_DOT` is duplicated from the base layer. | |||
*/ | |||
#define LAYOUT_LAYER_NUMERAL \ | |||
KC_LBRC, KC_7, KC_8, KC_9, KC_RBRC, _______________DEAD_HALF_ROW_______________, \ | |||
KC_SCLN, KC_4, KC_5, KC_6, KC_EQL, ______________HOME_ROW_GACS_R______________, \ | |||
KC_GRV, KC_1, KC_2, KC_3, KC_BSLS, _______________DEAD_HALF_ROW_______________, \ | |||
KC_DOT, KC_0, KC_MINS, XXXXXXX, _______ | |||
/** | |||
* \brief Symbols layer. | |||
* | |||
* Secondary left-hand layer has shifted symbols in the same locations to reduce | |||
* chording when using mods with shifted symbols. `KC_LPRN` is duplicated next to | |||
* `KC_RPRN`. | |||
*/ | |||
#define LAYOUT_LAYER_SYMBOLS \ | |||
KC_LCBR, KC_AMPR, KC_ASTR, KC_LPRN, KC_RCBR, _______________DEAD_HALF_ROW_______________, \ | |||
KC_COLN, KC_DLR, KC_PERC, KC_CIRC, KC_PLUS, ______________HOME_ROW_GACS_R______________, \ | |||
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_PIPE, _______________DEAD_HALF_ROW_______________, \ | |||
KC_LPRN, KC_RPRN, KC_UNDS, _______, XXXXXXX | |||
/** | |||
* \brief Add Home Row mod to a layout. | |||
* | |||
* Expects a 10-key per row layout. Adds support for GACS (Gui, Alt, Ctl, Shift) | |||
* home row. The layout passed in parameter must contain at least 20 keycodes. | |||
* | |||
* This is meant to be used with `LAYER_ALPHAS_QWERTY` defined above, eg.: | |||
* | |||
* HOME_ROW_MOD_GACS(LAYER_ALPHAS_QWERTY) | |||
*/ | |||
#define _HOME_ROW_MOD_GACS( \ | |||
L00, L01, L02, L03, L04, R05, R06, R07, R08, R09, \ | |||
L10, L11, L12, L13, L14, R15, R16, R17, R18, R19, \ | |||
...) \ | |||
L00, L01, L02, L03, L04, \ | |||
R05, R06, R07, R08, R09, \ | |||
LGUI_T(L10), LALT_T(L11), LCTL_T(L12), LSFT_T(L13), L14, \ | |||
R15, RSFT_T(R16), RCTL_T(R17), LALT_T(R18), RGUI_T(R19), \ | |||
__VA_ARGS__ | |||
#define HOME_ROW_MOD_GACS(...) _HOME_ROW_MOD_GACS(__VA_ARGS__) | |||
/** | |||
* \brief Add pointer layer keys to a layout. | |||
* | |||
* Expects a 10-key per row layout. The layout passed in parameter must contain | |||
* at least 30 keycodes. | |||
* | |||
* This is meant to be used with `LAYER_ALPHAS_QWERTY` defined above, eg.: | |||
* | |||
* POINTER_MOD(LAYER_ALPHAS_QWERTY) | |||
*/ | |||
#define _POINTER_MOD( \ | |||
L00, L01, L02, L03, L04, R05, R06, R07, R08, R09, \ | |||
L10, L11, L12, L13, L14, R15, R16, R17, R18, R19, \ | |||
L20, L21, L22, L23, L24, R25, R26, R27, R28, R29, \ | |||
...) \ | |||
L00, L01, L02, L03, L04, \ | |||
R05, R06, R07, R08, R09, \ | |||
L10, L11, L12, L13, L14, \ | |||
R15, R16, R17, R18, R19, \ | |||
_L_PTR(L20), L21, L22, L23, L24, \ | |||
R25, R26, R27, R28, _L_PTR(R29), \ | |||
__VA_ARGS__ | |||
#define POINTER_MOD(...) _POINTER_MOD(__VA_ARGS__) | |||
#define LAYOUT_wrapper(...) LAYOUT_charybdis_3x5(__VA_ARGS__) | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[LAYER_BASE] = LAYOUT_wrapper( | |||
POINTER_MOD(HOME_ROW_MOD_GACS(LAYOUT_LAYER_BASE)) | |||
), | |||
[LAYER_FUNCTION] = LAYOUT_wrapper(LAYOUT_LAYER_FUNCTION), | |||
[LAYER_NAVIGATION] = LAYOUT_wrapper(LAYOUT_LAYER_NAVIGATION), | |||
[LAYER_MEDIA] = LAYOUT_wrapper(LAYOUT_LAYER_MEDIA), | |||
[LAYER_NUMERAL] = LAYOUT_wrapper(LAYOUT_LAYER_NUMERAL), | |||
[LAYER_POINTER] = LAYOUT_wrapper(LAYOUT_LAYER_POINTER), | |||
[LAYER_SYMBOLS] = LAYOUT_wrapper(LAYOUT_LAYER_SYMBOLS), | |||
}; | |||
// 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(RGBLIGHT_MODE_STATIC_LIGHT); | |||
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 | |||
} |
@ -0,0 +1,63 @@ | |||
# Charybdis (3x5) `via` keymap | |||
The Charydbis (3x5) `via` keymap is based on a QWERTY layout with [home row mods](https://precondition.github.io/home-row-mods) and [Miryoku-inspired layers](https://github.com/manna-harbour/miryoku), and 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. | |||
This layout also supports VIA. | |||
## 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/uHEnqEN.png) |
@ -0,0 +1 @@ | |||
VIA_ENABLE = yes |
@ -0,0 +1,15 @@ | |||
# Charybdis Nano (3x5) | |||
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 4 layers. | |||
### [`via`](keymaps/via) | |||
A [Miryoku-inspired](https://github.com/manna-harbour/miryoku), feature-rich, keymap with VIA support. |
@ -0,0 +1,38 @@ | |||
# 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 nano is a split 3x5 keyboard with a maximum of 3 thumb keys (2 on | |||
# the trackball side). | |||
SPLIT_KEYBOARD = yes | |||
LAYOUTS = split_3x5_3 # Support community layout, in particular Manna-Harbour's Miryoku layout | |||
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 |
@ -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 |
@ -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 |
@ -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 |
@ -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 } | |||
] | |||
} | |||
} | |||
} |
@ -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 |
@ -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 |
@ -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. |
@ -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 |
@ -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 | |||
} |
@ -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) |
@ -0,0 +1 @@ | |||
VIA_ENABLE = yes |
@ -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. |
@ -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 |
@ -0,0 +1,343 @@ | |||
/* | |||
* 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 "charybdis.h" | |||
#ifdef CONSOLE_ENABLE | |||
# include "print.h" | |||
#endif // CONSOLE_ENABLE | |||
#ifdef POINTING_DEVICE_ENABLE | |||
# ifndef CHARYBDIS_MINIMUM_DEFAULT_DPI | |||
# define CHARYBDIS_MINIMUM_DEFAULT_DPI 400 | |||
# endif // CHARYBDIS_MINIMUM_DEFAULT_DPI | |||
# ifndef CHARYBDIS_DEFAULT_DPI_CONFIG_STEP | |||
# define CHARYBDIS_DEFAULT_DPI_CONFIG_STEP 200 | |||
# endif // CHARYBDIS_DEFAULT_DPI_CONFIG_STEP | |||
# ifndef CHARYBDIS_MINIMUM_SNIPING_DPI | |||
# define CHARYBDIS_MINIMUM_SNIPING_DPI 200 | |||
# endif // CHARYBDIS_MINIMUM_SNIPER_MODE_DPI | |||
# ifndef CHARYBDIS_SNIPING_DPI_CONFIG_STEP | |||
# define CHARYBDIS_SNIPING_DPI_CONFIG_STEP 100 | |||
# endif // CHARYBDIS_SNIPING_DPI_CONFIG_STEP | |||
// Fixed DPI for drag-scroll. | |||
# ifndef CHARYBDIS_DRAGSCROLL_DPI | |||
# define CHARYBDIS_DRAGSCROLL_DPI 100 | |||
# endif // CHARYBDIS_DRAGSCROLL_DPI | |||
# ifndef CHARYBDIS_DRAGSCROLL_BUFFER_SIZE | |||
# define CHARYBDIS_DRAGSCROLL_BUFFER_SIZE 6 | |||
# endif // !CHARYBDIS_DRAGSCROLL_BUFFER_SIZE | |||
# ifndef CHARYBDIS_POINTER_ACCELERATION_FACTOR | |||
# define CHARYBDIS_POINTER_ACCELERATION_FACTOR 24 | |||
# endif // !CHARYBDIS_POINTER_ACCELERATION_FACTOR | |||
typedef union { | |||
uint8_t raw; | |||
struct { | |||
uint8_t pointer_default_dpi : 4; // 16 steps available. | |||
uint8_t pointer_sniping_dpi : 2; // 4 steps available. | |||
bool is_dragscroll_enabled : 1; | |||
bool is_sniping_enabled : 1; | |||
} __attribute__((packed)); | |||
} charybdis_config_t; | |||
static charybdis_config_t g_charybdis_config = {0}; | |||
/** | |||
* \brief Set the value of `config` from EEPROM. | |||
* | |||
* Note that `is_dragscroll_enabled` and `is_sniping_enabled` are purposefully | |||
* ignored since we do not want to persist this state to memory. In practice, | |||
* this state is always written to maximize write-performances. Therefore, we | |||
* explicitly set them to `false` in this function. | |||
*/ | |||
static void read_charybdis_config_from_eeprom(charybdis_config_t* config) { | |||
config->raw = eeconfig_read_kb() & 0xff; | |||
config->is_dragscroll_enabled = false; | |||
config->is_sniping_enabled = false; | |||
} | |||
/** | |||
* \brief Save the value of `config` to eeprom. | |||
* | |||
* Note that all values are written verbatim, including whether drag-scroll | |||
* and/or sniper mode are enabled. `read_charybdis_config_from_eeprom(…)` | |||
* resets these 2 values to `false` since it does not make sense to persist | |||
* these across reboots of the board. | |||
*/ | |||
static void write_charybdis_config_to_eeprom(charybdis_config_t* config) { eeconfig_update_kb(config->raw); } | |||
/** \brief Return the current value of the pointer's default DPI. */ | |||
static uint16_t get_pointer_default_dpi(charybdis_config_t* config) { return (uint16_t)config->pointer_default_dpi * CHARYBDIS_DEFAULT_DPI_CONFIG_STEP + CHARYBDIS_MINIMUM_DEFAULT_DPI; } | |||
/** \brief Return the current value of the pointer's sniper-mode DPI. */ | |||
static uint16_t get_pointer_sniping_dpi(charybdis_config_t* config) { return (uint16_t)config->pointer_sniping_dpi * CHARYBDIS_SNIPING_DPI_CONFIG_STEP + CHARYBDIS_MINIMUM_SNIPING_DPI; } | |||
/** \brief Set the appropriate DPI for the input config. */ | |||
static void maybe_update_pointing_device_cpi(charybdis_config_t* config) { | |||
if (config->is_dragscroll_enabled) { | |||
pointing_device_set_cpi(CHARYBDIS_DRAGSCROLL_DPI); | |||
} else if (config->is_sniping_enabled) { | |||
pointing_device_set_cpi(get_pointer_sniping_dpi(config)); | |||
} else { | |||
pointing_device_set_cpi(get_pointer_default_dpi(config)); | |||
} | |||
} | |||
/** | |||
* \brief Update the pointer's default DPI to the next or previous step. | |||
* | |||
* Increases the DPI value if `forward` is `true`, decreases it otherwise. | |||
* The increment/decrement steps are equal to CHARYBDIS_DEFAULT_DPI_CONFIG_STEP. | |||
*/ | |||
static void step_pointer_default_dpi(charybdis_config_t* config, bool forward) { | |||
config->pointer_default_dpi += forward ? 1 : -1; | |||
maybe_update_pointing_device_cpi(config); | |||
} | |||
/** | |||
* \brief Update the pointer's sniper-mode DPI to the next or previous step. | |||
* | |||
* Increases the DPI value if `forward` is `true`, decreases it otherwise. | |||
* The increment/decrement steps are equal to CHARYBDIS_SNIPING_DPI_CONFIG_STEP. | |||
*/ | |||
static void step_pointer_sniping_dpi(charybdis_config_t* config, bool forward) { | |||
config->pointer_sniping_dpi += forward ? 1 : -1; | |||
maybe_update_pointing_device_cpi(config); | |||
} | |||
uint16_t charybdis_get_pointer_default_dpi(void) { return get_pointer_default_dpi(&g_charybdis_config); } | |||
uint16_t charybdis_get_pointer_sniping_dpi(void) { return get_pointer_sniping_dpi(&g_charybdis_config); } | |||
void charybdis_cycle_pointer_default_dpi_noeeprom(bool forward) { step_pointer_default_dpi(&g_charybdis_config, forward); } | |||
void charybdis_cycle_pointer_default_dpi(bool forward) { | |||
step_pointer_default_dpi(&g_charybdis_config, forward); | |||
write_charybdis_config_to_eeprom(&g_charybdis_config); | |||
} | |||
void charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward) { step_pointer_sniping_dpi(&g_charybdis_config, forward); } | |||
void charybdis_cycle_pointer_sniping_dpi(bool forward) { | |||
step_pointer_sniping_dpi(&g_charybdis_config, forward); | |||
write_charybdis_config_to_eeprom(&g_charybdis_config); | |||
} | |||
bool charybdis_get_pointer_sniping_enabled(void) { return g_charybdis_config.is_sniping_enabled; } | |||
void charybdis_set_pointer_sniping_enabled(bool enable) { | |||
g_charybdis_config.is_sniping_enabled = enable; | |||
maybe_update_pointing_device_cpi(&g_charybdis_config); | |||
} | |||
bool charybdis_get_pointer_dragscroll_enabled(void) { return g_charybdis_config.is_dragscroll_enabled; } | |||
void charybdis_set_pointer_dragscroll_enabled(bool enable) { | |||
g_charybdis_config.is_dragscroll_enabled = enable; | |||
maybe_update_pointing_device_cpi(&g_charybdis_config); | |||
} | |||
void pointing_device_init_kb(void) { maybe_update_pointing_device_cpi(&g_charybdis_config); } | |||
# ifndef CONSTRAIN_HID | |||
# define CONSTRAIN_HID(value) ((value) < -127 ? -127 : ((value) > 127 ? 127 : (value))) | |||
# endif // !CONSTRAIN_HID | |||
/** | |||
* \brief Add optional acceleration effect. | |||
* | |||
* If `CHARYBDIS_ENABLE_POINTER_ACCELERATION` is defined, add a simple and naive | |||
* acceleration effect to the provided value. Return the value unchanged | |||
* otherwise. | |||
*/ | |||
# ifndef DISPLACEMENT_WITH_ACCELERATION | |||
# ifdef CHARYBDIS_POINTER_ACCELERATION_ENABLE | |||
# define DISPLACEMENT_WITH_ACCELERATION(d) (CONSTRAIN_HID(d > 0 ? d * d / CHARYBDIS_POINTER_ACCELERATION_FACTOR + d : -d * d / CHARYBDIS_POINTER_ACCELERATION_FACTOR + d)) | |||
# else // !CHARYBDIS_POINTER_ACCELERATION_ENABLE | |||
# define DISPLACEMENT_WITH_ACCELERATION(d) (d) | |||
# endif // CHARYBDIS_POINTER_ACCELERATION_ENABLE | |||
# endif // !DISPLACEMENT_WITH_ACCELERATION | |||
/** | |||
* \brief Augment the pointing device behavior. | |||
* | |||
* Implement the Charybdis-specific features for pointing devices: | |||
* - Drag-scroll | |||
* - Sniping | |||
* - Acceleration | |||
*/ | |||
static void pointing_device_task_charybdis(report_mouse_t* mouse_report) { | |||
static int16_t scroll_buffer_x = 0; | |||
static int16_t scroll_buffer_y = 0; | |||
if (g_charybdis_config.is_dragscroll_enabled) { | |||
# ifdef CHARYBDIS_DRAGSCROLL_REVERSE_X | |||
scroll_buffer_x -= mouse_report->x; | |||
# else | |||
scroll_buffer_x += mouse_report->x; | |||
# endif // CHARYBDIS_DRAGSCROLL_REVERSE_X | |||
# ifdef CHARYBDIS_DRAGSCROLL_REVERSE_Y | |||
scroll_buffer_y -= mouse_report->y; | |||
# else | |||
scroll_buffer_y += mouse_report->y; | |||
# endif // CHARYBDIS_DRAGSCROLL_REVERSE_Y | |||
mouse_report->x = 0; | |||
mouse_report->y = 0; | |||
if (abs(scroll_buffer_x) > CHARYBDIS_DRAGSCROLL_BUFFER_SIZE) { | |||
mouse_report->h = scroll_buffer_x > 0 ? 1 : -1; | |||
scroll_buffer_x = 0; | |||
} | |||
if (abs(scroll_buffer_y) > CHARYBDIS_DRAGSCROLL_BUFFER_SIZE) { | |||
mouse_report->v = scroll_buffer_y > 0 ? 1 : -1; | |||
scroll_buffer_y = 0; | |||
} | |||
} else if (!g_charybdis_config.is_sniping_enabled) { | |||
mouse_report->x = DISPLACEMENT_WITH_ACCELERATION(mouse_report->x); | |||
mouse_report->y = DISPLACEMENT_WITH_ACCELERATION(mouse_report->y); | |||
} | |||
} | |||
report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) { | |||
if (is_keyboard_master()) { | |||
pointing_device_task_charybdis(&mouse_report); | |||
mouse_report = pointing_device_task_user(mouse_report); | |||
} | |||
return mouse_report; | |||
} | |||
# if defined(POINTING_DEVICE_ENABLE) && !defined(NO_CHARYBDIS_KEYCODES) | |||
/** \brief Whether SHIFT mod is enabled. */ | |||
static bool has_shift_mod(void) { | |||
# ifdef NO_ACTION_ONESHOT | |||
return mod_config(get_mods()) & MOD_MASK_SHIFT; | |||
# else | |||
return mod_config(get_mods() | get_oneshot_mods()) & MOD_MASK_SHIFT; | |||
# endif // NO_ACTION_ONESHOT | |||
} | |||
# endif // POINTING_DEVICE_ENABLE && !NO_CHARYBDIS_KEYCODES | |||
/** | |||
* \brief Outputs the Charybdis configuration to console. | |||
* | |||
* Prints the in-memory configuration structure to console, for debugging. | |||
* Includes: | |||
* - raw value | |||
* - drag-scroll: on/off | |||
* - sniping: on/off | |||
* - default DPI: internal table index/actual DPI | |||
* - sniping DPI: internal table index/actual DPI | |||
*/ | |||
static void debug_charybdis_config_to_console(charybdis_config_t* config) { | |||
# ifdef CONSOLE_ENABLE | |||
dprintf("(charybdis) process_record_kb: config = {\n" | |||
"\traw = 0x%04X,\n" | |||
"\t{\n" | |||
"\t\tis_dragscroll_enabled=%b\n" | |||
"\t\tis_sniping_enabled=%b\n" | |||
"\t\tdefault_dpi=0x%02X (%ld)\n" | |||
"\t\tsniping_dpi=0x%01X (%ld)\n" | |||
"\t}\n" | |||
"}\n", | |||
config->raw, config->is_dragscroll_enabled, config->is_sniping_enabled, config->pointer_default_dpi, get_pointer_default_dpi(config), config->pointer_sniping_dpi, get_pointer_sniping_dpi(config)); | |||
# endif // CONSOLE_ENABLE | |||
} | |||
bool process_record_kb(uint16_t keycode, keyrecord_t* record) { | |||
if (!process_record_user(keycode, record)) { | |||
debug_charybdis_config_to_console(&g_charybdis_config); | |||
return false; | |||
} | |||
# ifdef POINTING_DEVICE_ENABLE | |||
# ifndef NO_CHARYBDIS_KEYCODES | |||
switch (keycode) { | |||
case POINTER_DEFAULT_DPI_FORWARD: | |||
if (record->event.pressed) { | |||
// Step backward if shifted, forward otherwise. | |||
charybdis_cycle_pointer_default_dpi(/* forward= */ !has_shift_mod()); | |||
} | |||
break; | |||
case POINTER_DEFAULT_DPI_REVERSE: | |||
if (record->event.pressed) { | |||
// Step forward if shifted, backward otherwise. | |||
charybdis_cycle_pointer_default_dpi(/* forward= */ has_shift_mod()); | |||
} | |||
break; | |||
case POINTER_SNIPING_DPI_FORWARD: | |||
if (record->event.pressed) { | |||
// Step backward if shifted, forward otherwise. | |||
charybdis_cycle_pointer_sniping_dpi(/* forward= */ !has_shift_mod()); | |||
} | |||
break; | |||
case POINTER_SNIPING_DPI_REVERSE: | |||
if (record->event.pressed) { | |||
// Step forward if shifted, backward otherwise. | |||
charybdis_cycle_pointer_sniping_dpi(/* forward= */ has_shift_mod()); | |||
} | |||
break; | |||
case SNIPING_MODE: | |||
charybdis_set_pointer_sniping_enabled(record->event.pressed); | |||
break; | |||
case SNIPING_MODE_TOGGLE: | |||
if (record->event.pressed) { | |||
charybdis_set_pointer_sniping_enabled(!charybdis_get_pointer_sniping_enabled()); | |||
} | |||
break; | |||
case DRAGSCROLL_MODE: | |||
charybdis_set_pointer_dragscroll_enabled(record->event.pressed); | |||
break; | |||
case DRAGSCROLL_MODE_TOGGLE: | |||
if (record->event.pressed) { | |||
charybdis_set_pointer_dragscroll_enabled(!charybdis_get_pointer_dragscroll_enabled()); | |||
} | |||
break; | |||
} | |||
# endif // !NO_CHARYBDIS_KEYCODES | |||
# ifndef MOUSEKEY_ENABLE | |||
// Simulate mouse keys if full support is not enabled (reduces firmware size | |||
// while maintaining support for mouse keys). | |||
if (IS_MOUSEKEY_BUTTON(keycode)) { | |||
report_mouse_t mouse_report = pointing_device_get_report(); | |||
mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, record->event.pressed, keycode - KC_MS_BTN1); | |||
pointing_device_set_report(mouse_report); | |||
pointing_device_send(); | |||
} | |||
# endif // !MOUSEKEY_ENABLE | |||
# endif // POINTING_DEVICE_ENABLE | |||
debug_charybdis_config_to_console(&g_charybdis_config); | |||
return true; | |||
} | |||
void eeconfig_init_kb(void) { | |||
g_charybdis_config.raw = 0; | |||
write_charybdis_config_to_eeprom(&g_charybdis_config); | |||
maybe_update_pointing_device_cpi(&g_charybdis_config); | |||
eeconfig_init_user(); | |||
} | |||
void matrix_init_kb(void) { | |||
read_charybdis_config_from_eeprom(&g_charybdis_config); | |||
matrix_init_user(); | |||
} | |||
#endif // POINTING_DEVICE_ENABLE |
@ -0,0 +1,126 @@ | |||
/* | |||
* 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 | |||
// clang-format off | |||
#if defined(KEYBOARD_bastardkb_charybdis_3x5) | |||
# include "3x5.h" | |||
#elif defined(KEYBOARD_bastardkb_charybdis_4x6) | |||
# include "4x6.h" | |||
#else | |||
# error "Unsuported format" | |||
#endif | |||
// clang-format on | |||
#include "quantum.h" | |||
#ifdef POINTING_DEVICE_ENABLE | |||
# ifndef NO_CHARYBDIS_KEYCODES | |||
enum charybdis_keycodes { | |||
# ifdef VIA_ENABLE | |||
POINTER_DEFAULT_DPI_FORWARD = USER00, | |||
# else | |||
POINTER_DEFAULT_DPI_FORWARD = SAFE_RANGE, | |||
# endif // VIA_ENABLE | |||
POINTER_DEFAULT_DPI_REVERSE, | |||
POINTER_SNIPING_DPI_FORWARD, | |||
POINTER_SNIPING_DPI_REVERSE, | |||
SNIPING_MODE, | |||
SNIPING_MODE_TOGGLE, | |||
DRAGSCROLL_MODE, | |||
DRAGSCROLL_MODE_TOGGLE, | |||
CHARYBDIS_SAFE_RANGE, | |||
}; | |||
# define DPI_MOD POINTER_DEFAULT_DPI_FORWARD | |||
# define DPI_RMOD POINTER_DEFAULT_DPI_REVERSE | |||
# define S_D_MOD POINTER_SNIPING_DPI_FORWARD | |||
# define S_D_RMOD POINTER_SNIPING_DPI_REVERSE | |||
# define SNIPING SNIPING_MODE | |||
# define SNP_TOG SNIPING_MODE_TOGGLE | |||
# define DRGSCRL DRAGSCROLL_MODE | |||
# define DRG_TOG DRAGSCROLL_MODE_TOGGLE | |||
# endif // !NO_CHARYBDIS_KEYCODES | |||
/** \brief Return the current DPI value for the pointer's default mode. */ | |||
uint16_t charybdis_get_pointer_default_dpi(void); | |||
/** | |||
* \brief Update the pointer's default DPI to the next or previous step. | |||
* | |||
* Increases the DPI value if `forward` is `true`, decreases it otherwise. | |||
* The increment/decrement steps are equal to CHARYBDIS_DEFAULT_DPI_CONFIG_STEP. | |||
* | |||
* The new value is persisted in EEPROM. | |||
*/ | |||
void charybdis_cycle_pointer_default_dpi(bool forward); | |||
/** | |||
* \brief Same as `charybdis_cycle_pointer_default_dpi`, but do not write to | |||
* EEPROM. | |||
* | |||
* This means that reseting the board will revert the value to the last | |||
* persisted one. | |||
*/ | |||
void charybdis_cycle_pointer_default_dpi_noeeprom(bool forward); | |||
/** \brief Return the current DPI value for the pointer's sniper-mode. */ | |||
uint16_t charybdis_get_pointer_sniping_dpi(void); | |||
/** | |||
* \brief Update the pointer's sniper-mode DPI to the next or previous step. | |||
* | |||
* Increases the DPI value if `forward` is `true`, decreases it otherwise. | |||
* The increment/decrement steps are equal to CHARYBDIS_SNIPING_DPI_CONFIG_STEP. | |||
* | |||
* The new value is persisted in EEPROM. | |||
*/ | |||
void charybdis_cycle_pointer_sniping_dpi(bool forward); | |||
/** | |||
* \brief Same as `charybdis_cycle_pointer_sniping_dpi`, but do not write to | |||
* EEPROM. | |||
* | |||
* This means that reseting the board will revert the value to the last | |||
* persisted one. | |||
*/ | |||
void charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward); | |||
/** \brief Whether sniper-mode is enabled. */ | |||
bool charybdis_get_pointer_sniping_enabled(void); | |||
/** | |||
* \brief Enable/disable sniper mode. | |||
* | |||
* When sniper mode is enabled the dpi is reduced to slow down the pointer for | |||
* more accurate movements. | |||
*/ | |||
void charybdis_set_pointer_sniping_enabled(bool enable); | |||
/** \brief Whether drag-scroll is enabled. */ | |||
bool charybdis_get_pointer_dragscroll_enabled(void); | |||
/** | |||
* \brief Enable/disable drag-scroll mode. | |||
* | |||
* When drag-scroll mode is enabled, horizontal and vertical pointer movements | |||
* are translated into horizontal and vertical scroll movements. | |||
*/ | |||
void charybdis_set_pointer_dragscroll_enabled(bool enable); | |||
#endif // POINTING_DEVICE_ENABLE |
@ -0,0 +1,35 @@ | |||
/* | |||
* 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 "config_common.h" | |||
/* Pointing device configuration. */ | |||
// Enable use of pointing device on slave split. | |||
#define SPLIT_POINTING_ENABLE | |||
// Pointing device is on the right split. | |||
#define POINTING_DEVICE_RIGHT | |||
// Limits the frequency that the sensor is polled for motion. | |||
#define POINTING_DEVICE_TASK_THROTTLE_MS 1 | |||
/** \brief Invert X axis on mouse reports. */ | |||
#define POINTING_DEVICE_INVERT_X |
@ -0,0 +1,109 @@ | |||
/* | |||
* Copyright 2012 Jun Wako <wakojun@gmail.com> | |||
* Copyright 2015 Jack Humbert | |||
* 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 | |||
/* Mouse config. */ | |||
#ifndef MOUSEKEY_MOVE_DELTA | |||
# ifndef MK_KINETIC_SPEED | |||
# define MOUSEKEY_MOVE_DELTA 5 | |||
# else // MK_KINETIC_SPEED | |||
# define MOUSEKEY_MOVE_DELTA 25 | |||
# endif // !MK_KINETIC_SPEED | |||
#endif // !MOUSEKEY_MOVE_DELTA | |||
#ifndef MOUSEKEY_DELAY | |||
# ifndef MK_KINETIC_SPEED | |||
# define MOUSEKEY_DELAY 300 | |||
# else // MK_KINETIC_SPEED | |||
# define MOUSEKEY_DELAY 8 | |||
# endif // !MK_KINETIC_SPEED | |||
#endif // !MOUSEKEY_DELAY | |||
#ifndef MOUSEKEY_INTERVAL | |||
# ifndef MK_KINETIC_SPEED | |||
# define MOUSEKEY_INTERVAL 50 | |||
# else // MK_KINETIC_SPEED | |||
# define MOUSEKEY_INTERVAL 20 | |||
# endif // !MK_KINETIC_SPEED | |||
#endif // !MOUSEKEY_INTERNAL | |||
#ifndef MOUSEKEY_MAX_SPEED | |||
# define MOUSEKEY_MAX_SPEED 7 | |||
#endif // !MOUSEKEY_MAX_SPEED | |||
#ifndef MOUSEKEY_TIME_TO_MAX | |||
# define MOUSEKEY_TIME_TO_MAX 60 | |||
#endif // !MOUSEKEY_TIME_TO_MAX | |||
#ifndef MOUSEKEY_INITIAL_SPEED | |||
# define MOUSEKEY_INITIAL_SPEED 100 | |||
#endif // !MOUSEKEY_INITIAL_SPEED | |||
#ifndef MOUSEKEY_BASE_SPEED | |||
# define MOUSEKEY_BASE_SPEED 1000 | |||
#endif // !MOUSEKEY_BASE_SPEED | |||
#ifndef MOUSEKEY_DECELERATED_SPEED | |||
# define MOUSEKEY_DECELERATED_SPEED 400 | |||
#endif // !MOUSEKEY_DECELERATED_SPEED | |||
#ifndef MOUSEKEY_ACCELERATED_SPEED | |||
# define MOUSEKEY_ACCELERATED_SPEED 3000 | |||
#endif // !MOUSEKEY_ACCELERATED_SPEED | |||
/* Mouse scroll config. */ | |||
#ifndef MOUSEKEY_WHEEL_DELAY | |||
# define MOUSEKEY_WHEEL_DELAY 15 | |||
#endif // !MOUSEKEY_WHEEL_DELAY | |||
#ifndef MOUSEKEY_WHEEL_DELTA | |||
# define MOUSEKEY_WHEEL_DELTA 1 | |||
#endif // !MOUSEKEY_WHEEL_DELTA | |||
#ifndef MOUSEKEY_WHEEL_INTERVAL | |||
# define MOUSEKEY_WHEEL_INTERVAL 50 | |||
#endif // !MOUSEKEY_WHEEL_INTERVAL | |||
#ifndef MOUSEKEY_WHEEL_MAX_SPEED | |||
# define MOUSEKEY_WHEEL_MAX_SPEED 8 | |||
#endif // !MOUSEKEY_WHEEL_MAX_SPEED | |||
#ifndef MOUSEKEY_WHEEL_TIME_TO_MAX | |||
# define MOUSEKEY_WHEEL_TIME_TO_MAX 80 | |||
#endif // !MOUSEKEY_WHEEL_TIME_TO_MAX | |||
#ifndef MOUSEKEY_WHEEL_INITIAL_MOVEMENTS | |||
# define MOUSEKEY_WHEEL_INITIAL_MOVEMENTS 8 | |||
#endif // !MOUSEKEY_WHEEL_INITIAL_MOVEMENTS | |||
#ifndef MOUSEKEY_WHEEL_BASE_MOVEMENTS | |||
# define MOUSEKEY_WHEEL_BASE_MOVEMENTS 48 | |||
#endif // !MOUSEKEY_WHEEL_BASE_MOVEMENTS | |||
#ifndef MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS | |||
# define MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS 48 | |||
#endif // !MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS | |||
#ifndef MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS | |||
# define MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS 8 | |||
#endif // !MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS |
@ -0,0 +1,178 @@ | |||
# Charybdis (6x4, 5x3 "Nano") | |||
An ergonomic keyboard with integrated trackball. | |||
Engineered to be a full mouse replacement solution with high-quality, custom-developed components. | |||
There are 6x4 and 5x3 "Nano" versions. | |||
- Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb) | |||
- Hardware Supported: elite-C V4 | |||
- Hardware Availability: [Bastard Keyboards](https://bastardkb.com) | |||
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 the [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | |||
Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charybdis and other ergonomic keyboards. | |||
## Building the firmware | |||
### Charybdis (4x6) | |||
The `default` keymap is inspired from the original [Dactyl Manuform](../../handwired/dactyl_manuform) layout. | |||
```shell | |||
qmk compile -kb bastardkb/charybdis/4x6 -km default | |||
``` | |||
Check out the `via` layout if you're looking for VIA support: | |||
```shell | |||
qmk compile -kb bastardkb/charybdis/4x6 -km via | |||
``` | |||
### Charybdis (3x5) | |||
The `default` keymap is inspired from the original [Dactyl Manuform](../../handwired/dactyl_manuform) layout. | |||
```shell | |||
qmk compile -kb bastardkb/charybdis/3x5 -km default | |||
``` | |||
Check out the `via` layout if you're looking for VIA support: | |||
```shell | |||
qmk compile -kb bastardkb/charybdis/3x5 -km via | |||
``` | |||
## Customizing the firmware | |||
### Dynamic DPI scaling | |||
The pointer's DPI can be changed at runtime. | |||
By default, the DPI is set to `400`. The Charybdis supports up to 16 different DPI values. By default, it cycles between `400` and `3400`, with a step of `200` (_ie._ `400`, `600`, `800`, …, `3400`). | |||
Calling `charybdis_cycle_pointer_default_dpi(bool forward)` will cycle forward or backward the possible values. | |||
Use `charybdis_cycle_pointer_default_dpi_noeeprom(bool forward)` to change the DPI value without persisting the change to EEPROM (_ie._ resetting the board will revert to the last saved value). | |||
`charybdis_get_pointer_default_dpi()` returns the current DPI value. | |||
This behavior can be further customized with the following defines: | |||
```c | |||
#define CHARYBDIS_MINIMUM_DEFAULT_DPI 400 | |||
#define CHARYBDIS_DEFAULT_DPI_CONFIG_STEP 200 | |||
``` | |||
### Drag-scroll | |||
Drag-scroll enables scrolling with the trackball. When drag-scroll is enabled, the trackball's `x` and `y` movements are converted into `h` (horizontal) and `v` (vertical) movement, effectively sending scroll instructions to the host system. | |||
Call `charybdis_set_pointer_dragscroll_enabled(bool enable)` to enable/disable drag-scroll. | |||
`charybdis_get_pointer_dragscroll_enabled()` returns whether sniping mode is currently enabled. | |||
To invert the horizontal scrolling direction, define `CHARYBDIS_DRAGSCROLL_REVERSE_X`: | |||
```c | |||
#define CHARYBDIS_DRAGSCROLL_REVERSE_X | |||
``` | |||
To invert the vertical scrolling direction (_ie._ mimic macOS "natural" scroll direction), define `CHARYBDIS_DRAGSCROLL_REVERSE_Y`: | |||
```c | |||
#define CHARYBDIS_DRAGSCROLL_REVERSE_Y | |||
``` | |||
This only affects the vertical scroll direction. | |||
### Sniping mode | |||
Sniping mode slows down the pointer for more precise gestures. It is useful when combined with a higher default DPI. | |||
Call `charybdis_set_pointer_sniping_enabled(bool enable)` to enable/disable sniping mode. | |||
`charybdis_get_pointer_sniping_enabled()` returns whether sniping mode is currently enabled. | |||
Like the default pointer's DPI, the sniper mode DPI can be changed at runtime. | |||
By default, sniping mode lowers the DPI to `200`. This can be changed at runtime: the Charybdis supports up to 4 different DPI values for sniping mode. By default, it cycles between `200`, `300`, `400` and `500`. | |||
Calling `charybdis_cycle_pointer_sniping_dpi(bool forward)` will cycle forward or backward the possible values. | |||
Use `charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward)` to change the sniping mode DPI value without persisting the change to EEPROM (_ie._ resetting the board will revert to the last saved value). | |||
`charybdis_get_pointer_sniping_dpi()` returns the current sniping mode DPI value. | |||
This behavior can be further customized with the following defines: | |||
```c | |||
#define CHARYBDIS_MINIMUM_SNIPING_DPI 200 | |||
#define CHARYBDIS_SNIPING_DPI_CONFIG_STEP 100 | |||
``` | |||
### Acceleration | |||
By default, the pointer's movements are linear. To enable acceleration, add the following define: | |||
```c | |||
#define CHARYBDIS_POINTER_ACCELERATION_ENABLE | |||
``` | |||
The acceleration factor can be further tune _via_ the `CHARYBDIS_POINTER_ACCELERATION_FACTOR`: | |||
```c | |||
#define CHARYBDIS_POINTER_ACCELERATION_FACTOR 24 | |||
``` | |||
### Custom keycodes | |||
The Charybdis firmware defines a number of keycodes to leverage its features, namely: | |||
``` | |||
#ifndef NO_CHARYBDIS_KEYCODES | |||
enum charybdis_keycodes { | |||
POINTER_DEFAULT_DPI_FORWARD = SAFE_RANGE, | |||
POINTER_DEFAULT_DPI_REVERSE, | |||
POINTER_SNIPING_DPI_FORWARD, | |||
POINTER_SNIPING_DPI_REVERSE, | |||
SNIPING_MODE, | |||
SNIPING_MODE_TOGGLE, | |||
DRAGSCROLL_MODE, | |||
DRAGSCROLL_MODE_TOGGLE, | |||
CHARYBDIS_SAFE_RANGE, | |||
}; | |||
#define DPI_MOD POINTER_DEFAULT_DPI_FORWARD | |||
#define DPI_RMOD POINTER_DEFAULT_DPI_REVERSE | |||
#define S_D_MOD POINTER_SNIPING_DPI_FORWARD | |||
#define S_D_RMOD POINTER_SNIPING_DPI_REVERSE | |||
#define SNIPING SNIPING_MODE | |||
#define SNP_TOG SNIPING_MODE_TOGGLE | |||
#define DRGSCRL DRAGSCROLL_MODE | |||
#define DRG_TOG DRAGSCROLL_MODE_TOGGLE | |||
#endif // !NO_CHARYBDIS_KEYCODES | |||
``` | |||
Users extending the keycode set themselves (either in their keymap, or in their userspace) must start at `CHARYBDIS_SAFE_RANGE` to avoid conflicts, _eg._: | |||
```c | |||
enum userspace_keycodes { | |||
#ifndef NO_CHARYBDIS_KEYCODES | |||
MY_FIRST_KEYCODE = CHARYBDIS_SAFE_RANGE, | |||
#else | |||
MY_FIRST_KEYCODE = SAFE_RANGE, | |||
#endif // !NO_CHARYBDIS_KEYCODES | |||
MY_SECOND_KEYCODE, | |||
… | |||
}; | |||
``` | |||
To disable the custom keycodes, and reduce binary size, simply add a definition in `config.h`: | |||
```c | |||
#define NO_CHARYBDIS_KEYCODES | |||
``` |