Link Search Menu Expand Document

Rotary encoders

Vial implements optional GUI configuration for rotary encoders. This allows users to set up separate keycode actions for clockwise and counterclockwise encoder rotations. Encoders fully support QMK layers, so different keycodes can be used for different layers.

You will need to port your keyboard over to Vial before encoders are supported. Follow Step 1 and Step 2 to get started.

In order to enable encoder support in your firmware, follow these steps:

1. Add QMK encoder support to config.h

Follow QMK documentation in order to configure encoders. Note that you do not need to implement any encoder callbacks, the only changes should be within the config.h and rules.mk files.

2. Enable Vial encoders in rules.mk

Add VIAL_ENCODERS_ENABLE = yes to your keymaps/via/rules.mk file.

3. Add Vial encoders as part of KLE keymap

Set up encoders as 1u switches:

  • the center legend should be “e”
  • the top left legend is “encoder_index,encoder_rotation”, for example “0,0” for rotating encoder at index 0 counterclockwise, and “0,1” for rotating encoder at index 0 clockwise. You do not need to make these values unique from your other key coordinates as these keys will be compiled differently due to the “e” present on the legends.(example)
  • Exporting the json from KLE will introduce the following lines to your file, these relate to the encoder:
    ["0,0\n\n\n\n\n\n\n\n\ne",
    "0,1\n\n\n\n\n\n\n\n\ne"],
    

9 Key macro pad example

Building a basic 9 key macro pad and a rotary encoder (without button) will produce the following. (example KLE file)

{
    "name": "NinetyOne",
    "vendorId": "0xXXXX",
    "productId": "0xXXXX",
    "lighting": "none",
    "matrix": {
        "rows": 3,
        "cols": 3
    },
    "layouts": {
        "keymap": [
        [
          { "y": 0.25, "x": 0.5 },
          "0,0\n\n\n\n\n\n\n\n\ne",
          "0,1\n\n\n\n\n\n\n\n\ne"],
        [ {"y": 0.25},
          "0,0", "0,1", "0,2"],
          ["1,0", "1,1", "1,2"],
          ["2,0", "2,1", "2,2"]
        ]
    }
}

Done!

Compile and flash the firmware, and you should be able to configure encoders in the UI:

Configuration options

Vial encoders support the following options which can be specified in config.h:

#define VIAL_ENCODER_DEFAULT { ... }

Specify default key mapping for encoders. By default all encoders are set to KC_TRNS. Specify one-dimensional array where for each layer and every encoder on that layer 2 keycodes are specified for movements anticlockwise and clockwise.

For example if you have 4 layers and a single encoder and specify #define VIAL_ENCODER_DEFAULT { KC_A, KC_B, KC_C, KC_D, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS }:

  • on the first layer (layer 0) the encoder will enter KC_A when rotated anticlockwise and KC_B when rotated clockwise
  • on the second layer (layer 1) the encoder will enter KC_C when rotated anticlockwise and KC_D when rotated clockwise
  • the rest of the layers are transparent and will fall through to the lower layers

#define VIAL_ENCODER_KEYCODE_DELAY xxx

Delay for X milliseconds between pressing and releasing the encoder keycode. By default set to 10. You should set this value to at least 10, otherwise volume up/down keycodes do not work on Windows.

#define VIAL_ENCODER_SIMPLE_TAP

Use a simple keycode entry method, based on register_code16/unregister_code16. By default unset. Use this option if you are having issues with the default method, especially on platforms with reduced memory available such as ATmega32u4. Note that this method cannot handle all keycodes, for example macro keycodes will not work.