light_state.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
#include "esphome/core/optional.h"
#include "esphome/core/preferences.h"
#include "light_call.h"
#include "light_color_values.h"
#include "light_effect.h"
#include "light_traits.h"
#include "light_transformer.h"

#include <vector>

namespace esphome {
namespace light {

class LightOutput;

enum LightRestoreMode {
  LIGHT_RESTORE_DEFAULT_OFF,
  LIGHT_RESTORE_DEFAULT_ON,
  LIGHT_ALWAYS_OFF,
  LIGHT_ALWAYS_ON,
  LIGHT_RESTORE_INVERTED_DEFAULT_OFF,
  LIGHT_RESTORE_INVERTED_DEFAULT_ON,
  LIGHT_RESTORE_AND_OFF,
  LIGHT_RESTORE_AND_ON,
};

class LightState : public EntityBase, public Component {
 public:
  LightState(LightOutput *output);

  LightTraits get_traits();

  LightCall turn_on();
  LightCall turn_off();
  LightCall toggle();
  LightCall make_call();

  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
  void setup() override;
  void dump_config() override;
  void loop() override;
  float get_setup_priority() const override;

  LightColorValues current_values;

  LightColorValues remote_values;

  void publish_state();

  LightOutput *get_output() const;

  std::string get_effect_name();

  void add_new_remote_values_callback(std::function<void()> &&send_callback);

  void add_new_target_state_reached_callback(std::function<void()> &&send_callback);

  void set_default_transition_length(uint32_t default_transition_length);
  uint32_t get_default_transition_length() const;

  void set_flash_transition_length(uint32_t flash_transition_length);
  uint32_t get_flash_transition_length() const;

  void set_gamma_correct(float gamma_correct);
  float get_gamma_correct() const { return this->gamma_correct_; }

  void set_restore_mode(LightRestoreMode restore_mode);

  bool supports_effects();

  const std::vector<LightEffect *> &get_effects() const;

  void add_effects(const std::vector<LightEffect *> &effects);

  void current_values_as_binary(bool *binary);

  void current_values_as_brightness(float *brightness);

  void current_values_as_rgb(float *red, float *green, float *blue, bool color_interlock = false);

  void current_values_as_rgbw(float *red, float *green, float *blue, float *white, bool color_interlock = false);

  void current_values_as_rgbww(float *red, float *green, float *blue, float *cold_white, float *warm_white,
                               bool constant_brightness = false);

  void current_values_as_rgbct(float *red, float *green, float *blue, float *color_temperature,
                               float *white_brightness);

  void current_values_as_cwww(float *cold_white, float *warm_white, bool constant_brightness = false);

  void current_values_as_ct(float *color_temperature, float *white_brightness);

  bool is_transformer_active();

 protected:
  friend LightOutput;
  friend LightCall;
  friend class AddressableLight;

  void start_effect_(uint32_t effect_index);
  LightEffect *get_active_effect_();
  void stop_effect_();
  void start_transition_(const LightColorValues &target, uint32_t length, bool set_remote_values);

  void start_flash_(const LightColorValues &target, uint32_t length, bool set_remote_values);

  void set_immediately_(const LightColorValues &target, bool set_remote_values);

  void save_remote_values_();

  LightOutput *output_;
  uint32_t active_effect_index_{};
  std::unique_ptr<LightTransformer> transformer_{nullptr};
  bool next_write_{true};

  ESPPreferenceObject rtc_;

  CallbackManager<void()> remote_values_callback_{};

  CallbackManager<void()> target_state_reached_callback_{};

  uint32_t default_transition_length_{};
  uint32_t flash_transition_length_{};
  float gamma_correct_{};
  LightRestoreMode restore_mode_;
  std::vector<LightEffect *> effects_;

  // for effects, true if a transformer (transition) is active.
  bool is_transformer_active_ = false;
};

}  // namespace light
}  // namespace esphome