11static const char *
const TAG =
"light";
14static void clamp_and_log_if_invalid(
const char *name,
float &value,
const LogString *param_name,
float min = 0.0f,
16 if (value < min || value > max) {
17 ESP_LOGW(TAG,
"'%s': %s value %.2f is out of range [%.1f - %.1f]", name, LOG_STR_ARG(param_name), value, min, max);
18 value = clamp(value, min, max);
22#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
23static void log_feature_not_supported(
const char *name,
const LogString *feature) {
24 ESP_LOGW(TAG,
"'%s': %s not supported", name, LOG_STR_ARG(feature));
27static void log_color_mode_not_supported(
const char *name,
const LogString *feature) {
28 ESP_LOGW(TAG,
"'%s': color mode does not support setting %s", name, LOG_STR_ARG(feature));
31static void log_invalid_parameter(
const char *name,
const LogString *
message) {
32 ESP_LOGW(TAG,
"'%s': %s", name, LOG_STR_ARG(
message));
35#define log_feature_not_supported(name, feature)
36#define log_color_mode_not_supported(name, feature)
37#define log_invalid_parameter(name, message)
41#define IMPLEMENT_LIGHT_CALL_SETTER(name, type, flag) \
42 LightCall &LightCall::set_##name(optional<type>(name)) { \
43 if ((name).has_value()) { \
44 this->name##_ = (name).value(); \
46 this->set_flag_(flag, (name).has_value()); \
49 LightCall &LightCall::set_##name(type name) { \
50 this->name##_ = name; \
51 this->set_flag_(flag); \
57PROGMEM_STRING_TABLE(ColorModeHumanStrings,
"Unknown",
"On/Off",
"Brightness",
"White",
"Color temperature",
58 "Cold/warm white",
"RGB",
"RGBW",
"RGB + color temperature",
"RGB + cold/warm white");
60static const LogString *color_mode_to_human(
ColorMode color_mode) {
65#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
66static void log_percent(
const LogString *param,
float value) {
67 ESP_LOGD(TAG,
" %s: %.0f%%", LOG_STR_ARG(param), value * 100.0f);
70#define log_percent(param, value)
79 ESP_LOGD(TAG,
"'%s' Setting:", name);
84 if (target_color_mode != current_color_mode) {
85 ESP_LOGD(TAG,
" Color mode: %s", LOG_STR_ARG(color_mode_to_human(v.
get_color_mode())));
91 if (target_state != current_state) {
92 ESP_LOGD(TAG,
" State: %s", ONOFF(v.
is_on()));
103 ESP_LOGD(TAG,
" Red: %.0f%%, Green: %.0f%%, Blue: %.0f%%", v.
get_red() * 100.0f, v.
get_green() * 100.0f,
108 log_percent(LOG_STR(
"White"), v.
get_white());
115 ESP_LOGD(TAG,
" Cold white: %.0f%%, warm white: %.0f%%", v.
get_cold_white() * 100.0f,
123 ESP_LOGD(TAG,
" Flash length: %.1fs", this->
flash_length_ / 1e3f);
136 ESP_LOGD(TAG,
" Effect: 'None'");
153 ESP_LOGD(TAG,
" Effect: '%.*s'", (
int) effect_s.
size(), effect_s.
c_str());
168 listener->on_light_target_state_reached();
181 if (use_color_mode_log) {
182 log_color_mode_not_supported(name, feature);
184 log_feature_not_supported(name, feature);
194 if (this->
has_color_mode() && !traits.supports_color_mode(this->color_mode_)) {
195 ESP_LOGW(TAG,
"'%s' does not support color mode %s", name, LOG_STR_ARG(color_mode_to_human(this->
color_mode_)));
242 log_color_mode_not_supported(name, LOG_STR(
"RGB color"));
261 log_color_mode_not_supported(name, LOG_STR(
"cold/warm white value"));
271 v.set_state(this->
state_);
275#define VALIDATE_AND_APPLY(field, name_str, ...) \
276 if (this->has_##field()) { \
277 clamp_and_log_if_invalid(name, this->field##_, LOG_STR(name_str), ##__VA_ARGS__); \
278 v.field##_ = this->field##_; \
281 VALIDATE_AND_APPLY(brightness,
"Brightness")
282 VALIDATE_AND_APPLY(color_brightness,
"Color brightness")
283 VALIDATE_AND_APPLY(red,
"Red")
284 VALIDATE_AND_APPLY(green,
"Green")
285 VALIDATE_AND_APPLY(blue,
"Blue")
286 VALIDATE_AND_APPLY(white,
"White")
287 VALIDATE_AND_APPLY(cold_white,
"Cold white")
288 VALIDATE_AND_APPLY(warm_white,
"Warm white")
289 VALIDATE_AND_APPLY(color_temperature,
"Color temperature", traits.get_min_mireds(), traits.get_max_mireds())
291#undef VALIDATE_AND_APPLY
297 log_invalid_parameter(name, LOG_STR(
"flash length must be >0"));
311 ESP_LOGW(TAG,
"'%s': invalid effect index %" PRIu32, name, this->
effect_);
316 log_invalid_parameter(name, LOG_STR(
"effect cannot be used with transition/flash"));
322 log_invalid_parameter(name, LOG_STR(
"flash cannot be used with transition"));
327 supports_transition) {
347 log_invalid_parameter(name, LOG_STR(
"cannot start effect when turning off"));
374 const float max_mireds = traits.get_max_mireds();
380 min_mireds > 0.0f && max_mireds > 0.0f) {
381 ESP_LOGD(TAG,
"'%s': setting cold/warm white channels using white/color temperature values",
388 const float range = max_mireds - min_mireds;
389 const float ww_fraction = (color_temp - min_mireds) /
range;
390 const float cw_fraction = 1.0f - ww_fraction;
391 const float max_cw_ww = std::max(ww_fraction, cw_fraction);
406 int supported_count = supported_modes.
size();
409 if (supported_count == 0)
413 if (supported_count == 1)
414 return *supported_modes.begin();
429 ESP_LOGI(TAG,
"'%s': color mode not specified; retaining %s", this->
parent_->
get_name().
c_str(),
430 LOG_STR_ARG(color_mode_to_human(current_mode)));
435 if (intersection != 0) {
438 LOG_STR_ARG(color_mode_to_human(
mode)));
444 auto color_mode = current_mode !=
ColorMode::UNKNOWN ? current_mode : *supported_modes.begin();
445 ESP_LOGW(TAG,
"'%s': no suitable color mode supported; defaulting to %s", this->
parent_->
get_name().
c_str(),
446 LOG_STR_ARG(color_mode_to_human(color_mode)));
455static constexpr uint8_t SUITABLE_COLOR_MODES[] PROGMEM = {
504 uint8_t key =
has_white | (has_ct << 1) | (has_cwww << 2) | (has_rgb << 3);
509 if (
len == 4 && strncasecmp(effect,
"none", 4) == 0) {
524 ESP_LOGW(TAG,
"'%s': no such effect '%.*s'", this->
parent_->
get_name().
c_str(), (
int) len, effect);
615 if (effect.has_value())
646 this->
set_rgb(red, green, blue);
BedjetMode mode
BedJet operating mode.
const StringRef & get_name() const
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.
constexpr const char * c_str() const
constexpr size_type size() const
static constexpr StringRef from_lit(const CharT(&s)[N])
This class represents a requested change in a light state.
bool has_color_mode() const
bool has_color_temperature() const
LightCall & set_color_mode_if_supported(ColorMode color_mode)
Set the color mode of the light, if this mode is supported.
LightCall & set_color_temperature(optional< float > color_temperature)
Set the color temperature of the light in mireds for CWWW or RGBWW lights.
LightCall & set_publish(bool publish)
Set whether this light call should trigger a publish state.
void log_and_clear_unsupported_(FieldFlags flag, const LogString *feature, bool use_color_mode_log)
ColorMode compute_color_mode_()
LightCall & set_color_brightness(optional< float > brightness)
Set the color brightness of the light from 0.0 (no color) to 1.0 (fully on)
bool has_warm_white() const
bool has_brightness() const
LightCall & set_rgb(float red, float green, float blue)
Set the RGB color of the light by RGB values.
bool has_cold_white() const
LightCall & set_transition_length_if_supported(uint32_t transition_length)
Set the transition length property if the light supports transitions.
bool has_color_brightness() const
LightCall & set_red_if_supported(float red)
Set the red property if the light supports RGB.
LightCall & set_effect(optional< std::string > effect)
Set the effect of the light by its name.
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)
ColorMode get_active_color_mode_()
Get the currently targeted, or active if none set, color mode.
void set_flag_(FieldFlags flag, bool value=true)
LightCall & set_white_if_supported(float white)
Set the white property if the light supports RGB.
LightCall & set_cold_white_if_supported(float cold_white)
Set the cold white property if the light supports cold white output.
LightCall & set_warm_white_if_supported(float warm_white)
Set the warm white property if the light supports cold white output.
@ FLAG_HAS_COLOR_TEMPERATURE
@ FLAG_HAS_COLOR_BRIGHTNESS
LightCall & set_brightness_if_supported(float brightness)
Set the brightness property if the light supports brightness.
LightColorValues validate_()
Validate all properties and return the target light color values.
uint32_t transition_length_
LightCall & set_brightness(optional< float > brightness)
Set the target brightness of the light from 0.0 (fully off) to 1.0 (fully on)
LightCall & set_blue_if_supported(float blue)
Set the blue property if the light supports RGB.
void transform_parameters_()
Some color modes also can be set using non-native parameters, transform those calls.
LightCall & from_light_color_values(const LightColorValues &values)
LightCall & set_state(optional< bool > state)
Set the binary ON/OFF state of the light.
LightCall & set_color_mode(optional< ColorMode > color_mode)
Set the color mode of the light.
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 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.
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.
bool supports_color_mode(ColorMode color_mode) const
ColorModeMask get_supported_color_modes() const
float get_min_mireds() const
value_type const & value() const
IMPLEMENT_LIGHT_CALL_SETTER(state, bool, FLAG_HAS_STATE) IMPLEMENT_LIGHT_CALL_SETTER(transition_length
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
uint16_t color_mode_bitmask_t
ColorMode
Color modes are a combination of color capabilities that can be used at the same time.
@ RGB_COLD_WARM_WHITE
RGB color output, and separate cold and warm white outputs.
@ UNKNOWN
No color mode configured (cannot be a supported mode, only active when light is off).
@ RGB_WHITE
RGB color output and a separate white output.
@ RGB_COLOR_TEMPERATURE
RGB color output and a separate white output with controllable color temperature.
@ COLOR_TEMPERATURE
Controllable color temperature output.
@ WHITE
White output only (use only if the light also has another color mode such as RGB).
@ COLD_WARM_WHITE
Cold and warm white output with individually controllable brightness.
@ BRIGHTNESS
Master brightness of the light can be controlled.
@ RGB
Color can be controlled using RGB format (includes a brightness control for the color).
@ COLOR_TEMPERATURE
Color temperature can be controlled.
@ WHITE
Brightness of white channel can be controlled separately from other channels.
@ COLD_WARM_WHITE
Brightness of cold and warm white output can be controlled.
float gamma_uncorrect(float value, float gamma)
Reverts gamma correction of gamma to value.
bool str_equals_case_insensitive(const std::string &a, const std::string &b)
Compare strings for equality in case-insensitive manner.
uint8_t progmem_read_byte(const uint8_t *addr)
static constexpr unsigned to_bit(ColorMode mode)