Interface to write LightStates to hardware. More...
#include <light_output.h>
Public Member Functions | |
| virtual LightTraits | get_traits ()=0 |
| Return the LightTraits of this LightOutput. More... | |
| virtual std::unique_ptr< LightTransformer > | create_default_transition () |
| Return the default transformer used for transitions. More... | |
| virtual void | setup_state (LightState *state) |
| virtual void | update_state (LightState *state) |
| Called on every update of the current values of the associated LightState, can optionally be used to do processing of this change. More... | |
| virtual void | write_state (LightState *state)=0 |
| Called from loop() every time the light state has changed, and should should write the new state to hardware. More... | |
Detailed Description
Interface to write LightStates to hardware.
Definition at line 12 of file light_output.h.
Member Function Documentation
◆ create_default_transition()
|
virtual |
Return the default transformer used for transitions.
Reimplemented in esphome::light::AddressableLight.
Definition at line 7 of file light_output.cpp.
◆ get_traits()
|
pure virtual |
Return the LightTraits of this LightOutput.
Implemented in esphome::fastled_base::FastLEDLightOutput, esphome::neopixelbus::NeoPixelRGBWLightOutput< T_METHOD, T_COLOR_FEATURE >, esphome::neopixelbus::NeoPixelRGBLightOutput< T_METHOD, T_COLOR_FEATURE >, esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput, esphome::partition::PartitionLightOutput, esphome::sonoff_d1::SonoffD1Output, esphome::tuya::TuyaLight, esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput, esphome::demo::DemoLight, esphome::shelly_dimmer::ShellyDimmer, esphome::rgbct::RGBCTLightOutput, esphome::rgbww::RGBWWLightOutput, esphome::spi_led_strip::SpiLedStrip, esphome::hbridge::HBridgeLightOutput, esphome::light::AddressableLightWrapper, esphome::cwww::CWWWLightOutput, esphome::rgbw::RGBWLightOutput, esphome::color_temperature::CTLightOutput, esphome::rgb::RGBLightOutput, esphome::status_led::StatusLEDLightOutput, esphome::binary::BinaryLightOutput, and esphome::monochromatic::MonochromaticLightOutput.
◆ setup_state()
|
inlinevirtual |
Reimplemented in esphome::light::AddressableLight, esphome::sonoff_d1::SonoffD1Output, esphome::tuya::TuyaLight, esphome::shelly_dimmer::ShellyDimmer, and esphome::status_led::StatusLEDLightOutput.
Definition at line 20 of file light_output.h.
◆ update_state()
|
inlinevirtual |
Called on every update of the current values of the associated LightState, can optionally be used to do processing of this change.
Reimplemented in esphome::light::AddressableLight.
Definition at line 24 of file light_output.h.
◆ write_state()
|
pure virtual |
Called from loop() every time the light state has changed, and should should write the new state to hardware.
Every call to write_state() is preceded by (at least) one call to update_state().
Implemented in esphome::fastled_base::FastLEDLightOutput, esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >, esphome::light::AddressableLightWrapper, esphome::demo::DemoLight, esphome::spi_led_strip::SpiLedStrip, esphome::partition::PartitionLightOutput, esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput, esphome::sonoff_d1::SonoffD1Output, esphome::tuya::TuyaLight, esphome::hbridge::HBridgeLightOutput, esphome::rgbct::RGBCTLightOutput, esphome::shelly_dimmer::ShellyDimmer, esphome::rgbww::RGBWWLightOutput, esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput, esphome::status_led::StatusLEDLightOutput, esphome::rgbw::RGBWLightOutput, esphome::cwww::CWWWLightOutput, esphome::color_temperature::CTLightOutput, esphome::rgb::RGBLightOutput, esphome::binary::BinaryLightOutput, and esphome::monochromatic::MonochromaticLightOutput.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/light/light_output.h
- /opt/build/esphome/esphome/components/light/light_output.cpp
