Ipc Effect

Format

{
  "Type": "IpcEffect",
  "Config": {
    "IpcName": <string>,
        
    "ColorGenerationMethod": <enum>,
    "Trigger": <Trigger>
  }
}

Data Format

The plugin expects data sent to the Ipc Server in this format.

[
  {
    "Port": <PortIdentifier>,
    "Colors": [<LedColor>]
  }
]

Variables

IpcName

Client name that will be used when sending data to the Ipc Server.

Allowed values: Value must be unique from all plugins using ipc.

Required: No
Default value:

Example:

"IpcName": "MyEffect"

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

Example