Home Assistant

Flux

The flux switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. The flux switch restores its last state after startup.

The integration will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration.

During the day (in between start_time and sunset_time), it will fade the lights from the start_colortemp to the sunset_colortemp. After sunset (between sunset_time and stop_time), the lights will fade from the sunset_colortemp to the stop_colortemp. If the lights are still on after the stop_time it will continue to change the light to the stop_colortemp until the light is turned off. The fade effect is created by updating the lights periodically.

The value of sunset_time is automatically calculated based on the location specified in your Home Assistant configuration.

The color temperature is specified in kelvin, and accepted values are between 1000 and 40000 kelvin. Lower values will seem more red, while higher will look more white.

If you want to update at variable intervals, you can leave the switch turned off and use automation rules that call the service switch.<name>_update whenever you want the lights updated, where <name> equals the name: property in the switch configuration.

To use the Flux switch in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: flux
    lights:
      - light.desk
      - light.lamp

Configuration Variables

Looking for your configuration file?
lights list Required

array list of light entities.

name string (Optional, default: Flux)

The name to use when displaying this switch.

start_time time (Optional)

The start time.

stop_time time (Optional)

The stop time.

start_colortemp integer (Optional, default: 4000)

The color temperature at the start.

sunset_colortemp integer (Optional, default: 3000)

The sun set color temperature.

stop_colortemp integer (Optional, default: 1900)

The color temperature at the end.

brightness integer (Optional)

Constant brightness of the lights. Besides color temperature, brightness is also adjusted unless a value is specified here.

disable_brightness_adjust boolean (Optional, default: false)

If true, brightness will not be adjusted, only color temperature.

mode string (Optional, default: xy)

Select how color temperature is passed to lights. Valid values are xy, mired and rgb.

transition integer (Optional, default: 30)

Transition time in seconds for the light changes (high values may not be supported by all light models).

interval integer (Optional, default: 30)

Frequency in seconds at which the lights should be updated.

Full example:

# Example configuration.yaml entry
switch:
  - platform: flux
    lights:
      - light.desk
      - light.lamp
    name: Fluxer
    start_time: "7:00"
    stop_time: "23:00"
    start_colortemp: 4000
    sunset_colortemp: 3000
    stop_colortemp: 1900
    brightness: 200
    disable_brightness_adjust: true
    mode: xy
    transition: 30
    interval: 60