ESPHome 2025.10.0-dev
Loading...
Searching...
No Matches
light_call.cpp
Go to the documentation of this file.
1#include <cinttypes>
2#include "light_call.h"
3#include "light_state.h"
4#include "esphome/core/log.h"
6
7namespace esphome {
8namespace light {
9
10static const char *const TAG = "light";
11
12// Helper functions to reduce code size for logging
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);
16}
17
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));
20}
21
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));
24}
25
26static void log_invalid_parameter(const char *name, const LogString *message) {
27 ESP_LOGW(TAG, "'%s': %s", name, LOG_STR_ARG(message));
28}
29#else
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)
34#endif
35
36// Macro to reduce repetitive setter code
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(); \
41 } \
42 this->set_flag_(flag, (name).has_value()); \
43 return *this; \
44 } \
45 LightCall &LightCall::set_##name(type name) { \
46 this->name##_ = name; \
47 this->set_flag_(flag, true); \
48 return *this; \
49 }
50
51static const LogString *color_mode_to_human(ColorMode color_mode) {
52 if (color_mode == ColorMode::UNKNOWN)
53 return LOG_STR("Unknown");
54 if (color_mode == ColorMode::WHITE)
55 return LOG_STR("White");
56 if (color_mode == ColorMode::COLOR_TEMPERATURE)
57 return LOG_STR("Color temperature");
58 if (color_mode == ColorMode::COLD_WARM_WHITE)
59 return LOG_STR("Cold/warm white");
60 if (color_mode == ColorMode::RGB)
61 return LOG_STR("RGB");
62 if (color_mode == ColorMode::RGB_WHITE)
63 return LOG_STR("RGBW");
64 if (color_mode == ColorMode::RGB_COLD_WARM_WHITE)
65 return LOG_STR("RGB + cold/warm white");
66 if (color_mode == ColorMode::RGB_COLOR_TEMPERATURE)
67 return LOG_STR("RGB + color temperature");
68 return LOG_STR("");
69}
70
71// Helper to log percentage values
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);
75}
76#else
77#define log_percent(name, param, value)
78#endif
79
81 const char *name = this->parent_->get_name().c_str();
82 LightColorValues v = this->validate_();
83 const bool publish = this->get_publish_();
84
85 if (publish) {
86 ESP_LOGD(TAG, "'%s' Setting:", name);
87
88 // Only print color mode when it's being changed
89 ColorMode current_color_mode = this->parent_->remote_values.get_color_mode();
90 ColorMode target_color_mode = this->has_color_mode() ? this->color_mode_ : current_color_mode;
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())));
93 }
94
95 // Only print state when it's being changed
96 bool current_state = this->parent_->remote_values.is_on();
97 bool target_state = this->has_state() ? this->state_ : current_state;
98 if (target_state != current_state) {
99 ESP_LOGD(TAG, " State: %s", ONOFF(v.is_on()));
100 }
101
102 if (this->has_brightness()) {
103 log_percent(name, "Brightness", v.get_brightness());
104 }
105
106 if (this->has_color_brightness()) {
107 log_percent(name, "Color brightness", v.get_color_brightness());
108 }
109 if (this->has_red() || this->has_green() || this->has_blue()) {
110 ESP_LOGD(TAG, " Red: %.0f%%, Green: %.0f%%, Blue: %.0f%%", v.get_red() * 100.0f, v.get_green() * 100.0f,
111 v.get_blue() * 100.0f);
112 }
113
114 if (this->has_white()) {
115 log_percent(name, "White", v.get_white());
116 }
117 if (this->has_color_temperature()) {
118 ESP_LOGD(TAG, " Color temperature: %.1f mireds", v.get_color_temperature());
119 }
120
121 if (this->has_cold_white() || this->has_warm_white()) {
122 ESP_LOGD(TAG, " Cold white: %.0f%%, warm white: %.0f%%", v.get_cold_white() * 100.0f,
123 v.get_warm_white() * 100.0f);
124 }
125 }
126
127 if (this->has_flash_()) {
128 // FLASH
129 if (publish) {
130 ESP_LOGD(TAG, " Flash length: %.1fs", this->flash_length_ / 1e3f);
131 }
132
133 this->parent_->start_flash_(v, this->flash_length_, publish);
134 } else if (this->has_transition_()) {
135 // TRANSITION
136 if (publish) {
137 ESP_LOGD(TAG, " Transition length: %.1fs", this->transition_length_ / 1e3f);
138 }
139
140 // Special case: Transition and effect can be set when turning off
141 if (this->has_effect_()) {
142 if (publish) {
143 ESP_LOGD(TAG, " Effect: 'None'");
144 }
145 this->parent_->stop_effect_();
146 }
147
148 this->parent_->start_transition_(v, this->transition_length_, publish);
149
150 } else if (this->has_effect_()) {
151 // EFFECT
152 const char *effect_s;
153 if (this->effect_ == 0u) {
154 effect_s = "None";
155 } else {
156 effect_s = this->parent_->effects_[this->effect_ - 1]->get_name().c_str();
157 }
158
159 if (publish) {
160 ESP_LOGD(TAG, " Effect: '%s'", effect_s);
161 }
162
163 this->parent_->start_effect_(this->effect_);
164
165 // Also set light color values when starting an effect
166 // For example to turn off the light
167 this->parent_->set_immediately_(v, true);
168 } else {
169 // INSTANT CHANGE
170 this->parent_->set_immediately_(v, publish);
171 }
172
173 if (!this->has_transition_()) {
175 }
176 if (publish) {
177 this->parent_->publish_state();
178 }
179 if (this->get_save_()) {
181 }
182}
183
185 auto *name = this->parent_->get_name().c_str();
186 auto traits = this->parent_->get_traits();
187
188 // Color mode check
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_)));
191 this->set_flag_(FLAG_HAS_COLOR_MODE, false);
192 }
193
194 // Ensure there is always a color mode set
195 if (!this->has_color_mode()) {
196 this->color_mode_ = this->compute_color_mode_();
197 this->set_flag_(FLAG_HAS_COLOR_MODE, true);
198 }
199 auto color_mode = this->color_mode_;
200
201 // Transform calls that use non-native parameters for the current mode.
202 this->transform_parameters_();
203
204 // Brightness exists check
205 if (this->has_brightness() && this->brightness_ > 0.0f && !(color_mode & ColorCapability::BRIGHTNESS)) {
206 log_feature_not_supported(name, LOG_STR("brightness"));
207 this->set_flag_(FLAG_HAS_BRIGHTNESS, false);
208 }
209
210 // Transition length possible check
211 if (this->has_transition_() && this->transition_length_ != 0 && !(color_mode & ColorCapability::BRIGHTNESS)) {
212 log_feature_not_supported(name, LOG_STR("transitions"));
213 this->set_flag_(FLAG_HAS_TRANSITION, false);
214 }
215
216 // Color brightness exists check
217 if (this->has_color_brightness() && this->color_brightness_ > 0.0f && !(color_mode & ColorCapability::RGB)) {
218 log_color_mode_not_supported(name, LOG_STR("RGB brightness"));
220 }
221
222 // RGB exists check
223 if ((this->has_red() && this->red_ > 0.0f) || (this->has_green() && this->green_ > 0.0f) ||
224 (this->has_blue() && this->blue_ > 0.0f)) {
225 if (!(color_mode & ColorCapability::RGB)) {
226 log_color_mode_not_supported(name, LOG_STR("RGB color"));
227 this->set_flag_(FLAG_HAS_RED, false);
228 this->set_flag_(FLAG_HAS_GREEN, false);
229 this->set_flag_(FLAG_HAS_BLUE, false);
230 }
231 }
232
233 // White value exists check
234 if (this->has_white() && this->white_ > 0.0f &&
235 !(color_mode & ColorCapability::WHITE || color_mode & ColorCapability::COLD_WARM_WHITE)) {
236 log_color_mode_not_supported(name, LOG_STR("white value"));
237 this->set_flag_(FLAG_HAS_WHITE, false);
238 }
239
240 // Color temperature exists check
241 if (this->has_color_temperature() &&
243 log_color_mode_not_supported(name, LOG_STR("color temperature"));
245 }
246
247 // Cold/warm white value exists check
248 if ((this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f)) {
249 if (!(color_mode & ColorCapability::COLD_WARM_WHITE)) {
250 log_color_mode_not_supported(name, LOG_STR("cold/warm white value"));
251 this->set_flag_(FLAG_HAS_COLD_WHITE, false);
252 this->set_flag_(FLAG_HAS_WARM_WHITE, false);
253 }
254 }
255
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)); \
262 } \
263 }
264#define VALIDATE_RANGE(name, upper_name) VALIDATE_RANGE_(name, upper_name, 0.0f, 1.0f)
265
266 // Range checks
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())
276
277 // Flag whether an explicit turn off was requested, in which case we'll also stop the effect.
278 bool explicit_turn_off_request = this->has_state() && !this->state_;
279
280 // Turn off when brightness is set to zero, and reset brightness (so that it has nonzero brightness when turned on).
281 if (this->has_brightness() && this->brightness_ == 0.0f) {
282 this->state_ = false;
283 this->set_flag_(FLAG_HAS_STATE, true);
284 this->brightness_ = 1.0f;
285 }
286
287 // Set color brightness to 100% if currently zero and a color is set.
288 if (this->has_red() || this->has_green() || this->has_blue()) {
289 if (!this->has_color_brightness() && this->parent_->remote_values.get_color_brightness() == 0.0f) {
290 this->color_brightness_ = 1.0f;
292 }
293 }
294
295 // Create color values for the light with this call applied.
296 auto v = this->parent_->remote_values;
297 if (this->has_color_mode())
299 if (this->has_state())
300 v.set_state(this->state_);
301 if (this->has_brightness())
302 v.set_brightness(this->brightness_);
303 if (this->has_color_brightness())
304 v.set_color_brightness(this->color_brightness_);
305 if (this->has_red())
306 v.set_red(this->red_);
307 if (this->has_green())
308 v.set_green(this->green_);
309 if (this->has_blue())
310 v.set_blue(this->blue_);
311 if (this->has_white())
312 v.set_white(this->white_);
313 if (this->has_color_temperature())
314 v.set_color_temperature(this->color_temperature_);
315 if (this->has_cold_white())
316 v.set_cold_white(this->cold_white_);
317 if (this->has_warm_white())
318 v.set_warm_white(this->warm_white_);
319
320 v.normalize_color();
321
322 // Flash length check
323 if (this->has_flash_() && this->flash_length_ == 0) {
324 log_invalid_parameter(name, LOG_STR("flash length must be greater than zero"));
325 this->set_flag_(FLAG_HAS_FLASH, false);
326 }
327
328 // validate transition length/flash length/effect not used at the same time
329 bool supports_transition = color_mode & ColorCapability::BRIGHTNESS;
330
331 // If effect is already active, remove effect start
332 if (this->has_effect_() && this->effect_ == this->parent_->active_effect_index_) {
333 this->set_flag_(FLAG_HAS_EFFECT, false);
334 }
335
336 // validate effect index
337 if (this->has_effect_() && this->effect_ > this->parent_->effects_.size()) {
338 ESP_LOGW(TAG, "'%s': invalid effect index %" PRIu32, name, this->effect_);
339 this->set_flag_(FLAG_HAS_EFFECT, false);
340 }
341
342 if (this->has_effect_() && (this->has_transition_() || this->has_flash_())) {
343 log_invalid_parameter(name, LOG_STR("effect cannot be used with transition/flash"));
344 this->set_flag_(FLAG_HAS_TRANSITION, false);
345 this->set_flag_(FLAG_HAS_FLASH, false);
346 }
347
348 if (this->has_flash_() && this->has_transition_()) {
349 log_invalid_parameter(name, LOG_STR("flash cannot be used with transition"));
350 this->set_flag_(FLAG_HAS_TRANSITION, false);
351 }
352
353 if (!this->has_transition_() && !this->has_flash_() && (!this->has_effect_() || this->effect_ == 0) &&
354 supports_transition) {
355 // nothing specified and light supports transitions, set default transition length
357 this->set_flag_(FLAG_HAS_TRANSITION, true);
358 }
359
360 if (this->has_transition_() && this->transition_length_ == 0) {
361 // 0 transition is interpreted as no transition (instant change)
362 this->set_flag_(FLAG_HAS_TRANSITION, false);
363 }
364
365 if (this->has_transition_() && !supports_transition) {
366 log_feature_not_supported(name, LOG_STR("transitions"));
367 this->set_flag_(FLAG_HAS_TRANSITION, false);
368 }
369
370 // If not a flash and turning the light off, then disable the light
371 // Do not use light color values directly, so that effects can set 0% brightness
372 // Reason: When user turns off the light in frontend, the effect should also stop
373 bool target_state = this->has_state() ? this->state_ : v.is_on();
374 if (!this->has_flash_() && !target_state) {
375 if (this->has_effect_()) {
376 log_invalid_parameter(name, LOG_STR("cannot start effect when turning off"));
377 this->set_flag_(FLAG_HAS_EFFECT, false);
378 } else if (this->parent_->active_effect_index_ != 0 && explicit_turn_off_request) {
379 // Auto turn off effect
380 this->effect_ = 0;
381 this->set_flag_(FLAG_HAS_EFFECT, true);
382 }
383 }
384
385 // Disable saving for flashes
386 if (this->has_flash_())
387 this->set_flag_(FLAG_SAVE, false);
388
389 return v;
390}
392 auto traits = this->parent_->get_traits();
393
394 // Allow CWWW modes to be set with a white value and/or color temperature.
395 // This is used in three cases in HA:
396 // - CW/WW lights, which set the "brightness" and "color_temperature"
397 // - RGBWW lights with color_interlock=true, which also sets "brightness" and
398 // "color_temperature" (without color_interlock, CW/WW are set directly)
399 // - Legacy Home Assistant (pre-colormode), which sets "white" and "color_temperature"
400
401 // Cache min/max mireds to avoid repeated calls
402 const float min_mireds = traits.get_min_mireds();
403 const float max_mireds = traits.get_max_mireds();
404
405 if (((this->has_white() && this->white_ > 0.0f) || this->has_color_temperature()) && //
407 !(this->color_mode_ & ColorCapability::WHITE) && //
409 min_mireds > 0.0f && max_mireds > 0.0f) {
410 ESP_LOGD(TAG, "'%s': setting cold/warm white channels using white/color temperature values",
411 this->parent_->get_name().c_str());
412 if (this->has_color_temperature()) {
413 const float color_temp = clamp(this->color_temperature_, min_mireds, max_mireds);
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);
418 const float gamma = this->parent_->get_gamma_correct();
419 this->cold_white_ = gamma_uncorrect(cw_fraction / max_cw_ww, gamma);
420 this->warm_white_ = gamma_uncorrect(ww_fraction / max_cw_ww, gamma);
421 this->set_flag_(FLAG_HAS_COLD_WHITE, true);
422 this->set_flag_(FLAG_HAS_WARM_WHITE, true);
423 }
424 if (this->has_white()) {
425 this->brightness_ = this->white_;
426 this->set_flag_(FLAG_HAS_BRIGHTNESS, true);
427 }
428 }
429}
431 auto supported_modes = this->parent_->get_traits().get_supported_color_modes();
432 int supported_count = supported_modes.size();
433
434 // Some lights don't support any color modes (e.g. monochromatic light), leave it at unknown.
435 if (supported_count == 0)
436 return ColorMode::UNKNOWN;
437
438 // In the common case of lights supporting only a single mode, use that one.
439 if (supported_count == 1)
440 return *supported_modes.begin();
441
442 // Don't change if the light is being turned off.
443 ColorMode current_mode = this->parent_->remote_values.get_color_mode();
444 if (this->has_state() && !this->state_)
445 return current_mode;
446
447 // If no color mode is specified, we try to guess the color mode. This is needed for backward compatibility to
448 // pre-colormode clients and automations, but also for the MQTT API, where HA doesn't let us know which color mode
449 // was used for some reason.
450 std::set<ColorMode> suitable_modes = this->get_suitable_color_modes_();
451
452 // Don't change if the current mode is suitable.
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)));
456 return current_mode;
457 }
458
459 // Use the preferred suitable mode.
460 for (auto mode : suitable_modes) {
461 if (supported_modes.count(mode) == 0)
462 continue;
463
464 ESP_LOGI(TAG, "'%s': color mode not specified; using %s", this->parent_->get_name().c_str(),
465 LOG_STR_ARG(color_mode_to_human(mode)));
466 return mode;
467 }
468
469 // There's no supported mode for this call, so warn, use the current more or a mode at random and let validation strip
470 // out whatever we don't support.
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)));
474 return color_mode;
475}
477 bool has_white = this->has_white() && this->white_ > 0.0f;
478 bool has_ct = this->has_color_temperature();
479 bool has_cwww =
480 (this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f);
481 bool has_rgb = (this->has_color_brightness() && this->color_brightness_ > 0.0f) ||
482 (this->has_red() || this->has_green() || this->has_blue());
483
484// Build key from flags: [rgb][cwww][ct][white]
485#define KEY(white, ct, cwww, rgb) ((white) << 0 | (ct) << 1 | (cwww) << 2 | (rgb) << 3)
486
487 uint8_t key = KEY(has_white, has_ct, has_cwww, has_rgb);
488
489 switch (key) {
490 case KEY(true, false, false, false): // white only
493 case KEY(false, true, false, false): // ct only
496 case KEY(true, true, false, false): // white + ct
498 case KEY(false, false, true, false): // cwww only
500 case KEY(false, false, false, false): // none
503 case KEY(true, false, false, true): // rgb + white
505 case KEY(false, true, false, true): // rgb + ct
506 case KEY(true, true, false, true): // rgb + white + ct
508 case KEY(false, false, true, true): // rgb + cwww
510 case KEY(false, false, false, true): // rgb only
512 default:
513 return {}; // conflicting flags
514 }
515
516#undef KEY
517}
518
519LightCall &LightCall::set_effect(const std::string &effect) {
520 if (strcasecmp(effect.c_str(), "none") == 0) {
521 this->set_effect(0);
522 return *this;
523 }
524
525 bool found = false;
526 for (uint32_t i = 0; i < this->parent_->effects_.size(); i++) {
527 LightEffect *e = this->parent_->effects_[i];
528
529 if (strcasecmp(effect.c_str(), e->get_name().c_str()) == 0) {
530 this->set_effect(i + 1);
531 found = true;
532 break;
533 }
534 }
535 if (!found) {
536 ESP_LOGW(TAG, "'%s': no such effect '%s'", this->parent_->get_name().c_str(), effect.c_str());
537 }
538 return *this;
539}
559 this->set_transition_length(transition_length);
560 return *this;
561}
564 this->set_brightness(brightness);
565 return *this;
566}
568 if (this->parent_->get_traits().supports_color_mode(color_mode))
569 this->set_color_mode(color_mode);
570 return *this;
571}
574 this->set_color_brightness(brightness);
575 return *this;
576}
579 this->set_red(red);
580 return *this;
581}
584 this->set_green(green);
585 return *this;
586}
589 this->set_blue(blue);
590 return *this;
591}
594 this->set_white(white);
595 return *this;
596}
605 this->set_cold_white(cold_white);
606 return *this;
607}
610 this->set_warm_white(warm_white);
611 return *this;
612}
613IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE)
614IMPLEMENT_LIGHT_CALL_SETTER(transition_length, uint32_t, FLAG_HAS_TRANSITION)
615IMPLEMENT_LIGHT_CALL_SETTER(flash_length, uint32_t, FLAG_HAS_FLASH)
616IMPLEMENT_LIGHT_CALL_SETTER(brightness, float, FLAG_HAS_BRIGHTNESS)
617IMPLEMENT_LIGHT_CALL_SETTER(color_mode, ColorMode, FLAG_HAS_COLOR_MODE)
618IMPLEMENT_LIGHT_CALL_SETTER(color_brightness, float, FLAG_HAS_COLOR_BRIGHTNESS)
619IMPLEMENT_LIGHT_CALL_SETTER(red, float, FLAG_HAS_RED)
620IMPLEMENT_LIGHT_CALL_SETTER(green, float, FLAG_HAS_GREEN)
621IMPLEMENT_LIGHT_CALL_SETTER(blue, float, FLAG_HAS_BLUE)
622IMPLEMENT_LIGHT_CALL_SETTER(white, float, FLAG_HAS_WHITE)
623IMPLEMENT_LIGHT_CALL_SETTER(color_temperature, float, FLAG_HAS_COLOR_TEMPERATURE)
624IMPLEMENT_LIGHT_CALL_SETTER(cold_white, float, FLAG_HAS_COLD_WHITE)
625IMPLEMENT_LIGHT_CALL_SETTER(warm_white, float, FLAG_HAS_WARM_WHITE)
626LightCall &LightCall::set_effect(optional<std::string> effect) {
627 if (effect.has_value())
628 this->set_effect(*effect);
629 return *this;
630}
632 this->effect_ = effect_number;
633 this->set_flag_(FLAG_HAS_EFFECT, true);
634 return *this;
635}
637 if (effect_number.has_value()) {
638 this->effect_ = effect_number.value();
639 }
640 this->set_flag_(FLAG_HAS_EFFECT, effect_number.has_value());
641 return *this;
642}
644 this->set_flag_(FLAG_PUBLISH, publish);
645 return *this;
646}
648 this->set_flag_(FLAG_SAVE, save);
649 return *this;
650}
651LightCall &LightCall::set_rgb(float red, float green, float blue) {
652 this->set_red(red);
653 this->set_green(green);
654 this->set_blue(blue);
655 return *this;
656}
657LightCall &LightCall::set_rgbw(float red, float green, float blue, float white) {
658 this->set_rgb(red, green, blue);
659 this->set_white(white);
660 return *this;
661}
662
663} // namespace light
664} // namespace esphome
BedjetMode mode
BedJet operating mode.
const StringRef & get_name() const
constexpr const char * c_str() const
Definition string_ref.h:69
This class represents a requested change in a light state.
Definition light_call.h:18
bool has_color_mode() const
Definition light_call.h:149
bool has_color_temperature() const
Definition light_call.h:146
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.
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
Definition light_call.h:148
bool has_brightness() const
Definition light_call.h:140
LightCall & set_rgb(float red, float green, float blue)
Set the RGB color of the light by RGB values.
bool has_cold_white() const
Definition light_call.h:147
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
Definition light_call.h:141
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)
Definition light_call.h:217
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.
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.
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
bool has_value() const
Definition optional.h:92
value_type const & value() const
Definition optional.h:94
bool state
Definition fan.h:0
mopeka_std_values val[4]
Range range
Definition msa3xx.h:0
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.
Definition color_mode.h:49
@ 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.
@ RGB
RGB color output.
@ 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.
Definition a01nyub.cpp:7
float gamma_uncorrect(float value, float gamma)
Reverts gamma correction of gamma to value.
Definition helpers.cpp:502