Configurator Definitions

Terminology

  • POC: Jeff Rizo, Wai Lun Poon
  • Contact: @Jeff R on Slack, @Wai Lun on Slack

Configuration

  • The complete data representation of a keyboard’s settings and functional behavior.

Device Settings

  • Settings and telemetry pertaining to the specific device:
    • HW Version
    • FW Version
    • SKU/Serial Number
    • Battery Level
    • Paired BLE devices
    • Etc.
Layout
  • There are 3 layouts in a device
    • Each layout represents macro definitions and 5 layer definitions
Layer
  • A layer represents a collection of key and sensor bindings to behaviors (e.g. keypresses)
Keymap
  • ZMK data structure that encapsulates layers and their key/sensor bindings
Macro
  • A behavior that takes a keypress event as input, and outputs a sequence of keypresses

Device API Doc

#Keyboard Configurator

logo