Compare commits

..

3 Commits

Author SHA1 Message Date
Paul Bottein bb4f4e46c9 Add binary sensors to Yoto 2026-06-12 15:58:31 +02:00
Paul Bottein 7c9e5ad31b Bump yoto-api to 4.1.0 (#173601) 2026-06-12 14:24:03 +02:00
Erwin Douna 540e9a3d3b MELCloud Home add parallel updates (#173587) 2026-06-12 14:11:27 +02:00
17 changed files with 345 additions and 161 deletions
@@ -24,6 +24,8 @@ from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from .coordinator import MelCloudHomeConfigEntry, MelCloudHomeCoordinator
from .entity import MelCloudHomeATAUnitEntity, MelCloudHomeATWZoneEntity
PARALLEL_UPDATES = 1
ATA_HVAC_MODE_TO_OPERATION: dict[HVACMode, ATAOperationMode] = {
HVACMode.HEAT: ATAOperationMode.HEAT,
HVACMode.COOL: ATAOperationMode.COOL,
@@ -35,7 +35,7 @@ rules:
entity-unavailable: todo
integration-owner: done
log-when-unavailable: todo
parallel-updates: todo
parallel-updates: done
reauthentication-flow: todo
test-coverage: todo
+1 -1
View File
@@ -19,7 +19,7 @@ from homeassistant.helpers.config_entry_oauth2_flow import (
from .const import DOMAIN
from .coordinator import YotoConfigEntry, YotoDataUpdateCoordinator
PLATFORMS: list[Platform] = [Platform.MEDIA_PLAYER]
PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.MEDIA_PLAYER]
async def async_setup_entry(hass: HomeAssistant, entry: YotoConfigEntry) -> bool:
@@ -0,0 +1,87 @@
"""Binary sensor platform for the Yoto integration."""
from collections.abc import Callable
from dataclasses import dataclass
from yoto_api import YotoPlayer
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from .coordinator import YotoConfigEntry, YotoDataUpdateCoordinator
from .entity import YotoEntity
PARALLEL_UPDATES = 0
@dataclass(frozen=True, kw_only=True)
class YotoBinarySensorEntityDescription(BinarySensorEntityDescription):
"""Describes a Yoto binary sensor entity."""
is_on_fn: Callable[[YotoPlayer], bool | None]
BINARY_SENSORS: tuple[YotoBinarySensorEntityDescription, ...] = (
YotoBinarySensorEntityDescription(
key="charging",
device_class=BinarySensorDeviceClass.BATTERY_CHARGING,
entity_category=EntityCategory.DIAGNOSTIC,
is_on_fn=lambda player: player.status.is_charging,
),
YotoBinarySensorEntityDescription(
key="headphones",
translation_key="headphones",
device_class=BinarySensorDeviceClass.CONNECTIVITY,
entity_category=EntityCategory.DIAGNOSTIC,
is_on_fn=lambda player: player.status.is_audio_device_connected,
),
YotoBinarySensorEntityDescription(
key="bluetooth_audio",
translation_key="bluetooth_audio",
device_class=BinarySensorDeviceClass.CONNECTIVITY,
entity_category=EntityCategory.DIAGNOSTIC,
is_on_fn=lambda player: player.status.is_bluetooth_audio_connected,
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: YotoConfigEntry,
async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
"""Set up the Yoto binary sensor platform."""
coordinator = entry.runtime_data
async_add_entities(
YotoBinarySensor(coordinator, player, description)
for player in coordinator.client.players.values()
for description in BINARY_SENSORS
)
class YotoBinarySensor(YotoEntity, BinarySensorEntity):
"""Representation of a Yoto player binary sensor."""
entity_description: YotoBinarySensorEntityDescription
def __init__(
self,
coordinator: YotoDataUpdateCoordinator,
player: YotoPlayer,
description: YotoBinarySensorEntityDescription,
) -> None:
"""Initialize the binary sensor."""
super().__init__(coordinator, player)
self.entity_description = description
self._attr_unique_id = f"{player.id}_{description.key}"
@property
def is_on(self) -> bool | None:
"""Return the binary sensor state."""
return self.entity_description.is_on_fn(self.player)
@@ -14,7 +14,6 @@ from homeassistant.exceptions import (
OAuth2TokenRequestError,
OAuth2TokenRequestReauthError,
)
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.config_entry_oauth2_flow import OAuth2Session
from homeassistant.helpers.event import async_track_time_interval
@@ -47,7 +46,6 @@ class YotoDataUpdateCoordinator(DataUpdateCoordinator[dict[str, YotoPlayer]]):
)
self._session = session
self.client = YotoClient(session=async_get_clientsession(hass))
self._subscribed_players: set[str] = set()
self._sync_token()
def _sync_token(self) -> None:
@@ -89,8 +87,6 @@ class YotoDataUpdateCoordinator(DataUpdateCoordinator[dict[str, YotoPlayer]]):
translation_placeholders={"error": str(err)},
) from err
self._subscribed_players = set(self.client.players)
# The MQTT data/status topic is not pushed spontaneously; the firmware
# only emits it in response to a command/status/request publish.
self.config_entry.async_on_unload(
@@ -135,37 +131,8 @@ class YotoDataUpdateCoordinator(DataUpdateCoordinator[dict[str, YotoPlayer]]):
translation_placeholders={"error": str(err)},
) from err
await self._async_sync_subscriptions()
self._remove_stale_devices()
return self.client.players
async def _async_sync_subscriptions(self) -> None:
"""Subscribe new players to MQTT events and unsubscribe removed ones."""
current = set(self.client.players)
try:
for device_id in current - self._subscribed_players:
await self.client.subscribe_player_events(device_id)
for device_id in self._subscribed_players - current:
await self.client.unsubscribe_player_events(device_id)
except YotoError as err:
_LOGGER.warning("Could not update Yoto event subscriptions: %s", err)
return
self._subscribed_players = current
def _remove_stale_devices(self) -> None:
"""Drop devices for players no longer returned by the account."""
device_registry = dr.async_get(self.hass)
for device in dr.async_entries_for_config_entry(
device_registry, self.config_entry.entry_id
):
player_id = next(
(ident[1] for ident in device.identifiers if ident[0] == DOMAIN), None
)
if player_id is not None and player_id not in self.client.players:
device_registry.async_update_device(
device.id, remove_config_entry_id=self.config_entry.entry_id
)
async def _async_load_library(self) -> None:
"""Load the card library and groups; failures only affect browsing."""
try:
+5 -1
View File
@@ -43,4 +43,8 @@ class YotoEntity(CoordinatorEntity[YotoDataUpdateCoordinator]):
@property
def available(self) -> bool:
"""Return if the entity is available."""
return super().available and self._player_id in self.coordinator.data
return (
super().available
and self._player_id in self.coordinator.data
and bool(self.player.is_online)
)
+12
View File
@@ -0,0 +1,12 @@
{
"entity": {
"binary_sensor": {
"bluetooth_audio": {
"default": "mdi:bluetooth-audio"
},
"headphones": {
"default": "mdi:headphones"
}
}
}
}
+1 -1
View File
@@ -10,5 +10,5 @@
"iot_class": "cloud_push",
"loggers": ["yoto_api"],
"quality_scale": "bronze",
"requirements": ["yoto-api==4.0.2"]
"requirements": ["yoto-api==4.1.0"]
}
+5 -22
View File
@@ -16,7 +16,7 @@ from homeassistant.components.media_player import (
MediaPlayerState,
MediaType,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
@@ -47,22 +47,10 @@ async def async_setup_entry(
) -> None:
"""Set up the Yoto media player platform."""
coordinator = entry.runtime_data
known_players: set[str] = set()
@callback
def _add_players() -> None:
current = set(coordinator.data)
new_players = current - known_players
known_players.clear()
known_players.update(current)
if new_players:
async_add_entities(
YotoMediaPlayer(coordinator, coordinator.data[player_id])
for player_id in new_players
)
entry.async_on_unload(coordinator.async_add_listener(_add_players))
_add_players()
async_add_entities(
YotoMediaPlayer(coordinator, player)
for player in coordinator.client.players.values()
)
class YotoMediaPlayer(YotoEntity, MediaPlayerEntity):
@@ -94,11 +82,6 @@ class YotoMediaPlayer(YotoEntity, MediaPlayerEntity):
super().__init__(coordinator, player)
self._attr_unique_id = player.id
@property
def available(self) -> bool:
"""Return whether the player is reachable through the Yoto cloud."""
return super().available and bool(self.player.is_online)
@property
def state(self) -> MediaPlayerState:
"""Return the playback state."""
@@ -56,28 +56,22 @@ rules:
docs-supported-functions: todo
docs-troubleshooting: todo
docs-use-cases: todo
dynamic-devices: done
entity-category:
status: exempt
comment: Only the media_player entity ships in this PR; no diagnostic entities yet.
dynamic-devices: todo
entity-category: done
entity-device-class: done
entity-disabled-by-default:
status: exempt
comment: Only the media_player entity ships in this PR; no entities are disabled by default.
entity-translations:
status: exempt
comment: The media_player uses the device name; no translatable strings yet.
comment: No noisy or less popular entities; nothing is disabled by default.
entity-translations: done
exception-translations: done
icon-translations:
status: exempt
comment: No custom icon translations are needed yet.
icon-translations: done
reconfiguration-flow:
status: exempt
comment: Authorization is the only configuration; reauth covers re-linking the account.
repair-issues:
status: exempt
comment: No repair issues are raised yet.
stale-devices: done
stale-devices: todo
# Platinum
async-dependency: done
@@ -36,6 +36,16 @@
}
}
},
"entity": {
"binary_sensor": {
"bluetooth_audio": {
"name": "Bluetooth audio"
},
"headphones": {
"name": "Headphones"
}
}
},
"exceptions": {
"authentication_failed": {
"message": "Yoto credentials are no longer valid. Please reauthenticate your account."
+1 -1
View File
@@ -3436,7 +3436,7 @@ yeelightsunflower==0.0.10
yolink-api==0.6.5
# homeassistant.components.yoto
yoto-api==4.0.2
yoto-api==4.1.0
# homeassistant.components.youless
youless-api==2.2.0
+6
View File
@@ -15,6 +15,7 @@ from yoto_api import (
PlaybackEvent,
PlaybackStatus,
PlayerInfo,
PlayerStatus,
Track,
YotoPlayer,
)
@@ -88,6 +89,11 @@ def _build_player() -> YotoPlayer:
firmware_version="v2.17.5",
mac="aa:bb:cc:dd:ee:ff",
)
player.status = PlayerStatus(
is_charging=True,
is_audio_device_connected=False,
is_bluetooth_audio_connected=False,
)
player.last_event = PlaybackEvent(
player_id=PLAYER_ID,
playback_status=PlaybackStatus.PLAYING,
@@ -0,0 +1,154 @@
# serializer version: 1
# name: test_all_entities[binary_sensor.nursery_yoto_bluetooth_audio-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.nursery_yoto_bluetooth_audio',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Bluetooth audio',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.CONNECTIVITY: 'connectivity'>,
'original_icon': None,
'original_name': 'Bluetooth audio',
'platform': 'yoto',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'bluetooth_audio',
'unique_id': 'player-test_bluetooth_audio',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.nursery_yoto_bluetooth_audio-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'device_class': 'connectivity',
'friendly_name': 'Nursery Yoto Bluetooth audio',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.nursery_yoto_bluetooth_audio',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.nursery_yoto_charging-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.nursery_yoto_charging',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Charging',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.BATTERY_CHARGING: 'battery_charging'>,
'original_icon': None,
'original_name': 'Charging',
'platform': 'yoto',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': None,
'unique_id': 'player-test_charging',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.nursery_yoto_charging-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'device_class': 'battery_charging',
'friendly_name': 'Nursery Yoto Charging',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.nursery_yoto_charging',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.nursery_yoto_headphones-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.nursery_yoto_headphones',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Headphones',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.CONNECTIVITY: 'connectivity'>,
'original_icon': None,
'original_name': 'Headphones',
'platform': 'yoto',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'headphones',
'unique_id': 'player-test_headphones',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.nursery_yoto_headphones-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'device_class': 'connectivity',
'friendly_name': 'Nursery Yoto Headphones',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.nursery_yoto_headphones',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
@@ -0,0 +1,49 @@
"""Tests for the Yoto binary sensor platform."""
from unittest.mock import MagicMock, patch
import pytest
from syrupy.assertion import SnapshotAssertion
from homeassistant.const import STATE_UNAVAILABLE, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from . import setup_integration
from tests.common import MockConfigEntry, snapshot_platform
pytestmark = pytest.mark.usefixtures("setup_credentials")
ENTITY_ID = "binary_sensor.nursery_yoto_charging"
@pytest.mark.usefixtures("mock_yoto_client", "entity_registry_enabled_by_default")
async def test_all_entities(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
entity_registry: er.EntityRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Snapshot every Yoto binary sensor entity."""
with patch("homeassistant.components.yoto.PLATFORMS", [Platform.BINARY_SENSOR]):
await setup_integration(hass, mock_config_entry)
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
async def test_binary_sensor_unavailable_when_offline(
hass: HomeAssistant,
mock_yoto_client: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Binary sensors are unavailable while the player is offline."""
player = next(iter(mock_yoto_client.players.values()))
player.is_online = False
with patch("homeassistant.components.yoto.PLATFORMS", [Platform.BINARY_SENSOR]):
await setup_integration(hass, mock_config_entry)
state = hass.states.get(ENTITY_ID)
assert state is not None
assert state.state == STATE_UNAVAILABLE
+1 -86
View File
@@ -5,7 +5,7 @@ from unittest.mock import MagicMock, Mock, patch
import aiohttp
from freezegun.api import FrozenDateTimeFactory
import pytest
from yoto_api import AuthenticationError, Device, YotoAPIError, YotoError, YotoPlayer
from yoto_api import AuthenticationError, YotoAPIError, YotoError
from homeassistant.components.yoto.const import (
DOMAIN,
@@ -18,13 +18,11 @@ from homeassistant.exceptions import (
OAuth2TokenRequestError,
OAuth2TokenRequestReauthError,
)
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.config_entry_oauth2_flow import (
ImplementationUnavailableError,
)
from . import setup_integration
from .conftest import PLAYER_ID
from tests.common import MockConfigEntry, async_fire_time_changed
@@ -318,86 +316,3 @@ async def test_periodic_poll_fails_on_api_error(
coordinator = mock_config_entry.runtime_data
assert coordinator.last_update_success is False
def _build_second_player() -> YotoPlayer:
"""Build a second Yoto player discovered after setup."""
return YotoPlayer(
device=Device(
device_id="player-2",
name="Playroom Yoto",
device_type="v3",
device_family="v3",
generation="gen3",
),
is_online=True,
)
async def test_dynamic_device_added(
hass: HomeAssistant,
mock_yoto_client: MagicMock,
mock_config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
) -> None:
"""A player discovered after setup gets its entity without a reload."""
await setup_integration(hass, mock_config_entry)
assert hass.states.get("media_player.nursery_yoto") is not None
assert hass.states.get("media_player.playroom_yoto") is None
mock_yoto_client.players["player-2"] = _build_second_player()
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
assert hass.states.get("media_player.playroom_yoto") is not None
mock_yoto_client.subscribe_player_events.assert_called_once_with("player-2")
async def test_subscription_failure_does_not_fail_refresh(
hass: HomeAssistant,
mock_yoto_client: MagicMock,
mock_config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
) -> None:
"""A subscription error keeps the refreshed data and retries next cycle."""
await setup_integration(hass, mock_config_entry)
mock_yoto_client.players["player-2"] = _build_second_player()
mock_yoto_client.subscribe_player_events.side_effect = YotoAPIError("boom")
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
assert hass.states.get("media_player.playroom_yoto") is not None
assert mock_config_entry.runtime_data.last_update_success is True
mock_yoto_client.subscribe_player_events.side_effect = None
mock_yoto_client.subscribe_player_events.reset_mock()
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
mock_yoto_client.subscribe_player_events.assert_called_once_with("player-2")
async def test_stale_device_removed(
hass: HomeAssistant,
mock_yoto_client: MagicMock,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
freezer: FrozenDateTimeFactory,
) -> None:
"""A player removed from the account has its device dropped."""
await setup_integration(hass, mock_config_entry)
assert (
device_registry.async_get_device(identifiers={(DOMAIN, PLAYER_ID)}) is not None
)
mock_yoto_client.players.clear()
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
assert device_registry.async_get_device(identifiers={(DOMAIN, PLAYER_ID)}) is None
mock_yoto_client.unsubscribe_player_events.assert_called_once_with(PLAYER_ID)
+4 -3
View File
@@ -1,7 +1,7 @@
"""Tests for the Yoto media player platform."""
from typing import Any
from unittest.mock import MagicMock
from unittest.mock import MagicMock, patch
from freezegun.api import FrozenDateTimeFactory
import pytest
@@ -22,7 +22,7 @@ from homeassistant.components.media_player import (
SERVICE_VOLUME_SET,
MediaPlayerState,
)
from homeassistant.const import ATTR_ENTITY_ID, STATE_UNAVAILABLE
from homeassistant.const import ATTR_ENTITY_ID, STATE_UNAVAILABLE, Platform
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
from homeassistant.helpers import entity_registry as er
@@ -68,7 +68,8 @@ async def test_entity_state(
) -> None:
"""Snapshot the media player entity state."""
freezer.move_to("2026-05-08T12:00:00+00:00")
await setup_integration(hass, mock_config_entry)
with patch("homeassistant.components.yoto.PLATFORMS", [Platform.MEDIA_PLAYER]):
await setup_integration(hass, mock_config_entry)
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)