mirror of
https://github.com/esphome/esphome.git
synced 2026-06-24 12:33:10 +00:00
[light] Use constexpr template for DimRelativeAction transition_length (#16038)
This commit is contained in:
@@ -86,12 +86,15 @@ template<uint16_t Fields, typename... Ts> class LightControlAction : public Acti
|
|||||||
};
|
};
|
||||||
#undef LIGHT_CONTROL_FIELDS
|
#undef LIGHT_CONTROL_FIELDS
|
||||||
|
|
||||||
template<typename... Ts> class DimRelativeAction : public Action<Ts...> {
|
template<bool HasTransitionLength, typename... Ts> class DimRelativeAction : public Action<Ts...> {
|
||||||
public:
|
public:
|
||||||
explicit DimRelativeAction(LightState *parent) : parent_(parent) {}
|
explicit DimRelativeAction(LightState *parent) : parent_(parent) {}
|
||||||
|
|
||||||
TEMPLATABLE_VALUE(float, relative_brightness)
|
TEMPLATABLE_VALUE(float, relative_brightness)
|
||||||
TEMPLATABLE_VALUE(uint32_t, transition_length)
|
|
||||||
|
template<typename V> void set_transition_length(V value) requires(HasTransitionLength) {
|
||||||
|
this->transition_length_ = value;
|
||||||
|
}
|
||||||
|
|
||||||
void play(const Ts &...x) override {
|
void play(const Ts &...x) override {
|
||||||
auto call = this->parent_->make_call();
|
auto call = this->parent_->make_call();
|
||||||
@@ -105,7 +108,9 @@ template<typename... Ts> class DimRelativeAction : public Action<Ts...> {
|
|||||||
call.set_state(new_brightness != 0.0f);
|
call.set_state(new_brightness != 0.0f);
|
||||||
call.set_brightness(new_brightness);
|
call.set_brightness(new_brightness);
|
||||||
|
|
||||||
call.set_transition_length(this->transition_length_.optional_value(x...));
|
if constexpr (HasTransitionLength) {
|
||||||
|
call.set_transition_length(this->transition_length_.optional_value(x...));
|
||||||
|
}
|
||||||
call.perform();
|
call.perform();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -121,6 +126,9 @@ template<typename... Ts> class DimRelativeAction : public Action<Ts...> {
|
|||||||
float min_brightness_{0.0};
|
float min_brightness_{0.0};
|
||||||
float max_brightness_{1.0};
|
float max_brightness_{1.0};
|
||||||
LimitMode limit_mode_{LimitMode::CLAMP};
|
LimitMode limit_mode_{LimitMode::CLAMP};
|
||||||
|
struct NoTransition {};
|
||||||
|
[[no_unique_address]] std::conditional_t<HasTransitionLength, TemplatableFn<uint32_t, Ts...>, NoTransition>
|
||||||
|
transition_length_{};
|
||||||
};
|
};
|
||||||
|
|
||||||
template<typename... Ts> class LightIsOnCondition : public Condition<Ts...> {
|
template<typename... Ts> class LightIsOnCondition : public Condition<Ts...> {
|
||||||
|
|||||||
@@ -273,10 +273,12 @@ LIGHT_DIM_RELATIVE_ACTION_SCHEMA = cv.Schema(
|
|||||||
)
|
)
|
||||||
async def light_dim_relative_to_code(config, action_id, template_arg, args):
|
async def light_dim_relative_to_code(config, action_id, template_arg, args):
|
||||||
paren = await cg.get_variable(config[CONF_ID])
|
paren = await cg.get_variable(config[CONF_ID])
|
||||||
var = cg.new_Pvariable(action_id, template_arg, paren)
|
has_transition_length = CONF_TRANSITION_LENGTH in config
|
||||||
|
dim_template_arg = cg.TemplateArguments(has_transition_length, *template_arg)
|
||||||
|
var = cg.new_Pvariable(action_id, dim_template_arg, paren)
|
||||||
templ = await cg.templatable(config[CONF_RELATIVE_BRIGHTNESS], args, cg.float_)
|
templ = await cg.templatable(config[CONF_RELATIVE_BRIGHTNESS], args, cg.float_)
|
||||||
cg.add(var.set_relative_brightness(templ))
|
cg.add(var.set_relative_brightness(templ))
|
||||||
if CONF_TRANSITION_LENGTH in config:
|
if has_transition_length:
|
||||||
templ = await cg.templatable(config[CONF_TRANSITION_LENGTH], args, cg.uint32)
|
templ = await cg.templatable(config[CONF_TRANSITION_LENGTH], args, cg.uint32)
|
||||||
cg.add(var.set_transition_length(templ))
|
cg.add(var.set_transition_length(templ))
|
||||||
if conf := config.get(CONF_BRIGHTNESS_LIMITS):
|
if conf := config.get(CONF_BRIGHTNESS_LIMITS):
|
||||||
|
|||||||
@@ -108,6 +108,10 @@ esphome:
|
|||||||
relative_brightness: 5%
|
relative_brightness: 5%
|
||||||
brightness_limits:
|
brightness_limits:
|
||||||
max_brightness: 90%
|
max_brightness: 90%
|
||||||
|
- light.dim_relative:
|
||||||
|
id: test_monochromatic_light
|
||||||
|
relative_brightness: -5%
|
||||||
|
transition_length: 250ms
|
||||||
- light.turn_on:
|
- light.turn_on:
|
||||||
id: test_addressable_transition
|
id: test_addressable_transition
|
||||||
brightness: 50%
|
brightness: 50%
|
||||||
|
|||||||
60
tests/integration/fixtures/light_dim_relative_action.yaml
Normal file
60
tests/integration/fixtures/light_dim_relative_action.yaml
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
esphome:
|
||||||
|
name: light-dim-relative-action-test
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: DEBUG
|
||||||
|
|
||||||
|
output:
|
||||||
|
- platform: template
|
||||||
|
id: test_out
|
||||||
|
type: float
|
||||||
|
write_action:
|
||||||
|
- lambda: ""
|
||||||
|
|
||||||
|
light:
|
||||||
|
- platform: monochromatic
|
||||||
|
name: "Test Light"
|
||||||
|
id: test_light
|
||||||
|
output: test_out
|
||||||
|
default_transition_length: 0s
|
||||||
|
|
||||||
|
button:
|
||||||
|
# Set up: turn on at 50% brightness
|
||||||
|
- platform: template
|
||||||
|
id: btn_setup
|
||||||
|
name: "Setup"
|
||||||
|
on_press:
|
||||||
|
- light.turn_on:
|
||||||
|
id: test_light
|
||||||
|
brightness: 50%
|
||||||
|
|
||||||
|
# Test 1: dim_relative without transition_length (HasTransitionLength=false)
|
||||||
|
- platform: template
|
||||||
|
id: btn_dim_up
|
||||||
|
name: "Dim Up"
|
||||||
|
on_press:
|
||||||
|
- light.dim_relative:
|
||||||
|
id: test_light
|
||||||
|
relative_brightness: 25%
|
||||||
|
|
||||||
|
# Test 2: dim_relative with transition_length (HasTransitionLength=true)
|
||||||
|
- platform: template
|
||||||
|
id: btn_dim_down
|
||||||
|
name: "Dim Down"
|
||||||
|
on_press:
|
||||||
|
- light.dim_relative:
|
||||||
|
id: test_light
|
||||||
|
relative_brightness: -10%
|
||||||
|
transition_length: 0s
|
||||||
|
|
||||||
|
# Test 3: dim_relative with brightness limits
|
||||||
|
- platform: template
|
||||||
|
id: btn_dim_clamp
|
||||||
|
name: "Dim Clamp"
|
||||||
|
on_press:
|
||||||
|
- light.dim_relative:
|
||||||
|
id: test_light
|
||||||
|
relative_brightness: 50%
|
||||||
|
brightness_limits:
|
||||||
|
max_brightness: 80%
|
||||||
72
tests/integration/test_light_dim_relative_action.py
Normal file
72
tests/integration/test_light_dim_relative_action.py
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
"""Integration test for light::DimRelativeAction.
|
||||||
|
|
||||||
|
Tests both DimRelativeAction<HasTransitionLength=false> and
|
||||||
|
DimRelativeAction<HasTransitionLength=true> instantiations.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
from aioesphomeapi import ButtonInfo, EntityState, LightInfo, LightState
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from .state_utils import InitialStateHelper, require_entity
|
||||||
|
from .types import APIClientConnectedFactory, RunCompiledFunction
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_light_dim_relative_action(
|
||||||
|
yaml_config: str,
|
||||||
|
run_compiled: RunCompiledFunction,
|
||||||
|
api_client_connected: APIClientConnectedFactory,
|
||||||
|
) -> None:
|
||||||
|
"""Test light.dim_relative with and without transition_length."""
|
||||||
|
loop = asyncio.get_running_loop()
|
||||||
|
async with run_compiled(yaml_config), api_client_connected() as client:
|
||||||
|
light_state_future: asyncio.Future[LightState] | None = None
|
||||||
|
|
||||||
|
def on_state(state: EntityState) -> None:
|
||||||
|
if (
|
||||||
|
isinstance(state, LightState)
|
||||||
|
and light_state_future is not None
|
||||||
|
and not light_state_future.done()
|
||||||
|
):
|
||||||
|
light_state_future.set_result(state)
|
||||||
|
|
||||||
|
async def wait_for_light_state(timeout: float = 5.0) -> LightState:
|
||||||
|
nonlocal light_state_future
|
||||||
|
light_state_future = loop.create_future()
|
||||||
|
try:
|
||||||
|
return await asyncio.wait_for(light_state_future, timeout)
|
||||||
|
finally:
|
||||||
|
light_state_future = None
|
||||||
|
|
||||||
|
entities, _ = await client.list_entities_services()
|
||||||
|
initial_state_helper = InitialStateHelper(entities)
|
||||||
|
client.subscribe_states(initial_state_helper.on_state_wrapper(on_state))
|
||||||
|
await initial_state_helper.wait_for_initial_states()
|
||||||
|
|
||||||
|
require_entity(entities, "test_light", LightInfo)
|
||||||
|
|
||||||
|
async def press_and_wait(name: str) -> LightState:
|
||||||
|
btn = require_entity(entities, name.lower().replace(" ", "_"), ButtonInfo)
|
||||||
|
client.button_command(btn.key)
|
||||||
|
return await wait_for_light_state()
|
||||||
|
|
||||||
|
# Setup: turn on at 50%
|
||||||
|
state = await press_and_wait("Setup")
|
||||||
|
assert state.state is True
|
||||||
|
assert state.brightness == pytest.approx(0.5, abs=0.05)
|
||||||
|
|
||||||
|
# Test 1: dim_relative without transition_length: 50% + 25% = 75%
|
||||||
|
state = await press_and_wait("Dim Up")
|
||||||
|
assert state.brightness == pytest.approx(0.75, abs=0.05)
|
||||||
|
|
||||||
|
# Test 2: dim_relative with transition_length: 75% - 10% = 65%
|
||||||
|
state = await press_and_wait("Dim Down")
|
||||||
|
assert state.brightness == pytest.approx(0.65, abs=0.05)
|
||||||
|
|
||||||
|
# Test 3: dim_relative with max_brightness limit: 65% + 50% clamped to 80%
|
||||||
|
state = await press_and_wait("Dim Clamp")
|
||||||
|
assert state.brightness == pytest.approx(0.80, abs=0.05)
|
||||||
Reference in New Issue
Block a user