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

Document position_state_changed and keycode_state_changed

Browse source
This commit is contained in:
Ally Parker 2020-12-29 15:02:05 +00:00
parent d09a2eb469
commit 1d52944a61
1 changed files with 11 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/docs/development/events.md
View file

@ -52,12 +52,19 @@ todo
todo
### `position_state_changed`
Fired whenever there is a change in state of any key after a matrix scan.
The column/row data coming from the matrix is converted into an integer key `position` representing the 0 based index of the key that was pressed. Positions go from left to right, top to bottom, starting from 0.
That `state` bool represents whether the key is pressed or not.
`keymap` subscribes to these events, processes them against the configured keymap configuration and raises `keycode_state_changed` with the parsed keycodes.
### `keycode_state_changed`
todo
That's for the state of a specific hid usage (keycode) being pressed/released.
Those events would be what you would feed into a WPM calculation.
Fired in response to processing a `position_state_changed` event which is processed against the keymap configuration and raises `keycode_state_changed` events with the parsed keycode and pressed state.
### `layer_state_changed`
@ -67,16 +74,6 @@ todo
todo
### `position_state_changed`
todo
A "key position" is a logical identifier for a physical key.
We transform from row/column to single integer position early on.
So the position is the 0-indexed value in the array of physical switches, normally if you started counting from top left corner and went left ttomright, top to bottom.
A keymap is a set of layers, where each layer is an array of bindings for each logical key position.
So, the "earliest event when a key is pressed" is the position state changed. The state being pressed or released.
Once that gets processed by the keymap, mostly the behaviors then generate keycode state changes.
### `sensor_event`
todo