Skip to content

Add a delay to switch statuses on Transmission #157493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Add a delay to switch statuses on Transmission #157493

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79c8346
Add an optimistic delay to switch status
andrew-codechimp Nov 28, 2025
6fc165e
Improve optimistic switches
andrew-codechimp Nov 29, 2025
ca66f29
Change to sleep delay on setting switches
andrew-codechimp Nov 29, 2025
1b7347e
Be less optimistic about sleep for slower systems
andrew-codechimp Nov 29, 2025
bc819ab
Remove writes and add delayed test
andrew-codechimp Nov 29, 2025
4be0b6f
Fix pylance warning on patch_sleep
andrew-codechimp Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions homeassistant/components/transmission/switch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from collections.abc import Callable
from dataclasses import dataclass
import time
from typing import Any

from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription
Expand Down Expand Up @@ -59,22 +60,35 @@ class TransmissionSwitch(TransmissionEntity, SwitchEntity):
"""Representation of a Transmission switch."""

entity_description: TransmissionSwitchEntityDescription
_state_delay = 5 # seconds
_last_action = 0.0

@property
def is_on(self) -> bool:
"""Return true if device is on."""
# The Transmission API has a delay in state change after
# calling for a change. This state delay will ensure that HA keeps an
# optimistic value of state during this period to improve the user
# experience and avoid confusion.
if self._last_action > (time.time() - self._state_delay):
return bool(self._attr_is_on)
self._last_action = time.time()
return bool(self.entity_description.is_on_func(self.coordinator))
Comment on lines 65 to 68
Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation is reinventing Home Assistant's built-in optimistic state handling. The standard approach for devices with delayed state reporting is to use _attr_assumed_state = True, which properly signals to the UI that the state is assumed rather than confirmed. This built-in pattern handles state management more reliably and is the established pattern used throughout Home Assistant integrations.

Consider using the standard assumed state pattern instead:

_attr_assumed_state = True

async def async_turn_on(self, **kwargs: Any) -> None:
    """Turn the device on."""
    self._attr_is_on = True
    self.async_write_ha_state()
    await self.hass.async_add_executor_job(
        self.entity_description.on_func, self.coordinator
    )
    await self.coordinator.async_request_refresh()

This approach is simpler, more maintainable, and follows established Home Assistant patterns.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@andrew-codechimp andrew-codechimp Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_attr_assumed_state does not seem to achieve what is required here.


async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn the device on."""
await self.hass.async_add_executor_job(
self.entity_description.on_func, self.coordinator
)
await self.coordinator.async_request_refresh()
self._last_action = time.time()
self._attr_is_on = True
self.async_write_ha_state()
Copy link
Member

@joostlek joostlek Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You wouldn't need this state write though!


async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn the device off."""
await self.hass.async_add_executor_job(
self.entity_description.off_func, self.coordinator
)
await self.coordinator.async_request_refresh()
self._last_action = time.time()
self._attr_is_on = False
self.async_write_ha_state()
Loading