remote.py

Go to the documentation of this file.

"""Support for the DIRECTV remote."""
 
from __future__ import annotations
 
from collections.abc import Iterable
from datetime import timedelta
import logging
from typing import Any
 
from directv import DIRECTV, DIRECTVError
 
from homeassistant.components.remote import ATTR_NUM_REPEATS, RemoteEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .entity import DIRECTVEntity
 
_LOGGER = logging.getLogger(__name__)
 
SCAN_INTERVAL = timedelta(minutes=2)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Load DirecTV remote based on a config entry."""
    dtv = hass.data[DOMAIN][entry.entry_id]
 
    async_add_entities(
        (
            DIRECTVRemote(
                dtv=dtv,
                name=str.title(location.name),
                address=location.address,
            )
            for location in dtv.device.locations
        ),
        True,
    )
 
 
class DIRECTVRemote(DIRECTVEntity, RemoteEntity):
    """Device that sends commands to a DirecTV receiver."""
 
    def __init__(self, *, dtv: DIRECTV, name: str, address: str = "0") -> None:
        """Initialize DirecTV remote."""
        super().__init__(
            dtv=dtv,
            name=name,
            address=address,
        )
 
        self._attr_unique_id_attr_unique_id = self._device_id_device_id
        self._attr_available_attr_available = False
        self._attr_is_on_attr_is_on = True
 
    async def async_update(self) -> None:
        """Update device state."""
        status = await self.dtvdtv.status(self._address_address)
 
        if status in ("active", "standby"):
            self._attr_available_attr_available = True
            self._attr_is_on_attr_is_on = status == "active"
        else:
            self._attr_available_attr_available = False
            self._attr_is_on_attr_is_on = False
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        await self.dtvdtv.remote("poweron", self._address_address)
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        await self.dtvdtv.remote("poweroff", self._address_address)
 
    async def async_send_command(self, command: Iterable[str], **kwargs: Any) -> None:
        """Send a command to a device.
 
        Supported keys: power, poweron, poweroff, format,
        pause, rew, replay, stop, advance, ffwd, record,
        play, guide, active, list, exit, back, menu, info,
        up, down, left, right, select, red, green, yellow,
        blue, chanup, chandown, prev, 0, 1, 2, 3, 4, 5,
        6, 7, 8, 9, dash, enter
        """
        num_repeats = kwargs[ATTR_NUM_REPEATS]
 
        for _ in range(num_repeats):
            for single_command in command:
                try:
                    await self.dtvdtv.remote(single_command, self._address_address)
                except DIRECTVError:
                    _LOGGER.exception(
                        "Sending command %s to device %s failed",
                        single_command,
                        self._device_id_device_id,
                    )