Flow Effect

Format

{
  "Type": "FlowEffect",
  "Config": {
    "FillStep": <float>,
    "HueStep": <int>,
    "Saturation": <float>,
    "Brightness": <float>,

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

Variables

FillStep

Determines how fast the colors fill the device.

Required: No
Default value:

0.05

Example:

"FillStep": 0.1

HueStep

Determines color hue increment when the device gets completly filled.

Required: No
Default value:

Example:

"HueStep": 60

Saturation

Saturation of colors.

Note: Value from 0.0 to 1.0.

Required: No
Default value:

1.0

Example:

"Saturation": 0.5

Brightness

Brightness of colors.

Note: Value from 0.0 to 1.0.

Required: No
Default value:

1.0

Example:

"Brightness": 0.5

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"
}