Aurora Effect

Format

{
  "Type": "AuroraEffect",
  "Config": {
    "Step": <float>,
    "Length": <int>,
    "Mirror": <bool>,
    "Brightness": <float>,
    "Saturation": <float>,
    "Gradient": <LedColorGradient>,

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

Variables

Step

Gradient advance speed.

Required: No
Default value:

0.003

Example:

"Step": 0.01

Length

Gradient length.

Note: Higher values improve color smoothness.

Required: No
Default value:

Example:

"Length": 256

Mirror

If set to true, the gradient is mirrored across device center axis.

Required: No
Default value:

false

Example:

"Mirror": true

Brightness

Brightness of colors.

Note: Value from 0.0 to 1.0.

Required: No
Default value:

1.0

Example:

"Brightness": 0.5

Saturation

Saturation of colors.

Note: Value from 0.0 to 1.0.

Required: No
Default value:

1.0

Example:

"Saturation": 0.5

Gradient

A Led Color Gradient.

Note: The gradient <location> values are values from 0.0 to 1.0.

Note: If not set, a default rainbow gradient will be generated.

Required: No
Default value:

Example:

"Gradient": [
  [0.0, [0, 0, 0]],
  [0.75, [255, 255, 255]],
  [1.0, [255, 0, 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"
}