diff --git a/app/dts/bindings/input_processors/zmk,input-processor-behaviors.yaml b/app/dts/bindings/input_processors/zmk,input-processor-behaviors.yaml new file mode 100644 index 00000000000..c8c54c557ae --- /dev/null +++ b/app/dts/bindings/input_processors/zmk,input-processor-behaviors.yaml @@ -0,0 +1,18 @@ +# Copyright (c) 2024, The ZMK Contributors +# SPDX-License-Identifier: MIT + +description: Input Processor for invoking behaviors on certain events + +compatible: "zmk,input-processor-behaviors" + +include: ip_zero_param.yaml + +properties: + type: + type: int + codes: + type: array + required: true + bindings: + type: phandle-array + required: true diff --git a/app/dts/input/processors.dtsi b/app/dts/input/processors.dtsi index d072c0fcfcf..17398bada7f 100644 --- a/app/dts/input/processors.dtsi +++ b/app/dts/input/processors.dtsi @@ -7,4 +7,5 @@ #include #include #include -#include \ No newline at end of file +#include +#include \ No newline at end of file diff --git a/app/dts/input/processors/behaviors.dtsi b/app/dts/input/processors/behaviors.dtsi new file mode 100644 index 00000000000..a50f9384b08 --- /dev/null +++ b/app/dts/input/processors/behaviors.dtsi @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2024 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#include + +/ { + zip_button_behaviors: zip_button_behaviors { + compatible = "zmk,input-processor-behaviors"; + #input-processor-cells = <0>; + codes = ; + bindings = <&none &none &none>; + }; +}; \ No newline at end of file diff --git a/app/include/drivers/input_processor.h b/app/include/drivers/input_processor.h index 38ada12af90..fac4459b910 100644 --- a/app/include/drivers/input_processor.h +++ b/app/include/drivers/input_processor.h @@ -36,6 +36,7 @@ struct zmk_input_processor_entry { } struct zmk_input_processor_state { + uint8_t input_device_index; int16_t *remainder; }; diff --git a/app/include/zmk/combos.h b/app/include/zmk/combos.h new file mode 100644 index 00000000000..a7166dff583 --- /dev/null +++ b/app/include/zmk/combos.h @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2020 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#pragma once + +#include + +#define ZMK_COMBOS_UTIL_ONE(n) 1 + +#define ZMK_COMBOS_LEN \ + COND_CODE_1( \ + DT_HAS_COMPAT_STATUS_OKAY(zmk_combos), \ + (DT_FOREACH_CHILD_STATUS_OKAY_SEP(DT_INST(0, zmk_combos), ZMK_COMBOS_UTIL_ONE, (+))), (0)) \ No newline at end of file diff --git a/app/include/zmk/input_listeners.h b/app/include/zmk/input_listeners.h new file mode 100644 index 00000000000..446706fb310 --- /dev/null +++ b/app/include/zmk/input_listeners.h @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2020 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#pragma once + +#include + +#define ZMK_INPUT_LISTENERS_UTIL_ONE(n) 1 + + +#define ZMK_INPUT_LISTENERS_LEN \ + (DT_FOREACH_STATUS_OKAY(zmk_input_listener, ZMK_INPUT_LISTENERS_UTIL_ONE) 0) \ No newline at end of file diff --git a/app/include/zmk/virtual_key_position.h b/app/include/zmk/virtual_key_position.h index 563f951eba7..466ea3efc18 100644 --- a/app/include/zmk/virtual_key_position.h +++ b/app/include/zmk/virtual_key_position.h @@ -7,6 +7,8 @@ #pragma once #include +#include +#include #include /** @@ -22,4 +24,9 @@ /** * Gets the virtual key position to use for the combo with the given index. */ -#define ZMK_VIRTUAL_KEY_POSITION_COMBO(index) (ZMK_KEYMAP_LEN + ZMK_KEYMAP_SENSORS_LEN + (index)) +#define ZMK_VIRTUAL_KEY_POSITION_COMBO(index) \ + (ZMK_VIRTUAL_KEY_POSITION_SENSOR(ZMK_KEYMAP_SENSORS_LEN) + (index)) + +#define ZMK_VIRTUAL_KEY_POSITION_BEHAVIOR_INPUT_PROCESSOR(listener_index, processor_index) \ + (ZMK_VIRTUAL_KEY_POSITION_COMBO(ZMK_COMBOS_LEN) + \ + (ZMK_INPUT_LISTENERS_LEN * (processor_index)) + (listener_index)) diff --git a/app/src/pointing/CMakeLists.txt b/app/src/pointing/CMakeLists.txt index ad74c1ea786..8609277d6eb 100644 --- a/app/src/pointing/CMakeLists.txt +++ b/app/src/pointing/CMakeLists.txt @@ -6,5 +6,6 @@ target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_TRANSFORM app PRIVATE input_proc target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_SCALER app PRIVATE input_processor_scaler.c) target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_TEMP_LAYER app PRIVATE input_processor_temp_layer.c) target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_CODE_MAPPER app PRIVATE input_processor_code_mapper.c) +target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_BEHAVIORS app PRIVATE input_processor_behaviors.c) target_sources_ifdef(CONFIG_ZMK_POINTING_SMOOTH_SCROLLING app PRIVATE resolution_multipliers.c) target_sources_ifdef(CONFIG_ZMK_INPUT_SPLIT app PRIVATE input_split.c) diff --git a/app/src/pointing/Kconfig b/app/src/pointing/Kconfig index 42cf8e8c072..b4051e1fcef 100644 --- a/app/src/pointing/Kconfig +++ b/app/src/pointing/Kconfig @@ -57,6 +57,11 @@ config ZMK_INPUT_PROCESSOR_CODE_MAPPER default y depends on DT_HAS_ZMK_INPUT_PROCESSOR_CODE_MAPPER_ENABLED +config ZMK_INPUT_PROCESSOR_BEHAVIORS + bool "Behaviors Input Processor" + default y + depends on DT_HAS_ZMK_INPUT_PROCESSOR_BEHAVIORS_ENABLED + config ZMK_INPUT_SPLIT bool "Split input support" default y diff --git a/app/src/pointing/input_listener.c b/app/src/pointing/input_listener.c index ee8809f4240..28f25300032 100644 --- a/app/src/pointing/input_listener.c +++ b/app/src/pointing/input_listener.c @@ -71,6 +71,7 @@ struct input_listener_processor_data { }; struct input_listener_config { + uint8_t listener_index; struct input_listener_config_entry base; size_t layer_overrides_len; struct input_listener_layer_override layer_overrides[]; @@ -152,7 +153,7 @@ static inline bool is_y_data(const struct input_event *evt) { return evt->type == INPUT_EV_REL && evt->code == INPUT_REL_Y; } -static int apply_config(const struct input_listener_config_entry *cfg, +static int apply_config(uint8_t listener_index, const struct input_listener_config_entry *cfg, struct input_listener_processor_data *processor_data, struct input_listener_data *data, struct input_event *evt) { size_t remainder_index = 0; @@ -183,7 +184,9 @@ static int apply_config(const struct input_listener_config_entry *cfg, } } - struct zmk_input_processor_state state = {.remainder = remainder}; + LOG_DBG("LISTENER INDEX: %d", listener_index); + struct zmk_input_processor_state state = {.input_device_index = listener_index, + .remainder = remainder}; int ret = zmk_input_processor_handle_event(proc_e->dev, evt, proc_e->param1, proc_e->param2, &state); @@ -211,7 +214,8 @@ static int filter_with_input_config(const struct input_listener_config *cfg, uint8_t layer = 0; while (mask != 0) { if (mask & BIT(0) && zmk_keymap_layer_active(layer)) { - int ret = apply_config(&override->config, override_data, data, evt); + int ret = + apply_config(cfg->listener_index, &override->config, override_data, data, evt); if (ret < 0) { return ret; @@ -226,7 +230,7 @@ static int filter_with_input_config(const struct input_listener_config *cfg, } } - return apply_config(&cfg->base, &data->base_processor_data, data, evt); + return apply_config(cfg->listener_index, &cfg->base, &data->base_processor_data, data, evt); } static void clear_xy_data(struct input_listener_xy_data *data) { @@ -376,6 +380,7 @@ static void input_handler(const struct input_listener_config *config, DT_INST_FOREACH_CHILD_VARGS(n, CHILD_CONFIG, \ n) static const struct input_listener_config config_##n = \ { \ + .listener_index = n, \ .base = IL_EXTRACT_CONFIG(DT_DRV_INST(n), n, base), \ .layer_overrides_len = (0 DT_INST_FOREACH_CHILD(n, IL_ONE)), \ .layer_overrides = {DT_INST_FOREACH_CHILD_SEP_VARGS(n, IL_OVERRIDE, (, ), n)}, \ diff --git a/app/src/pointing/input_processor_behaviors.c b/app/src/pointing/input_processor_behaviors.c new file mode 100644 index 00000000000..0c8d75cdc3e --- /dev/null +++ b/app/src/pointing/input_processor_behaviors.c @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2024 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#define DT_DRV_COMPAT zmk_input_processor_behaviors + +#include + +#include +#include +#include + +#include + +LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); + +#include +#include +#include + +struct ip_behaviors_config { + uint8_t index; + size_t size; + uint16_t type; + + const uint16_t *codes; + const struct zmk_behavior_binding *bindings; +}; + +static int ip_behaviors_handle_event(const struct device *dev, struct input_event *event, + uint32_t param1, uint32_t param2, + struct zmk_input_processor_state *state) { + const struct ip_behaviors_config *cfg = dev->config; + + if (event->type != cfg->type) { + return 0; + } + + for (size_t i = 0; i < cfg->size; i++) { + if (cfg->codes[i] == event->code) { + struct zmk_behavior_binding_event behavior_event = { + .position = ZMK_VIRTUAL_KEY_POSITION_BEHAVIOR_INPUT_PROCESSOR( + state->input_device_index, cfg->index), + .timestamp = k_uptime_get(), +#if IS_ENABLED(CONFIG_ZMK_SPLIT) + .source = ZMK_POSITION_STATE_CHANGE_SOURCE_LOCAL, +#endif + }; + + LOG_DBG("FOUND A MATCHING CODE, invoke %s for position %d with %d listeners", + cfg->bindings[i].behavior_dev, behavior_event.position, + ZMK_INPUT_LISTENERS_LEN); + int ret = zmk_behavior_invoke_binding(&cfg->bindings[i], behavior_event, event->value); + if (ret < 0) { + return ret; + } + + return ZMK_INPUT_PROC_STOP; + } + } + + return 0; +} + +static struct zmk_input_processor_driver_api ip_behaviors_driver_api = { + .handle_event = ip_behaviors_handle_event, +}; + +static int ip_behaviors_init(const struct device *dev) { return 0; } + +#define ENTRY(i, node) ZMK_KEYMAP_EXTRACT_BINDING(i, node) + +#define IP_BEHAVIORS_INST(n) \ + static const uint16_t ip_behaviors_codes_##n[] = DT_INST_PROP(n, codes); \ + static const struct zmk_behavior_binding ip_behaviors_bindings_##n[] = { \ + LISTIFY(DT_INST_PROP_LEN(n, bindings), ZMK_KEYMAP_EXTRACT_BINDING, (, ), DT_DRV_INST(n))}; \ + BUILD_ASSERT(ARRAY_SIZE(ip_behaviors_codes_##n) == ARRAY_SIZE(ip_behaviors_bindings_##n), \ + "codes and bindings need to be the same length"); \ + static const struct ip_behaviors_config ip_behaviors_config_##n = { \ + .index = n, \ + .type = DT_INST_PROP_OR(n, type, INPUT_EV_KEY), \ + .size = DT_INST_PROP_LEN(n, codes), \ + .codes = ip_behaviors_codes_##n, \ + .bindings = ip_behaviors_bindings_##n, \ + }; \ + DEVICE_DT_INST_DEFINE(n, &ip_behaviors_init, NULL, NULL, &ip_behaviors_config_##n, \ + POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, \ + &ip_behaviors_driver_api); + +DT_INST_FOREACH_STATUS_OKAY(IP_BEHAVIORS_INST) \ No newline at end of file diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/events.patterns b/app/tests/pointing/mouse-move/processors/behaviors_basic/events.patterns new file mode 100644 index 00000000000..7374badf0f3 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_basic/events.patterns @@ -0,0 +1,2 @@ +s/.*hid_mouse_//p +s/.*hid_listener_keycode_//p \ No newline at end of file diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/keycode_events.snapshot b/app/tests/pointing/mouse-move/processors/behaviors_basic/keycode_events.snapshot new file mode 100644 index 00000000000..7ad856db606 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_basic/keycode_events.snapshot @@ -0,0 +1,6 @@ +pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00 +pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00 +pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00 diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.conf b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.conf new file mode 100644 index 00000000000..fa514727ba5 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.conf @@ -0,0 +1,6 @@ +CONFIG_GPIO=n +CONFIG_ZMK_BLE=n +CONFIG_LOG=y +CONFIG_LOG_BACKEND_SHOW_COLOR=n +CONFIG_ZMK_LOG_LEVEL_DBG=y +CONFIG_ZMK_POINTING=y diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.keymap b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.keymap new file mode 100644 index 00000000000..e5079d331a6 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.keymap @@ -0,0 +1,44 @@ + +#include +#include + +#include +#include +#include +#include +#include + + +&zip_button_behaviors { + bindings = <&kp A &kp B &kp C>; +}; + +&mkp_input_listener { + input-processors = <&zip_button_behaviors>; +}; + +/ { + keymap { + compatible = "zmk,keymap"; + label ="Default keymap"; + + default_layer { + bindings = < + &mkp LCLK &mkp RCLK + &mkp MCLK &none + >; + }; + }; +}; + + +&kscan { + events = < + ZMK_MOCK_PRESS(0,0,10) + ZMK_MOCK_RELEASE(0,0,10) + ZMK_MOCK_PRESS(0,1,10) + ZMK_MOCK_RELEASE(0,1,10) + ZMK_MOCK_PRESS(1,0,10) + ZMK_MOCK_RELEASE(1,0,10) + >; +}; \ No newline at end of file diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/events.patterns b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/events.patterns new file mode 100644 index 00000000000..7374badf0f3 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/events.patterns @@ -0,0 +1,2 @@ +s/.*hid_mouse_//p +s/.*hid_listener_keycode_//p \ No newline at end of file diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/keycode_events.snapshot b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/keycode_events.snapshot new file mode 100644 index 00000000000..7ad856db606 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/keycode_events.snapshot @@ -0,0 +1,6 @@ +pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00 +pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00 +pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00 +released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00 diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.conf b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.conf new file mode 100644 index 00000000000..fa514727ba5 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.conf @@ -0,0 +1,6 @@ +CONFIG_GPIO=n +CONFIG_ZMK_BLE=n +CONFIG_LOG=y +CONFIG_LOG_BACKEND_SHOW_COLOR=n +CONFIG_ZMK_LOG_LEVEL_DBG=y +CONFIG_ZMK_POINTING=y diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.keymap b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.keymap new file mode 100644 index 00000000000..eb1d8f02795 --- /dev/null +++ b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.keymap @@ -0,0 +1,54 @@ + +#include +#include + +#include +#include +#include +#include +#include + + +&zip_button_behaviors { + bindings = <&mt LCTL A &mt LSHFT B &mt LALT C>; +}; + +&mkp_input_listener { + input-processors = <&zip_button_behaviors>; +}; + +/ { + keymap { + compatible = "zmk,keymap"; + label ="Default keymap"; + + default_layer { + bindings = < + &mkp LCLK &mkp RCLK + &mkp MCLK &none + >; + }; + }; +}; + + +&kscan { + events = < + ZMK_MOCK_PRESS(0,0,10) + ZMK_MOCK_RELEASE(0,0,10) + ZMK_MOCK_PRESS(0,1,10) + ZMK_MOCK_RELEASE(0,1,10) + ZMK_MOCK_PRESS(1,0,10) + ZMK_MOCK_RELEASE(1,0,10) + ZMK_MOCK_PRESS(0,0,500) + ZMK_MOCK_RELEASE(0,0,10) + ZMK_MOCK_PRESS(0,1,500) + ZMK_MOCK_RELEASE(0,1,10) + ZMK_MOCK_PRESS(1,0,500) + ZMK_MOCK_RELEASE(1,0,10) + ZMK_MOCK_PRESS(0,0,10) + ZMK_MOCK_PRESS(0,1,10) + ZMK_MOCK_RELEASE(0,1,10) + ZMK_MOCK_RELEASE(0,0,10) + >; +}; \ No newline at end of file diff --git a/docs/docs/keymaps/input-processors/behaviors.md b/docs/docs/keymaps/input-processors/behaviors.md new file mode 100644 index 00000000000..c37b2279e81 --- /dev/null +++ b/docs/docs/keymaps/input-processors/behaviors.md @@ -0,0 +1,69 @@ +--- +title: Behaviors Input Processor +sidebar_label: Behaviors +--- + +## Overview + +The behaviors input processor is used invoke standard behaviors when certain input events occur; most frequently this is used to trigger behaviors when certain mouse buttons are triggered by physical pointing devices. + +## Usage + +When used, this input processor takes no parameters, as the event code to behavior mapping is specified in the definition of the specific processor instance, e.g.: + +```dts +&zip_button_behaviors +``` + +## Pre-Defined Instances + +One pre-defined instance of the out-of-band behaviors input processor is available: + +| Reference | Description | +| ----------------------- | -------------------------------------------------- | +| `&zip_button_behaviors` | Maps left/right/middle clicks to a given behavior. | + +Should you with to update the existing instance to trigger different behaviors for each mouse button, you can override the `bindings` property, e.g.: + +```dts +&zip_button_behaviors { + bindings = <&kp A &kp B &kp C>; +}; +``` + +## User-Defined Instances + +Users can define new instances of the out-of-band behaviors input processor if they want to target different codes or assign different behaviors. + +### Example + +Below example maps the left mouse button code to the middle mouse button. + +```dts +#include + +/ { + input_processors { + zip_right_click_trigger_paste: zip_right_click_trigger_paste { + compatible = "zmk,input-processor-behaviors"; + #input-processor-cells = <0>; + codes = ; + bindings = <&kp LC(V) >; + }; + }; +} +``` + +### Compatible + +The code mapper input processor uses a `compatible` property of `"zmk,input-processor-behaviors"`. + +### Standard Properties + +- `#input-processor-cells` - required to be constant value of `<0>`. + +### User Properties + +- `type` - The [type](https://github.com/zmkfirmware/zephyr/blob/v3.5.0%2Bzmk-fixes/include/zephyr/dt-bindings/input/input-event-codes.h#L25) of events to scale. Usually, this is `INPUT_EV_KEY` for key/button events. The default value if omitted is `INPUT_EV_KEY`. +- `codes` - The specific codes of the given type to capture, e.g. [button event codes](https://github.com/zmkfirmware/zephyr/blob/v3.5.0%2Bzmk-fixes/include/zephyr/dt-bindings/input/input-event-codes.h#L180). This list must be the same length as the `bindings` property. +- `bindings` - The bindings to trigger when an event with the corresponding code is processed. diff --git a/docs/docs/keymaps/input-processors/index.md b/docs/docs/keymaps/input-processors/index.md index 489003b8303..c854b5369e7 100644 --- a/docs/docs/keymaps/input-processors/index.md +++ b/docs/docs/keymaps/input-processors/index.md @@ -25,25 +25,27 @@ A set of predefined input processors is available by adding the following at the Once included, you can use the following: -| Binding | Processor | Description | -| -------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------- | -| `&zip_xy_scaler` | [XY Scaler](scaler.md#pre-defined-instances) | Scale a the X/Y input events using a multiplier and divisor | -| `&zip_x_scaler` | [X Scaler](scaler.md#pre-defined-instances) | Scale a the X input events using a multiplier and divisor | -| `&zip_y_scaler` | [Y Scaler](scaler.md#pre-defined-instances) | Scale a the Y input events using a multiplier and divisor | -| `&zip_xy_transform` | [XY Transform](transformer.md#pre-defined-instances) | Transform X/Y values, e.g. inverting or swapping | -| `&zip_scroll_transform` | [Scroll Transform](transformer.md#pre-defined-instances) | Transform wheel/horizontal wheel values, e.g. inverting or swapping | -| `&zip_xy_to_scroll_mapper` | [XY To Scroll Mapper](code-mapper.md#pre-defined-instances) | Map X/Y values to scroll wheel/horizontal wheel events | -| `&zip_xy_swap_mapper` | [XY Swap Mapper](code-mapper.md#pre-defined-instances) | Swap X/Y values | -| `&zip_temp_layer` | [Temporary Layer](temp-layer.md#pre-defined-instances) | Temporarily enable a layer during pointer use | +| Binding | Processor | Description | +| -------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------- | +| `&zip_xy_scaler` | [XY Scaler](scaler.md#pre-defined-instances) | Scale a the X/Y input events using a multiplier and divisor | +| `&zip_x_scaler` | [X Scaler](scaler.md#pre-defined-instances) | Scale a the X input events using a multiplier and divisor | +| `&zip_y_scaler` | [Y Scaler](scaler.md#pre-defined-instances) | Scale a the Y input events using a multiplier and divisor | +| `&zip_xy_transform` | [XY Transform](transformer.md#pre-defined-instances) | Transform X/Y values, e.g. inverting or swapping | +| `&zip_scroll_transform` | [Scroll Transform](transformer.md#pre-defined-instances) | Transform wheel/horizontal wheel values, e.g. inverting or swapping | +| `&zip_xy_to_scroll_mapper` | [XY To Scroll Mapper](code-mapper.md#pre-defined-instances) | Map X/Y values to scroll wheel/horizontal wheel events | +| `&zip_xy_swap_mapper` | [XY Swap Mapper](code-mapper.md#pre-defined-instances) | Swap X/Y values | +| `&zip_temp_layer` | [Temporary Layer](temp-layer.md#pre-defined-instances) | Temporarily enable a layer during pointer use | +| `&zip_button_behaviors` | [Mouse Button Behaviors](behaviors.md#pre-defined-instances) | Trigger behaviors when certain mouse buttons are pressed | ### User-Defined Processors Several of the input processors that have predefined instances, e.g. `&zip_xy_scaler` or `&zip_xy_to_scroll_mapper` can also have new instances created with custom properties around which input codes to scale, or which codes to map, etc. -| Compatible | Processor | Description | -| --------------------------------- | ---------------------------------------------------- | ------------------------------------------------ | -| `zmk,input-processor-transform` | [Transform](transformer.md#user-defined-instances) | Perform various transforms like inverting values | -| `zmk,input-processor-code-mapper` | [Code Mapper](code-mapper.md#user-defined-instances) | Map one event code to another type | +| Compatible | Processor | Description | +| --------------------------------- | ---------------------------------------------------- | --------------------------------------------------- | +| `zmk,input-processor-transform` | [Transform](transformer.md#user-defined-instances) | Perform various transforms like inverting values | +| `zmk,input-processor-code-mapper` | [Code Mapper](code-mapper.md#user-defined-instances) | Map one event code to another type | +| `zmk,input-processor-behaviors` | [Behaviors](behaviors.md#user-defined-instances) | Trigger behaviors for certain matching input events | ## External Processors