Compare commits

..

13 commits

Author SHA1 Message Date
Bas Nijholt
bd6e724030 Normalize turn-off transitions during light recovery 2026-09-08 05:06:26 -07:00
Bas Nijholt
c2d9ea3e51 Merge remote-tracking branch 'origin/main' into fix/unavailable-light-recovery
# Conflicts:
#	custom_components/adaptive_lighting/switch.py
#	tests/test_switch.py
2026-09-08 05:04:34 -07:00
Bas Nijholt
ee835c98c7 Test sibling recovery preserves group turn-off intent 2026-09-06 23:48:48 -07:00
Bas Nijholt
9f4089f3d8 Resume eligible light adaptation after availability returns 2026-09-06 23:40:31 -07:00
Bas Nijholt
f148b40807 Merge branch 'fix/pending-adaptation-cancellation' into fix/unavailable-light-recovery
# Conflicts:
#	custom_components/adaptive_lighting/switch.py
#	tests/test_switch.py
2026-09-06 23:32:36 -07:00
Bas Nijholt
87a30972a7 Merge remote-tracking branch 'origin/main' into fix/unavailable-light-recovery 2026-09-06 23:31:16 -07:00
Bas Nijholt
e6dce70163 Fix pending adaptations after light or profile removal 2026-09-06 23:30:42 -07:00
Bas Nijholt
d1d2383c04 Merge main after turn-off fix 2026-09-06 22:41:49 -07:00
Bas Nijholt
97133597e3 docs: refresh generated recovery troubleshooting 2026-09-06 14:21:33 -07:00
Bas Nijholt
3b93032519 Preserve turn-off intent during light recovery 2026-09-06 14:18:45 -07:00
Bas Nijholt
d8fdd75696 Merge turn-off target tracking fix 2026-09-06 14:14:16 -07:00
Bas Nijholt
da75a16d36 Handle lights recovering from unavailable 2026-09-06 14:13:29 -07:00
Bas Nijholt
69df1fa0a4 fix: track mixed targets during light turn-off 2026-09-06 14:10:22 -07:00
4 changed files with 843 additions and 11 deletions

View file

@ -769,7 +769,9 @@ If lights stop adapting after you turn them on with a physical switch or a Zigbe
To adapt these turn-ons while still detecting later manual changes, enable `detect_non_ha_changes` and leave `manual_control_on_external_turn_on` disabled. This requires the light integration to report its state reliably. If you want Adaptive Lighting to keep adapting regardless of manual changes, disable `take_over_control` along with the options that require it: `detect_non_ha_changes`, `adapt_only_on_bare_turn_on`, and `manual_control_on_external_turn_on`.
This explains the physical-switch case in [#1056](https://github.com/basnijholt/adaptive-lighting/issues/1056), but not every report in that thread. If the light is not listed in `manual_control`, include diagnostics and debug logs from the failed turn-on when reporting it. Lights returning from `unavailable` after a power cut are a separate case from an `off` to `on` state change.
This explains the physical-switch case in [#1056](https://github.com/basnijholt/adaptive-lighting/issues/1056), but not every report in that thread. If the light is not listed in `manual_control`, include diagnostics and debug logs from the failed turn-on when reporting it. When a light returns directly from `unavailable` to `on`, Adaptive Lighting resumes eligible adaptation after `adapt_delay`, using `initial_transition`. Reconnection preserves existing manual overrides and their reset timeouts; it does not start a new adaptation cycle with `only_once`. A light still transitioning may wait until the next interval. A recent turn-off fade still prevents adaptation unless a newer turn-on overrides it.
With `detect_non_ha_changes: true`, changed power-on brightness or color still follows normal manual-change detection and may pause adaptation. Availability alone cannot distinguish a physical power cycle from a temporary connection loss, so reconnection does not clear manual control or solve every power-cycle reset request in [#307](https://github.com/basnijholt/adaptive-lighting/issues/307).
#### :bulb: Lights Not Responding or Turning On by Themselves

View file

@ -50,6 +50,7 @@ from homeassistant.const import (
SERVICE_TURN_ON,
STATE_OFF,
STATE_ON,
STATE_UNAVAILABLE,
)
from homeassistant.core import (
CALLBACK_TYPE,
@ -1532,13 +1533,14 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity):
data,
)
async def _update_attrs_and_maybe_adapt_lights(
async def _update_attrs_and_maybe_adapt_lights( # noqa: PLR0912
self,
*,
context: Context,
lights: list[str] | None = None,
transition: int | None = None,
force: bool = False,
recovery_event: Event[EventStateChangedData] | None = None,
) -> None:
assert context is not None
_LOGGER.debug(
@ -1613,6 +1615,13 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity):
context,
)
# Polling may yield before a cancellable adaptation task exists.
if recovery_event is not None and not self._recovery_is_current(
light,
recovery_event,
):
continue
# Performance optimization: Skip adaptation task if all attributes are
# manually controlled and the task wouldn't actually do anything.
if self.manager.get_adaption_control_attributes(self, light).has_none():
@ -1640,6 +1649,45 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity):
if tasks:
await asyncio.gather(*tasks)
def _recovery_is_current(
self,
entity_id: str,
event: Event[EventStateChangedData],
) -> bool:
"""Reject superseded reconnects and current off intent."""
current = self.hass.states.get(entity_id)
recovered = event.data["new_state"]
return (
not self._removed
and self.is_on
and not self._only_once
and entity_id in self.lights
and current is not None
and current.state == STATE_ON
and recovered is not None
and current.last_changed == recovered.last_changed
and not self.manager.recovery_is_during_turn_off(entity_id)
)
async def _respond_to_recovery_event(
self,
entity_id: str,
event: Event[EventStateChangedData],
) -> None:
"""Resume eligible adaptation without starting a new turn-on cycle."""
if self._only_once:
return
if self._adapt_delay > 0:
await asyncio.sleep(self._adapt_delay)
if not self._recovery_is_current(entity_id, event):
return
await self._update_attrs_and_maybe_adapt_lights(
context=self.create_context("recovery", parent=event.context),
lights=[entity_id],
transition=self.initial_transition,
recovery_event=event,
)
async def _respond_to_off_to_on_event(
self,
entity_id: str,
@ -1711,8 +1759,8 @@ class AdaptiveSwitch(SwitchEntity, RestoreEntity):
if self._adapt_delay > 0:
await asyncio.sleep(self._adapt_delay)
# Runtime settings may retire this profile's target while the event waits.
if self._removed or entity_id not in self.lights:
# Runtime settings may disable the profile or retire its target while waiting.
if self._removed or not self.is_on or entity_id not in self.lights:
return
await self._update_attrs_and_maybe_adapt_lights(
@ -2780,6 +2828,7 @@ class AdaptiveLightingManager:
if old_state is not None and old_state.state == STATE_OFF
else None
)
old_unavailable = old_state is not None and old_state.state == STATE_UNAVAILABLE
if new_on:
_LOGGER.debug(
"Detected a '%s' 'state_changed' event: '%s' with context.id='%s'",
@ -2843,8 +2892,17 @@ class AdaptiveLightingManager:
entity_id,
event.context.id,
)
elif old_unavailable and new_on:
if self.is_proactively_adapting(event.context.id):
return
for switch in _switches_with_lights(
self.hass,
[entity_id],
expand_light_groups=False,
):
if switch.is_on:
await switch._respond_to_recovery_event(entity_id, event)
elif old_off and new_on:
# Tracks 'off' → 'on' state changes
self.off_to_on_event[entity_id] = event
_LOGGER.debug(
"Detected an 'off''on' event for '%s' with context.id='%s'",
@ -2885,6 +2943,25 @@ class AdaptiveLightingManager:
event,
)
def recovery_is_during_turn_off(self, entity_id: str) -> bool:
"""Respect an active fade, regardless of the reconnect's context."""
turn_off = self.turn_off_event.get(entity_id)
if turn_off is None:
return False
transition = _turn_off_transition(turn_off)
elapsed = (dt_util.utcnow() - turn_off.time_fired).total_seconds()
if not 0 <= elapsed <= max(transition or 0, TURNING_OFF_DELAY):
return False
targets = [entity_id]
state = self.hass.states.get(entity_id)
if state is not None and _is_light_group(state):
targets.extend(state.attributes[ATTR_ENTITY_ID])
return not any(
(turn_on := self.turn_on_event.get(target)) is not None
and turn_on.time_fired > turn_off.time_fired
for target in targets
)
async def update_manually_controlled_from_event(
self,
switch: AdaptiveSwitch,

View file

@ -51,7 +51,9 @@ If lights stop adapting after you turn them on with a physical switch or a Zigbe
To adapt these turn-ons while still detecting later manual changes, enable `detect_non_ha_changes` and leave `manual_control_on_external_turn_on` disabled. This requires the light integration to report its state reliably. If you want Adaptive Lighting to keep adapting regardless of manual changes, disable `take_over_control` along with the options that require it: `detect_non_ha_changes`, `adapt_only_on_bare_turn_on`, and `manual_control_on_external_turn_on`.
This explains the physical-switch case in [#1056](https://github.com/basnijholt/adaptive-lighting/issues/1056), but not every report in that thread. If the light is not listed in `manual_control`, include diagnostics and debug logs from the failed turn-on when reporting it. Lights returning from `unavailable` after a power cut are a separate case from an `off` to `on` state change.
This explains the physical-switch case in [#1056](https://github.com/basnijholt/adaptive-lighting/issues/1056), but not every report in that thread. If the light is not listed in `manual_control`, include diagnostics and debug logs from the failed turn-on when reporting it. When a light returns directly from `unavailable` to `on`, Adaptive Lighting resumes eligible adaptation after `adapt_delay`, using `initial_transition`. Reconnection preserves existing manual overrides and their reset timeouts; it does not start a new adaptation cycle with `only_once`. A light still transitioning may wait until the next interval. A recent turn-off fade still prevents adaptation unless a newer turn-on overrides it.
With `detect_non_ha_changes: true`, changed power-on brightness or color still follows normal manual-change detection and may pause adaptation. Availability alone cannot distinguish a physical power cycle from a temporary connection loss, so reconnection does not clear manual control or solve every power-cycle reset request in [#307](https://github.com/basnijholt/adaptive-lighting/issues/307).
#### :bulb: Lights Not Responding or Turning On by Themselves

View file

@ -40,6 +40,7 @@ from homeassistant.components.adaptive_lighting.const import (
CONF_DETECT_NON_HA_CHANGES,
CONF_EXPAND_LIGHT_GROUPS,
CONF_INITIAL_TRANSITION,
CONF_INTERVAL,
CONF_MANUAL_CONTROL,
CONF_MANUAL_CONTROL_ON_EXTERNAL_TURN_ON,
CONF_MAX_BRIGHTNESS,
@ -124,6 +125,7 @@ from homeassistant.const import (
STATE_OFF,
STATE_ON,
STATE_UNAVAILABLE,
STATE_UNKNOWN,
EntityCategory,
)
from homeassistant.core import Context, CoreState, Event, HomeAssistant, State
@ -5287,6 +5289,449 @@ async def test_manual_control_on_external_turn_on_external_state_change(
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
async def _recover_light_from_unavailable(hass, brightness=200):
"""Publish the state sequence emitted when a powered-off bulb reconnects."""
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
attributes[ATTR_BRIGHTNESS] = brightness
hass.states.async_set(
ENTITY_LIGHT_1,
STATE_UNAVAILABLE,
attributes,
context=Context(id="became_unavailable"),
)
await hass.async_block_till_done()
hass.states.async_set(
ENTITY_LIGHT_1,
STATE_ON,
attributes,
context=Context(id="recovered_on"),
)
await hass.async_block_till_done()
@pytest.mark.parametrize("external_turn_on_is_manual", [False, True])
@pytest.mark.parametrize("brightness", [128, 200])
async def test_unavailable_light_recovery_adapts_immediately(
hass,
external_turn_on_is_manual,
brightness,
):
"""Reconnect keeps automatic control regardless of external turn-on policy."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_MANUAL_CONTROL_ON_EXTERNAL_TURN_ON: external_turn_on_is_manual,
CONF_DETECT_NON_HA_CHANGES: False,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
calls = _track_adaptive_light_calls(hass)
await _recover_light_from_unavailable(hass, brightness)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 128
assert (
switch.manager.get_manual_control_attributes(ENTITY_LIGHT_1)
== LightControlAttributes.NONE
)
assert calls
calls.clear()
await switch._async_update_at_interval_action()
await hass.async_block_till_done()
assert any(call[ATTR_ENTITY_ID] == ENTITY_LIGHT_1 for call in calls)
async def test_unavailable_recovery_only_once_sends_no_commands(hass):
"""Availability cannot establish a new only_once on cycle."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_ONLY_ONCE: True,
CONF_DETECT_NON_HA_CHANGES: True,
CONF_INITIAL_TRANSITION: 0,
},
)
calls = _track_adaptive_light_calls(hass)
await _recover_light_from_unavailable(hass)
assert not calls
assert (
switch.manager.get_manual_control_attributes(ENTITY_LIGHT_1)
== LightControlAttributes.NONE
)
async def test_reconnect_keeps_non_ha_manual_timer_updates(hass, freezer, cleanup):
"""Preserved comparison data lets subsequent physical changes renew takeover."""
switch, lights = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: True,
CONF_AUTORESET_CONTROL: 7200,
},
)
manager = switch.manager
async def flush_physical_state(hass, entity_id):
for light in lights:
if light.entity_id == entity_id:
light.async_write_ha_state()
with patch(
"homeassistant.components.adaptive_lighting.switch.async_update_entity",
new=flush_physical_state,
):
set_light_brightness(lights[0], 20)
await switch._async_update_at_interval_action()
await hass.async_block_till_done()
assert (
manager.get_manual_control_attributes(ENTITY_LIGHT_1)
== LightControlAttributes.BRIGHTNESS
)
timer = manager.auto_reset_manual_control_timers[ENTITY_LIGHT_1]
before = timer.start_time
baseline = dict(manager.last_service_data[ENTITY_LIGHT_1])
await _recover_light_from_unavailable(hass, 20)
assert manager.last_service_data[ENTITY_LIGHT_1] == baseline
assert timer.start_time == before
freezer.tick(90)
set_light_brightness(lights[0], 200)
await switch._async_update_at_interval_action()
await hass.async_block_till_done()
assert timer.start_time > before
async def test_unavailable_recovery_off_during_poll(hass, monkeypatch):
"""Off arriving before child task registration must suppress recovery commands."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: True,
CONF_INITIAL_TRANSITION: 0,
},
)
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNAVAILABLE, attributes)
await hass.async_block_till_done()
entered, release = asyncio.Event(), asyncio.Event()
async def gated_poll(hass, entity_id):
entered.set()
await release.wait()
monkeypatch.setattr(
"homeassistant.components.adaptive_lighting.switch.async_update_entity",
gated_poll,
)
calls = _track_adaptive_light_calls(hass)
hass.states.async_set(ENTITY_LIGHT_1, STATE_ON, attributes)
try:
await asyncio.wait_for(entered.wait(), 1)
hass.bus.async_fire(
EVENT_CALL_SERVICE,
{
"domain": LIGHT_DOMAIN,
"service": SERVICE_TURN_OFF,
"service_data": {ATTR_ENTITY_ID: ENTITY_LIGHT_1, ATTR_TRANSITION: 10},
},
context=Context(),
)
await asyncio.sleep(0)
assert (
switch.manager.turn_off_event[ENTITY_LIGHT_1].time_fired
> switch.manager.turn_on_event[ENTITY_LIGHT_1].time_fired
)
assert hass.states.get(ENTITY_LIGHT_1).state == STATE_ON
finally:
release.set()
await hass.async_block_till_done()
assert not calls
async def test_unavailable_light_recovery_preserves_manual_control(hass):
"""A reconnect does not discard existing manual-control intent."""
switch, lights = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: True,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
set_light_brightness(lights[0], 200)
switch.manager.set_manual_control_attributes(ENTITY_LIGHT_1)
await _recover_light_from_unavailable(hass)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
assert (
switch.manager.get_manual_control_attributes(ENTITY_LIGHT_1)
== LightControlAttributes.ALL
)
async def test_unavailable_light_recovery_adapts_non_manual_attributes(hass):
"""PAUSE_CHANGED keeps manual brightness while adapting color."""
switch, lights = await setup_lights_and_switch(
hass,
{
CONF_TAKE_OVER_CONTROL_MODE: TakeOverControlMode.PAUSE_CHANGED.value,
CONF_DETECT_NON_HA_CHANGES: True,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
switch.manager.set_manual_control_attributes(
ENTITY_LIGHT_1,
LightControlAttributes.BRIGHTNESS,
)
switch.manager.last_service_data.pop(ENTITY_LIGHT_1, None)
set_light_brightness(lights[0], 200)
await _recover_light_from_unavailable(hass)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
assert (
switch.manager.get_manual_control_attributes(ENTITY_LIGHT_1)
== LightControlAttributes.BRIGHTNESS
)
service_data = switch.manager.last_service_data[ENTITY_LIGHT_1]
assert ATTR_BRIGHTNESS not in service_data
assert ATTR_COLOR_TEMP_KELVIN in service_data
async def test_unavailable_light_recovery_ignores_disabled_profile(hass):
"""A disabled profile does not act when one of its lights reconnects."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: True,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
await switch.async_turn_off()
await _recover_light_from_unavailable(hass)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
async def test_unknown_to_on_does_not_trigger_recovery(hass):
"""An unknown-to-on update remains outside unavailable recovery."""
await setup_lights_and_switch(
hass,
{
CONF_TAKE_OVER_CONTROL: False,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
attributes[ATTR_BRIGHTNESS] = 200
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNKNOWN, attributes)
await hass.async_block_till_done()
hass.states.async_set(ENTITY_LIGHT_1, STATE_ON, attributes)
await hass.async_block_till_done()
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
async def test_unavailable_light_is_skipped_by_interval(hass):
"""Periodic updates do not send commands to unavailable lights."""
switch, _ = await setup_lights_and_switch(hass)
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNAVAILABLE, attributes)
await hass.async_block_till_done()
switch.manager.last_service_data.pop(ENTITY_LIGHT_1, None)
await switch._update_attrs_and_maybe_adapt_lights(
context=switch.create_context("interval"),
lights=[ENTITY_LIGHT_1],
)
assert ENTITY_LIGHT_1 not in switch.manager.last_service_data
async def test_unavailable_light_recovery_preserves_recent_turn_off(hass):
"""A false on report does not override a newer explicit turn-off."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_TAKE_OVER_CONTROL: False,
CONF_DETECT_NON_HA_CHANGES: False,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
switch.manager.turn_on_event.pop(ENTITY_LIGHT_1, None)
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: ENTITY_LIGHT_1},
blocking=True,
)
await hass.async_block_till_done()
assert ENTITY_LIGHT_1 not in switch.manager.turn_on_event
await _recover_light_from_unavailable(hass)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 200
@pytest.mark.parametrize(("elapsed", "should_adapt"), [(0, False), (11, True)])
async def test_unavailable_recovery_respects_fresh_turn_off_window(
hass,
freezer,
elapsed,
should_adapt,
):
"""Recovery must not reverse an active fade, but adapts after it expires."""
await setup_lights_and_switch(
hass,
{
CONF_TAKE_OVER_CONTROL: True,
CONF_ONLY_ONCE: False,
CONF_INTERVAL: 3600,
CONF_DETECT_NON_HA_CHANGES: False,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
turn_off_context = Context()
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: ENTITY_LIGHT_1, ATTR_TRANSITION: 10},
blocking=True,
context=turn_off_context,
)
await hass.async_block_till_done()
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
attributes[ATTR_BRIGHTNESS] = 200
hass.states.async_set(
ENTITY_LIGHT_1,
STATE_UNAVAILABLE,
attributes,
context=turn_off_context,
)
await hass.async_block_till_done()
freezer.tick(elapsed)
calls = _track_adaptive_light_calls(hass)
hass.states.async_set(
ENTITY_LIGHT_1,
STATE_ON,
attributes,
context=Context(),
)
await hass.async_block_till_done()
if should_adapt:
assert calls[-1][ATTR_BRIGHTNESS] == 128
else:
assert not calls
@pytest.mark.parametrize(
("cancel_reason", "detect_non_ha_changes", "expected_brightness"),
[
("light_turn_off", False, 200),
("light_turn_off", True, 200),
("turn_off_then_turn_on", True, 128),
("profile_disabled", False, 200),
],
)
async def test_unavailable_light_recovery_cancelled_during_delay(
hass,
monkeypatch,
cancel_reason,
detect_non_ha_changes,
expected_brightness,
):
"""A changed off intent during recovery delay prevents adaptation."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_TAKE_OVER_CONTROL: False,
CONF_DETECT_NON_HA_CHANGES: detect_non_ha_changes,
CONF_ADAPT_DELAY: 0.1234,
CONF_INITIAL_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
attributes[ATTR_BRIGHTNESS] = 200
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNAVAILABLE, attributes)
await hass.async_block_till_done()
entered_delay = asyncio.Event()
release_delay = asyncio.Event()
original_sleep = asyncio.sleep
async def controlled_sleep(delay, *args, **kwargs):
if delay == 0.1234:
entered_delay.set()
await release_delay.wait()
else:
await original_sleep(delay, *args, **kwargs)
monkeypatch.setattr(asyncio, "sleep", controlled_sleep)
hass.states.async_set(ENTITY_LIGHT_1, STATE_ON, attributes)
await entered_delay.wait()
if cancel_reason in ("light_turn_off", "turn_off_then_turn_on"):
hass.bus.async_fire(
EVENT_CALL_SERVICE,
{
"domain": LIGHT_DOMAIN,
"service": SERVICE_TURN_OFF,
"service_data": {
ATTR_ENTITY_ID: ENTITY_LIGHT_1,
ATTR_TRANSITION: 10,
},
},
context=Context(id="turn_off_during_recovery_delay"),
)
await original_sleep(0)
assert hass.states.get(ENTITY_LIGHT_1).state == STATE_ON
assert (
switch.manager.turn_off_event[ENTITY_LIGHT_1].time_fired
> switch.manager.turn_on_event[ENTITY_LIGHT_1].time_fired
)
if cancel_reason == "turn_off_then_turn_on":
hass.bus.async_fire(
EVENT_CALL_SERVICE,
{
"domain": LIGHT_DOMAIN,
"service": SERVICE_TURN_ON,
"service_data": {ATTR_ENTITY_ID: ENTITY_LIGHT_1},
},
context=Context(id="turn_on_during_recovery_delay"),
)
await original_sleep(0)
assert (
switch.manager.turn_on_event[ENTITY_LIGHT_1].time_fired
> switch.manager.turn_off_event[ENTITY_LIGHT_1].time_fired
)
else:
await switch.async_turn_off()
assert not switch.is_on
release_delay.set()
await hass.async_block_till_done()
assert (
hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS]
== expected_brightness
)
@pytest.mark.parametrize("intercept", [True, False])
async def test_manual_control_on_external_turn_on_keeps_non_ha_change_detection(
hass,
@ -6271,13 +6716,15 @@ async def test_profile_unloaded_during_split_delay(hass, monkeypatch):
@pytest.mark.parametrize("unload_before_split", [False, True])
@pytest.mark.parametrize("recovery", [False, True])
async def test_unloaded_polling_profile_preserves_other_split_adaptation(
hass,
monkeypatch,
unload_before_split,
recovery,
):
"""A removed profile resuming a poll must not cancel another profile's work."""
switch, _ = await setup_lights_and_switch(hass, {CONF_ONLY_ONCE: True})
switch, _ = await setup_lights_and_switch(hass, {CONF_ONLY_ONCE: not recovery})
_, other = await setup_switch(
hass,
{
@ -6314,11 +6761,19 @@ async def test_unloaded_polling_profile_preserves_other_split_adaptation(
)
monkeypatch.setattr(asyncio, "sleep", controlled_sleep)
calls = _track_adaptive_light_calls(hass)
recovery_event = Event(
EVENT_STATE_CHANGED,
{"new_state": hass.states.get(ENTITY_LIGHT_1)},
)
polling = hass.async_create_task(
switch._update_attrs_and_maybe_adapt_lights(
context=switch.create_context("test"),
lights=[ENTITY_LIGHT_1],
force=True,
(
switch._respond_to_recovery_event(ENTITY_LIGHT_1, recovery_event)
if recovery
else switch._update_attrs_and_maybe_adapt_lights(
context=switch.create_context("test"),
lights=[ENTITY_LIGHT_1],
force=True,
)
),
)
await asyncio.wait_for(poll_entered.wait(), 2)
@ -6344,3 +6799,299 @@ async def test_unloaded_polling_profile_preserves_other_split_adaptation(
await hass.async_block_till_done()
assert len(calls) == 2
assert ATTR_COLOR_TEMP_KELVIN in calls[-1]
@pytest.mark.parametrize("changed", [False, True])
@pytest.mark.parametrize(
"mode",
[TakeOverControlMode.PAUSE_ALL, TakeOverControlMode.PAUSE_CHANGED],
)
async def test_recovery_retains_non_ha_detection(hass, changed, mode):
"""Physical reconnect changes use normal detection and takeover mode."""
switch, lights = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: True,
CONF_TAKE_OVER_CONTROL_MODE: mode.value,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
brightness = 200 if changed else 128
set_light_brightness(lights[0], brightness)
calls = _track_adaptive_light_calls(hass)
await _recover_light_from_unavailable(hass, brightness)
assert switch.manager.get_manual_control_attributes(ENTITY_LIGHT_1) == (
LightControlAttributes.BRIGHTNESS if changed else LightControlAttributes.NONE
)
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == brightness
if changed and mode == TakeOverControlMode.PAUSE_ALL:
assert not calls
else:
assert calls
if changed:
assert all(ATTR_BRIGHTNESS not in call for call in calls)
@pytest.mark.parametrize(
"change",
["churn", "attributes", "manual", "removed", "unloaded"],
)
async def test_recovery_revalidates_after_delay(hass, monkeypatch, freezer, change):
"""Only the current on period and live profile may resume after waiting."""
switch, _ = await setup_lights_and_switch(
hass,
{
CONF_DETECT_NON_HA_CHANGES: False,
CONF_ADAPT_DELAY: 0.1234,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
attributes = dict(hass.states.get(ENTITY_LIGHT_1).attributes)
attributes[ATTR_BRIGHTNESS] = 200
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNAVAILABLE, attributes)
await hass.async_block_till_done()
entered = asyncio.Queue()
releases = [asyncio.Event(), asyncio.Event()]
original_sleep = asyncio.sleep
async def gated_sleep(delay, *args, **kwargs):
if delay == 0.1234:
gate = releases[gated_sleep.count]
gated_sleep.count += 1
entered.put_nowait(None)
await gate.wait()
else:
await original_sleep(delay, *args, **kwargs)
gated_sleep.count = 0
monkeypatch.setattr(asyncio, "sleep", gated_sleep)
calls = _track_adaptive_light_calls(hass)
hass.states.async_set(ENTITY_LIGHT_1, STATE_ON, attributes)
try:
await asyncio.wait_for(entered.get(), 1)
if change == "churn":
freezer.tick(1)
hass.states.async_set(ENTITY_LIGHT_1, STATE_UNAVAILABLE, attributes)
await original_sleep(0)
hass.states.async_set(ENTITY_LIGHT_1, STATE_ON, attributes)
await asyncio.wait_for(entered.get(), 1)
elif change == "attributes":
hass.states.async_set(
ENTITY_LIGHT_1,
STATE_ON,
{**attributes, ATTR_BRIGHTNESS: 199},
)
elif change == "manual":
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{
ATTR_ENTITY_ID: ENTITY_LIGHT_1,
ATTR_BRIGHTNESS: 77,
},
blocking=True,
)
elif change == "removed":
switch.lights.remove(ENTITY_LIGHT_1)
else:
entry = next(
entry
for entry in hass.config_entries.async_entries(DOMAIN)
if entry.data[CONF_NAME] == DEFAULT_NAME
)
assert await hass.config_entries.async_unload(entry.entry_id)
releases[0].set()
await original_sleep(0)
await original_sleep(0)
if change == "churn":
assert not calls
releases[1].set()
await hass.async_block_till_done()
if change in ("churn", "attributes"):
assert len(calls) == 1
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 128
else:
assert not calls
if change == "manual":
assert hass.states.get(ENTITY_LIGHT_1).attributes[ATTR_BRIGHTNESS] == 77
finally:
for gate in releases:
gate.set()
await hass.async_block_till_done()
@pytest.mark.parametrize(
("transition", "window"),
[(10, 10), ("10", 10), (10000, 6553), ("10000", 6553), ("inf", 6553), (None, 5)],
)
async def test_recovery_normalizes_turn_off_transition(
hass,
cleanup,
transition,
window,
):
"""Recovery suppression ends after the light service's normalized window."""
switch, _ = await setup_lights_and_switch(hass)
manager = switch.manager
manager.turn_on_event.pop(ENTITY_LIGHT_1, None)
now = dt_util.utcnow().timestamp()
for elapsed, expected in [(window - 1, True), (window + 1, False)]:
manager.turn_off_event[ENTITY_LIGHT_1] = _turn_off_service_event(
[ENTITY_LIGHT_1],
now - elapsed,
Context(),
transition,
)
assert manager.recovery_is_during_turn_off(ENTITY_LIGHT_1) is expected
async def test_recovery_preserves_active_transition(hass, cleanup):
"""Availability does not reset a transition that still suppresses adaptation."""
switch, _ = await setup_lights_and_switch(hass, {CONF_DETECT_NON_HA_CHANGES: False})
switch.manager.last_service_data[ENTITY_LIGHT_1][ATTR_TRANSITION] = 60
switch.manager.start_transition_timer(ENTITY_LIGHT_1)
calls = _track_adaptive_light_calls(hass)
await _recover_light_from_unavailable(hass)
assert not calls
assert switch.manager.transition_timers[ENTITY_LIGHT_1].is_running()
@pytest.mark.parametrize("member_on", [False, True])
async def test_recovery_newer_member_on_overrides_off_during_delay(
hass,
monkeypatch,
freezer,
member_on,
):
"""A newer member turn-on overrides group off even after recovery began."""
await setup_lights(hass, with_group=True)
group = "light.light_group"
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: group},
blocking=True,
)
_, switch = await setup_switch(
hass,
{
CONF_LIGHTS: [group, "light.light_4"],
CONF_EXPAND_LIGHT_GROUPS: False,
CONF_DETECT_NON_HA_CHANGES: False,
CONF_ADAPT_DELAY: 0.1234,
CONF_INITIAL_TRANSITION: 0,
CONF_TRANSITION: 0,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
attributes = dict(hass.states.get(group).attributes)
hass.states.async_set(group, STATE_UNAVAILABLE, attributes)
await hass.async_block_till_done()
entered, release = asyncio.Event(), asyncio.Event()
original_sleep = asyncio.sleep
async def gated_sleep(delay, *args, **kwargs):
if delay == 0.1234:
entered.set()
await release.wait()
else:
await original_sleep(delay, *args, **kwargs)
monkeypatch.setattr(asyncio, "sleep", gated_sleep)
calls = _track_adaptive_light_calls(hass)
hass.states.async_set(group, STATE_ON, attributes)
await asyncio.wait_for(entered.wait(), 1)
freezer.tick(1)
hass.bus.async_fire(
EVENT_CALL_SERVICE,
{
"domain": LIGHT_DOMAIN,
"service": SERVICE_TURN_OFF,
"service_data": {ATTR_ENTITY_ID: group, ATTR_TRANSITION: 10},
},
context=Context(),
)
await original_sleep(0)
if member_on:
freezer.tick(1)
hass.bus.async_fire(
EVENT_CALL_SERVICE,
{
"domain": LIGHT_DOMAIN,
"service": SERVICE_TURN_ON,
"service_data": {ATTR_ENTITY_ID: "light.light_4"},
},
context=Context(),
)
await original_sleep(0)
release.set()
await hass.async_block_till_done()
assert bool(calls) is member_on
if member_on:
assert hass.states.get(group).attributes[ATTR_BRIGHTNESS] == 128
@pytest.mark.parametrize(
("turn_on_target", "should_adapt"),
[("light.light_4", False), ("light.light_5", True), ("light.light_group", True)],
)
async def test_recovery_sibling_turn_on_preserves_member_off_intent(
hass,
freezer,
turn_on_target,
should_adapt,
):
"""Turning on one member must not revive a sibling during a group off fade."""
await setup_lights(hass, with_group=True)
group, sibling = "light.light_group", "light.light_5"
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: group},
blocking=True,
)
_, switch = await setup_switch(
hass,
{
CONF_LIGHTS: [group],
CONF_DETECT_NON_HA_CHANGES: False,
CONF_TAKE_OVER_CONTROL: False,
CONF_INITIAL_TRANSITION: 0,
CONF_TRANSITION: 0,
CONF_INTERVAL: 3600,
CONF_MIN_BRIGHTNESS: 50,
CONF_MAX_BRIGHTNESS: 50,
},
)
attributes = dict(hass.states.get(sibling).attributes)
attributes[ATTR_BRIGHTNESS] = 200
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: group, ATTR_TRANSITION: 30},
blocking=True,
)
await hass.async_block_till_done()
assert sibling in switch.manager.turn_off_event
freezer.tick(1)
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: turn_on_target},
blocking=True,
)
await hass.async_block_till_done()
assert hass.states.get(group).state == STATE_ON
assert hass.states.get(sibling).state == (STATE_ON if should_adapt else STATE_OFF)
calls = _track_adaptive_light_calls(hass)
hass.states.async_set(sibling, STATE_UNAVAILABLE, attributes, context=Context())
await hass.async_block_till_done()
hass.states.async_set(sibling, STATE_ON, attributes, context=Context())
await hass.async_block_till_done()
assert any(call[ATTR_ENTITY_ID] == sibling for call in calls) is should_adapt
assert hass.states.get(sibling).attributes[ATTR_BRIGHTNESS] == (
128 if should_adapt else 200
)