10static const char *
const TAG =
"light";
13#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
14static void log_validation_warning(
const char *name,
const LogString *param_name,
float val,
float min,
float max) {
15 ESP_LOGW(TAG,
"'%s': %s value %.2f is out of range [%.1f - %.1f]", name, LOG_STR_ARG(param_name),
val, min, max);
18static void log_feature_not_supported(
const char *name,
const LogString *feature) {
19 ESP_LOGW(TAG,
"'%s': %s not supported", name, LOG_STR_ARG(feature));
22static void log_color_mode_not_supported(
const char *name,
const LogString *feature) {
23 ESP_LOGW(TAG,
"'%s': color mode does not support setting %s", name, LOG_STR_ARG(feature));
26static void log_invalid_parameter(
const char *name,
const LogString *message) {
27 ESP_LOGW(TAG,
"'%s': %s", name, LOG_STR_ARG(message));
30#define log_validation_warning(name, param_name, val, min, max)
31#define log_feature_not_supported(name, feature)
32#define log_color_mode_not_supported(name, feature)
33#define log_invalid_parameter(name, message)
37#define IMPLEMENT_LIGHT_CALL_SETTER(name, type, flag) \
38 LightCall &LightCall::set_##name(optional<type>(name)) { \
39 if ((name).has_value()) { \
40 this->name##_ = (name).value(); \
42 this->set_flag_(flag, (name).has_value()); \
45 LightCall &LightCall::set_##name(type name) { \
46 this->name##_ = name; \
47 this->set_flag_(flag, true); \
51static const LogString *color_mode_to_human(
ColorMode color_mode) {
53 return LOG_STR(
"Unknown");
55 return LOG_STR(
"White");
57 return LOG_STR(
"Color temperature");
59 return LOG_STR(
"Cold/warm white");
61 return LOG_STR(
"RGB");
63 return LOG_STR(
"RGBW");
65 return LOG_STR(
"RGB + cold/warm white");
67 return LOG_STR(
"RGB + color temperature");
72#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
73static void log_percent(
const char *name,
const char *param,
float value) {
74 ESP_LOGD(TAG,
" %s: %.0f%%", param, value * 100.0f);
77#define log_percent(name, param, value)
86 ESP_LOGD(TAG,
"'%s' Setting:", name);
91 if (target_color_mode != current_color_mode) {
92 ESP_LOGD(TAG,
" Color mode: %s", LOG_STR_ARG(color_mode_to_human(v.
get_color_mode())));
98 if (target_state != current_state) {
99 ESP_LOGD(TAG,
" State: %s", ONOFF(v.
is_on()));
110 ESP_LOGD(TAG,
" Red: %.0f%%, Green: %.0f%%, Blue: %.0f%%", v.
get_red() * 100.0f, v.
get_green() * 100.0f,
115 log_percent(name,
"White", v.
get_white());
122 ESP_LOGD(TAG,
" Cold white: %.0f%%, warm white: %.0f%%", v.
get_cold_white() * 100.0f,
130 ESP_LOGD(TAG,
" Flash length: %.1fs", this->
flash_length_ / 1e3f);
143 ESP_LOGD(TAG,
" Effect: 'None'");
152 const char *effect_s;
160 ESP_LOGD(TAG,
" Effect: '%s'", effect_s);
189 if (this->
has_color_mode() && !traits.supports_color_mode(this->color_mode_)) {
190 ESP_LOGW(TAG,
"'%s' does not support color mode %s", name, LOG_STR_ARG(color_mode_to_human(this->
color_mode_)));
206 log_feature_not_supported(name, LOG_STR(
"brightness"));
212 log_feature_not_supported(name, LOG_STR(
"transitions"));
218 log_color_mode_not_supported(name, LOG_STR(
"RGB brightness"));
226 log_color_mode_not_supported(name, LOG_STR(
"RGB color"));
236 log_color_mode_not_supported(name, LOG_STR(
"white value"));
243 log_color_mode_not_supported(name, LOG_STR(
"color temperature"));
250 log_color_mode_not_supported(name, LOG_STR(
"cold/warm white value"));
256#define VALIDATE_RANGE_(name_, upper_name, min, max) \
257 if (this->has_##name_()) { \
258 auto val = this->name_##_; \
259 if (val < (min) || val > (max)) { \
260 log_validation_warning(name, LOG_STR(upper_name), val, (min), (max)); \
261 this->name_##_ = clamp(val, (min), (max)); \
264#define VALIDATE_RANGE(name, upper_name) VALIDATE_RANGE_(name, upper_name, 0.0f, 1.0f)
267 VALIDATE_RANGE(brightness,
"Brightness")
268 VALIDATE_RANGE(color_brightness,
"Color brightness")
269 VALIDATE_RANGE(red,
"Red")
270 VALIDATE_RANGE(green,
"Green")
271 VALIDATE_RANGE(blue,
"Blue")
272 VALIDATE_RANGE(white,
"White")
273 VALIDATE_RANGE(cold_white,
"Cold white")
274 VALIDATE_RANGE(warm_white,
"Warm white")
275 VALIDATE_RANGE_(color_temperature,
"Color temperature", traits.get_min_mireds(), traits.get_max_mireds())
300 v.set_state(this->
state_);
306 v.set_red(this->
red_);
308 v.set_green(this->
green_);
310 v.set_blue(this->
blue_);
312 v.set_white(this->
white_);
324 log_invalid_parameter(name, LOG_STR(
"flash length must be greater than zero"));
338 ESP_LOGW(TAG,
"'%s': invalid effect index %" PRIu32, name, this->
effect_);
343 log_invalid_parameter(name, LOG_STR(
"effect cannot be used with transition/flash"));
349 log_invalid_parameter(name, LOG_STR(
"flash cannot be used with transition"));
354 supports_transition) {
366 log_feature_not_supported(name, LOG_STR(
"transitions"));
376 log_invalid_parameter(name, LOG_STR(
"cannot start effect when turning off"));
403 const float max_mireds = traits.get_max_mireds();
409 min_mireds > 0.0f && max_mireds > 0.0f) {
410 ESP_LOGD(TAG,
"'%s': setting cold/warm white channels using white/color temperature values",
414 const float range = max_mireds - min_mireds;
415 const float ww_fraction = (color_temp - min_mireds) /
range;
416 const float cw_fraction = 1.0f - ww_fraction;
417 const float max_cw_ww = std::max(ww_fraction, cw_fraction);
432 int supported_count = supported_modes.size();
435 if (supported_count == 0)
439 if (supported_count == 1)
440 return *supported_modes.begin();
453 if (suitable_modes.count(current_mode) > 0) {
454 ESP_LOGI(TAG,
"'%s': color mode not specified; retaining %s", this->
parent_->
get_name().
c_str(),
455 LOG_STR_ARG(color_mode_to_human(current_mode)));
460 for (
auto mode : suitable_modes) {
461 if (supported_modes.count(
mode) == 0)
465 LOG_STR_ARG(color_mode_to_human(
mode)));
471 auto color_mode = current_mode !=
ColorMode::UNKNOWN ? current_mode : *supported_modes.begin();
472 ESP_LOGW(TAG,
"'%s': no suitable color mode supported; defaulting to %s", this->
parent_->
get_name().
c_str(),
473 LOG_STR_ARG(color_mode_to_human(color_mode)));
485#define KEY(white, ct, cwww, rgb) ((white) << 0 | (ct) << 1 | (cwww) << 2 | (rgb) << 3)
487 uint8_t key = KEY(
has_white, has_ct, has_cwww, has_rgb);
490 case KEY(
true,
false,
false,
false):
493 case KEY(
false,
true,
false,
false):
496 case KEY(
true,
true,
false,
false):
498 case KEY(
false,
false,
true,
false):
500 case KEY(
false,
false,
false,
false):
503 case KEY(
true,
false,
false,
true):
505 case KEY(
false,
true,
false,
true):
506 case KEY(
true,
true,
false,
true):
508 case KEY(
false,
false,
true,
true):
510 case KEY(
false,
false,
false,
true):
520 if (strcasecmp(effect.c_str(),
"none") == 0) {
529 if (strcasecmp(effect.c_str(), e->
get_name().c_str()) == 0) {
627 if (effect.has_value())
658 this->
set_rgb(red, green, blue);
BedjetMode mode
BedJet operating mode.
const StringRef & get_name() const
constexpr const char * c_str() const
This class represents a requested change in a light state.
bool has_color_mode() const
bool has_color_temperature() const
LightCall & set_color_mode_if_supported(ColorMode color_mode)
Set the color mode of the light, if this mode is supported.
LightCall & set_color_temperature(optional< float > color_temperature)
Set the color temperature of the light in mireds for CWWW or RGBWW lights.
LightCall & set_publish(bool publish)
Set whether this light call should trigger a publish state.
ColorMode compute_color_mode_()
LightCall & set_color_brightness(optional< float > brightness)
Set the color brightness of the light from 0.0 (no color) to 1.0 (fully on)
bool has_warm_white() const
bool has_brightness() const
LightCall & set_rgb(float red, float green, float blue)
Set the RGB color of the light by RGB values.
bool has_cold_white() const
LightCall & set_transition_length_if_supported(uint32_t transition_length)
Set the transition length property if the light supports transitions.
bool has_color_brightness() const
LightCall & set_red_if_supported(float red)
Set the red property if the light supports RGB.
LightCall & set_effect(optional< std::string > effect)
Set the effect of the light by its name.
std::set< ColorMode > get_suitable_color_modes_()
Get potential color modes for this light call.
LightCall & set_color_brightness_if_supported(float brightness)
Set the color brightness property if the light supports RGBW.
LightCall & set_white(optional< float > white)
Set the white value value of the light from 0.0 to 1.0 for RGBW[W] lights.
LightCall & set_green(optional< float > green)
Set the green RGB value of the light from 0.0 to 1.0.
LightCall & set_green_if_supported(float green)
Set the green property if the light supports RGB.
LightCall & set_warm_white(optional< float > warm_white)
Set the warm white value of the light from 0.0 to 1.0.
LightCall & set_rgbw(float red, float green, float blue, float white)
Set the RGBW color of the light by RGB values.
LightCall & set_save(bool save)
Set whether this light call should trigger a save state to recover them at startup....
LightCall & set_color_temperature_if_supported(float color_temperature)
Set the color_temperature property if the light supports color temperature.
LightCall & set_blue(optional< float > blue)
Set the blue RGB value of the light from 0.0 to 1.0.
LightCall & set_cold_white(optional< float > cold_white)
Set the cold white value of the light from 0.0 to 1.0.
LightCall & set_red(optional< float > red)
Set the red RGB value of the light from 0.0 to 1.0.
ColorMode get_active_color_mode_()
Get the currently targeted, or active if none set, color mode.
void set_flag_(FieldFlags flag, bool value)
LightCall & set_white_if_supported(float white)
Set the white property if the light supports RGB.
LightCall & set_cold_white_if_supported(float cold_white)
Set the cold white property if the light supports cold white output.
LightCall & set_warm_white_if_supported(float warm_white)
Set the warm white property if the light supports cold white output.
@ FLAG_HAS_COLOR_TEMPERATURE
@ FLAG_HAS_COLOR_BRIGHTNESS
LightCall & set_brightness_if_supported(float brightness)
Set the brightness property if the light supports brightness.
LightColorValues validate_()
Validate all properties and return the target light color values.
uint32_t transition_length_
LightCall & set_brightness(optional< float > brightness)
Set the target brightness of the light from 0.0 (fully off) to 1.0 (fully on)
LightCall & set_blue_if_supported(float blue)
Set the blue property if the light supports RGB.
void transform_parameters_()
Some color modes also can be set using non-native parameters, transform those calls.
LightCall & from_light_color_values(const LightColorValues &values)
LightCall & set_state(optional< bool > state)
Set the binary ON/OFF state of the light.
LightCall & set_color_mode(optional< ColorMode > color_mode)
Set the color mode of the light.
LightCall & set_transition_length(optional< uint32_t > transition_length)
Set the transition length of this call in milliseconds.
This class represents the color state for a light object.
void set_color_mode(ColorMode color_mode)
Set the color mode of these light color values.
float get_brightness() const
Get the brightness property of these light color values. In range 0.0 to 1.0.
float get_blue() const
Get the blue property of these light color values. In range 0.0 to 1.0.
float get_white() const
Get the white property of these light color values. In range 0.0 to 1.0.
float get_color_temperature() const
Get the color temperature property of these light color values in mired.
float get_cold_white() const
Get the cold white property of these light color values. In range 0.0 to 1.0.
bool is_on() const
Get the binary true/false state of these light color values.
float get_green() const
Get the green property of these light color values. In range 0.0 to 1.0.
float get_warm_white() const
Get the warm white property of these light color values. In range 0.0 to 1.0.
ColorMode get_color_mode() const
Get the color mode of these light color values.
float get_red() const
Get the red property of these light color values. In range 0.0 to 1.0.
float get_color_brightness() const
Get the color brightness property of these light color values. In range 0.0 to 1.0.
const std::string & get_name()
void start_effect_(uint32_t effect_index)
Internal method to start an effect with the given index.
void stop_effect_()
Internal method to stop the current effect (if one is active).
LightColorValues remote_values
The remote color values reported to the frontend.
void save_remote_values_()
Internal method to save the current remote_values to the preferences.
void set_immediately_(const LightColorValues &target, bool set_remote_values)
Internal method to set the color values to target immediately (with no transition).
float get_gamma_correct() const
void publish_state()
Publish the currently active state to the frontend.
uint32_t active_effect_index_
Value for storing the index of the currently active effect. 0 if no effect is active.
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.
std::vector< LightEffect * > effects_
List of effects for this light.
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...
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.
uint32_t default_transition_length_
Default transition length for all transitions in ms.
bool supports_color_mode(ColorMode color_mode) const
const std::set< ColorMode > & get_supported_color_modes() const
float get_min_mireds() const
value_type const & value() const
IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE) IMPLEMENT_LIGHT_CALL_SETTER(transition_length
ColorMode
Color modes are a combination of color capabilities that can be used at the same time.
@ RGB_COLD_WARM_WHITE
RGB color output, and separate cold and warm white outputs.
@ UNKNOWN
No color mode configured (cannot be a supported mode, only active when light is off).
@ RGB_WHITE
RGB color output and a separate white output.
@ RGB_COLOR_TEMPERATURE
RGB color output and a separate white output with controllable color temperature.
@ COLOR_TEMPERATURE
Controllable color temperature output.
@ WHITE
White output only (use only if the light also has another color mode such as RGB).
@ COLD_WARM_WHITE
Cold and warm white output with individually controllable brightness.
@ BRIGHTNESS
Master brightness of the light can be controlled.
@ RGB
Color can be controlled using RGB format (includes a brightness control for the color).
@ COLOR_TEMPERATURE
Color temperature can be controlled.
@ WHITE
Brightness of white channel can be controlled separately from other channels.
@ COLD_WARM_WHITE
Brightness of cold and warm white output can be controlled.
Providing packet encoding functions for exchanging data with a remote host.
float gamma_uncorrect(float value, float gamma)
Reverts gamma correction of gamma to value.