ESPHome  2024.5.5
light_state.h
Go to the documentation of this file.
1 #pragma once
2 
7 #include "light_call.h"
8 #include "light_color_values.h"
9 #include "light_effect.h"
10 #include "light_traits.h"
11 #include "light_transformer.h"
12 
13 #include <vector>
14 
15 namespace esphome {
16 namespace light {
17 
18 class LightOutput;
19 
29 };
30 
34 class LightState : public EntityBase, public Component {
35  public:
36  LightState(LightOutput *output);
37 
39 
43  LightCall toggle();
45 
46  // ========== INTERNAL METHODS ==========
47  // (In most use cases you won't need these)
49  void setup() override;
50  void dump_config() override;
51  void loop() override;
53  float get_setup_priority() const override;
54 
66 
78 
80  void publish_state();
81 
83  LightOutput *get_output() const;
84 
86  std::string get_effect_name();
87 
94  void add_new_remote_values_callback(std::function<void()> &&send_callback);
95 
102  void add_new_target_state_reached_callback(std::function<void()> &&send_callback);
103 
105  void set_default_transition_length(uint32_t default_transition_length);
106  uint32_t get_default_transition_length() const;
107 
109  void set_flash_transition_length(uint32_t flash_transition_length);
110  uint32_t get_flash_transition_length() const;
111 
113  void set_gamma_correct(float gamma_correct);
114  float get_gamma_correct() const { return this->gamma_correct_; }
115 
117  void set_restore_mode(LightRestoreMode restore_mode);
118 
120  bool supports_effects();
121 
123  const std::vector<LightEffect *> &get_effects() const;
124 
126  void add_effects(const std::vector<LightEffect *> &effects);
127 
129  void current_values_as_binary(bool *binary);
130 
131  void current_values_as_brightness(float *brightness);
132 
133  void current_values_as_rgb(float *red, float *green, float *blue, bool color_interlock = false);
134 
135  void current_values_as_rgbw(float *red, float *green, float *blue, float *white, bool color_interlock = false);
136 
137  void current_values_as_rgbww(float *red, float *green, float *blue, float *cold_white, float *warm_white,
138  bool constant_brightness = false);
139 
140  void current_values_as_rgbct(float *red, float *green, float *blue, float *color_temperature,
141  float *white_brightness);
142 
143  void current_values_as_cwww(float *cold_white, float *warm_white, bool constant_brightness = false);
144 
145  void current_values_as_ct(float *color_temperature, float *white_brightness);
146 
156  bool is_transformer_active();
157 
158  protected:
159  friend LightOutput;
160  friend LightCall;
161  friend class AddressableLight;
162 
164  void start_effect_(uint32_t effect_index);
168  void stop_effect_();
170  void start_transition_(const LightColorValues &target, uint32_t length, bool set_remote_values);
171 
173  void start_flash_(const LightColorValues &target, uint32_t length, bool set_remote_values);
174 
176  void set_immediately_(const LightColorValues &target, bool set_remote_values);
177 
179  void save_remote_values_();
180 
186  std::unique_ptr<LightTransformer> transformer_{nullptr};
188  bool next_write_{true};
189 
192 
201 
206 
212  float gamma_correct_{};
216  std::vector<LightEffect *> effects_;
217 
218  // for effects, true if a transformer (transition) is active.
220 };
221 
222 } // namespace light
223 } // namespace esphome
void current_values_as_rgbww(float *red, float *green, float *blue, float *cold_white, float *warm_white, bool constant_brightness=false)
float gamma_correct_
Gamma correction factor for the light.
Definition: light_state.h:212
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition: light_state.h:34
ESPPreferenceObject rtc_
Object used to store the persisted values of the light.
Definition: light_state.h:191
void set_flash_transition_length(uint32_t flash_transition_length)
Set the flash transition length.
uint32_t get_flash_transition_length() const
void publish_state()
Publish the currently active state to the frontend.
std::unique_ptr< LightTransformer > transformer_
The currently active transformer for this light (transition/flash).
Definition: light_state.h:186
void set_immediately_(const LightColorValues &target, bool set_remote_values)
Internal method to set the color values to target immediately (with no transition).
uint32_t default_transition_length_
Default transition length for all transitions in ms.
Definition: light_state.h:208
Interface to write LightStates to hardware.
Definition: light_output.h:12
LightColorValues current_values
The current values of the light as outputted to the light.
Definition: light_state.h:65
void set_default_transition_length(uint32_t default_transition_length)
Set the default transition length, i.e. the transition length when no transition is provided...
std::string get_effect_name()
Return the name of the current effect, or if no effect is active "None".
LightCall turn_on()
Make a light state call.
Definition: light_state.cpp:14
void start_transition_(const LightColorValues &target, uint32_t length, bool set_remote_values)
Internal method to start a transition to the target color with the given length.
float get_gamma_correct() const
Definition: light_state.h:114
void start_effect_(uint32_t effect_index)
Internal method to start an effect with the given index.
LightRestoreMode restore_mode_
Restore mode of the light.
Definition: light_state.h:214
LightOutput * get_output() const
Get the light output associated with this object.
bool supports_effects()
Return whether the light has any effects that meet the trait requirements.
void start_flash_(const LightColorValues &target, uint32_t length, bool set_remote_values)
Internal method to start a flash for the specified amount of time.
void add_new_target_state_reached_callback(std::function< void()> &&send_callback)
The callback is called once the state of current_values and remote_values are equal (when the transit...
void setup() override
Load state from preferences.
Definition: light_state.cpp:34
void dump_config() override
void current_values_as_binary(bool *binary)
The result of all the current_values_as_* methods have gamma correction applied.
bool next_write_
Whether the light value should be written in the next cycle.
Definition: light_state.h:188
void current_values_as_rgb(float *red, float *green, float *blue, bool color_interlock=false)
uint32_t flash_transition_length_
Transition length to use for flash transitions.
Definition: light_state.h:210
LightState(LightOutput *output)
Definition: light_state.cpp:11
LightOutput * output_
Store the output to allow effects to have more access.
Definition: light_state.h:182
float gamma_correct(float value, float gamma)
Applies gamma correction of gamma to value.
Definition: helpers.cpp:539
This class represents the color state for a light object.
void current_values_as_rgbct(float *red, float *green, float *blue, float *color_temperature, float *white_brightness)
LightEffect * get_active_effect_()
Internal method to get the currently active effect.
void add_effects(const std::vector< LightEffect *> &effects)
Add effects for this light state.
void current_values_as_brightness(float *brightness)
uint32_t get_default_transition_length() const
void set_gamma_correct(float gamma_correct)
Set the gamma correction factor.
const std::vector< LightEffect * > & get_effects() const
Get all effects for this light state.
This class represents a requested change in a light state.
Definition: light_call.h:14
std::vector< LightEffect * > effects_
List of effects for this light.
Definition: light_state.h:216
void current_values_as_ct(float *color_temperature, float *white_brightness)
void current_values_as_cwww(float *cold_white, float *warm_white, bool constant_brightness=false)
float get_setup_priority() const override
Shortly after HARDWARE.
CallbackManager< void()> remote_values_callback_
Callback to call when new values for the frontend are available.
Definition: light_state.h:200
This class is used to represent the capabilities of a light.
Definition: light_traits.h:11
void add_new_remote_values_callback(std::function< void()> &&send_callback)
This lets front-end components subscribe to light change events.
void set_restore_mode(LightRestoreMode restore_mode)
Set the restore mode of this light.
void save_remote_values_()
Internal method to save the current remote_values to the preferences.
uint16_t length
Definition: tt21100.cpp:12
CallbackManager< void()> target_state_reached_callback_
Callback to call when the state of current_values and remote_values are equal This should be called o...
Definition: light_state.h:205
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
uint32_t active_effect_index_
Value for storing the index of the currently active effect. 0 if no effect is active.
Definition: light_state.h:184
LightColorValues remote_values
The remote color values reported to the frontend.
Definition: light_state.h:77
bool is_transformer_active()
Indicator if a transformer (e.g.
void stop_effect_()
Internal method to stop the current effect (if one is active).
void current_values_as_rgbw(float *red, float *green, float *blue, float *white, bool color_interlock=false)