ESPHome  2024.3.1
Public Member Functions
esphome::light::LightOutput Class Referenceabstract

Interface to write LightStates to hardware. More...

#include <light_output.h>

Inheritance diagram for esphome::light::LightOutput:
esphome::binary::BinaryLightOutput esphome::color_temperature::CTLightOutput esphome::cwww::CWWWLightOutput esphome::demo::DemoLight esphome::hbridge::HBridgeLightOutput esphome::light::AddressableLight esphome::monochromatic::MonochromaticLightOutput esphome::rgb::RGBLightOutput esphome::rgbct::RGBCTLightOutput esphome::rgbw::RGBWLightOutput esphome::rgbww::RGBWWLightOutput esphome::shelly_dimmer::ShellyDimmer esphome::sonoff_d1::SonoffD1Output esphome::status_led::StatusLEDLightOutput esphome::tuya::TuyaLight

Public Member Functions

virtual LightTraits get_traits ()=0
 Return the LightTraits of this LightOutput. More...
 
virtual std::unique_ptr< LightTransformercreate_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()

std::unique_ptr< LightTransformer > esphome::light::LightOutput::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()

virtual LightTraits esphome::light::LightOutput::get_traits ( )
pure virtual

◆ setup_state()

virtual void esphome::light::LightOutput::setup_state ( LightState state)
inlinevirtual

◆ update_state()

virtual void esphome::light::LightOutput::update_state ( LightState 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()

virtual void esphome::light::LightOutput::write_state ( LightState state)
pure virtual

The documentation for this class was generated from the following files: