Port Configuration

Format

{
  "Ports": [<PortIdentifier>],
  "Config": {
    "Name": <string>,
    "DeviceType": <string>,
    "ColorModifiers": [<LedColorModifier>],
    "IgnoreColorCache": <bool>,
    "IgnoreSpeedCache": <bool>
  }
}

Variables

Ports

List of Port Identifiers modified by this config.

Required: Yes
Default value:

[]

Example:

"Ports": [
  [9802, 9101, 1],
  [9802, 9101, 3]
]

Name

Name of this port config.

Note: Unused.

Required: No
Default value:

"Unknown"

Example:

"Name": "Top Fans"

DeviceType

Used by effects to know exact led count and zones of each device
This ensures that the colors are generated properly.

Allowed values: "Default", "RiingQuad", "RiingTrio", "RiingDuo", "Riing", "FloeRiing", "PurePlus", "Level20Desk"

Required: No
Default value:

"Default"

Example:

"DeviceType": "RiingTrio"

ColorModifiers

List of Led Color Modifier objects to use for modifying colors before they are set on Ports.

Required: No
Default value:

Example:

[
  {
    "Type": "LerpLedColorModifier"
  },
  {
    "Type": "RotateLedColorModifier",
    "Config": {
      "ZoneRotation": [1, 2, 3]
    }
  }
]

IgnoreColorCache

By default the service stores the led colors in a cache and only sends data to the controller if there is a mismatch to improve the performance. Setting "IgnoreColorCache" to true ignores this optimization.

Note: Newer controllers like Riing Quad controller or Level 20 Desk controller require this option to be set, otherwise they will fallback to a default rainbow effect after some time of inactivity.

Required: No
Default value:

false

Example:

"IgnoreColorCache": true

IgnoreSpeedCache

By default the service stores the port speed in a cache and only sends data to the controller if there is a mismatch to improve the performance. Setting "IgnoreSpeedCache" to true ignores this optimization.

Required: No
Default value:

false

Example:

"IgnoreSpeedCache": true

Examples

{
  "Ports": [
  	[9802, 8101, 1],
  	[9802, 8101, 2]
  ],
  "Config": {
    "DeviceType": "RiingQuad",
    "IgnoreColorCache": true,
    "ColorModifiers": [
      {
        "Type": "LerpLedColorModifier"
      }
    ]
  }
}