qmk_firmare/keyboards/fingerpunch

fingerpunch keyboards

Operating system

Setting	Description	Default
FP_MAC_PREFERRED	(Optional) If you are primarily using a Mac, enable to use Mac specific logic for fingerpunch features (mostly for keycodes)	undefined

Keycodes and settings

Settings

Setting	Description	Default
FP_DISABLE_CUSTOM_KEYCODES	(Optional) Disables all the custom keycodes defined in the Keycodes section on this page	undefined
FP_SUPER_TAB_TIMEOUT	(Required) Sets the timeout (in milliseconds) for the alt tab (using keycode FP_SUPER_TAB) to go away	500

Keycodes

Key	Description
FP_SCROLL_TOG	Pointing Device: Toggle scrolling mode
FP_SCROLL_ON	Pointing Device: Turn on scrolling mode
FP_SCROLL_OFF	Pointing Device: Turn off scrolling mode
FP_SNIPE_TOG	Pointing Device: Toggle sniping mode
FP_SNIPE_ON	Pointing Device: Turn on sniping mode
FP_SNIPE_OFF	Pointing Device: Turn off sniping mode
FP_SUPER_TAB	Super alt tab, tap to alt tab instead of holding alt, supports holding shift to alt tab backwards (to use on Mac, see FP_MAC_PREFERRED and see FP_SUPER_TAB_TIMEOUT to change timeout)

Note: if you are using a userspace, and you have custom keycodes, you will need to add some logic in your userspace keycodes .h file that will handle the SAFE_RANGE appropriately.

// Check to see which keyboard you're using, and define the PLACEHOLDER_SAFE_RANGE based on that.
#if defined(KEYBOARD_fingerpunch_arachnophobe) \
    || defined(KEYBOARD_fingerpunch_barobord) \
    || defined(KEYBOARD_fingerpunch_barobord_byomcu) \
    || defined(KEYBOARD_fingerpunch_bgkeeb) \
    || defined(KEYBOARD_fingerpunch_bigbarobord) \
    || defined(KEYBOARD_fingerpunch_euclid36) \
    || defined(KEYBOARD_fingerpunch_euclid36_proto) \
    || defined(KEYBOARD_fingerpunch_ffkb) \
    || defined(KEYBOARD_fingerpunch_ffkb_byomcu_v1) \
    || defined(KEYBOARD_fingerpunch_ffkb_byomcu_v2) \
    || defined(KEYBOARD_fingerpunch_ffkb_byomcu_v3) \
    || defined(KEYBOARD_fingerpunch_luakeeb) \
    || defined(KEYBOARD_fingerpunch_pinkiesout) \
    || defined(KEYBOARD_fingerpunch_rockon_v1) \
    || defined(KEYBOARD_fingerpunch_rockon_v2) \
    || defined(KEYBOARD_fingerpunch_rockon_v3) \
    || defined(KEYBOARD_fingerpunch_rockon_bp) \
    || defined(KEYBOARD_fingerpunch_sweeeeep) \
    || defined(KEYBOARD_fingerpunch_ximi)
#    define PLACEHOLDER_SAFE_RANGE FP_SAFE_RANGE
#else
#    define PLACEHOLDER_SAFE_RANGE SAFE_RANGE
#endif

enum userspace_custom_keycodes {
    YOUR_KEYCODE_1 = PLACEHOLDER_SAFE_RANGE,
    YOUR_KEYCODE_2,
...
    NEW_SAFE_RANGE,
}

Pointing Device

General Settings

Setting	Description	Default
FP_POINTING_DEFAULT_DPI	(Required) Sets the default DPI for your pointing device	1000
FP_POINTING_SCROLLING_DPI	(Required) Sets the default DPI for scrolling	50
FP_POINTING_SCROLLING_LAYER_ENABLE	(Optional) Enables scrolling mode for the layer FP_POINTING_SCROLLING_LAYER	undefined
FP_POINTING_SCROLLING_LAYER	(Required) Defines the layer used to enable scrolling	3 (_RAISE on default keymap)
FP_POINTING_SNIPING_DPI	(Required) Sets the default DPI for scrolling	50
FP_POINTING_SNIPING_LAYER_ENABLE	(Required) Enables scrolling mode for the layer FP_POINTING_SNIPING_LAYER	undefined
FP_POINTING_SNIPING_LAYER	(Required) Defines the layer used to enable sniping	2 (_LOWER on default keymap)

Combined Pointing Devices

This only applies if you are using a split fingerpunch keyboard with two pointing devices. The default is for the left one to be scrolling, and the right one to act as the mouse, but this is configurable via FP_POINTING_COMBINED_SCROLLING_LEFT and FP_POINTING_COMBINED_SCROLLING_RIGHT

Setting	Description	Default
FP_POINTING_COMBINED_SCROLLING_LEFT	(Required) Sets default behavior to scrolling on the left half	true
FP_POINTING_COMBINED_SCROLLING_RIGHT	(Required) Sets default behavior to scrolling on the right half	false

Auto mouse layer

As of 2022-09-26, this has been pulled in early from qmk develop, but should be available in the Q4 release. See the documentation here: https://github.com/qmk/qmk_firmware/blob/develop/docs/feature_pointing_device.md#automatic-mouse-layer-idpointing-device-auto-mouse

This is fully supported. Once I merge the next major release in Q4, I will remove this documentation.

In addition to the default configurations, there are additional features added to fingerpunch keyboards:

Setting	Description	Default
FP_AUTO_MOUSE_TRACKBALL_SENSITIVITY	(Required) Trackball auto mouse sensitivity value	3

(Additional auto mouse configuration in the layer lighting section)

More detail on FP_AUTO_MOUSE_TRACKBALL_SENSITIVITY. If you are experiencing that the auto mouse layer triggers while typing, you can adjust this value. The default for for the core qmk feature is 0, which works great for trackpads. As you increase, it will require more mouse movement to trigger auto mouse layer. The default for trackballs on fingerpunch keyboards is 3. This value is only applied if you are using a trackball, and is otherwise ignored.

Note that I'm automatically enabling the feature if you add the POINTING_DEVICE_AUTO_MOUSE_ENABLE and AUTO_MOUSE_DEFAULT_LAYER to your config.h, such that you don't have to add this code:

// in keymap.c:
void pointing_device_init_user(void) {
    set_auto_mouse_layer(<mouse_layer>); // only required if AUTO_MOUSE_DEFAULT_LAYER is not set to index of <mouse_layer>
    set_auto_mouse_enable(true);         // always required before the auto mouse feature will work
}

RGB Lighting

Notes:

• Unless otherwise specified, features for rgb are supported on both rgblight ( https://github.com/qmk/qmk_firmware/blob/master/docs/feature_rgblight.md ) and rgb matrix ( https://github.com/qmk/qmk_firmware/blob/master/docs/feature_rgb_matrix.md ).
• The base layer is still configurable using the QMK rgb keycodes ( https://github.com/qmk/qmk_firmware/blob/master/docs/feature_rgblight.md#keycodes ). If you want the base layer to be static, you will need to define the FP_LAYER_LIGHTING_DYNAMIC_BASE_LAYER_DISABLE config.

Some config parameters will depend on which you're using, like FP_LAYER_LIGHTING_MODE.

Layer lighting

Please note that the FP_LAYER_LIGHTING_AUTO_MOUSE_ENABLE will be automatically disabled unless you define FP_LAYER_LIGHTING_DISABLE. Given that this fingerpunch layer lighting will handle the auto mouse layer as well, you don't need to activate the layer lighting twice. Just set the mouse layer lighting to the color you prefer using the FP_LAYER_LIGHTING_HUE_X below.

Setting	Description	Default
FP_STARTUP_ANIMATION_DISABLE	(Optional) Define this to disable startup animation
FP_LAYER_LIGHTING_DISABLE	(Optional) Define this to disable layer lighting	undefined
FP_LAYER_LIGHTING_DYNAMIC_BASE_LAYER_DISABLE	(Optional) While using layer lighting, disable dynamically changing the base layer	undefined
FP_LAYER_LIGHTING_MODE	(Required) Set the layer lighting default mode	RGBLIGHT_MODE_STATIC_LIGHT or RGB_MATRIX_SOLID_COLOR
FP_LAYER_LIGHTING_HUE_0	(Required) Set the layer lighting hue for layer 0	HSV_BLUE
FP_LAYER_LIGHTING_HUE_1	(Required) Set the layer lighting hue for layer 1	HSV_WHITE
FP_LAYER_LIGHTING_HUE_2	(Required) Set the layer lighting hue for layer 2	HSV_GREEN
FP_LAYER_LIGHTING_HUE_3	(Required) Set the layer lighting hue for layer 3	HSV_PURPLE
FP_LAYER_LIGHTING_HUE_4	(Required) Set the layer lighting hue for layer 4	HSV_YELLOW
FP_LAYER_LIGHTING_HUE_5	(Required) Set the layer lighting hue for layer 5	FP_HSV_MELON
FP_LAYER_LIGHTING_HUE_6	(Required) Set the layer lighting hue for layer 6	HSV_CYAN
FP_LAYER_LIGHTING_HUE_7	(Required) Set the layer lighting hue for layer 7	HSV_SPRINGGREEN
FP_LAYER_LIGHTING_MODE_0	(Required) Set the layer lighting mode for layer 0	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_1	(Required) Set the layer lighting mode for layer 1	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_2	(Required) Set the layer lighting mode for layer 2	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_3	(Required) Set the layer lighting mode for layer 3	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_4	(Required) Set the layer lighting mode for layer 4	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_5	(Required) Set the layer lighting mode for layer 5	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_6	(Required) Set the layer lighting mode for layer 6	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_MODE_7	(Required) Set the layer lighting mode for layer 7	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_CAPS_LOCK_HUE	(Required) Set the layer lighting hue when caps lock is enabled	HSV_RED
FP_LAYER_LIGHTING_CAPS_LOCK_MODE	(Required) Set the layer lighting mode when caps lock is enabled	FP_LAYER_LIGHTING_MODE
FP_LAYER_LIGHTING_AUTO_MOUSE_ENABLE	(Optional) If using RGB, set the layer lighting when auto mouse is triggered	undefined
FP_LAYER_LIGHTING_AUTO_MOUSE_HUE	(Required) This is the hue that is used for the auto mouse layer lighting	HSV_ORANGE
FP_LAYER_LIGHTING_AUTO_MOUSE_MODE	(Required) This is the mode that is used for the auto mouse layer lighting	FP_LAYER_LIGHTING_MODE

Additional colors

Define	HSV	Reference
FP_HSV_LAVENDER	184, 200, 255	https://encycolorpedia.com/ccb3ff
FP_HSV_LEMON	43, 200, 255	https://encycolorpedia.com/ffff9f
FP_HSV_LIME	63, 225, 255	https://encycolorpedia.com/9efd38
FP_HSV_MELON	0, 180, 255	https://encycolorpedia.com/febaad
FP_HSV_MINT	84, 185, 255	https://encycolorpedia.com/98ff98

Haptic Feedback

Enable special haptic feedback features.

Note that the ctrl-X haptic feedback responses will use control as the modifier, so it won't work on a Mac by default. However, if are primarily using a Mac, enable the FP_MAC_PREFERRED in your config.h

Setting	Description	Default
FP_HAPTIC_MOUSE_BUTTONS	(Optional) Enable haptic feedback response for Mouse 1, 2, and 3	undefined
FP_HAPTIC_CUT_COPY_PASTE	(Optional) Enable haptic feedback response for ctrl-x, ctrl-c, ctrl-v	undefined
FP_HAPTIC_SAVE	(Optional) Enable haptic feedback response for ctrl-s	undefined

Keymap

If you are looking to use process_record_kb() or process_record

Debugging

Setting	Description	Default
FP_SR595_MATRIX_DEBUG	(Optional) Enable debugging the 74hc595 shift register code	undefined
FP_SR595_MATRIX_DEBUG_RATIO	(Optional) Frequency for outputting matrix scan information for the shift register (1 in X scans)	10000

Appreciation

Thank you:

• Drashna - for the great examples in their userspace implementation.
• Wilbatech - for the example of keyboard agnostic code in QMK.