mirror of
https://github.com/esphome/esphome.git
synced 2026-02-08 00:31:58 +00:00
[esp32_ble] Remove requirement for configured network (#12891)
This commit is contained in:
@@ -22,7 +22,6 @@ from esphome.core import CORE, CoroPriority, TimePeriod, coroutine_with_priority
|
|||||||
import esphome.final_validate as fv
|
import esphome.final_validate as fv
|
||||||
|
|
||||||
DEPENDENCIES = ["esp32"]
|
DEPENDENCIES = ["esp32"]
|
||||||
AUTO_LOAD = ["socket"]
|
|
||||||
CODEOWNERS = ["@jesserockz", "@Rapsssito", "@bdraco"]
|
CODEOWNERS = ["@jesserockz", "@Rapsssito", "@bdraco"]
|
||||||
DOMAIN = "esp32_ble"
|
DOMAIN = "esp32_ble"
|
||||||
|
|
||||||
|
|||||||
@@ -47,6 +47,8 @@ def require_wake_loop_threadsafe() -> None:
|
|||||||
This enables the shared UDP loopback socket mechanism (~208 bytes RAM).
|
This enables the shared UDP loopback socket mechanism (~208 bytes RAM).
|
||||||
The socket is shared across all components that use this feature.
|
The socket is shared across all components that use this feature.
|
||||||
|
|
||||||
|
This call is a no-op if networking is not enabled in the configuration.
|
||||||
|
|
||||||
IMPORTANT: This is for background thread context only, NOT ISR context.
|
IMPORTANT: This is for background thread context only, NOT ISR context.
|
||||||
Socket operations are not safe to call from ISR handlers.
|
Socket operations are not safe to call from ISR handlers.
|
||||||
|
|
||||||
@@ -56,8 +58,11 @@ def require_wake_loop_threadsafe() -> None:
|
|||||||
async def to_code(config):
|
async def to_code(config):
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Only set up once (idempotent - multiple components can call this)
|
# Only set up once (idempotent - multiple components can call this)
|
||||||
if not CORE.data.get(KEY_WAKE_LOOP_THREADSAFE_REQUIRED, False):
|
if CORE.has_networking and not CORE.data.get(
|
||||||
|
KEY_WAKE_LOOP_THREADSAFE_REQUIRED, False
|
||||||
|
):
|
||||||
CORE.data[KEY_WAKE_LOOP_THREADSAFE_REQUIRED] = True
|
CORE.data[KEY_WAKE_LOOP_THREADSAFE_REQUIRED] = True
|
||||||
cg.add_define("USE_WAKE_LOOP_THREADSAFE")
|
cg.add_define("USE_WAKE_LOOP_THREADSAFE")
|
||||||
# Consume 1 socket for the shared wake notification socket
|
# Consume 1 socket for the shared wake notification socket
|
||||||
|
|||||||
@@ -721,6 +721,25 @@ class EsphomeCore:
|
|||||||
def config_filename(self) -> str:
|
def config_filename(self) -> str:
|
||||||
return self.config_path.name
|
return self.config_path.name
|
||||||
|
|
||||||
|
def has_at_least_one_component(self, *components: str) -> bool:
|
||||||
|
"""
|
||||||
|
Are any of the given components configured?
|
||||||
|
:param components: component names
|
||||||
|
:return: true if so
|
||||||
|
"""
|
||||||
|
if self.config is None:
|
||||||
|
raise ValueError("Config has not been loaded yet")
|
||||||
|
|
||||||
|
return any(component in self.config for component in components)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def has_networking(self) -> bool:
|
||||||
|
"""
|
||||||
|
Is a network component configured?
|
||||||
|
:return: true if so
|
||||||
|
"""
|
||||||
|
return self.has_at_least_one_component("wifi", "ethernet", "openthread")
|
||||||
|
|
||||||
def relative_config_path(self, *path: str | Path) -> Path:
|
def relative_config_path(self, *path: str | Path) -> Path:
|
||||||
path_ = Path(*path).expanduser()
|
path_ = Path(*path).expanduser()
|
||||||
return self.config_dir / path_
|
return self.config_dir / path_
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ from esphome.core import CORE
|
|||||||
|
|
||||||
def test_require_wake_loop_threadsafe__first_call() -> None:
|
def test_require_wake_loop_threadsafe__first_call() -> None:
|
||||||
"""Test that first call sets up define and consumes socket."""
|
"""Test that first call sets up define and consumes socket."""
|
||||||
|
CORE.config = {"wifi": True}
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
|
|
||||||
# Verify CORE.data was updated
|
# Verify CORE.data was updated
|
||||||
@@ -17,6 +18,7 @@ def test_require_wake_loop_threadsafe__idempotent() -> None:
|
|||||||
"""Test that subsequent calls are idempotent."""
|
"""Test that subsequent calls are idempotent."""
|
||||||
# Set up initial state as if already called
|
# Set up initial state as if already called
|
||||||
CORE.data[socket.KEY_WAKE_LOOP_THREADSAFE_REQUIRED] = True
|
CORE.data[socket.KEY_WAKE_LOOP_THREADSAFE_REQUIRED] = True
|
||||||
|
CORE.config = {"ethernet": True}
|
||||||
|
|
||||||
# Call again - should not raise or fail
|
# Call again - should not raise or fail
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
@@ -31,6 +33,7 @@ def test_require_wake_loop_threadsafe__idempotent() -> None:
|
|||||||
def test_require_wake_loop_threadsafe__multiple_calls() -> None:
|
def test_require_wake_loop_threadsafe__multiple_calls() -> None:
|
||||||
"""Test that multiple calls only set up once."""
|
"""Test that multiple calls only set up once."""
|
||||||
# Call three times
|
# Call three times
|
||||||
|
CORE.config = {"openthread": True}
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
socket.require_wake_loop_threadsafe()
|
socket.require_wake_loop_threadsafe()
|
||||||
@@ -40,3 +43,35 @@ def test_require_wake_loop_threadsafe__multiple_calls() -> None:
|
|||||||
|
|
||||||
# Verify the define was added (only once, but we can just check it exists)
|
# Verify the define was added (only once, but we can just check it exists)
|
||||||
assert any(d.name == "USE_WAKE_LOOP_THREADSAFE" for d in CORE.defines)
|
assert any(d.name == "USE_WAKE_LOOP_THREADSAFE" for d in CORE.defines)
|
||||||
|
|
||||||
|
|
||||||
|
def test_require_wake_loop_threadsafe__no_networking() -> None:
|
||||||
|
"""Test that wake loop is NOT configured when no networking is configured."""
|
||||||
|
# Set up config without any networking components
|
||||||
|
CORE.config = {"esphome": {"name": "test"}, "logger": {}}
|
||||||
|
|
||||||
|
# Call require_wake_loop_threadsafe
|
||||||
|
socket.require_wake_loop_threadsafe()
|
||||||
|
|
||||||
|
# Verify CORE.data flag was NOT set (since has_networking returns False)
|
||||||
|
assert socket.KEY_WAKE_LOOP_THREADSAFE_REQUIRED not in CORE.data
|
||||||
|
|
||||||
|
# Verify the define was NOT added
|
||||||
|
assert not any(d.name == "USE_WAKE_LOOP_THREADSAFE" for d in CORE.defines)
|
||||||
|
|
||||||
|
|
||||||
|
def test_require_wake_loop_threadsafe__no_networking_does_not_consume_socket() -> None:
|
||||||
|
"""Test that no socket is consumed when no networking is configured."""
|
||||||
|
# Set up config without any networking components
|
||||||
|
CORE.config = {"logger": {}}
|
||||||
|
|
||||||
|
# Track initial socket consumer state
|
||||||
|
initial_consumers = CORE.data.get(socket.KEY_SOCKET_CONSUMERS, {})
|
||||||
|
|
||||||
|
# Call require_wake_loop_threadsafe
|
||||||
|
socket.require_wake_loop_threadsafe()
|
||||||
|
|
||||||
|
# Verify no socket was consumed
|
||||||
|
consumers = CORE.data.get(socket.KEY_SOCKET_CONSUMERS, {})
|
||||||
|
assert "socket.wake_loop_threadsafe" not in consumers
|
||||||
|
assert consumers == initial_consumers
|
||||||
|
|||||||
@@ -718,3 +718,65 @@ class TestEsphomeCore:
|
|||||||
# Even though "web_server" is in loaded_integrations due to the platform,
|
# Even though "web_server" is in loaded_integrations due to the platform,
|
||||||
# web_port must return None because the full web_server component is not configured
|
# web_port must return None because the full web_server component is not configured
|
||||||
assert target.web_port is None
|
assert target.web_port is None
|
||||||
|
|
||||||
|
def test_has_at_least_one_component__none_configured(self, target):
|
||||||
|
"""Test has_at_least_one_component returns False when none of the components are configured."""
|
||||||
|
target.config = {const.CONF_ESPHOME: {"name": "test"}, "logger": {}}
|
||||||
|
|
||||||
|
assert target.has_at_least_one_component("wifi", "ethernet") is False
|
||||||
|
|
||||||
|
def test_has_at_least_one_component__one_configured(self, target):
|
||||||
|
"""Test has_at_least_one_component returns True when one component is configured."""
|
||||||
|
target.config = {const.CONF_WIFI: {}, "logger": {}}
|
||||||
|
|
||||||
|
assert target.has_at_least_one_component("wifi", "ethernet") is True
|
||||||
|
|
||||||
|
def test_has_at_least_one_component__multiple_configured(self, target):
|
||||||
|
"""Test has_at_least_one_component returns True when multiple components are configured."""
|
||||||
|
target.config = {
|
||||||
|
const.CONF_WIFI: {},
|
||||||
|
const.CONF_ETHERNET: {},
|
||||||
|
"logger": {},
|
||||||
|
}
|
||||||
|
|
||||||
|
assert (
|
||||||
|
target.has_at_least_one_component("wifi", "ethernet", "bluetooth") is True
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_has_at_least_one_component__single_component(self, target):
|
||||||
|
"""Test has_at_least_one_component works with a single component."""
|
||||||
|
target.config = {const.CONF_MQTT: {}}
|
||||||
|
|
||||||
|
assert target.has_at_least_one_component("mqtt") is True
|
||||||
|
assert target.has_at_least_one_component("wifi") is False
|
||||||
|
|
||||||
|
def test_has_at_least_one_component__config_not_loaded(self, target):
|
||||||
|
"""Test has_at_least_one_component raises ValueError when config is not loaded."""
|
||||||
|
target.config = None
|
||||||
|
|
||||||
|
with pytest.raises(ValueError, match="Config has not been loaded yet"):
|
||||||
|
target.has_at_least_one_component("wifi")
|
||||||
|
|
||||||
|
def test_has_networking__with_wifi(self, target):
|
||||||
|
"""Test has_networking returns True when wifi is configured."""
|
||||||
|
target.config = {const.CONF_WIFI: {}}
|
||||||
|
|
||||||
|
assert target.has_networking is True
|
||||||
|
|
||||||
|
def test_has_networking__with_ethernet(self, target):
|
||||||
|
"""Test has_networking returns True when ethernet is configured."""
|
||||||
|
target.config = {const.CONF_ETHERNET: {}}
|
||||||
|
|
||||||
|
assert target.has_networking is True
|
||||||
|
|
||||||
|
def test_has_networking__with_openthread(self, target):
|
||||||
|
"""Test has_networking returns True when openthread is configured."""
|
||||||
|
target.config = {const.CONF_OPENTHREAD: {}}
|
||||||
|
|
||||||
|
assert target.has_networking is True
|
||||||
|
|
||||||
|
def test_has_networking__without_networking(self, target):
|
||||||
|
"""Test has_networking returns False when no networking component is configured."""
|
||||||
|
target.config = {const.CONF_ESPHOME: {"name": "test"}, "logger": {}}
|
||||||
|
|
||||||
|
assert target.has_networking is False
|
||||||
|
|||||||
Reference in New Issue
Block a user