Table of contents

  1. Table of contents
  2. Introduction
  3. Charybdis features
    1. Charybdis stock keymap
    2. Trackball related features
      1. DPI
      2. Sniping
      3. Auto sniping on layer
      4. Auto pointer layer
      5. Drag-scroll
    3. Configuration Syncing

Introduction

All the features listed below are available in the Charybdis vendor keymaps.

The vendor keymap aims at providing a consistent experience out of the box. Because some features can be mutually exclusive (e.g. Auto sniping on layer and Auto pointer layer), not all features are enabled by default. It may be necessary to rebuild the firmware to enable or disable some of the features listed below.

Charybdis features

Charybdis stock keymap

Custom features were developed for the Charybdis, and have since been ported to QMK core.

For each feature, there are:

  • custom keycodes you can implement in VIA or when compiling your own firmware
  • custom defines to change the behavior of the feature
  • custom functions you can call to read or write options

Those are detailed below.

DPI

DPI (i.e. dots per linear inch), a.k.a. mouse sensitivity, can be controlled by the firmware. The Charybdis keymap offers 2 different DPI settings:

  • Default DPI: the sensitivity of the pointer in normal mode.
  • Sniping DPI: the sensitivity of the pointer in sniping mode

For each mode, the firmware allows cycling through multiple pre-defined values.

  • Default mode:
    • Default value: 400 DPI
    • 16 steps available
    • Increments of 200 DPI
    • Total range from 400 to 3,400 (400 → 600 → 800 → … → 3,400)
  • Sniping mode:
    • Default value: 200 DPI
    • 4 steps available
    • Increments of 100 DPI
    • Total range from 200 to 500 (200 → 300 → 400 → 500)

The firmware cycles through these values, which means that, for example, incrementing the sniping DPI of 500 by 1 step will loop back to 200.

You can cycle through those values by using custom keycodes (also present in the default keymap), and also [modify those values in your own firmware if needed.](#changing-dynamic-dpi-scaling-default-and-increment-values].

Custom keycodes:

Name Description
DPI_MOD increase the sensitivity of the pointer movement by one step
DPI_RMOD decrease the sensitivity of the pointer movement by one step

Custom defines (with default values):

#define CHARYBDIS_MINIMUM_DEFAULT_DPI 400
#define CHARYBDIS_DEFAULT_DPI_CONFIG_STEP 200

Custom functions:

charybdis_cycle_pointer_default_dpi(bool forward) // cycle forward or backward the possible values
charybdis_cycle_pointer_default_dpi_noeeprom(bool forward) // cycle forward or backward the possible values without persisting the change to EEPROM
charybdis_get_pointer_default_dpi() // returns the current DPI value

Sniping

Sniping mode slows down the pointer for more precise gestures. It is useful when combined with a higher default DPI. Like the default pointer’s DPI, the sniper mode DPI can be changed at runtime

Custom Keycodes:

Name Description
S_D_MOD increase the sensitivity of the pointer movement in sniping mode by one step
S_D_RMOD decrease the sensitivity of the pointer movement in sniping mode by one step
SNIPING enable sniping mode as long as the key is pressed
SNP_TOG toggle sniping mode on and off

Custom defines (with default values):

#define CHARYBDIS_MINIMUM_SNIPING_DPI 200
#define CHARYBDIS_SNIPING_DPI_CONFIG_STEP 100

Custom functions:

charybdis_set_pointer_sniping_enabled(bool enable) // enable/disable sniping mode
charybdis_get_pointer_sniping_enabled() // returns whether sniping mode is currently enabled
charybdis_cycle_pointer_sniping_dpi(bool forward) // cycle forward or backward the possible values
charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward) // cycle forward or backward the possible values without persisting the change to EEPROM
charybdis_get_pointer_sniping_dpi() // returns the current sniping mode DPI value

Auto sniping on layer

You can trigger sniping automatically when on a specific layer by adjusting the following in your keymap:

#define CHARYBDIS_AUTO_SNIPING_ON_LAYER LAYER_POINTER

Auto pointer layer

You can trigger the pointer layer automatically upon moving the trackball by adjusting the following in your keymap:

#define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_ENABLE
#define CHARYBDIS_AUTO_POINTER_LAYER_TRIGGER_TIMEOUT_MS 1000

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.

Custom keycodes:

Name Description
DRGSCRL enable drag-scroll mode as long as the key is pressed
DRG_TOG toggle drag-scroll mode on and off

Custom functions:

charybdis_set_pointer_dragscroll_enabled(bool enable) // enable/disable drag-scroll
charybdis_get_pointer_dragscroll_enabled() // returns whether drag-scroll mode is currently enabled

Custom defines:

#define CHARYBDIS_DRAGSCROLL_REVERSE_X // inverts horizontal scrolling 
#define CHARYBDIS_DRAGSCROLL_REVERSE_Y // inverts vertical scrolling

Configuration Syncing

If you want/need to enable syncing of the charybdis config, such as to read the sniping or drag scroll modes on the other half (e.g. for displaying the status via rgb matrix, or added on screens), you can enabled this. To do so, add this to your config.h:

#define CHARYBDIS_CONFIG_SYNC

Please note that you will need to reflash both sides when enabling this.