Add Button platform to Bravia TV (#78093)

* Add Button platform to Bravia TV

* Add button.py to coveragerc

* improve callable type
pull/78998/head
Artem Draft 2022-09-23 16:39:24 +03:00 committed by GitHub
parent 7c460cc641
commit ab4c1ebfd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 105 additions and 1 deletions

View File

@ -139,6 +139,7 @@ omit =
homeassistant/components/bosch_shc/sensor.py
homeassistant/components/bosch_shc/switch.py
homeassistant/components/braviatv/__init__.py
homeassistant/components/braviatv/button.py
homeassistant/components/braviatv/const.py
homeassistant/components/braviatv/coordinator.py
homeassistant/components/braviatv/entity.py

View File

@ -14,7 +14,11 @@ from homeassistant.helpers.aiohttp_client import async_create_clientsession
from .const import CONF_IGNORED_SOURCES, CONF_USE_PSK, DOMAIN
from .coordinator import BraviaTVCoordinator
PLATFORMS: Final[list[Platform]] = [Platform.MEDIA_PLAYER, Platform.REMOTE]
PLATFORMS: Final[list[Platform]] = [
Platform.BUTTON,
Platform.MEDIA_PLAYER,
Platform.REMOTE,
]
async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:

View File

@ -0,0 +1,89 @@
"""Button support for Bravia TV."""
from __future__ import annotations
from collections.abc import Callable, Coroutine
from dataclasses import dataclass
from homeassistant.components.button import (
ButtonDeviceClass,
ButtonEntity,
ButtonEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity import EntityCategory
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN
from .coordinator import BraviaTVCoordinator
from .entity import BraviaTVEntity
@dataclass
class BraviaTVButtonDescriptionMixin:
"""Mixin to describe a Bravia TV Button entity."""
press_action: Callable[[BraviaTVCoordinator], Coroutine]
@dataclass
class BraviaTVButtonDescription(
ButtonEntityDescription, BraviaTVButtonDescriptionMixin
):
"""Bravia TV Button description."""
BUTTONS: tuple[BraviaTVButtonDescription, ...] = (
BraviaTVButtonDescription(
key="reboot",
name="Reboot",
device_class=ButtonDeviceClass.RESTART,
entity_category=EntityCategory.CONFIG,
press_action=lambda coordinator: coordinator.async_reboot_device(),
),
BraviaTVButtonDescription(
key="terminate_apps",
name="Terminate apps",
entity_category=EntityCategory.CONFIG,
press_action=lambda coordinator: coordinator.async_terminate_apps(),
),
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Bravia TV Button entities."""
coordinator = hass.data[DOMAIN][config_entry.entry_id]
unique_id = config_entry.unique_id
assert unique_id is not None
async_add_entities(
BraviaTVButton(coordinator, unique_id, config_entry.title, description)
for description in BUTTONS
)
class BraviaTVButton(BraviaTVEntity, ButtonEntity):
"""Representation of a Bravia TV Button."""
entity_description: BraviaTVButtonDescription
def __init__(
self,
coordinator: BraviaTVCoordinator,
unique_id: str,
model: str,
description: BraviaTVButtonDescription,
) -> None:
"""Initialize the button."""
super().__init__(coordinator, unique_id, model)
self._attr_unique_id = f"{unique_id}_{description.key}"
self.entity_description = description
async def async_press(self) -> None:
"""Trigger the button action."""
await self.entity_description.press_action(self.coordinator)

View File

@ -287,3 +287,13 @@ class BraviaTVCoordinator(DataUpdateCoordinator[None]):
cmd,
commands_keys,
)
@catch_braviatv_errors
async def async_reboot_device(self) -> None:
"""Send command to reboot the device."""
await self.client.reboot()
@catch_braviatv_errors
async def async_terminate_apps(self) -> None:
"""Send command to terminate all applications."""
await self.client.terminate_apps()