ESPHome 2025.12.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
13static void clamp_and_log_if_invalid(const char *name, float &value, const LogString *param_name, float min = 0.0f,
14 float max = 1.0f) {
15 if (value < min || value > 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 value = clamp(value, min, max);
18 }
19}
20
21#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
22static void log_feature_not_supported(const char *name, const LogString *feature) {
23 ESP_LOGW(TAG, "'%s': %s not supported", name, LOG_STR_ARG(feature));
24}
25
26static void log_color_mode_not_supported(const char *name, const LogString *feature) {
27 ESP_LOGW(TAG, "'%s': color mode does not support setting %s", name, LOG_STR_ARG(feature));
28}
29
30static void log_invalid_parameter(const char *name, const LogString *message) {
31 ESP_LOGW(TAG, "'%s': %s", name, LOG_STR_ARG(message));
32}
33#else
34#define log_feature_not_supported(name, feature)
35#define log_color_mode_not_supported(name, feature)
36#define log_invalid_parameter(name, message)
37#endif
38
39// Macro to reduce repetitive setter code
40#define IMPLEMENT_LIGHT_CALL_SETTER(name, type, flag) \
41 LightCall &LightCall::set_##name(optional<type>(name)) { \
42 if ((name).has_value()) { \
43 this->name##_ = (name).value(); \
44 } \
45 this->set_flag_(flag, (name).has_value()); \
46 return *this; \
47 } \
48 LightCall &LightCall::set_##name(type name) { \
49 this->name##_ = name; \
50 this->set_flag_(flag); \
51 return *this; \
52 }
53
54static const LogString *color_mode_to_human(ColorMode color_mode) {
55 if (color_mode == ColorMode::ON_OFF)
56 return LOG_STR("On/Off");
57 if (color_mode == ColorMode::BRIGHTNESS)
58 return LOG_STR("Brightness");
59 if (color_mode == ColorMode::WHITE)
60 return LOG_STR("White");
61 if (color_mode == ColorMode::COLOR_TEMPERATURE)
62 return LOG_STR("Color temperature");
63 if (color_mode == ColorMode::COLD_WARM_WHITE)
64 return LOG_STR("Cold/warm white");
65 if (color_mode == ColorMode::RGB)
66 return LOG_STR("RGB");
67 if (color_mode == ColorMode::RGB_WHITE)
68 return LOG_STR("RGBW");
69 if (color_mode == ColorMode::RGB_COLD_WARM_WHITE)
70 return LOG_STR("RGB + cold/warm white");
71 if (color_mode == ColorMode::RGB_COLOR_TEMPERATURE)
72 return LOG_STR("RGB + color temperature");
73 return LOG_STR("Unknown");
74}
75
76// Helper to log percentage values
77#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
78static void log_percent(const char *name, const char *param, float value) {
79 ESP_LOGD(TAG, " %s: %.0f%%", param, value * 100.0f);
80}
81#else
82#define log_percent(name, param, value)
83#endif
84
86 const char *name = this->parent_->get_name().c_str();
87 LightColorValues v = this->validate_();
88 const bool publish = this->get_publish_();
89
90 if (publish) {
91 ESP_LOGD(TAG, "'%s' Setting:", name);
92
93 // Only print color mode when it's being changed
94 ColorMode current_color_mode = this->parent_->remote_values.get_color_mode();
95 ColorMode target_color_mode = this->has_color_mode() ? this->color_mode_ : current_color_mode;
96 if (target_color_mode != current_color_mode) {
97 ESP_LOGD(TAG, " Color mode: %s", LOG_STR_ARG(color_mode_to_human(v.get_color_mode())));
98 }
99
100 // Only print state when it's being changed
101 bool current_state = this->parent_->remote_values.is_on();
102 bool target_state = this->has_state() ? this->state_ : current_state;
103 if (target_state != current_state) {
104 ESP_LOGD(TAG, " State: %s", ONOFF(v.is_on()));
105 }
106
107 if (this->has_brightness()) {
108 log_percent(name, "Brightness", v.get_brightness());
109 }
110
111 if (this->has_color_brightness()) {
112 log_percent(name, "Color brightness", v.get_color_brightness());
113 }
114 if (this->has_red() || this->has_green() || this->has_blue()) {
115 ESP_LOGD(TAG, " Red: %.0f%%, Green: %.0f%%, Blue: %.0f%%", v.get_red() * 100.0f, v.get_green() * 100.0f,
116 v.get_blue() * 100.0f);
117 }
118
119 if (this->has_white()) {
120 log_percent(name, "White", v.get_white());
121 }
122 if (this->has_color_temperature()) {
123 ESP_LOGD(TAG, " Color temperature: %.1f mireds", v.get_color_temperature());
124 }
125
126 if (this->has_cold_white() || this->has_warm_white()) {
127 ESP_LOGD(TAG, " Cold white: %.0f%%, warm white: %.0f%%", v.get_cold_white() * 100.0f,
128 v.get_warm_white() * 100.0f);
129 }
130 }
131
132 if (this->has_flash_()) {
133 // FLASH
134 if (publish) {
135 ESP_LOGD(TAG, " Flash length: %.1fs", this->flash_length_ / 1e3f);
136 }
137
138 this->parent_->start_flash_(v, this->flash_length_, publish);
139 } else if (this->has_transition_()) {
140 // TRANSITION
141 if (publish) {
142 ESP_LOGD(TAG, " Transition length: %.1fs", this->transition_length_ / 1e3f);
143 }
144
145 // Special case: Transition and effect can be set when turning off
146 if (this->has_effect_()) {
147 if (publish) {
148 ESP_LOGD(TAG, " Effect: 'None'");
149 }
150 this->parent_->stop_effect_();
151 }
152
153 this->parent_->start_transition_(v, this->transition_length_, publish);
154
155 } else if (this->has_effect_()) {
156 // EFFECT
157 const char *effect_s;
158 if (this->effect_ == 0u) {
159 effect_s = "None";
160 } else {
161 effect_s = this->parent_->effects_[this->effect_ - 1]->get_name();
162 }
163
164 if (publish) {
165 ESP_LOGD(TAG, " Effect: '%s'", effect_s);
166 }
167
168 this->parent_->start_effect_(this->effect_);
169
170 // Also set light color values when starting an effect
171 // For example to turn off the light
172 this->parent_->set_immediately_(v, true);
173 } else {
174 // INSTANT CHANGE
175 this->parent_->set_immediately_(v, publish);
176 }
177
178 if (!this->has_transition_()) {
180 }
181 if (publish) {
182 this->parent_->publish_state();
183 }
184 if (this->get_save_()) {
186 }
187}
188
189void LightCall::log_and_clear_unsupported_(FieldFlags flag, const LogString *feature, bool use_color_mode_log) {
190 auto *name = this->parent_->get_name().c_str();
191 if (use_color_mode_log) {
192 log_color_mode_not_supported(name, feature);
193 } else {
194 log_feature_not_supported(name, feature);
195 }
196 this->clear_flag_(flag);
197}
198
200 auto *name = this->parent_->get_name().c_str();
201 auto traits = this->parent_->get_traits();
202
203 // Color mode check
204 if (this->has_color_mode() && !traits.supports_color_mode(this->color_mode_)) {
205 ESP_LOGW(TAG, "'%s' does not support color mode %s", name, LOG_STR_ARG(color_mode_to_human(this->color_mode_)));
207 }
208
209 // Ensure there is always a color mode set
210 if (!this->has_color_mode()) {
211 this->color_mode_ = this->compute_color_mode_();
213 }
214 auto color_mode = this->color_mode_;
215
216 // Transform calls that use non-native parameters for the current mode.
217 this->transform_parameters_();
218
219 // Business logic adjustments before validation
220 // Flag whether an explicit turn off was requested, in which case we'll also stop the effect.
221 bool explicit_turn_off_request = this->has_state() && !this->state_;
222
223 // Turn off when brightness is set to zero, and reset brightness (so that it has nonzero brightness when turned on).
224 if (this->has_brightness() && this->brightness_ == 0.0f) {
225 this->state_ = false;
227 this->brightness_ = 1.0f;
228 }
229
230 // Set color brightness to 100% if currently zero and a color is set.
231 if ((this->has_red() || this->has_green() || this->has_blue()) && !this->has_color_brightness() &&
232 this->parent_->remote_values.get_color_brightness() == 0.0f) {
233 this->color_brightness_ = 1.0f;
235 }
236
237 // Capability validation
238 if (this->has_brightness() && this->brightness_ > 0.0f && !(color_mode & ColorCapability::BRIGHTNESS))
239 this->log_and_clear_unsupported_(FLAG_HAS_BRIGHTNESS, LOG_STR("brightness"), false);
240
241 // Transition length possible check
242 if (this->has_transition_() && this->transition_length_ != 0 && !(color_mode & ColorCapability::BRIGHTNESS))
243 this->log_and_clear_unsupported_(FLAG_HAS_TRANSITION, LOG_STR("transitions"), false);
244
245 if (this->has_color_brightness() && this->color_brightness_ > 0.0f && !(color_mode & ColorCapability::RGB))
246 this->log_and_clear_unsupported_(FLAG_HAS_COLOR_BRIGHTNESS, LOG_STR("RGB brightness"), true);
247
248 // RGB exists check
249 if (((this->has_red() && this->red_ > 0.0f) || (this->has_green() && this->green_ > 0.0f) ||
250 (this->has_blue() && this->blue_ > 0.0f)) &&
251 !(color_mode & ColorCapability::RGB)) {
252 log_color_mode_not_supported(name, LOG_STR("RGB color"));
256 }
257
258 // White value exists check
259 if (this->has_white() && this->white_ > 0.0f &&
260 !(color_mode & ColorCapability::WHITE || color_mode & ColorCapability::COLD_WARM_WHITE))
261 this->log_and_clear_unsupported_(FLAG_HAS_WHITE, LOG_STR("white value"), true);
262
263 // Color temperature exists check
264 if (this->has_color_temperature() &&
266 this->log_and_clear_unsupported_(FLAG_HAS_COLOR_TEMPERATURE, LOG_STR("color temperature"), true);
267
268 // Cold/warm white value exists check
269 if (((this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f)) &&
270 !(color_mode & ColorCapability::COLD_WARM_WHITE)) {
271 log_color_mode_not_supported(name, LOG_STR("cold/warm white value"));
274 }
275
276 // Create color values and validate+apply ranges in one step to eliminate duplicate checks
277 auto v = this->parent_->remote_values;
278 if (this->has_color_mode())
280 if (this->has_state())
281 v.set_state(this->state_);
282
283#define VALIDATE_AND_APPLY(field, setter, name_str, ...) \
284 if (this->has_##field()) { \
285 clamp_and_log_if_invalid(name, this->field##_, LOG_STR(name_str), ##__VA_ARGS__); \
286 v.setter(this->field##_); \
287 }
288
289 VALIDATE_AND_APPLY(brightness, set_brightness, "Brightness")
290 VALIDATE_AND_APPLY(color_brightness, set_color_brightness, "Color brightness")
291 VALIDATE_AND_APPLY(red, set_red, "Red")
292 VALIDATE_AND_APPLY(green, set_green, "Green")
293 VALIDATE_AND_APPLY(blue, set_blue, "Blue")
294 VALIDATE_AND_APPLY(white, set_white, "White")
295 VALIDATE_AND_APPLY(cold_white, set_cold_white, "Cold white")
296 VALIDATE_AND_APPLY(warm_white, set_warm_white, "Warm white")
297 VALIDATE_AND_APPLY(color_temperature, set_color_temperature, "Color temperature", traits.get_min_mireds(),
298 traits.get_max_mireds())
299
300#undef VALIDATE_AND_APPLY
301
302 v.normalize_color();
303
304 // Flash length check
305 if (this->has_flash_() && this->flash_length_ == 0) {
306 log_invalid_parameter(name, LOG_STR("flash length must be >0"));
308 }
309
310 // validate transition length/flash length/effect not used at the same time
311 bool supports_transition = color_mode & ColorCapability::BRIGHTNESS;
312
313 // If effect is already active, remove effect start
314 if (this->has_effect_() && this->effect_ == this->parent_->active_effect_index_) {
316 }
317
318 // validate effect index
319 if (this->has_effect_() && this->effect_ > this->parent_->effects_.size()) {
320 ESP_LOGW(TAG, "'%s': invalid effect index %" PRIu32, name, this->effect_);
322 }
323
324 if (this->has_effect_() && (this->has_transition_() || this->has_flash_())) {
325 log_invalid_parameter(name, LOG_STR("effect cannot be used with transition/flash"));
328 }
329
330 if (this->has_flash_() && this->has_transition_()) {
331 log_invalid_parameter(name, LOG_STR("flash cannot be used with transition"));
333 }
334
335 if (!this->has_transition_() && !this->has_flash_() && (!this->has_effect_() || this->effect_ == 0) &&
336 supports_transition) {
337 // nothing specified and light supports transitions, set default transition length
340 }
341
342 if (this->has_transition_() && this->transition_length_ == 0) {
343 // 0 transition is interpreted as no transition (instant change)
345 }
346
347 if (this->has_transition_() && !supports_transition)
348 this->log_and_clear_unsupported_(FLAG_HAS_TRANSITION, LOG_STR("transitions"), false);
349
350 // If not a flash and turning the light off, then disable the light
351 // Do not use light color values directly, so that effects can set 0% brightness
352 // Reason: When user turns off the light in frontend, the effect should also stop
353 bool target_state = this->has_state() ? this->state_ : v.is_on();
354 if (!this->has_flash_() && !target_state) {
355 if (this->has_effect_()) {
356 log_invalid_parameter(name, LOG_STR("cannot start effect when turning off"));
358 } else if (this->parent_->active_effect_index_ != 0 && explicit_turn_off_request) {
359 // Auto turn off effect
360 this->effect_ = 0;
362 }
363 }
364
365 // Disable saving for flashes
366 if (this->has_flash_())
367 this->clear_flag_(FLAG_SAVE);
368
369 return v;
370}
372 auto traits = this->parent_->get_traits();
373
374 // Allow CWWW modes to be set with a white value and/or color temperature.
375 // This is used in three cases in HA:
376 // - CW/WW lights, which set the "brightness" and "color_temperature"
377 // - RGBWW lights with color_interlock=true, which also sets "brightness" and
378 // "color_temperature" (without color_interlock, CW/WW are set directly)
379 // - Legacy Home Assistant (pre-colormode), which sets "white" and "color_temperature"
380
381 // Cache min/max mireds to avoid repeated calls
382 const float min_mireds = traits.get_min_mireds();
383 const float max_mireds = traits.get_max_mireds();
384
385 if (((this->has_white() && this->white_ > 0.0f) || this->has_color_temperature()) && //
387 !(this->color_mode_ & ColorCapability::WHITE) && //
389 min_mireds > 0.0f && max_mireds > 0.0f) {
390 ESP_LOGD(TAG, "'%s': setting cold/warm white channels using white/color temperature values",
391 this->parent_->get_name().c_str());
392 if (this->has_color_temperature()) {
393 const float color_temp = clamp(this->color_temperature_, min_mireds, max_mireds);
394 const float range = max_mireds - min_mireds;
395 const float ww_fraction = (color_temp - min_mireds) / range;
396 const float cw_fraction = 1.0f - ww_fraction;
397 const float max_cw_ww = std::max(ww_fraction, cw_fraction);
398 const float gamma = this->parent_->get_gamma_correct();
399 this->cold_white_ = gamma_uncorrect(cw_fraction / max_cw_ww, gamma);
400 this->warm_white_ = gamma_uncorrect(ww_fraction / max_cw_ww, gamma);
403 }
404 if (this->has_white()) {
405 this->brightness_ = this->white_;
407 }
408 }
409}
411 auto supported_modes = this->parent_->get_traits().get_supported_color_modes();
412 int supported_count = supported_modes.size();
413
414 // Some lights don't support any color modes (e.g. monochromatic light), leave it at unknown.
415 if (supported_count == 0)
416 return ColorMode::UNKNOWN;
417
418 // In the common case of lights supporting only a single mode, use that one.
419 if (supported_count == 1)
420 return *supported_modes.begin();
421
422 // Don't change if the light is being turned off.
423 ColorMode current_mode = this->parent_->remote_values.get_color_mode();
424 if (this->has_state() && !this->state_)
425 return current_mode;
426
427 // If no color mode is specified, we try to guess the color mode. This is needed for backward compatibility to
428 // pre-colormode clients and automations, but also for the MQTT API, where HA doesn't let us know which color mode
429 // was used for some reason.
430 // Compute intersection of suitable and supported modes using bitwise AND
431 color_mode_bitmask_t intersection = this->get_suitable_color_modes_mask_() & supported_modes.get_mask();
432
433 // Don't change if the current mode is in the intersection (suitable AND supported)
434 if (ColorModeMask::mask_contains(intersection, current_mode)) {
435 ESP_LOGI(TAG, "'%s': color mode not specified; retaining %s", this->parent_->get_name().c_str(),
436 LOG_STR_ARG(color_mode_to_human(current_mode)));
437 return current_mode;
438 }
439
440 // Use the preferred suitable mode.
441 if (intersection != 0) {
443 ESP_LOGI(TAG, "'%s': color mode not specified; using %s", this->parent_->get_name().c_str(),
444 LOG_STR_ARG(color_mode_to_human(mode)));
445 return mode;
446 }
447
448 // There's no supported mode for this call, so warn, use the current more or a mode at random and let validation strip
449 // out whatever we don't support.
450 auto color_mode = current_mode != ColorMode::UNKNOWN ? current_mode : *supported_modes.begin();
451 ESP_LOGW(TAG, "'%s': no suitable color mode supported; defaulting to %s", this->parent_->get_name().c_str(),
452 LOG_STR_ARG(color_mode_to_human(color_mode)));
453 return color_mode;
454}
456 bool has_white = this->has_white() && this->white_ > 0.0f;
457 bool has_ct = this->has_color_temperature();
458 bool has_cwww =
459 (this->has_cold_white() && this->cold_white_ > 0.0f) || (this->has_warm_white() && this->warm_white_ > 0.0f);
460 bool has_rgb = (this->has_color_brightness() && this->color_brightness_ > 0.0f) ||
461 (this->has_red() || this->has_green() || this->has_blue());
462
463 // Build key from flags: [rgb][cwww][ct][white]
464#define KEY(white, ct, cwww, rgb) ((white) << 0 | (ct) << 1 | (cwww) << 2 | (rgb) << 3)
465
466 uint8_t key = KEY(has_white, has_ct, has_cwww, has_rgb);
467
468 switch (key) {
469 case KEY(true, false, false, false): // white only
472 .get_mask();
473 case KEY(false, true, false, false): // ct only
476 .get_mask();
477 case KEY(true, true, false, false): // white + ct
478 return ColorModeMask(
480 .get_mask();
481 case KEY(false, false, true, false): // cwww only
483 case KEY(false, false, false, false): // none
486 .get_mask();
487 case KEY(true, false, false, true): // rgb + white
489 .get_mask();
490 case KEY(false, true, false, true): // rgb + ct
491 case KEY(true, true, false, true): // rgb + white + ct
493 case KEY(false, false, true, true): // rgb + cwww
495 case KEY(false, false, false, true): // rgb only
498 .get_mask();
499 default:
500 return 0; // conflicting flags
501 }
502
503#undef KEY
504}
505
506LightCall &LightCall::set_effect(const std::string &effect) {
507 if (strcasecmp(effect.c_str(), "none") == 0) {
508 this->set_effect(0);
509 return *this;
510 }
511
512 bool found = false;
513 for (uint32_t i = 0; i < this->parent_->effects_.size(); i++) {
514 LightEffect *e = this->parent_->effects_[i];
515
516 if (strcasecmp(effect.c_str(), e->get_name()) == 0) {
517 this->set_effect(i + 1);
518 found = true;
519 break;
520 }
521 }
522 if (!found) {
523 ESP_LOGW(TAG, "'%s': no such effect '%s'", this->parent_->get_name().c_str(), effect.c_str());
524 }
525 return *this;
526}
546 this->set_transition_length(transition_length);
547 return *this;
548}
551 this->set_brightness(brightness);
552 return *this;
553}
555 if (this->parent_->get_traits().supports_color_mode(color_mode))
556 this->set_color_mode(color_mode);
557 return *this;
558}
561 this->set_color_brightness(brightness);
562 return *this;
563}
566 this->set_red(red);
567 return *this;
568}
571 this->set_green(green);
572 return *this;
573}
576 this->set_blue(blue);
577 return *this;
578}
581 this->set_white(white);
582 return *this;
583}
592 this->set_cold_white(cold_white);
593 return *this;
594}
597 this->set_warm_white(warm_white);
598 return *this;
599}
600IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE)
601IMPLEMENT_LIGHT_CALL_SETTER(transition_length, uint32_t, FLAG_HAS_TRANSITION)
602IMPLEMENT_LIGHT_CALL_SETTER(flash_length, uint32_t, FLAG_HAS_FLASH)
603IMPLEMENT_LIGHT_CALL_SETTER(brightness, float, FLAG_HAS_BRIGHTNESS)
604IMPLEMENT_LIGHT_CALL_SETTER(color_mode, ColorMode, FLAG_HAS_COLOR_MODE)
605IMPLEMENT_LIGHT_CALL_SETTER(color_brightness, float, FLAG_HAS_COLOR_BRIGHTNESS)
606IMPLEMENT_LIGHT_CALL_SETTER(red, float, FLAG_HAS_RED)
607IMPLEMENT_LIGHT_CALL_SETTER(green, float, FLAG_HAS_GREEN)
608IMPLEMENT_LIGHT_CALL_SETTER(blue, float, FLAG_HAS_BLUE)
609IMPLEMENT_LIGHT_CALL_SETTER(white, float, FLAG_HAS_WHITE)
610IMPLEMENT_LIGHT_CALL_SETTER(color_temperature, float, FLAG_HAS_COLOR_TEMPERATURE)
611IMPLEMENT_LIGHT_CALL_SETTER(cold_white, float, FLAG_HAS_COLD_WHITE)
612IMPLEMENT_LIGHT_CALL_SETTER(warm_white, float, FLAG_HAS_WARM_WHITE)
613LightCall &LightCall::set_effect(optional<std::string> effect) {
614 if (effect.has_value())
615 this->set_effect(*effect);
616 return *this;
617}
619 this->effect_ = effect_number;
621 return *this;
622}
624 if (effect_number.has_value()) {
625 this->effect_ = effect_number.value();
626 }
627 this->set_flag_(FLAG_HAS_EFFECT, effect_number.has_value());
628 return *this;
629}
631 this->set_flag_(FLAG_PUBLISH, publish);
632 return *this;
633}
635 this->set_flag_(FLAG_SAVE, save);
636 return *this;
637}
638LightCall &LightCall::set_rgb(float red, float green, float blue) {
639 this->set_red(red);
640 this->set_green(green);
641 this->set_blue(blue);
642 return *this;
643}
644LightCall &LightCall::set_rgbw(float red, float green, float blue, float white) {
645 this->set_rgb(red, green, blue);
646 this->set_white(white);
647 return *this;
648}
649
650} // namespace light
651} // namespace esphome
BedjetMode mode
BedJet operating mode.
const StringRef & get_name() const
static constexpr ColorMode first_value_from_mask(bitmask_t mask)
constexpr size_t size() const
Count the number of values in the set.
static constexpr bool mask_contains(bitmask_t mask, ColorMode value)
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:21
bool has_color_mode() const
Definition light_call.h:152
bool has_color_temperature() const
Definition light_call.h:149
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:151
bool has_brightness() const
Definition light_call.h:143
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:150
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:144
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.
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.
void clear_flag_(FieldFlags flag)
Definition light_call.h:229
ColorMode get_active_color_mode_()
Get the currently targeted, or active if none set, color mode.
void set_flag_(FieldFlags flag, bool value=true)
Definition light_call.h:220
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.
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.
const char * get_name() const
Returns the name of this effect.
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 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.
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
ColorModeMask get_supported_color_modes() const
bool has_value() const
Definition optional.h:92
value_type const & value() const
Definition optional.h:94
const char * message
Definition component.cpp:38
bool state
Definition fan.h:0
Range range
Definition msa3xx.h:0
IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE) IMPLEMENT_LIGHT_CALL_SETTER(transition_length
FiniteSetMask< ColorMode, ColorModeBitPolicy > ColorModeMask
Definition color_mode.h:148
uint16_t color_mode_bitmask_t
Definition color_mode.h:109
ColorMode
Color modes are a combination of color capabilities that can be used at the same time.
Definition color_mode.h:50
@ ON_OFF
Only on/off control.
@ RGB_COLD_WARM_WHITE
RGB color output, and separate cold and warm white outputs.
@ BRIGHTNESS
Dimmable light.
@ 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:544