Skip to content

Key inspector โ€‹

The right-hand inspector edits whatever is selected on the canvas. With one key selected it shows that key's element type, binding, geometry, rotation and matrix wiring; with several selected it shows bulk actions; with nothing selected it shows a hint.

๐Ÿ“ท Screenshot slot โ€” docs/public/images/builder/inspector.png

The inspector with one key selected โ€” the Element tabs, Key binding, Geometry (U), Rotation and Matrix wiring sections.

Element type โ€‹

A header reads Element with three tabs that set what the position is (keyboard.keys[i].element):

TabElementAdds
Keya normal switcha single binding per layer
Encodera rotary encoderCW / CCW / press bindings
Slideran analog slidera value-map (volume / brightness / wheel)

The label above shows Key #3 / Encoder #3 / Slider #3 (the index in keyboard.keys).

Binding โ€‹

For a Key, the Key binding ยท {layer} section shows the current binding as a cap preview with Edit binding and Clear binding. Editing opens the binding picker.

For an Encoder, Encoder rotary ยท {layer} has three slots โ€” Rotate โ†ป (CW), Rotate โ†บ (CCW), Press. For a Slider, Slider value-map ยท {layer} has a mapping dropdown (Volume / Brightness / Wheel / โ€” No mapping โ€”) plus Min (out) / Max (out).

TIP

"Analog input is exported as firmware guidance โ€” the board-side ADC wiring is added in your overlay/keymap.c."

Geometry (U) โ€‹

Fields X, Y, Width, Height, plus quick width presets (1u, 1.25u, 1.5u, 1.75u, 2u, 2.25u, 2.75u, 6.25u) and a 2uโ†• height toggle. These map to x/y/w/h.

Rotation โ€‹

Angle ยฐ (โ†’ r) with Reset, fine โˆ’5ยฐ / +5ยฐ and step โˆ’15ยฐ / +15ยฐ buttons. When a key is rotated, Pivot X / Pivot Y (โ†’ rx/ry) appear.

Matrix wiring ยท row / column โ€‹

Set the key's electrical position (โ†’ matrix: [row, col]):

  • Row / Column dropdowns (each option shows its pin, e.g. Row 2 ยท GP6).
  • Status line: "Wired to {rowPin} ร— {colPin}".
  • Auto-assign row/col from position โ€” re-derives row/col whenever the key moves. "Editing row/column by hand turns it off."
  • Snap to grid on row/col change.

Direct GPIO pin โ€‹

A single direct-wired GPIO for this key (โ†’ pin), labelled by element: Direct GPIO pin (optional) for a key, Encoder pin A (direct) for an encoder, ADC pin for a slider. Placeholder e.g. GP29. Export metadata for now.

Layout variant โ€‹

When the board has layout variants, a Layout variant dropdown tags the key into one (โ†’ variant); the default is Common (all variants).

Multi-select โ€” bulk actions โ€‹

Select several keys and the inspector switches to {n} keys selected ยท Bulk actions apply to all:

GroupControls
Matrix wiringSet all to row + Apply; Number columns from + By X
Align & sizeLeft edges, Top edges, Reset to 1U, Auto matrix, Duplicate, Delete

Nothing selected โ€‹

Shows "Nothing selected โ€” click a key to edit its size, position & matrix. Drag on empty space to marquee-select."

Next โ€‹

Layers & bindings โ†’

Apache-2.0. Originally forked from ZMK Studio; application layer fully rewritten.