RGB Light

The rgb light platform creates an RGB light from 3 float output components (one for each color channel).

../../_images/rgb-strip.jpg

Example of an RGB LED strip that can be used with this component.

../../_images/rgb-ui.png
# Example configuration entry
light:
  - platform: rgb
    name: "Living Room Lights"
    red: output_component1
    green: output_component2
    blue: output_component3

# Example output entry
output:
  - platform: esp8266_pwm
    id: output_component1
    pin: D1
  # Repeat for green and blue output

Color Correction

It is often favourable to calibrate/correct the color produced by an LED strip light as the perceived intensity of different colors will generally vary. This can be done by using max_power on individual output channels:

# Example configuration entry
light:
  - platform: rgb
    name: "Living Room Lights"
    red: output_component1
    green: output_component2
    blue: output_component3

# Example output entry
output:
  - platform: esp8266_pwm
    id: output_component1
    pin: D1
    max_power: 80%
  # Repeat for green and blue output

Note

Remember that gamma_correct is enabled by default (γ=2.8), and you may want take it into account for the calibration. For instance if you command a light to 50% brightness and want it to be the new maximum: max_PWM_power = max_light_power^2.8 = 0.5^2.8 = 0.144, then you would set max_power to 14.4%.

Configuration variables:

  • name (Required, string): The name of the light.

  • red (Required, ID): The id of the float Output Component to use for the red channel.

  • green (Required, ID): The id of the float Output Component to use for the green channel.

  • blue (Required, ID): The id of the float Output Component to use for the blue channel.

  • effects (Optional, list): A list of light effects to use for this light.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • All other options from Light.

See Also

../../_images/rgb-detail.jpg