Reference Manual


Device / VirtualLeds / CustomVledDefinition Value

Virtual LED (VLED) definitions describe how one or more LEDs are to be activated when the corresponding VLED port is enabled via UI.Enable or BaltechScript.

The first 8 VLED definitions (0x40 - 0x47) are also used to maintain legacy compatibility. They're evaluated by the firmware in case a legacy LED port (GreenLed/RedLed/BlueLed) is switched. To avoid an undesired behavior, use either legacy or VLED ports, but not both.

Properties

Format

Name Type/Size Description
api-composite -
VledDefinition.Mode Bit mask (8 bits) This byte is required to enable additional fields for the characterization of the desired LED behavior.
RFU Integer (bit mask area 0xF8) Zero padding
ContainsTransitionTime Boolean (bit 0x04) If true, this virtual LED definition contains an individual transition time, which is applied to this VLED only. If false, the default transition time will be applied.
IsPulse Boolean (bit 0x02) If true, this virtual LED definition describes a pulse signal that continuously fades between 2 RGB colors. It contains the second RGB color value in an additional field.
ContainsPhysicalLedSelection Boolean (bit 0x01) If true, this virtual LED definition contains the field PhysicalLedSelection.
If false, the firmware uses the default value All.
VledDefinition.RgbColor Integer (32 bits) This is the color of the VLED port in the RGB color space (0x00RRGGBB). In case of a pulse signal, this is the first color value.
Optional field, condition: ContainsPhysicalLedSelection
VledDefinition.PhysicalLedSelection Enumeration (8 bits) This field defines which physical LEDs are to be activated when the corresponding VLED port is enabled.
Values:
  • Right (0x01)
    Activates only the LEDs on the right side.
  • Left (0x02)
    Activates only the LEDs on the left side.
  • All (0x03)
    Activates all LEDs.
Optional field, condition: IsPulse
VledDefinition.RgbColor2 Integer (32 bits) This field is only available in case of a pulse signal. It defines the second RGB color of the pulse.
Optional field, condition: ContainsTransitionTime
VledDefinition.TransitionTime Integer (16 bits) This field defines the transition time which is applied whenever this virtual LED is enabled. This value overrides the default transition time.