mirror of
https://github.com/esphome/esphome.git
synced 2026-05-19 03:01:49 +08:00
[cover] Fold ControlAction/CoverPublishAction fields into stateless lambdas (#16046)
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
import logging
|
||||
|
||||
from esphome import automation
|
||||
@@ -36,14 +38,14 @@ from esphome.const import (
|
||||
DEVICE_CLASS_SHUTTER,
|
||||
DEVICE_CLASS_WINDOW,
|
||||
)
|
||||
from esphome.core import CORE, ID, CoroPriority, coroutine_with_priority
|
||||
from esphome.core import CORE, ID, CoroPriority, Lambda, coroutine_with_priority
|
||||
from esphome.core.entity_helpers import (
|
||||
entity_duplicate_validator,
|
||||
queue_entity_register,
|
||||
setup_device_class,
|
||||
setup_entity,
|
||||
)
|
||||
from esphome.cpp_generator import MockObj, MockObjClass
|
||||
from esphome.cpp_generator import LambdaExpression, MockObj, MockObjClass
|
||||
from esphome.types import ConfigType, TemplateArgsType
|
||||
|
||||
IS_PLATFORM_COMPONENT = True
|
||||
@@ -68,6 +70,7 @@ _LOGGER = logging.getLogger(__name__)
|
||||
cover_ns = cg.esphome_ns.namespace("cover")
|
||||
|
||||
Cover = cover_ns.class_("Cover", cg.EntityBase)
|
||||
CoverCall = cover_ns.class_("CoverCall")
|
||||
|
||||
COVER_OPEN = cover_ns.COVER_OPEN
|
||||
COVER_CLOSED = cover_ns.COVER_CLOSED
|
||||
@@ -294,25 +297,94 @@ COVER_CONTROL_ACTION_SCHEMA = cv.Schema(
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ApplyField:
|
||||
"""One field in a folded-lambda action.
|
||||
|
||||
`conf_key` is the YAML key looked up in `config`. When present, the
|
||||
helper emits `statement_fn(target, value_expr)` into the lambda body.
|
||||
`target` is whatever the statement function needs to identify the
|
||||
field (typically a setter name like `"set_position"` or a struct
|
||||
member like `"position"`). `type_` is the C++ return type for
|
||||
`cg.process_lambda` when the value is a user lambda.
|
||||
"""
|
||||
|
||||
conf_key: str
|
||||
target: str
|
||||
type_: object
|
||||
|
||||
|
||||
async def build_apply_lambda_action(
|
||||
config: ConfigType,
|
||||
action_id: ID,
|
||||
template_arg: cg.TemplateArguments,
|
||||
args: TemplateArgsType,
|
||||
fields: tuple[ApplyField, ...],
|
||||
prefix_args: list[tuple[object, str]],
|
||||
statement_fn: Callable[[str, str], str],
|
||||
) -> MockObj:
|
||||
"""Fold configured fields into a single stateless apply lambda action.
|
||||
|
||||
Used by both `cover.control` and `cover.template.publish` (and shared
|
||||
with the template/cover platform). Constants are emitted as flash
|
||||
immediates; user lambdas are invoked inline so trigger args still flow.
|
||||
The trigger arg types are wrapped as `const T &` to match the
|
||||
`void (*)(..., const Ts &...)` ApplyFn signature.
|
||||
"""
|
||||
paren = await cg.get_variable(config[CONF_ID])
|
||||
fwd_args = ", ".join(name for _, name in args)
|
||||
body_lines: list[str] = []
|
||||
for field in fields:
|
||||
if (value := config.get(field.conf_key)) is None:
|
||||
continue
|
||||
if isinstance(value, Lambda):
|
||||
inner = await cg.process_lambda(value, args, return_type=field.type_)
|
||||
value_expr = f"({inner})({fwd_args})"
|
||||
else:
|
||||
value_expr = str(cg.safe_exp(value))
|
||||
body_lines.append(statement_fn(field.target, value_expr))
|
||||
|
||||
apply_args = [
|
||||
*prefix_args,
|
||||
*((t.operator("const").operator("ref"), n) for t, n in args),
|
||||
]
|
||||
apply_lambda = LambdaExpression(
|
||||
["\n".join(body_lines)],
|
||||
apply_args,
|
||||
capture="",
|
||||
return_type=cg.void,
|
||||
)
|
||||
return cg.new_Pvariable(action_id, template_arg, paren, apply_lambda)
|
||||
|
||||
|
||||
# CONF_STATE and CONF_POSITION are cv.Exclusive in the schema, so at most
|
||||
# one is present and both dispatch to set_position.
|
||||
_COVER_CONTROL_FIELDS: tuple[ApplyField, ...] = (
|
||||
ApplyField(CONF_STOP, "set_stop", cg.bool_),
|
||||
ApplyField(CONF_STATE, "set_position", cg.float_),
|
||||
ApplyField(CONF_POSITION, "set_position", cg.float_),
|
||||
ApplyField(CONF_TILT, "set_tilt", cg.float_),
|
||||
)
|
||||
|
||||
|
||||
@automation.register_action(
|
||||
"cover.control", ControlAction, COVER_CONTROL_ACTION_SCHEMA, synchronous=True
|
||||
)
|
||||
async def cover_control_to_code(config, action_id, template_arg, args):
|
||||
paren = await cg.get_variable(config[CONF_ID])
|
||||
var = cg.new_Pvariable(action_id, template_arg, paren)
|
||||
if (stop := config.get(CONF_STOP)) is not None:
|
||||
template_ = await cg.templatable(stop, args, cg.bool_)
|
||||
cg.add(var.set_stop(template_))
|
||||
if (state := config.get(CONF_STATE)) is not None:
|
||||
template_ = await cg.templatable(state, args, cg.float_)
|
||||
cg.add(var.set_position(template_))
|
||||
if (position := config.get(CONF_POSITION)) is not None:
|
||||
template_ = await cg.templatable(position, args, cg.float_)
|
||||
cg.add(var.set_position(template_))
|
||||
if (tilt := config.get(CONF_TILT)) is not None:
|
||||
template_ = await cg.templatable(tilt, args, cg.float_)
|
||||
cg.add(var.set_tilt(template_))
|
||||
return var
|
||||
async def cover_control_to_code(
|
||||
config: ConfigType,
|
||||
action_id: ID,
|
||||
template_arg: cg.TemplateArguments,
|
||||
args: TemplateArgsType,
|
||||
) -> MockObj:
|
||||
return await build_apply_lambda_action(
|
||||
config=config,
|
||||
action_id=action_id,
|
||||
template_arg=template_arg,
|
||||
args=args,
|
||||
fields=_COVER_CONTROL_FIELDS,
|
||||
prefix_args=[(CoverCall.operator("ref"), "call")],
|
||||
statement_fn=lambda setter, expr: f"call.{setter}({expr});",
|
||||
)
|
||||
|
||||
|
||||
COVER_CONDITION_SCHEMA = cv.maybe_simple_value(
|
||||
|
||||
@@ -46,48 +46,41 @@ template<typename... Ts> class ToggleAction : public Action<Ts...> {
|
||||
Cover *cover_;
|
||||
};
|
||||
|
||||
// All configured fields are baked into a single stateless lambda whose
|
||||
// constants live in flash. Each action stores only one function pointer
|
||||
// plus one parent pointer, regardless of how many fields the user set.
|
||||
// Trigger args are forwarded to the apply function so user lambdas
|
||||
// (e.g. `position: !lambda "return x;"`) keep working.
|
||||
|
||||
template<typename... Ts> class ControlAction : public Action<Ts...> {
|
||||
public:
|
||||
explicit ControlAction(Cover *cover) : cover_(cover) {}
|
||||
|
||||
TEMPLATABLE_VALUE(bool, stop)
|
||||
TEMPLATABLE_VALUE(float, position)
|
||||
TEMPLATABLE_VALUE(float, tilt)
|
||||
using ApplyFn = void (*)(CoverCall &, const Ts &...);
|
||||
ControlAction(Cover *cover, ApplyFn apply) : cover_(cover), apply_(apply) {}
|
||||
|
||||
void play(const Ts &...x) override {
|
||||
auto call = this->cover_->make_call();
|
||||
if (this->stop_.has_value())
|
||||
call.set_stop(this->stop_.value(x...));
|
||||
if (this->position_.has_value())
|
||||
call.set_position(this->position_.value(x...));
|
||||
if (this->tilt_.has_value())
|
||||
call.set_tilt(this->tilt_.value(x...));
|
||||
this->apply_(call, x...);
|
||||
call.perform();
|
||||
}
|
||||
|
||||
protected:
|
||||
Cover *cover_;
|
||||
ApplyFn apply_;
|
||||
};
|
||||
|
||||
template<typename... Ts> class CoverPublishAction : public Action<Ts...> {
|
||||
public:
|
||||
CoverPublishAction(Cover *cover) : cover_(cover) {}
|
||||
TEMPLATABLE_VALUE(float, position)
|
||||
TEMPLATABLE_VALUE(float, tilt)
|
||||
TEMPLATABLE_VALUE(CoverOperation, current_operation)
|
||||
using ApplyFn = void (*)(Cover *, const Ts &...);
|
||||
CoverPublishAction(Cover *cover, ApplyFn apply) : cover_(cover), apply_(apply) {}
|
||||
|
||||
void play(const Ts &...x) override {
|
||||
if (this->position_.has_value())
|
||||
this->cover_->position = this->position_.value(x...);
|
||||
if (this->tilt_.has_value())
|
||||
this->cover_->tilt = this->tilt_.value(x...);
|
||||
if (this->current_operation_.has_value())
|
||||
this->cover_->current_operation = this->current_operation_.value(x...);
|
||||
this->apply_(this->cover_, x...);
|
||||
this->cover_->publish_state();
|
||||
}
|
||||
|
||||
protected:
|
||||
Cover *cover_;
|
||||
ApplyFn apply_;
|
||||
};
|
||||
|
||||
template<bool OPEN, typename... Ts> class CoverPositionCondition : public Condition<Ts...> {
|
||||
|
||||
@@ -19,6 +19,9 @@ from esphome.const import (
|
||||
CONF_TILT_ACTION,
|
||||
CONF_TILT_LAMBDA,
|
||||
)
|
||||
from esphome.core import ID
|
||||
from esphome.cpp_generator import MockObj
|
||||
from esphome.types import ConfigType, TemplateArgsType
|
||||
|
||||
from .. import template_ns
|
||||
|
||||
@@ -110,6 +113,16 @@ async def to_code(config):
|
||||
cg.add(var.set_restore_mode(config[CONF_RESTORE_MODE]))
|
||||
|
||||
|
||||
# CONF_STATE and CONF_POSITION are cv.Exclusive in the schema, so at most
|
||||
# one is present and both map to the position field.
|
||||
_COVER_PUBLISH_FIELDS: tuple[cover.ApplyField, ...] = (
|
||||
cover.ApplyField(CONF_STATE, "position", cg.float_),
|
||||
cover.ApplyField(CONF_POSITION, "position", cg.float_),
|
||||
cover.ApplyField(CONF_TILT, "tilt", cg.float_),
|
||||
cover.ApplyField(CONF_CURRENT_OPERATION, "current_operation", cover.CoverOperation),
|
||||
)
|
||||
|
||||
|
||||
@automation.register_action(
|
||||
"cover.template.publish",
|
||||
cover.CoverPublishAction,
|
||||
@@ -126,21 +139,20 @@ async def to_code(config):
|
||||
),
|
||||
synchronous=True,
|
||||
)
|
||||
async def cover_template_publish_to_code(config, action_id, template_arg, args):
|
||||
paren = await cg.get_variable(config[CONF_ID])
|
||||
var = cg.new_Pvariable(action_id, template_arg, paren)
|
||||
if CONF_STATE in config:
|
||||
template_ = await cg.templatable(config[CONF_STATE], args, cg.float_)
|
||||
cg.add(var.set_position(template_))
|
||||
if CONF_POSITION in config:
|
||||
template_ = await cg.templatable(config[CONF_POSITION], args, cg.float_)
|
||||
cg.add(var.set_position(template_))
|
||||
if CONF_TILT in config:
|
||||
template_ = await cg.templatable(config[CONF_TILT], args, cg.float_)
|
||||
cg.add(var.set_tilt(template_))
|
||||
if CONF_CURRENT_OPERATION in config:
|
||||
template_ = await cg.templatable(
|
||||
config[CONF_CURRENT_OPERATION], args, cover.CoverOperation
|
||||
)
|
||||
cg.add(var.set_current_operation(template_))
|
||||
return var
|
||||
async def cover_template_publish_to_code(
|
||||
config: ConfigType,
|
||||
action_id: ID,
|
||||
template_arg: cg.TemplateArguments,
|
||||
args: TemplateArgsType,
|
||||
) -> MockObj:
|
||||
# Mutates Cover fields directly (no CoverCall) since publish is a state
|
||||
# push, not a control request.
|
||||
return await cover.build_apply_lambda_action(
|
||||
config=config,
|
||||
action_id=action_id,
|
||||
template_arg=template_arg,
|
||||
args=args,
|
||||
fields=_COVER_PUBLISH_FIELDS,
|
||||
prefix_args=[(cover.Cover.operator("ptr"), "cover")],
|
||||
statement_fn=lambda field, expr: f"cover->{field} = {expr};",
|
||||
)
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
esphome:
|
||||
name: cover-control-action-test
|
||||
host:
|
||||
api:
|
||||
logger:
|
||||
level: DEBUG
|
||||
|
||||
globals:
|
||||
- id: test_position
|
||||
type: float
|
||||
initial_value: "0.42"
|
||||
|
||||
cover:
|
||||
- platform: template
|
||||
name: "Test Cover"
|
||||
id: test_cover
|
||||
has_position: true
|
||||
optimistic: true
|
||||
assumed_state: true
|
||||
open_action:
|
||||
- cover.template.publish:
|
||||
id: test_cover
|
||||
position: 1.0
|
||||
close_action:
|
||||
- cover.template.publish:
|
||||
id: test_cover
|
||||
position: 0.0
|
||||
stop_action:
|
||||
- cover.template.publish:
|
||||
id: test_cover
|
||||
current_operation: IDLE
|
||||
tilt_action:
|
||||
- lambda: |-
|
||||
// Manually set tilt and publish
|
||||
id(test_cover).tilt = tilt;
|
||||
id(test_cover).publish_state();
|
||||
|
||||
button:
|
||||
# cover.control: position only
|
||||
- platform: template
|
||||
id: btn_position
|
||||
name: "Set Position"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
position: 50%
|
||||
|
||||
# cover.control: tilt only
|
||||
- platform: template
|
||||
id: btn_tilt
|
||||
name: "Set Tilt"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
tilt: 75%
|
||||
|
||||
# cover.control: position + tilt
|
||||
- platform: template
|
||||
id: btn_pos_tilt
|
||||
name: "Set Pos Tilt"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
position: 25%
|
||||
tilt: 30%
|
||||
|
||||
# cover.control: state alias for position
|
||||
- platform: template
|
||||
id: btn_open_state
|
||||
name: "Open State"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
state: OPEN
|
||||
|
||||
# cover.control: lambda position (exercises lambda path)
|
||||
- platform: template
|
||||
id: btn_lambda_position
|
||||
name: "Lambda Position"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
position: !lambda "return id(test_position);"
|
||||
|
||||
# cover.template.publish: position only
|
||||
- platform: template
|
||||
id: btn_publish_pos
|
||||
name: "Publish Pos"
|
||||
on_press:
|
||||
- cover.template.publish:
|
||||
id: test_cover
|
||||
position: 0.6
|
||||
|
||||
# cover.template.publish: current_operation only
|
||||
- platform: template
|
||||
id: btn_publish_op
|
||||
name: "Publish Op"
|
||||
on_press:
|
||||
- cover.template.publish:
|
||||
id: test_cover
|
||||
current_operation: OPENING
|
||||
|
||||
# cover.control: stop only — runs after Publish Op so the test can
|
||||
# verify current_operation transitions OPENING -> IDLE.
|
||||
- platform: template
|
||||
id: btn_stop
|
||||
name: "Stop Cover"
|
||||
on_press:
|
||||
- cover.control:
|
||||
id: test_cover
|
||||
stop: true
|
||||
@@ -0,0 +1,92 @@
|
||||
"""Integration test for cover ControlAction and CoverPublishAction.
|
||||
|
||||
Tests that cover.control and cover.template.publish automation actions
|
||||
work correctly with the single stateless apply lambda/function pointer
|
||||
implementation. Exercises multiple field combinations and the lambda path.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
|
||||
from aioesphomeapi import ButtonInfo, CoverInfo, CoverState, EntityState
|
||||
import pytest
|
||||
|
||||
from .state_utils import InitialStateHelper, require_entity
|
||||
from .types import APIClientConnectedFactory, RunCompiledFunction
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_cover_control_action(
|
||||
yaml_config: str,
|
||||
run_compiled: RunCompiledFunction,
|
||||
api_client_connected: APIClientConnectedFactory,
|
||||
) -> None:
|
||||
"""Test cover ControlAction/CoverPublishAction with constants and lambdas."""
|
||||
loop = asyncio.get_running_loop()
|
||||
async with run_compiled(yaml_config), api_client_connected() as client:
|
||||
cover_state_future: asyncio.Future[CoverState] | None = None
|
||||
|
||||
def on_state(state: EntityState) -> None:
|
||||
if (
|
||||
isinstance(state, CoverState)
|
||||
and cover_state_future is not None
|
||||
and not cover_state_future.done()
|
||||
):
|
||||
cover_state_future.set_result(state)
|
||||
|
||||
async def wait_for_cover_state(timeout: float = 5.0) -> CoverState:
|
||||
nonlocal cover_state_future
|
||||
cover_state_future = loop.create_future()
|
||||
try:
|
||||
return await asyncio.wait_for(cover_state_future, timeout)
|
||||
finally:
|
||||
cover_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_cover", CoverInfo)
|
||||
|
||||
async def press_and_wait(name: str) -> CoverState:
|
||||
btn = require_entity(entities, name.lower().replace(" ", "_"), ButtonInfo)
|
||||
client.button_command(btn.key)
|
||||
return await wait_for_cover_state()
|
||||
|
||||
# cover.control: position only
|
||||
state = await press_and_wait("Set Position")
|
||||
assert state.position == pytest.approx(0.5, abs=0.01)
|
||||
|
||||
# cover.control: tilt only
|
||||
state = await press_and_wait("Set Tilt")
|
||||
assert state.tilt == pytest.approx(0.75, abs=0.01)
|
||||
|
||||
# cover.control: position + tilt
|
||||
state = await press_and_wait("Set Pos Tilt")
|
||||
assert state.position == pytest.approx(0.25, abs=0.01)
|
||||
assert state.tilt == pytest.approx(0.30, abs=0.01)
|
||||
|
||||
# cover.control: state alias for position 1.0
|
||||
state = await press_and_wait("Open State")
|
||||
assert state.position == pytest.approx(1.0, abs=0.01)
|
||||
|
||||
# cover.control: lambda position (test_position global = 0.42)
|
||||
state = await press_and_wait("Lambda Position")
|
||||
assert state.position == pytest.approx(0.42, abs=0.01)
|
||||
|
||||
# cover.template.publish: position only
|
||||
state = await press_and_wait("Publish Pos")
|
||||
assert state.position == pytest.approx(0.6, abs=0.01)
|
||||
|
||||
# cover.template.publish: current_operation only
|
||||
state = await press_and_wait("Publish Op")
|
||||
# CoverOperation.OPENING == 1
|
||||
assert state.current_operation == 1
|
||||
|
||||
# cover.control: stop only — template cover's stop_action publishes
|
||||
# current_operation: IDLE.
|
||||
state = await press_and_wait("Stop Cover")
|
||||
# CoverOperation.IDLE == 0
|
||||
assert state.current_operation == 0
|
||||
Reference in New Issue
Block a user