osamuaoki/interception-dual-function-keys

NAME

interception - dual function keys

DESCRIPTION

Tap for one key, hold for another.

Great for modifier keys like: hold for ctrl, tap for delete.

A hand-saver for those with restricted finger mobility.

A plugin for interception tools.

QUICK START

1. Create some mappings /etc/interception/dual-function-keys/my-mappings.yaml. There are many examples
2. Create your interception tools udevmon configuration: /etc/interception/udevmon.d/my-keyboards.yaml. You can use my configuration to get started.
3. Enable udevmon: sudo systemctl enable udevmon
4. (Re)start udevmon: sudo systemctl restart udevmon
5. Check for problems: journalctl -u udevmon. No news is good news. You can safely disregard any ignoring /etc/interception/udevmon.yaml, reason: bad file: /etc/interception/udevmon.yaml messages.

FUNCTIONALITY

In these examples we will use the left shift key (LS).

It is configured to tap for delete (DE) and hold for LS.

  - KEY: KEY_LEFTSHIFT
    TAP: KEY_DELETE
    HOLD: KEY_LEFTSHIFT

Tap

Press and release LS within TAP_MILLIS (default 200ms) for DE.

By default, until the tap is complete, we get LS. See below for other options.

                <---------200ms--------->     <---------200ms--------->
keyboard:       LS↓      LS↑                  LS↓                          LS↑
computer sees:  LS↓      LS↑ DE↓ DE↑          LS↓                          LS↑

Double Tap

Tap then press again with DOUBLE_TAP_MILLIS (default 150ms) to hold DE.

                             <-------150ms------->
                <---------200ms--------->
keyboard:       LS↓         LS↑             LS↓               LS↑
computer sees:  LS↓         LS↑ DE↓ DE↑     DE↓ ..(repeats).. DE↑

You can continue double tapping so long as it is within the DOUBLE_TAP_MILLIS window.

Consumption

Press or release another key during the TAP_MILLIS window and the tap will not occur.

This is especially useful for modifiers, for instance a quick ctrl-C. In this example we press the a key during the window.

Double taps do not apply after consumption; you will need to tap first.

Mouse and touchpad events (EV_REL and EV_ABS) can also consume taps, however you will need to use a Multiple Devices configuration.

                                                               <-------150ms------->
                                                 <---------200ms--------->
                                 <-------150ms------->
                <---------200ms--------->
keyboard:       LS↓      a↓  a↑  LS↑             LS↓          LS↑           LS↓
computer sees:  LS↓      a↓  a↑  LS↑             LS↓          LS↑ DE↓ DE↑   DE↓ ..(repeats)..

INSTALLATION

Package Manager

From Source

See runtime dependencies.

Install Interception Tools first.

git clone https://gitlab.com/interception/linux/plugins/dual-function-keys.git
cd dual-function-keys
make && sudo make install

Installation prefix defaults to /usr/local. This can be overridden in config.mk.

CONFIGURATION

There are two parts to be configured: dual-function-keys and udevmon, which launches dual-function-keys.

See examples which contains dual-function-keys and udevmon.yaml configurations.

dual-function-keys

This yaml file conventionally resides in /etc/interception/dual-function-keys.

You can use raw (integer) keycodes, however it is easier to use the #defined strings from input-event-codes.h.

# optional
TIMING:
    TAP_MILLISEC: <integer>
    DOUBLE_TAP_MILLISEC: <integer>
    SYNTHETIC_KEYS_PAUSE_MILLISEC: <integer>

# necessary
MAPPINGS:
    - KEY: <integer | string>
      TAP: [ <integer | string>, ... ]
      HOLD: [ <integer | string>, ... ]
      # optional
      HOLD_START: [ AFTER_PRESS | BEFORE_CONSUME | BEFORE_CONSUME_OR_RELEASE ]
    - KEY: ...

Our example from the previous section looks like:

TIMING:
    TAP_MILLISEC: 200
    DOUBLE_TAP_MILLISEC: 150

MAPPINGS:
    - KEY: KEY_LEFTSHIFT
      TAP: KEY_DELETE
      HOLD: KEY_LEFTSHIFT

Combo Keys

You can configure the TAP as a “combo”, which will press then release multiple keys in order e.g. space cadet (:

MAPPINGS:
    - KEY: KEY_LEFTSHIFT
      TAP: [ KEY_LEFTSHIFT, KEY_9, ]
      HOLD: KEY_LEFTSHIFT

You can configure the HOLD as a “combo”, which will press then release multiple keys in order e.g. hyper modifier:

MAPPINGS:
    - KEY: KEY_TAB
      TAP: KEY_TAB
      HOLD: [ KEY_LEFTCTRL, KEY_LEFTMETA, KEY_LEFTALT, ]

By default, there will be a pause of 20ms between keys in the “combo”. This may be changed:

TIMING:
    SYNTHETIC_KEYS_PAUSE_MILLISEC: 10

Changing the Behavior of HOLD Keys

Additionally, you can use HOLD_START to configure the behavior of HOLD keys. The examples above will be used again here.

• If HOLD_START is unspecified, AFTER_PRESS or an unrecognized value, HOLD keys are pressed after KEY is pressed, and released when KEY is released. This this the default behavior used in examples above.

• If HOLD_START is BEFORE_CONSUME, HOLD keys are pressed before KEY is consumed, and released when KEY is released. Therefore no extra keys beside TAP keys are sent when KEY is tapped, while HOLD keys can still be used as modifiers.

                <---------200ms--------->     <---------200ms--------->
keyboard:       LS↓      LS↑                  LS↓                          LS↑
computer sees:           DE↓ DE↑

                                                               <-------150ms------->
                                                 <---------200ms--------->
                                 <-------150ms------->
                <---------200ms--------->
keyboard:       LS↓      a↓  a↑   LS↑             LS↓          LS↑           LS↓
computer sees:       LS↓ a↓  a↑   LS↑                          DE↓ DE↑       DE↓ ..(repeats)..

• If HOLD_START is BEFORE_CONSUME_OR_RELEASE, the behavior is like BEFORE_CONSUME except that when KEY is released and is neither tapped nor consumed before, HOLD keys are pressed in order and then released in order.

                <---------200ms--------->     <---------200ms--------->
keyboard:       LS↓      LS↑                  LS↓                          LS↑
computer sees:           DE↓ DE↑                                           LS↓ LS↑

Warning

Do not assign the same modifier to two keys that you intend to press at the same time, as they will interfere with each other. Use left and right versions of the modifiers e.g. alt-tab with space-caps:

MAPPINGS:
    - KEY: KEY_CAPSLOCK
      TAP: KEY_TAB
      HOLD: KEY_LEFTALT

    - KEY: KEY_SPACE
      TAP: KEY_SPACE
      HOLD: KEY_RIGHTALT

Alternatively, you can use HOLD_START: BEFORE_CONSUME or HOLD_START: BEFORE_CONSUME_OR_RELEASE and then assigning the same modifier will be fine:

MAPPINGS:
    - KEY: KEY_CAPSLOCK
      TAP: KEY_TAB
      HOLD: KEY_LEFTALT
      HOLD_START: BEFORE_CONSUME_OR_RELEASE

    - KEY: KEY_SPACE
      TAP: KEY_SPACE
      HOLD: KEY_LEFTALT
      HOLD_START: BEFORE_CONSUME_OR_RELEASE

udevmon

udevmon needs to be informed that we desire Dual Function Keys. See How It Works for the full story.

- JOB: "intercept -g $DEVNODE | dual-function-keys -c </path/to/dual-function-keys.yaml> | uinput -d $DEVNODE"
  DEVICE:
    NAME: <keyboard name>

The name may be determined by executing:

sudo uinput -p -d /dev/input/by-id/X

where X is the device with the name that looks like your keyboard. Ensure that all EV_KEYs are present under EVENTS. If you can’t find your keyboard under /dev/input/by-id, look at devices directly under /dev/input.

See Interception Tools: How It Works for more information on uinput -p.

Usually the name is sufficient to uniquely identify the keyboard, however some keyboards register many devices such as a virtal mouse. You can run dual-function-keys for all the devices, however I prefer to run it only for the actual keyboard.

My /etc/interception/udevmon.d/my-keyboards.yaml:

- JOB: "intercept -g $DEVNODE | dual-function-keys -c /etc/interception/dual-function-keys/home-row-modifiers.yaml | uinput -d $DEVNODE"
  DEVICE:
    NAME: "Minimalist Keyboard ABC"
    EVENTS:
      EV_KEY: [ KEY_LEFTSHIFT ]
- JOB: "intercept -g $DEVNODE | dual-function-keys -c /etc/interception/dual-function-keys/thumb-cluster.yaml | uinput -d $DEVNODE"
  DEVICE:
    NAME: "Split Keyboard XYZ"
    EVENTS:
      EV_KEY: [ KEY_LEFTSHIFT ]

Multiple Devices

When using inputs from multiple devices e.g. ctrl-scroll it may be necessary to mux those devices for dual-function-keys to work across these devices e.g. scroll consuming ctrl.

Example udevmon configuration for a mouse and keyboard:

- CMD: mux -c dfk -c my-keyboard -c my-mouse
- JOB:
    - mux -i dfk | dual-function-keys -c /etc/interception/dual-function-keys/my-cfg.yaml | mux -o my-keyboard -o my-mouse
    - mux -i my-keyboard | uinput -c /etc/interception/udevmon.d/my-keyboard.yaml
    - mux -i my-mouse | uinput -c /etc/interception/udevmon.d/my-mouse.yaml
- JOB: intercept -g $DEVNODE | mux -o dfk
  DEVICE:
    NAME: AT Translated Set 2 keyboard
    EVENTS:
      EV_KEY: [ KEY_LEFTCTRL ]
- JOB: intercept -g $DEVNODE | mux -o dfk
  DEVICE:
    NAME: Razer Razer Naga Trinity
    EVENTS:
      EV_REL: [REL_WHEEL]
      EV_KEY: [BTN_LEFT]

In the above example, my-keyboard.yaml and my-mouse.yaml represent the virtual devices that udevmon will create to output events. They are generated once from the device itself e.g.

sudo uinput -p -d /dev/input/by-id/usb-my-keyboard-kbd > my-keyboard.yaml

An alternative, if you want to live dangerously, is to generate the virtual device configuration on the fly e.g.:

- CMD: mux -c dfk -c my-keyboard -c my-mouse
- JOB:
    - mux -i dfk | dual-function-keys -c /etc/interception/dual-function-keys/my-cfg.yaml | mux -o my-keyboard -o my-mouse
    - mux -i my-keyboard | uinput -d /dev/input/by-path/my-keyboard-event-kbd
    - mux -i my-mouse | uinput -d /dev/input/by-id/usb-my-mouse-event-mouse
- JOB: intercept -g $DEVNODE | mux -o dfk
  DEVICE:
    LINK: /dev/input/by-path/my-keyboard-event-kbd
- JOB: intercept -g $DEVNODE | mux -o dfk
  DEVICE:
    LINK: /dev/input/by-id/usb-my-mouse-event-mouse

CAVEATS

As always, there is a caveat: dual-function-keys operates on raw keycodes, not keysyms, as seen by X11 or Wayland.

If you have anything modifying the keycode->keysym mapping, such as XKB or xmodmap, be mindful that dual-function-keys operates before them.

Some common XKB usages that might be found in your X11 configuration:

    Option "XkbModel" "pc105"
    Option "XKbLayout" "us"
    Option "XkbVariant" "dvp"
    Option "XkbOptions" "caps:escape"

FAQ

I have a new use case. Can you support it?

Please raise an issue.

dual-function-keys has been built for my needs. I will be intrigued to hear your ideas and help you make them happen.

As usual, PRs are very welcome.

I see you are using q.m.k HHKB mod Keyboard in your udevmon. It uses QMK Firmware. Why not just use Tap-Hold?

Good catch! That does indeed provide the same functionality as dual-function-keys. Unfortunately there are some drawbacks:

1. Few keyboards run QMK Firmware.
2. There are some issues with that functionality, as noted in the documentation Tap-Hold.
3. It requires a fast processor in the keyboard. My unscientific testing with an Ergodox (~800 scans/sec) and HHKB (~140) revealed that the slower keyboard is mushy and unuseably inaccurate.

Why not use xcape?

Xcape only provides simple tap/hold functionality. It appears difficult (impossible?) to add the remaining functionality using its XTestFakeKeyEvent mechanisms.

My Key Combination Isn’t Working

Ensure that your window manager is not intercepting that key combination.

I Don’t Want Double Tap Functionality

Set DOUBLE_TAP_MILLISEC to 0. See Key Combinations, No Double Tap.

CONTRIBUTORS

Please fork this repo and submit a PR.

If you are making changes to the documentation, please edit the pandoc flavoured dual-function-keys.md and run make doc. Please ensure that this README.md and the man page dual-function-keys.1 has your changes and commit all three.

As usual, please obey .editorconfig.

LICENSE

Copyright © 2020 Alexander Courtis