kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): switch sensor rotate parameter order

Browse source
This commit is contained in:
Nick Coutsos 2023-04-22 20:14:08 -04:00 • committed by Pete Johanson
parent 3db163aa2c
commit 9d64c2a3a0
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/docs/behaviors/sensor-rotate.md
View file

@ -12,8 +12,8 @@ two behaviors and their parameters together, or allowing binding the sensor rota
The standard sensor rotation behavior allows fully binding behaviors to be invoked: The standard sensor rotation behavior allows fully binding behaviors to be invoked:
- If rotated counter-clockwise, the first bound behavior is triggered. - If rotated clockwise, the first bound behavior is triggered.
- If rotated clockwise, the second bound behavior is triggered. - If rotated counter-clockwise, the second bound behavior is triggered.
### Configuration ### Configuration
@ -26,7 +26,7 @@ Here is an example that binds the [RGB Underglow Behavior](/docs/behaviors/under
compatible = "zmk,behavior-sensor-rotate"; compatible = "zmk,behavior-sensor-rotate";
label = "RGB_ENCODER"; label = "RGB_ENCODER";
#sensor-binding-cells = <0>; #sensor-binding-cells = <0>;
bindings = <&rgb_ug RGB_BRD>, <&rgb_ug RGB_BRI>; bindings = <&rgb_ug RGB_BRI>, <&rgb_ug RGB_BRD>;
}; };
}; };
@ -46,8 +46,8 @@ Here is an example that binds the [RGB Underglow Behavior](/docs/behaviors/under
The variable sensor rotation behavior is configured with two behaviors that each expect a single parameter, The variable sensor rotation behavior is configured with two behaviors that each expect a single parameter,
allowing the sensor rotation instance to be bound with two parameters at usage time. allowing the sensor rotation instance to be bound with two parameters at usage time.
- If rotated counter-clockwise, the first bound behavior is triggered with the first parameter passed to the sensor rotation. - If rotated clockwise, the first bound behavior is triggered with the first parameter passed to the sensor rotation.
- If rotated clockwise, the second bound behavior is triggered with the second parameter passed to the sensor rotation. - If rotated counter-clockwise, the second bound behavior is triggered with the second parameter passed to the sensor rotation.
### Configuration ### Configuration
@ -70,7 +70,7 @@ First, defining the sensor rotation itself, binding the [Key Press Behavior](/do
compatible = "zmk,keymap"; compatible = "zmk,keymap";
base { base {
... ...
sensor-bindings = <&rot_kp PG_DN PG_UP>; sensor-bindings = <&rot_kp PG_UP PG_DN>;
} }
} }
}; };