ESPHome 2026.8.0-dev
Loading...
Searching...
No Matches
light_call.cpp
Go to the documentation of this file.
1#include <cinttypes>
2
3#include "light_call.h"
4#include "light_state.h"
5#include "esphome/core/log.h"
8
9namespace esphome::light {
10
11static const char *const TAG = "light";
12
13// Cold-path logger; caller handles the clamp so the in-range hot path avoids
14// the spill/reload around the call.
15static void log_value_out_of_range(const char *name, float value, const LogString *param_name, float min, float max) {
16 ESP_LOGW(TAG, "'%s': %s value %.2f is out of range [%.1f - %.1f]", name, LOG_STR_ARG(param_name), value, min, max);
17}
18
19#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
20static void log_feature_not_supported(const char *name, const LogString *feature) {
21 ESP_LOGW(TAG, "'%s': %s not supported", name, LOG_STR_ARG(feature));
22}
23
24static void log_color_mode_not_supported(const char *name, const LogString *feature) {
25 ESP_LOGW(TAG, "'%s': color mode does not support setting %s", name, LOG_STR_ARG(feature));
26}
27
28static void log_invalid_parameter(const char *name, const LogString *message) {
29 ESP_LOGW(TAG, "'%s': %s", name, LOG_STR_ARG(message));
30}
31#else
32#define log_feature_not_supported(name, feature)
33#define log_color_mode_not_supported(name, feature)
34#define log_invalid_parameter(name, message)
35#endif
36
37// Macro to reduce repetitive setter code
38#define IMPLEMENT_LIGHT_CALL_SETTER(name, type, flag) \
39 LightCall &LightCall::set_##name(optional<type>(name)) { \
40 if ((name).has_value()) { \
41 this->name##_ = (name).value(); \
42 } \
43 this->set_flag_(flag, (name).has_value()); \
44 return *this; \
45 } \
46 LightCall &LightCall::set_##name(type name) { \
47 this->name##_ = name; \
48 this->set_flag_(flag); \
49 return *this; \
50 }
51
52// Color mode human-readable strings indexed by ColorModeBitPolicy::to_bit() (0-9)
53// Index 0 is Unknown (for ColorMode::UNKNOWN), also used as fallback for out-of-range
54PROGMEM_STRING_TABLE(ColorModeHumanStrings, "Unknown", "On/Off", "Brightness", "White", "Color temperature",
55 "Cold/warm white", "RGB", "RGBW", "RGB + color temperature", "RGB + cold/warm white");
56
57// Indices 0-7 match FieldFlags bits 0-7; index 8 is color_temperature.
58// PROGMEM_STRING_TABLE is constexpr-init (no RAM guard variable).
59PROGMEM_STRING_TABLE(ValidateFieldNames, "Brightness", "Color brightness", "Red", "Green", "Blue", "White",
60 "Cold white", "Warm white", "Color temperature");
61static constexpr uint8_t VALIDATE_CT_INDEX = 8;
62
63static const LogString *color_mode_to_human(ColorMode color_mode) {
64 return ColorModeHumanStrings::get_log_str(ColorModeBitPolicy::to_bit(color_mode), 0);
65}
66
67// Helper to log percentage values
68#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
69static void log_percent(const LogString *param, float value) {
70 ESP_LOGV(TAG, " %s: %.0f%%", LOG_STR_ARG(param), value * 100.0f);
71}
72#else
73#define log_percent(param, value)
74#endif
75
77 const char *name = this->parent_->get_name().c_str();
78 LightColorValues v = this->validate_();
79 const bool publish = this->get_publish_();
80
81 if (publish) {
82 ESP_LOGV(TAG, "'%s' Setting:", name);
83
84 // Only print color mode when it's being changed
85 ColorMode current_color_mode = this->parent_->remote_values.get_color_mode();
86 ColorMode target_color_mode = this->has_color_mode() ? this->color_mode_ : current_color_mode;
87 if (target_color_mode != current_color_mode) {
88 ESP_LOGV(TAG, " Color mode: %s", LOG_STR_ARG(color_mode_to_human(v.get_color_mode())));
89 }
90
91 // Only print state when it's being changed
92 bool current_state = this->parent_->remote_values.is_on();
93 bool target_state = this->has_state() ? this->state_ : current_state;
94 if (target_state != current_state) {
95 ESP_LOGV(TAG, " State: %s", ONOFF(v.is_on()));
96 }
97
98 if (this->has_brightness()) {
99 log_percent(LOG_STR("Brightness"), v.get_brightness());
100 }
101
102 if (this->has_color_brightness()) {
103 log_percent(LOG_STR("Color brightness"), v.get_color_brightness());
104 }
105 if (this->has_red() || this->has_green() || this->has_blue()) {
106 ESP_LOGV(TAG, " Red: %.0f%%, Green: %.0f%%, Blue: %.0f%%", v.get_red() * 100.0f, v.get_green() * 100.0f,
107 v.get_blue() * 100.0f);
108 }
109
110 if (this->has_white()) {
111 log_percent(LOG_STR("White"), v.get_white());
112 }
113 if (this->has_color_temperature()) {
114 ESP_LOGV(TAG, " Color temperature: %.1f mireds", v.get_color_temperature());
115 }
116
117 if (this->has_cold_white() || this->has_warm_white()) {
118 ESP_LOGV(TAG, " Cold white: %.0f%%, warm white: %.0f%%", v.get_cold_white() * 100.0f,
119 v.get_warm_white() * 100.0f);
120 }
121 }
122
123 if (this->has_flash_()) {
124 // FLASH
125 if (publish) {
126 ESP_LOGV(TAG, " Flash length: %.1fs", this->flash_length_ / 1e3f);
127 }
128
129 this->parent_->start_flash_(v, this->flash_length_, publish);
130 } else if (this->has_transition_()) {
131 // TRANSITION
132 if (publish) {
133 ESP_LOGV(TAG, " Transition length: %.1fs", this->transition_length_ / 1e3f);
134 }
135
136 // Special case: Transition and effect can be set when turning off
137 if (this->has_effect_()) {
138 if (publish) {
139 ESP_LOGV(TAG, " Effect: 'None'");
140 }
141 this->parent_->stop_effect_();
142 }
143
144 this->parent_->start_transition_(v, this->transition_length_, publish);
145
146 } else if (this->has_effect_()) {
147 // EFFECT
148 StringRef effect_s;
149 if (this->effect_ == 0u) {
150 effect_s = StringRef::from_lit("None");
151 } else {
152 effect_s = this->parent_->effects_[this->effect_ - 1]->get_name();
153 }
154
155 if (publish) {
156 ESP_LOGV(TAG, " Effect: '%.*s'", (int) effect_s.size(), effect_s.c_str());
157 }
158
159 this->parent_->start_effect_(this->effect_);
160
161 // Also set light color values when starting an effect
162 // For example to turn off the light
163 this->parent_->set_immediately_(v, true);
164 } else {
165 // INSTANT CHANGE
166 this->parent_->set_immediately_(v, publish);
167 }
168
170 for (auto *listener : *this->parent_->target_state_reached_listeners_) {
171 listener->on_light_target_state_reached();
172 }
173 }
174 if (publish) {
175 this->parent_->publish_state();
176 }
177 if (this->get_save_()) {
179 }
180}
181
182void LightCall::log_and_clear_unsupported_(FieldFlags flag, const LogString *feature, bool use_color_mode_log) {
183 auto *name = this->parent_->get_name().c_str();
184 if (use_color_mode_log) {
185 log_color_mode_not_supported(name, feature);
186 } else {
187 log_feature_not_supported(name, feature);
188 }
189 this->clear_flag_(flag);
190}
191
193 auto *name = this->parent_->get_name().c_str();
194 auto traits = this->parent_->get_traits();
195
196 // Color mode check
197 if (this->has_color_mode() && !traits.supports_color_mode(this->color_mode_)) {
198 ESP_LOGW(TAG, "'%s' does not support color mode %s", name, LOG_STR_ARG(color_mode_to_human(this->color_mode_)));
200 }
201
202 // Ensure there is always a color mode set
203 if (!this->has_color_mode()) {
204 this->color_mode_ = this->compute_color_mode_(traits);
206 }
207 auto color_mode = this->color_mode_;
208
209 // Transform calls that use non-native parameters for the current mode.
210 this->transform_parameters_(traits);
211
212 // Business logic adjustments before validation
213 // Flag whether an explicit turn off was requested, in which case we'll also stop the effect.
214 bool explicit_turn_off_request = this->has_state() && !this->state_;
215
216 // Treat zero brightness as an implicit turn-off when no state was explicitly requested.
217 if (this->has_brightness() && this->brightness_ == 0.0f && !this->has_state()) {
218 this->state_ = false;
220 }
221
222 // Make sure a simple (no specific brightness) turn-on makes the light visible
223 if (this->has_state() && this->state_ && (color_mode & ColorCapability::BRIGHTNESS) && !this->has_brightness() &&
224 this->parent_->remote_values.get_brightness() == 0.0f) {
225 this->brightness_ = 1.0f;
227 }
228
229 // Set color brightness to 100% if currently zero and a color is set.
230 if ((this->has_red() || this->has_green() || this->has_blue()) && !this->has_color_brightness() &&
231 this->parent_->remote_values.get_color_brightness() == 0.0f) {
232 this->color_brightness_ = 1.0f;
234 }
235
236 // Capability validation
237 if (this->has_brightness() && this->brightness_ > 0.0f && !(color_mode & ColorCapability::BRIGHTNESS))
238 this->log_and_clear_unsupported_(FLAG_HAS_BRIGHTNESS, LOG_STR("brightness"), false);
239
240 // Transition length possible check
241 if (this->has_transition_() && this->transition_length_ != 0 && !(color_mode & ColorCapability::BRIGHTNESS))
242 this->log_and_clear_unsupported_(FLAG_HAS_TRANSITION, LOG_STR("transitions"), false);
243
244 if (this->has_color_brightness() && this->color_brightness_ > 0.0f && !(color_mode & ColorCapability::RGB))
245 this->log_and_clear_unsupported_(FLAG_HAS_COLOR_BRIGHTNESS, LOG_STR("RGB brightness"), true);
246
247 // RGB exists check
248 if (((this->has_red() && this->red_ > 0.0f) || (this->has_green() && this->green_ > 0.0f) ||
249 (this->has_blue() && this->blue_ > 0.0f)) &&
250 !(color_mode & ColorCapability::RGB)) {
251 log_color_mode_not_supported(name, LOG_STR("RGB color"));
255 }
256
257 // White value exists check
258 if (this->has_white() && this->white_ > 0.0f &&
259 !(color_mode & ColorCapability::WHITE || color_mode & ColorCapability::COLD_WARM_WHITE))
260 this->log_and_clear_unsupported_(FLAG_HAS_WHITE, LOG_STR("white value"), true);
261
262 // Color temperature exists check
263 if (this->has_color_temperature() &&
265 this->log_and_clear_unsupported_(FLAG_HAS_COLOR_TEMPERATURE, LOG_STR("color temperature"), true);
266
267 // Cold/warm white value exists check
268 if (((this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f)) &&
269 !(color_mode & ColorCapability::COLD_WARM_WHITE)) {
270 log_color_mode_not_supported(name, LOG_STR("cold/warm white value"));
273 }
274
275 // Create color values and validate+apply ranges in one step to eliminate duplicate checks
276 auto v = this->parent_->remote_values;
277 if (this->has_color_mode())
279 if (this->has_state())
280 v.set_state(this->state_);
281
282 // FieldFlags bits 0-7 must match unit_fields_ array indices.
283 static_assert(FLAG_HAS_BRIGHTNESS == 1u << 0 && FLAG_HAS_COLOR_BRIGHTNESS == 1u << 1 && FLAG_HAS_RED == 1u << 2 &&
284 FLAG_HAS_GREEN == 1u << 3 && FLAG_HAS_BLUE == 1u << 4 && FLAG_HAS_WHITE == 1u << 5 &&
285 FLAG_HAS_COLD_WHITE == 1u << 6 && FLAG_HAS_WARM_WHITE == 1u << 7,
286 "FieldFlags bits 0-7 must match unit_fields_ indices");
287
288 // Iterate set bits only (ctz + clear-lowest) — HA can drive perform()
289 // at high frequency so the hot path is O(popcount).
290 unsigned active = this->flags_ & CLAMP_FLAGS_MASK;
291 while (active != 0) {
292 unsigned bit = __builtin_ctz(active);
293 active &= active - 1; // clear lowest set bit
294 float &value = this->unit_fields_[bit];
295 if (float_out_of_unit_range(value)) {
296 log_value_out_of_range(name, value, ValidateFieldNames::get_log_str(bit, 0), 0.0f, 1.0f);
297 value = clamp_unit_float(value);
298 }
299 v.unit_fields_[bit] = value;
300 }
301
302 // color_temperature: runtime range from traits.
303 if (this->has_color_temperature()) {
304 const float ct_min = traits.get_min_mireds();
305 const float ct_max = traits.get_max_mireds();
307 log_value_out_of_range(name, this->color_temperature_, ValidateFieldNames::get_log_str(VALIDATE_CT_INDEX, 0),
308 ct_min, ct_max);
309 this->color_temperature_ = clamp(this->color_temperature_, ct_min, ct_max);
310 }
311 v.color_temperature_ = this->color_temperature_;
312 }
313
314 v.normalize_color();
315
316 // Flash length check
317 if (this->has_flash_() && this->flash_length_ == 0) {
318 log_invalid_parameter(name, LOG_STR("flash length must be >0"));
320 }
321
322 // validate transition length/flash length/effect not used at the same time
323 bool supports_transition = color_mode & ColorCapability::BRIGHTNESS;
324
325 // If effect is already active, remove effect start
326 if (this->has_effect_() && this->effect_ == this->parent_->active_effect_index_) {
328 }
329
330 // validate effect index
331 if (this->has_effect_() && this->effect_ > this->parent_->effects_.size()) {
332 ESP_LOGW(TAG, "'%s': invalid effect index %" PRIu32, name, this->effect_);
334 }
335
336 if (this->has_effect_() && (this->has_transition_() || this->has_flash_())) {
337 log_invalid_parameter(name, LOG_STR("effect cannot be used with transition/flash"));
340 }
341
342 if (this->has_flash_() && this->has_transition_()) {
343 log_invalid_parameter(name, LOG_STR("flash cannot be used with transition"));
345 }
346
347 if (!this->has_transition_() && !this->has_flash_() && (!this->has_effect_() || this->effect_ == 0) &&
348 supports_transition) {
349 // nothing specified and light supports transitions, set default transition length
352 }
353
354 if (this->has_transition_() && this->transition_length_ == 0) {
355 // 0 transition is interpreted as no transition (instant change)
357 }
358
359 if (this->has_transition_() && !supports_transition)
360 this->log_and_clear_unsupported_(FLAG_HAS_TRANSITION, LOG_STR("transitions"), false);
361
362 // If not a flash and turning the light off, then disable the light
363 // Do not use light color values directly, so that effects can set 0% brightness
364 // Reason: When user turns off the light in frontend, the effect should also stop
365 bool target_state = this->has_state() ? this->state_ : v.is_on();
366 if (!this->has_flash_() && !target_state) {
367 if (this->has_effect_()) {
368 log_invalid_parameter(name, LOG_STR("cannot start effect when turning off"));
370 } else if (this->parent_->active_effect_index_ != 0 && explicit_turn_off_request) {
371 // Auto turn off effect
372 this->effect_ = 0;
374 }
375 }
376
377 // Disable saving for flashes
378 if (this->has_flash_())
379 this->clear_flag_(FLAG_SAVE);
380
381 return v;
382}
384 // Allow CWWW modes to be set with a white value and/or color temperature.
385 // This is used in three cases in HA:
386 // - CW/WW lights, which set the "brightness" and "color_temperature"
387 // - RGBWW lights with color_interlock=true, which also sets "brightness" and
388 // "color_temperature" (without color_interlock, CW/WW are set directly)
389 // - Legacy Home Assistant (pre-colormode), which sets "white" and "color_temperature"
390
391 // Cache min/max mireds to avoid repeated calls
392 const float min_mireds = traits.get_min_mireds();
393 const float max_mireds = traits.get_max_mireds();
394
395 if (((this->has_white() && this->white_ > 0.0f) || this->has_color_temperature()) && //
397 !(this->color_mode_ & ColorCapability::WHITE) && //
399 min_mireds > 0.0f && max_mireds > 0.0f) {
400 ESP_LOGV(TAG, "'%s': setting cold/warm white channels using white/color temperature values",
401 this->parent_->get_name().c_str());
402 // Only compute cold_white/warm_white from color_temperature if they're not already explicitly set.
403 // This is important for state restoration, where both color_temperature and cold_white/warm_white
404 // are restored from flash - we want to preserve the saved cold_white/warm_white values.
405 if (this->has_color_temperature() && !this->has_cold_white() && !this->has_warm_white()) {
406 const float color_temp = clamp(this->color_temperature_, min_mireds, max_mireds);
407 const float range = max_mireds - min_mireds;
408 const float ww_fraction = (color_temp - min_mireds) / range;
409 const float cw_fraction = 1.0f - ww_fraction;
410 const float max_cw_ww = std::max(ww_fraction, cw_fraction);
411 this->cold_white_ = this->parent_->gamma_uncorrect_lut(cw_fraction / max_cw_ww);
412 this->warm_white_ = this->parent_->gamma_uncorrect_lut(ww_fraction / max_cw_ww);
415 }
416 if (this->has_white()) {
417 this->brightness_ = this->white_;
419 }
420 }
421}
423 auto supported_modes = traits.get_supported_color_modes();
424 int supported_count = supported_modes.size();
425
426 // Some lights don't support any color modes (e.g. monochromatic light), leave it at unknown.
427 if (supported_count == 0)
428 return ColorMode::UNKNOWN;
429
430 // In the common case of lights supporting only a single mode, use that one.
431 if (supported_count == 1)
432 return *supported_modes.begin();
433
434 // Don't change if the light is being turned off.
435 ColorMode current_mode = this->parent_->remote_values.get_color_mode();
436 if (this->has_state() && !this->state_)
437 return current_mode;
438
439 // If no color mode is specified, we try to guess the color mode. This is needed for backward compatibility to
440 // pre-colormode clients and automations, but also for the MQTT API, where HA doesn't let us know which color mode
441 // was used for some reason.
442 // Compute intersection of suitable and supported modes using bitwise AND
443 color_mode_bitmask_t intersection = this->get_suitable_color_modes_mask_() & supported_modes.get_mask();
444
445 // Don't change if the current mode is in the intersection (suitable AND supported)
446 if (ColorModeMask::mask_contains(intersection, current_mode)) {
447 ESP_LOGV(TAG, "'%s': color mode not specified; retaining %s", this->parent_->get_name().c_str(),
448 LOG_STR_ARG(color_mode_to_human(current_mode)));
449 return current_mode;
450 }
451
452 // Use the preferred suitable mode.
453 if (intersection != 0) {
455 ESP_LOGV(TAG, "'%s': color mode not specified; using %s", this->parent_->get_name().c_str(),
456 LOG_STR_ARG(color_mode_to_human(mode)));
457 return mode;
458 }
459
460 // There's no supported mode for this call, so warn, use the current more or a mode at random and let validation strip
461 // out whatever we don't support.
462 auto color_mode = current_mode != ColorMode::UNKNOWN ? current_mode : *supported_modes.begin();
463 ESP_LOGW(TAG, "'%s': no suitable color mode supported; defaulting to %s", this->parent_->get_name().c_str(),
464 LOG_STR_ARG(color_mode_to_human(color_mode)));
465 return color_mode;
466}
467// PROGMEM lookup table for get_suitable_color_modes_mask_().
468// Maps 4-bit key (white | ct<<1 | cwww<<2 | rgb<<3) to color mode bitmask.
469// Packed into uint8_t by right-shifting by PACK_SHIFT since the lower bits
470// (UNKNOWN, ON_OFF, BRIGHTNESS) are never present in suitable mode masks.
471static constexpr unsigned PACK_SHIFT = ColorModeBitPolicy::to_bit(ColorMode::WHITE);
472// clang-format off
473static constexpr uint8_t SUITABLE_COLOR_MODES[] PROGMEM = {
474 // [0] none - all modes with brightness
477 ColorMode::COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
478 // [1] white only
481 // [2] ct only
484 // [3] white + ct
486 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
487 // [4] cwww only
488 static_cast<uint8_t>(ColorModeMask({ColorMode::COLD_WARM_WHITE,
489 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
490 0, // [5] white + cwww (conflicting)
491 0, // [6] ct + cwww (conflicting)
492 0, // [7] white + ct + cwww (conflicting)
493 // [8] rgb only
495 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
496 // [9] rgb + white
498 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
499 // [10] rgb + ct
501 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
502 // [11] rgb + white + ct
504 ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
505 // [12] rgb + cwww
506 static_cast<uint8_t>(ColorModeMask({ColorMode::RGB_COLD_WARM_WHITE}).get_mask() >> PACK_SHIFT),
507 0, // [13] rgb + white + cwww (conflicting)
508 0, // [14] rgb + ct + cwww (conflicting)
509 0, // [15] all (conflicting)
510};
511// clang-format on
512
514 bool has_white = this->has_white() && this->white_ > 0.0f;
515 bool has_ct = this->has_color_temperature();
516 bool has_cwww =
517 (this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f);
518 bool has_rgb = (this->has_color_brightness() && this->color_brightness_ > 0.0f) ||
519 (this->has_red() || this->has_green() || this->has_blue());
520
521 // Build key from flags: [rgb][cwww][ct][white]
522 uint8_t key = has_white | (has_ct << 1) | (has_cwww << 2) | (has_rgb << 3);
523 return static_cast<color_mode_bitmask_t>(progmem_read_byte(&SUITABLE_COLOR_MODES[key])) << PACK_SHIFT;
524}
525
526LightCall &LightCall::set_effect(const char *effect, size_t len) {
527 if (len == 4 && strncasecmp(effect, "none", 4) == 0) {
528 this->set_effect(uint32_t{0});
529 return *this;
530 }
531
532 bool found = false;
533 StringRef effect_ref(effect, len);
534 for (uint32_t i = 0; i < this->parent_->effects_.size(); i++) {
535 if (str_equals_case_insensitive(effect_ref, this->parent_->effects_[i]->get_name())) {
536 this->set_effect(i + 1);
537 found = true;
538 break;
539 }
540 }
541 if (!found) {
542 ESP_LOGW(TAG, "'%s': no such effect '%.*s'", this->parent_->get_name().c_str(), (int) len, effect);
543 }
544 return *this;
545}
565 this->set_transition_length(transition_length);
566 return *this;
567}
570 this->set_brightness(brightness);
571 return *this;
572}
574 if (this->parent_->get_traits().supports_color_mode(color_mode))
575 this->set_color_mode(color_mode);
576 return *this;
577}
580 this->set_color_brightness(brightness);
581 return *this;
582}
585 this->set_red(red);
586 return *this;
587}
590 this->set_green(green);
591 return *this;
592}
595 this->set_blue(blue);
596 return *this;
597}
600 this->set_white(white);
601 return *this;
602}
611 this->set_cold_white(cold_white);
612 return *this;
613}
616 this->set_warm_white(warm_white);
617 return *this;
618}
619IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE)
620IMPLEMENT_LIGHT_CALL_SETTER(transition_length, uint32_t, FLAG_HAS_TRANSITION)
621IMPLEMENT_LIGHT_CALL_SETTER(flash_length, uint32_t, FLAG_HAS_FLASH)
622IMPLEMENT_LIGHT_CALL_SETTER(brightness, float, FLAG_HAS_BRIGHTNESS)
623IMPLEMENT_LIGHT_CALL_SETTER(color_mode, ColorMode, FLAG_HAS_COLOR_MODE)
624IMPLEMENT_LIGHT_CALL_SETTER(color_brightness, float, FLAG_HAS_COLOR_BRIGHTNESS)
625IMPLEMENT_LIGHT_CALL_SETTER(red, float, FLAG_HAS_RED)
626IMPLEMENT_LIGHT_CALL_SETTER(green, float, FLAG_HAS_GREEN)
627IMPLEMENT_LIGHT_CALL_SETTER(blue, float, FLAG_HAS_BLUE)
628IMPLEMENT_LIGHT_CALL_SETTER(white, float, FLAG_HAS_WHITE)
629IMPLEMENT_LIGHT_CALL_SETTER(color_temperature, float, FLAG_HAS_COLOR_TEMPERATURE)
630IMPLEMENT_LIGHT_CALL_SETTER(cold_white, float, FLAG_HAS_COLD_WHITE)
631IMPLEMENT_LIGHT_CALL_SETTER(warm_white, float, FLAG_HAS_WARM_WHITE)
632LightCall &LightCall::set_effect(optional<std::string> effect) {
633 if (effect.has_value())
634 this->set_effect(*effect);
635 return *this;
636}
638 this->effect_ = effect_number;
640 return *this;
641}
642LightCall &LightCall::set_effect(optional<uint32_t> effect_number) {
643 if (effect_number.has_value()) {
644 this->effect_ = effect_number.value();
645 }
646 this->set_flag_(FLAG_HAS_EFFECT, effect_number.has_value());
647 return *this;
648}
650 this->set_flag_(FLAG_PUBLISH, publish);
651 return *this;
652}
654 this->set_flag_(FLAG_SAVE, save);
655 return *this;
656}
657LightCall &LightCall::set_rgb(float red, float green, float blue) {
658 this->set_red(red);
659 this->set_green(green);
660 this->set_blue(blue);
661 return *this;
662}
663LightCall &LightCall::set_rgbw(float red, float green, float blue, float white) {
664 this->set_rgb(red, green, blue);
665 this->set_white(white);
666 return *this;
667}
668
669} // namespace esphome::light
BedjetMode mode
BedJet operating mode.
const StringRef & get_name() const
Definition entity_base.h:71
static constexpr ColorMode first_value_from_mask(bitmask_t mask)
constexpr bitmask_t get_mask() const
Get the raw bitmask value for optimized operations.
constexpr size_t size() const
Count the number of values in the set.
static constexpr bool mask_contains(bitmask_t mask, ColorMode value)
StringRef is a reference to a string owned by something else.
Definition string_ref.h:26
constexpr const char * c_str() const
Definition string_ref.h:73
constexpr size_type size() const
Definition string_ref.h:74
static constexpr StringRef from_lit(const CharT(&s)[N])
Definition string_ref.h:50
This class represents a requested change in a light state.
Definition light_call.h:22
bool has_color_mode() const
Definition light_call.h:157
bool has_color_temperature() const
Definition light_call.h:154
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.
void log_and_clear_unsupported_(FieldFlags flag, const LogString *feature, bool use_color_mode_log)
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:156
void set_flag_(FieldFlags flag, bool value=true) ESPHOME_ALWAYS_INLINE
Definition light_call.h:226
bool has_brightness() const
Definition light_call.h:148
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:155
void transform_parameters_(const LightTraits &traits)
Some color modes also can be set using non-native parameters, transform those calls.
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:149
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.
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.
void clear_flag_(FieldFlags flag) ESPHOME_ALWAYS_INLINE
Definition light_call.h:235
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.
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.
ColorMode compute_color_mode_(const LightTraits &traits)
static constexpr uint16_t CLAMP_FLAGS_MASK
Definition light_call.h:217
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.
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.
color_mode_bitmask_t get_suitable_color_modes_mask_()
Get potential color modes bitmask for this light call.
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.
FixedVector< LightEffect * > effects_
List of effects for this light.
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 gamma_uncorrect_lut(float value) const
Reverse gamma correction by binary-searching the forward LUT.
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.
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.
std::unique_ptr< std::vector< LightTargetStateReachedListener * > > target_state_reached_listeners_
Listeners for target state reached.
This class is used to represent the capabilities of a light.
Definition light_traits.h:9
bool supports_color_mode(ColorMode color_mode) const
ColorModeMask get_supported_color_modes() const
const LogString * message
Definition component.cpp:35
bool state
Definition fan.h:2
Range range
Definition msa3xx.h:0
IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE) IMPLEMENT_LIGHT_CALL_SETTER(transition_length
float clamp_unit_float(float x)
PROGMEM_STRING_TABLE(ColorModeHumanStrings, "Unknown", "On/Off", "Brightness", "White", "Color temperature", "Cold/warm white", "RGB", "RGBW", "RGB + color temperature", "RGB + cold/warm white")
FiniteSetMask< ColorMode, ColorModeBitPolicy > ColorModeMask
Definition color_mode.h:147
bool float_out_of_unit_range(float x)
uint16_t color_mode_bitmask_t
Definition color_mode.h:108
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.
const void size_t len
Definition hal.h:64
bool str_equals_case_insensitive(const std::string &a, const std::string &b)
Compare strings for equality in case-insensitive manner.
Definition helpers.cpp:201
uint8_t progmem_read_byte(const uint8_t *addr)
Definition hal.h:43
STL namespace.
static constexpr unsigned to_bit(ColorMode mode)
Definition color_mode.h:131