light_call.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/optional.h"
#include "light_color_values.h"
#include <set>

namespace esphome {
namespace light {

class LightState;

class LightCall {
 public:
  explicit LightCall(LightState *parent) : parent_(parent) {}

  LightCall &set_state(optional<bool> state);
  LightCall &set_state(bool state);
  LightCall &set_transition_length(optional<uint32_t> transition_length);
  LightCall &set_transition_length(uint32_t transition_length);
  LightCall &set_transition_length_if_supported(uint32_t transition_length);
  LightCall &set_flash_length(optional<uint32_t> flash_length);
  LightCall &set_flash_length(uint32_t flash_length);
  LightCall &set_brightness(optional<float> brightness);
  LightCall &set_brightness(float brightness);
  LightCall &set_brightness_if_supported(float brightness);

  LightCall &set_color_mode(optional<ColorMode> color_mode);
  LightCall &set_color_mode(ColorMode color_mode);
  LightCall &set_color_mode_if_supported(ColorMode color_mode);

  LightCall &set_color_brightness(optional<float> brightness);
  LightCall &set_color_brightness(float brightness);
  LightCall &set_color_brightness_if_supported(float brightness);
  LightCall &set_red(optional<float> red);
  LightCall &set_red(float red);
  LightCall &set_red_if_supported(float red);
  LightCall &set_green(optional<float> green);
  LightCall &set_green(float green);
  LightCall &set_green_if_supported(float green);
  LightCall &set_blue(optional<float> blue);
  LightCall &set_blue(float blue);
  LightCall &set_blue_if_supported(float blue);
  LightCall &set_white(optional<float> white);
  LightCall &set_white(float white);
  LightCall &set_white_if_supported(float white);
  LightCall &set_color_temperature(optional<float> color_temperature);
  LightCall &set_color_temperature(float color_temperature);
  LightCall &set_color_temperature_if_supported(float color_temperature);
  LightCall &set_cold_white(optional<float> cold_white);
  LightCall &set_cold_white(float cold_white);
  LightCall &set_cold_white_if_supported(float cold_white);
  LightCall &set_warm_white(optional<float> warm_white);
  LightCall &set_warm_white(float warm_white);
  LightCall &set_warm_white_if_supported(float warm_white);
  LightCall &set_effect(optional<std::string> effect);
  LightCall &set_effect(const std::string &effect);
  LightCall &set_effect(uint32_t effect_number);
  LightCall &set_effect(optional<uint32_t> effect_number);
  LightCall &set_publish(bool publish);
  LightCall &set_save(bool save);

  LightCall &set_rgb(float red, float green, float blue);
  LightCall &set_rgbw(float red, float green, float blue, float white);
  LightCall &from_light_color_values(const LightColorValues &values);

  void perform();

 protected:
  ColorMode get_active_color_mode_();

  LightColorValues validate_();

  ColorMode compute_color_mode_();
  std::set<ColorMode> get_suitable_color_modes_();
  void transform_parameters_();

  bool has_transition_() { return this->transition_length_.has_value(); }
  bool has_flash_() { return this->flash_length_.has_value(); }
  bool has_effect_() { return this->effect_.has_value(); }

  LightState *parent_;
  optional<bool> state_;
  optional<uint32_t> transition_length_;
  optional<uint32_t> flash_length_;
  optional<ColorMode> color_mode_;
  optional<float> brightness_;
  optional<float> color_brightness_;
  optional<float> red_;
  optional<float> green_;
  optional<float> blue_;
  optional<float> white_;
  optional<float> color_temperature_;
  optional<float> cold_white_;
  optional<float> warm_white_;
  optional<uint32_t> effect_;
  bool publish_{true};
  bool save_{true};
};

}  // namespace light
}  // namespace esphome