Zone Effect

Format

{
  "Type": "ZoneEffect",
  "Config": {
    "Effects": [<Effect>],

    "ColorGenerationMethod": <enum>,
    "Trigger": <Trigger>
  }
}

Variables

Effects

List of Effect objects.

Allowed values: Each effect will be matched to the device zone.

Required: No
Default value:

Example:

"Effects": [
  {
    "Type": "StaticColorEffect",
    "Config": {
      "Color": {
        "Full": [255, 0, 0]
      }
    }
  },
  {
    "Type": "StaticColorEffect",
    "Config": {
      "Color": {
        "Full": [0, 255, 0]
      }
    }
  }
]

ColorGenerationMethod

Tells the effect how to generate colors for multiple devices. The actual behaviour is depended on the effect implementation.

Allowed values:

"PerPort" - Duplicates the effect on each device.
"SpanPorts" - Treats multiple devices as one.

Required: No
Default value:

"PerPort"

Example:

"ColorGenerationMethod": "SpanPorts"

Trigger

Instance of a Trigger plugin.

Required: Yes
Default value:

Example:

"Trigger": {
  "Type": "AlwaysTrigger"
}