# Copyright (c) 2020, The ZMK Contributors
# SPDX-License-Identifier: MIT

description: Global animation configuration

compatible: "zmk,animation"

properties:
  drivers:
    type: phandles
    required: true
    description: |
      This array should contain all driver devices responsible for illuminating animated LEDs.
      The devices must implement Zephyr's LED Strip Interface.

  chain-lengths:
    type: array
    required: true
    description: |
      This field contains the number of LEDs controlled by each driver device.

  pixels:
    type: phandle-array
    required: true
    description: |
      This field contains the pixel configuration for the entire board.
      The order of this array determines in what order pixels are sent to the driver device API.
      If multiple driving devices are used, their chain-length property determines the size of the buffer for each device.

  key-pixels:
    type: array
    description: |
      Use this field to specify the pixel index corresponding to each key
      following the order used in your keymap.
      When left unspecified, the driver assumes that for every key, the pixel has a matching id.
      So for N keys, the first N pixels are exactly in the same order as keys in your keymap.