Sensor Effect

Format

{
  "Type": "SensorEffect",
  "Config": {
    "Sensors": [<SensorIdentifier>],
    "SensorMixFunction": <enum>,
    "SmoothingFactor": <float>,
    "ColorGradient": <LedColorGradient>,

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

Variables

Sensors

List of Sensor Identifiers to read values from.

Required: Yes
Default value:

[]

Example:

"Sensors": ["/intelcpu/0/temperature/8"]

SensorMixFunction

Determines how to combine values from Sensors.

Allowed values: "Maximum", "Minimum", "Average"

Required: No
Default value:

"Maximum"

Example:

"SensorMixFunction": "Average"

SmoothingFactor

Determines how fast should the current color blend to the target ColorGradient color.

Required: No
Default value:

0.05

Example:

"SmoothingFactor": 0.35

ColorGradient

A Led Color Gradient to translate Sensors values to led colors.

Note: The gradient <location> values are calculated Sensors values.

Required: Yes
Default value:

[]

Example:

"ColorGradient": [
  [30, [16, 0, 0]],
  [50, [64, 0, 0]],
  [70, [256, 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"
}

Example