Ripple Effect

Format

{
  "Type": "RippleEffect",
  "Config": {
    "Length": <int>,
    "TickInterval": <int>,
    "RippleColor": <LedColorProvider>,
    "BackgroundColor": <LedColorProvider>,

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

Variables

Length

Ripple length in number of leds.

Required: No
Default value:

Example:

"Length": 3

TickInterval

Number of updates before the ripple advances to the next led.

Required: No
Default value:

Example:

"TickInterval": 2

RippleColor

A Led Color Provider object for the ripple.

Required: Yes
Default value:

Example:

{
  "Gradient": [
    [0, [255, 0, 0]],
    [0.5, [0, 255, 0]],
    [1.0 [255, 0, 0]]
  ]
}

BackgroundColor

A Led Color Provider object for the background.

Required: No
Default value:

Example:

"Color": {
  "Gradient": [
    [0, [255, 0, 0]],
    [0.5, [0, 255, 0]],
    [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"
}