Skip to content

Commit

Permalink
fixup! docs: Add initial pointer docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
petejohanson committed Nov 22, 2024
1 parent b670c75 commit 971ffae
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/docs/keymaps/input-processors/temp-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,35 @@ Three pre-defined instance of the scaler input processor are available:
| Reference | Description |
| ----------------- | --------------------------------------------------------------- |
| `&zip_temp_layer` | Enable a certain layer temporarily until no events are received |

## User Defined Instances

Users can define new instances of the temporary layer input processor to use different settings.

### Example

```dts
#include <zephyr/dt-bindings/input/input-event-codes.h>
/ {
/omit-if-no-ref/ zip_temp_layer: zip_temp_layer {
compatible = "zmk,input-processor-temp-layer";
#input-processor-cells = <2>;
require-prior-idle-ms = <2000>;
excluded-positions = <1 2 3>;
};
};
```

### Compatible

The temp layer input processor uses a `compatible` property of `"zmk,input-processor-temp-layer"`.

### Standard Properties

- `#input-processor-cells` - required to be constant value of `<2>`.

### User Properties

- `require-prior-idle-ms` - Only activate the layer if there have not been any key presses for at least the set number of milliseconds
- `excluded-positions` - Exclude certain positions from deactivating the layer once it is active.

0 comments on commit 971ffae

Please sign in to comment.