Merge remote-tracking branch 'origin/dev' into HEAD

# Conflicts:
#	esphome/cpp_generator.py
#	tests/unit_tests/test_cpp_generator.py

esphome/automation.py

@@ -5,6 +5,7 @@ import logging
 import math
 import re
 import string
+import struct
 from typing import Any
 
 import voluptuous as vol
@@ -2123,6 +2124,17 @@ def _direct_function(
     )
 
 
+def _call_target(
+    plan: list[MockObj | list[_InlineAction]],
+    args: TemplateArgsType,
+    config: ConfigType,
+) -> MockObj | str:
+    """What a generated callback calls: the direct function, else ``<automation>->trigger``."""
+    if (target := _direct_function(plan, args, config)) is None:
+        target = parent_ref(_automation_from_plan(plan, args, config)).trigger
+    return target
+
+
 def _when_call(
     when: str | ApplyCall | None, parent: MockObj | None
 ) -> ApplyCall | None:
@@ -2140,6 +2152,40 @@ async def build_automation(
     return await new_automation(args, config, trigger)
 
 
+async def build_component_automation(
+    config: ConfigType, component_class: MockObjClass, priority: float | None = None
+) -> MockObj:
+    """Create and register the Component that runs a no-argument automation.
+
+    That is ``component_class<function[, priority bits]>``, whose function runs the actions
+    directly when they are all inline, else triggers their Automation. A ``trigger_id`` set
+    by hand keeps its Trigger, built with ``priority`` if given.
+    """
+    trigger_id: ID = config[CONF_TRIGGER_ID]
+    if trigger_id.is_manual:
+        var = cg.new_Pvariable(trigger_id, *([] if priority is None else [priority]))
+        await cg.register_component(var, config)
+        await build_automation(var, [], config)
+        return var
+    # Declared and registered before the actions are built, which can wait for other ids
+    name = _apply_function_name(trigger_id)
+    define = cg.declare_static_function(name, cg.void, [])
+    id_ = trigger_id.copy()
+    id_.type = component_class
+    bits = [] if priority is None else [_float_bits(priority)]
+    var = cg.new_Pvariable(id_, cg.TemplateArguments(cg.RawExpression(name), *bits))
+    await cg.register_component(var, config)
+    plan = await _build_automation_plan([], config)
+    define([str(cg.statement(CallExpression(_call_target(plan, [], config))))])
+    return var
+
+
+def _float_bits(value: float) -> HexInt:
+    """``value`` as a C++ float's bit pattern, for a template argument."""
+    (bits,) = struct.unpack("<I", struct.pack("<f", value))
+    return HexInt(bits)
+
+
 async def build_trigger_callback(
     args: TemplateArgsType,
     config: ConfigType,
@@ -2173,8 +2219,7 @@ async def _trigger_callback(
     call: ApplyCall | None,
     parent: MockObj | None,
 ) -> LambdaExpression:
-    if (target := _direct_function(plan, args, config)) is None:
-        target = f"{parent_ref(_automation_from_plan(plan, args, config))}->trigger"
+    target = _call_target(plan, args, config)
     statements: list[str] = []
     if call is not None:
         members = call.members

esphome/codegen.py

@@ -31,6 +31,7 @@ from esphome.cpp_generator import (  # noqa: F401
     add_global,
     add_library,
     add_platformio_option,
+    declare_static_function,
     extern_progmem_array,
     get_variable,
     get_variable_with_full_id,

esphome/core/base_automation.h

@@ -171,6 +171,41 @@ class LoopTrigger : public Trigger<>, public Component {
   float get_setup_priority() const override { return setup_priority::DATA; }
 };
 
+/// Component whose setup priority is the float with bit pattern PRIORITY_BITS, since GCC 10 (ESP8266)
+/// has no float template parameters. Templated on the priority only, so each priority has one copy.
+template<uint32_t PRIORITY_BITS> class PriorityComponent : public Component {
+ public:
+  float get_setup_priority() const override { return bit_cast<float>(PRIORITY_BITS); }
+};
+
+/// Bit pattern of setup_priority::DATA (600.0f), the Component default.
+static constexpr uint32_t SETUP_PRIORITY_DATA_BITS = 0x44160000;
+// bit_cast is constexpr only where std::bit_cast exists, which GCC 10 (ESP8266) lacks
+#if __cpp_lib_bit_cast >= 201806
+static_assert(bit_cast<uint32_t>(setup_priority::DATA) == SETUP_PRIORITY_DATA_BITS);
+#endif
+
+/// The default priority needs no override.
+template<> class PriorityComponent<SETUP_PRIORITY_DATA_BITS> : public Component {};
+
+/// Calls Fn from setup(), for on_boot.
+template<auto Fn, uint32_t PRIORITY_BITS> class StartupCallback final : public PriorityComponent<PRIORITY_BITS> {
+ public:
+  void setup() override { Fn(); }
+};
+
+/// Calls Fn from on_shutdown(), for on_shutdown.
+template<auto Fn, uint32_t PRIORITY_BITS> class ShutdownCallback final : public PriorityComponent<PRIORITY_BITS> {
+ public:
+  void on_shutdown() override { Fn(); }
+};
+
+/// Calls Fn from loop(), for on_loop.
+template<auto Fn> class LoopCallback final : public Component {
+ public:
+  void loop() override { Fn(); }
+};
+
 #ifdef ESPHOME_PROJECT_NAME
 class ProjectUpdateTrigger : public Trigger<std::string>, public Component {
  public:

esphome/core/config.py

@@ -124,6 +124,9 @@ ShutdownTrigger = cg.esphome_ns.class_(
 LoopTrigger = cg.esphome_ns.class_(
     "LoopTrigger", cg.Component, automation.Trigger.template()
 )
+StartupCallback = cg.esphome_ns.class_("StartupCallback", cg.Component)
+ShutdownCallback = cg.esphome_ns.class_("ShutdownCallback", cg.Component)
+LoopCallback = cg.esphome_ns.class_("LoopCallback", cg.Component)
 ProjectUpdateTrigger = cg.esphome_ns.class_(
     "ProjectUpdateTrigger", cg.Component, automation.Trigger.template(cg.std_string)
 )
@@ -785,20 +788,15 @@ async def _add_environment_variables(env_vars: dict[str, str]) -> None:
 
 @coroutine_with_priority(CoroPriority.AUTOMATION)
 async def _add_automations(config):
-    for conf in config.get(CONF_ON_BOOT, []):
-        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], conf.get(CONF_PRIORITY))
-        await cg.register_component(trigger, conf)
-        await automation.build_automation(trigger, [], conf)
-
-    for conf in config.get(CONF_ON_SHUTDOWN, []):
-        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], conf.get(CONF_PRIORITY))
-        await cg.register_component(trigger, conf)
-        await automation.build_automation(trigger, [], conf)
-
-    for conf in config.get(CONF_ON_LOOP, []):
-        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID])
-        await cg.register_component(trigger, conf)
-        await automation.build_automation(trigger, [], conf)
+    for key, component_class in (
+        (CONF_ON_BOOT, StartupCallback),
+        (CONF_ON_SHUTDOWN, ShutdownCallback),
+        (CONF_ON_LOOP, LoopCallback),
+    ):
+        for conf in config.get(key, []):
+            await automation.build_component_automation(
+                conf, component_class, conf.get(CONF_PRIORITY)
+            )
 
 
 # Datetime component has special subtypes that need additional defines

esphome/cpp_generator.py

@@ -883,14 +883,13 @@ def new_Pvariable(id_: ID, *args: SafeExpType) -> "MockObj":
     return Pvariable(id_, rhs)
 
 
-def static_function(
+def declare_static_function(
     name: str,
     return_type: SafeExpType,
     parameters: TemplateArgsType,
-    body: list[str | Statement],
-) -> RawExpression:
-    """Emit ``static <return_type> <name>(parameters) { body }`` at global scope and return an
-    expression naming it, for use as a template argument or a function pointer.
+) -> Callable[[list[str | Statement]], RawExpression]:
+    """Declare ``static <return_type> <name>(parameters)`` now and return the function that
+    emits its body, for a caller that names the function before the body is known.
 
     The declaration goes with the other globals, so a template argument can name the function
     at once; the body goes after the user includes, where every id and everything those
@@ -900,10 +899,24 @@ def static_function(
         f"static {safe_exp(return_type)} {name}({ParameterListExpression(*parameters)})"
     )
     add_global(RawStatement(f"{signature};"))
-    add_global_after_includes(
-        RawStatement(f"{signature} {{\n{indent(chr(10).join(map(str, body)))}\n}}")
-    )
-    return RawExpression(name)
+
+    def define(body: list[str | Statement]) -> RawExpression:
+        add_global_after_includes(
+            RawStatement(f"{signature} {{\n{indent(chr(10).join(map(str, body)))}\n}}")
+        )
+        return RawExpression(name)
+
+    return define
+
+
+def static_function(
+    name: str,
+    return_type: SafeExpType,
+    parameters: TemplateArgsType,
+    body: list[str | Statement],
+) -> RawExpression:
+    """``declare_static_function`` with the body known at once."""
+    return declare_static_function(name, return_type, parameters)(body)
 
 
 @dataclass

tests/component_tests/automation/test_core_automations.py

@@ -30,14 +30,6 @@ def _automation_of(main_cpp: str, trigger: str) -> str:
     return match.group(1)
 
 
-def _has_delay(main_cpp: str, trigger: str) -> bool:
-    automation = _automation_of(main_cpp, trigger)
-    return (
-        re.search(rf"{automation}->add_action\(delayaction_id\w*\);", main_cpp)
-        is not None
-    )
-
-
 def _registered(main_cpp: str) -> list[str]:
     return re.findall(r"App\.register_component_\((\w+), \d+\);", main_cpp)
 
@@ -56,18 +48,59 @@ def test_core_automations_registration_order(main_cpp: str) -> None:
     ]
 
 
+def _function_body(main_cpp: str, name: str) -> str:
+    match = re.search(rf"static void {name}\(\) \{{(.*?)\n\}}\n", main_cpp, re.DOTALL)
+    assert match is not None, name
+    return match.group(1)
+
+
+def _actions_body(main_cpp: str, function: str) -> str:
+    """The body of the function of inline actions that ``function`` calls."""
+    match = re.fullmatch(r"\n  (\w+)\(\);", _function_body(main_cpp, function))
+    assert match is not None, function
+    return _function_body(main_cpp, match.group(1))
+
+
+def _delayed_automation(main_cpp: str, function: str) -> str:
+    """The Automation that ``function`` triggers, checked to hold a delay; found through the
+    function rather than an id counter."""
+    match = re.fullmatch(
+        r"\n  ::(\w+)->trigger\(\);", _function_body(main_cpp, function)
+    )
+    assert match is not None, function
+    automation = match.group(1)
+    assert f"new({automation}) Automation<>();" in main_cpp
+    assert re.search(rf"{automation}->add_action\(delayaction_id\w*\);", main_cpp)
+    return automation
+
+
 def test_on_boot_inline_priorities(main_cpp: str) -> None:
-    """All-inline on_boot blocks keep their configured priority, default 600."""
-    assert _constructed(main_cpp, "startuptrigger_id") == "StartupTrigger(800.0f)"
-    assert _constructed(main_cpp, "startuptrigger_id_2") == "StartupTrigger(600.0f)"
-    _automation_of(main_cpp, "startuptrigger_id")
-    _automation_of(main_cpp, "startuptrigger_id_2")
+    """All-inline on_boot blocks call one function from setup() at their priority, default 600.
+
+    The priority is the float's bit pattern: 0x44480000 is 800.0f, 0x44160000 is 600.0f.
+    """
+    assert _constructed(main_cpp, "startuptrigger_id") == (
+        "StartupCallback<esphome__startuptrigger_id__fn, 0x44480000>()"
+    )
+    assert _constructed(main_cpp, "startuptrigger_id_2") == (
+        "StartupCallback<esphome__startuptrigger_id_2__fn, 0x44160000>()"
+    )
+    assert "Automation<>(startuptrigger_id" not in main_cpp
+    # Both actions of the first block run in the one function, with no stop checks
+    body = _actions_body(main_cpp, "esphome__startuptrigger_id__fn")
+    assert "boot high" in body
+    assert "boot high lambda" in body
+    assert "esphome__running" not in body
+    assert "Automation" not in body
+    assert "boot default" in _actions_body(main_cpp, "esphome__startuptrigger_id_2__fn")
 
 
-def test_on_boot_delay_keeps_trigger(main_cpp: str) -> None:
-    """A delay needs the Trigger and its Automation of separate actions."""
-    assert _constructed(main_cpp, "startuptrigger_id_3") == "StartupTrigger(-100.0f)"
-    assert _has_delay(main_cpp, "startuptrigger_id_3")
+def test_on_boot_delay_triggers_automation(main_cpp: str) -> None:
+    """A delay keeps the Automation of separate actions, which the function triggers."""
+    assert _constructed(main_cpp, "startuptrigger_id_3") == (
+        "StartupCallback<esphome__startuptrigger_id_3__fn, 0xC2C80000>()"
+    )
+    _delayed_automation(main_cpp, "esphome__startuptrigger_id_3__fn")
 
 
 def test_on_boot_manual_trigger_id_keeps_trigger(main_cpp: str) -> None:
@@ -77,19 +110,30 @@ def test_on_boot_manual_trigger_id_keeps_trigger(main_cpp: str) -> None:
 
 
 def test_on_shutdown_priorities(main_cpp: str) -> None:
-    """on_shutdown blocks keep their priority; a delay keeps the Trigger."""
-    assert _constructed(main_cpp, "shutdowntrigger_id") == "ShutdownTrigger(700.0f)"
-    _automation_of(main_cpp, "shutdowntrigger_id")
-    assert _constructed(main_cpp, "shutdowntrigger_id_2") == "ShutdownTrigger(600.0f)"
-    assert _has_delay(main_cpp, "shutdowntrigger_id_2")
+    """on_shutdown calls its function at its priority; a delay keeps the Automation."""
+    assert _constructed(main_cpp, "shutdowntrigger_id") == (
+        "ShutdownCallback<esphome__shutdowntrigger_id__fn, 0x442F0000>()"
+    )
+    assert "shutdown inline" in _actions_body(
+        main_cpp, "esphome__shutdowntrigger_id__fn"
+    )
+    assert _constructed(main_cpp, "shutdowntrigger_id_2") == (
+        "ShutdownCallback<esphome__shutdowntrigger_id_2__fn, 0x44160000>()"
+    )
+    _delayed_automation(main_cpp, "esphome__shutdowntrigger_id_2__fn")
 
 
 def test_on_loop(main_cpp: str) -> None:
-    """on_loop blocks are looping components; a delay keeps the Trigger."""
-    assert _constructed(main_cpp, "looptrigger_id") == "LoopTrigger()"
-    _automation_of(main_cpp, "looptrigger_id")
-    assert _constructed(main_cpp, "looptrigger_id_2") == "LoopTrigger()"
-    assert _has_delay(main_cpp, "looptrigger_id_2")
+    """on_loop calls its function each loop; a delay keeps the Automation."""
+    assert _constructed(main_cpp, "looptrigger_id") == (
+        "LoopCallback<esphome__looptrigger_id__fn>()"
+    )
+    assert "loop inline" in _actions_body(main_cpp, "esphome__looptrigger_id__fn")
+    assert "HasLoopOverride<LoopCallback<esphome__looptrigger_id__fn>>" in main_cpp
+    assert _constructed(main_cpp, "looptrigger_id_2") == (
+        "LoopCallback<esphome__looptrigger_id_2__fn>()"
+    )
+    _delayed_automation(main_cpp, "esphome__looptrigger_id_2__fn")
 
 
 def test_on_boot_registered_before_its_actions_are_built(

tests/components/core/test_core_automation_callbacks.cpp

@@ -0,0 +1,64 @@
+#include <gtest/gtest.h>
+
+#include "esphome/core/base_automation.h"
+
+namespace esphome::core::testing {
+
+namespace {
+
+int calls = 0;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
+
+void count_call() { calls++; }
+
+// Bit patterns of 800.0f, 600.0f, -100.0f and 250.5f, as the code generator writes them
+constexpr uint32_t PRIORITY_800 = 0x44480000;
+constexpr uint32_t PRIORITY_MINUS_100 = 0xC2C80000;
+constexpr uint32_t PRIORITY_250_5 = 0x437A8000;
+
+}  // namespace
+
+TEST(CoreAutomationCallbacks, StartupCallbackRunsFromSetupAtItsPriority) {
+  calls = 0;
+  StartupCallback<count_call, PRIORITY_800> high;
+  StartupCallback<count_call, PRIORITY_MINUS_100> late;
+  StartupCallback<count_call, PRIORITY_250_5> fractional;
+  EXPECT_EQ(high.get_setup_priority(), 800.0f);
+  EXPECT_EQ(late.get_setup_priority(), -100.0f);
+  EXPECT_EQ(fractional.get_setup_priority(), 250.5f);
+  StartupCallback<count_call, SETUP_PRIORITY_DATA_BITS> standard;
+  EXPECT_EQ(standard.get_setup_priority(), setup_priority::DATA);
+
+  high.loop();
+  high.on_shutdown();
+  EXPECT_EQ(calls, 0);
+  high.setup();
+  EXPECT_EQ(calls, 1);
+}
+
+TEST(CoreAutomationCallbacks, ShutdownCallbackRunsFromOnShutdownAtItsPriority) {
+  calls = 0;
+  ShutdownCallback<count_call, PRIORITY_MINUS_100> shutdown;
+  EXPECT_EQ(shutdown.get_setup_priority(), -100.0f);
+
+  shutdown.setup();
+  shutdown.loop();
+  EXPECT_EQ(calls, 0);
+  shutdown.on_shutdown();
+  EXPECT_EQ(calls, 1);
+}
+
+TEST(CoreAutomationCallbacks, LoopCallbackRunsEachLoopAtDataPriority) {
+  calls = 0;
+  LoopCallback<count_call> looping;
+  EXPECT_EQ(looping.get_setup_priority(), setup_priority::DATA);
+  EXPECT_TRUE(HasLoopOverride<LoopCallback<count_call>>::value);
+  EXPECT_FALSE((HasLoopOverride<StartupCallback<count_call, PRIORITY_800>>::value));
+
+  looping.setup();
+  EXPECT_EQ(calls, 0);
+  looping.loop();
+  looping.loop();
+  EXPECT_EQ(calls, 2);
+}
+
+}  // namespace esphome::core::testing

tests/unit_tests/test_cpp_generator.py

@@ -1173,6 +1173,21 @@ def test_static_function_declares_early_and_defines_after_includes() -> None:
     ]
 
 
+def test_declare_static_function_defines_the_body_later() -> None:
+    """The declaration is emitted at once; the body only when define() is called."""
+    define = cg.declare_static_function("esphome__act__fn", ct.void, [])
+    assert [str(st) for st in CORE.global_statements] == [
+        "static void esphome__act__fn();"
+    ]
+    assert CORE.global_statements_after_includes == []
+
+    fn = define(["first();", "second();"])
+    assert str(fn) == "esphome__act__fn"
+    assert [str(st) for st in CORE.global_statements_after_includes] == [
+        "static void esphome__act__fn() {\n  first();\n  second();\n}"
+    ]
+
+
 def test_static_function_accepts_statements() -> None:
     call = cg.MockObj("foo")(cg.MockObj("x") >> 2)
     cg.static_function(