forked from kofal.net/zmk
feat: Add keyboard physical layout system.
* 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.
This commit is contained in:
committed by
Pete Johanson
parent
80173f8ea3
commit
c5cca5b34f
24
app/dts/bindings/zmk,key-physical-attrs.yaml
Normal file
24
app/dts/bindings/zmk,key-physical-attrs.yaml
Normal file
@@ -0,0 +1,24 @@
|
||||
#
|
||||
# Copyright (c) 2024 The ZMK Contributors
|
||||
#
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
description: |
|
||||
The physical attributes of a key, including size, location, and rotation
|
||||
|
||||
compatible: "zmk,key-physical-attrs"
|
||||
|
||||
properties:
|
||||
"#key-cells":
|
||||
type: int
|
||||
required: true
|
||||
const: 7
|
||||
|
||||
key-cells:
|
||||
- width
|
||||
- height
|
||||
- x
|
||||
- y
|
||||
- r
|
||||
- rx
|
||||
- ry
|
||||
23
app/dts/bindings/zmk,physical-layout-position-map.yaml
Normal file
23
app/dts/bindings/zmk,physical-layout-position-map.yaml
Normal file
@@ -0,0 +1,23 @@
|
||||
#
|
||||
# Copyright (c) 2024 The ZMK Contributors
|
||||
#
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
description: |
|
||||
Describes how to correlate equivalent keys between layouts that don't have the exact same X,Y location.
|
||||
|
||||
compatible: "zmk,physical-layout-position-map"
|
||||
|
||||
properties:
|
||||
complete:
|
||||
type: boolean
|
||||
description: If the mapping complete describes the key mapping, and no position based mapping should be used.
|
||||
|
||||
child-binding:
|
||||
properties:
|
||||
physical-layout:
|
||||
type: phandle
|
||||
description: The physical layout that corresponds to this mapping entry.
|
||||
positions:
|
||||
type: array
|
||||
description: Array of key positions that match the same array entry in the other sibling nodes.
|
||||
26
app/dts/bindings/zmk,physical-layout.yaml
Normal file
26
app/dts/bindings/zmk,physical-layout.yaml
Normal file
@@ -0,0 +1,26 @@
|
||||
#
|
||||
# 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.
|
||||
13
app/dts/physical_layouts.dtsi
Normal file
13
app/dts/physical_layouts.dtsi
Normal file
@@ -0,0 +1,13 @@
|
||||
/*
|
||||
* Copyright (c) 2024 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
/ {
|
||||
key_physical_attrs: key_physical_attrs {
|
||||
compatible = "zmk,key-physical-attrs";
|
||||
|
||||
#key-cells = <7>;
|
||||
};
|
||||
};
|
||||
Reference in New Issue
Block a user