c5cca5b34f
* Add bindings to allow creating multiple physical layouts that specify their key's physical attributes, and the matching matrix transform and dependant kscan to use. * Synthesize a basic physical layout if none specified, for backwards compatibility. * Update matrix transform API to explicitly pass in the selected transform to the API instead of using a fixed chosen transform. * Move kscan subscription and handling into the physical layout code, so that selecting a different physical layout at runtime can also use the correct kscan instance. * Add `physical_layouts.dtsi` file to include so you can use the pre-configured `&key_physical_attrs` for adding you layout keys.
26 lines
754 B
YAML
26 lines
754 B
YAML
#
|
|
# Copyright (c) 2024 The ZMK Contributors
|
|
#
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
description: |
|
|
Describe the physical layout of a keyboard, including deps like the transform and kscan
|
|
that are needed for that layout to work.
|
|
|
|
compatible: "zmk,physical-layout"
|
|
|
|
properties:
|
|
display-name:
|
|
type: string
|
|
required: true
|
|
description: The name of this layout to display in the UI
|
|
transform:
|
|
type: phandle
|
|
required: true
|
|
description: The matrix transform to use along with this layout.
|
|
kscan:
|
|
type: phandle
|
|
description: The kscan to use along with this layout. The `zmk,kscan` chosen will be used as a fallback if this property is omitted.
|
|
keys:
|
|
type: phandle-array
|
|
description: Array of key physical attributes.
|