263 lines
8.7 KiB
Python
263 lines
8.7 KiB
Python
"""Support for Enigma2 media players."""
|
|
from __future__ import annotations
|
|
|
|
from openwebif.api import OpenWebIfDevice
|
|
from openwebif.enums import RemoteControlCodes
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.media_player import (
|
|
MediaPlayerEntity,
|
|
MediaPlayerEntityFeature,
|
|
MediaPlayerState,
|
|
MediaType,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_NAME,
|
|
CONF_PASSWORD,
|
|
CONF_PORT,
|
|
CONF_SSL,
|
|
CONF_USERNAME,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.config_validation import PLATFORM_SCHEMA
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
from .const import (
|
|
CONF_DEEP_STANDBY,
|
|
CONF_MAC_ADDRESS,
|
|
CONF_SOURCE_BOUQUET,
|
|
CONF_USE_CHANNEL_ICON,
|
|
DEFAULT_DEEP_STANDBY,
|
|
DEFAULT_MAC_ADDRESS,
|
|
DEFAULT_NAME,
|
|
DEFAULT_PASSWORD,
|
|
DEFAULT_PORT,
|
|
DEFAULT_SOURCE_BOUQUET,
|
|
DEFAULT_SSL,
|
|
DEFAULT_USE_CHANNEL_ICON,
|
|
DEFAULT_USERNAME,
|
|
)
|
|
|
|
ATTR_MEDIA_CURRENTLY_RECORDING = "media_currently_recording"
|
|
ATTR_MEDIA_DESCRIPTION = "media_description"
|
|
ATTR_MEDIA_END_TIME = "media_end_time"
|
|
ATTR_MEDIA_START_TIME = "media_start_time"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
|
|
vol.Optional(CONF_USERNAME, default=DEFAULT_USERNAME): cv.string,
|
|
vol.Optional(CONF_PASSWORD, default=DEFAULT_PASSWORD): cv.string,
|
|
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
|
|
vol.Optional(
|
|
CONF_USE_CHANNEL_ICON, default=DEFAULT_USE_CHANNEL_ICON
|
|
): cv.boolean,
|
|
vol.Optional(CONF_DEEP_STANDBY, default=DEFAULT_DEEP_STANDBY): cv.boolean,
|
|
vol.Optional(CONF_MAC_ADDRESS, default=DEFAULT_MAC_ADDRESS): cv.string,
|
|
vol.Optional(CONF_SOURCE_BOUQUET, default=DEFAULT_SOURCE_BOUQUET): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up of an enigma2 media player."""
|
|
if discovery_info:
|
|
# Discovery gives us the streaming service port (8001)
|
|
# which is not useful as OpenWebif never runs on that port.
|
|
# So use the default port instead.
|
|
config[CONF_PORT] = DEFAULT_PORT
|
|
config[CONF_NAME] = discovery_info["hostname"]
|
|
config[CONF_HOST] = discovery_info["host"]
|
|
config[CONF_USERNAME] = DEFAULT_USERNAME
|
|
config[CONF_PASSWORD] = DEFAULT_PASSWORD
|
|
config[CONF_SSL] = DEFAULT_SSL
|
|
config[CONF_USE_CHANNEL_ICON] = DEFAULT_USE_CHANNEL_ICON
|
|
config[CONF_MAC_ADDRESS] = DEFAULT_MAC_ADDRESS
|
|
config[CONF_DEEP_STANDBY] = DEFAULT_DEEP_STANDBY
|
|
config[CONF_SOURCE_BOUQUET] = DEFAULT_SOURCE_BOUQUET
|
|
|
|
device = OpenWebIfDevice(
|
|
host=config[CONF_HOST],
|
|
port=config.get(CONF_PORT),
|
|
username=config.get(CONF_USERNAME),
|
|
password=config.get(CONF_PASSWORD),
|
|
is_https=config[CONF_SSL],
|
|
turn_off_to_deep=config.get(CONF_DEEP_STANDBY),
|
|
source_bouquet=config.get(CONF_SOURCE_BOUQUET),
|
|
)
|
|
|
|
async_add_entities(
|
|
[Enigma2Device(config[CONF_NAME], device, await device.get_about())]
|
|
)
|
|
|
|
|
|
class Enigma2Device(MediaPlayerEntity):
|
|
"""Representation of an Enigma2 box."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
_attr_media_content_type = MediaType.TVSHOW
|
|
_attr_supported_features = (
|
|
MediaPlayerEntityFeature.VOLUME_SET
|
|
| MediaPlayerEntityFeature.VOLUME_MUTE
|
|
| MediaPlayerEntityFeature.TURN_OFF
|
|
| MediaPlayerEntityFeature.NEXT_TRACK
|
|
| MediaPlayerEntityFeature.STOP
|
|
| MediaPlayerEntityFeature.PREVIOUS_TRACK
|
|
| MediaPlayerEntityFeature.VOLUME_STEP
|
|
| MediaPlayerEntityFeature.TURN_ON
|
|
| MediaPlayerEntityFeature.PAUSE
|
|
| MediaPlayerEntityFeature.SELECT_SOURCE
|
|
)
|
|
_attr_volume_step = 5 / 100
|
|
|
|
def __init__(self, name: str, device: OpenWebIfDevice, about: dict) -> None:
|
|
"""Initialize the Enigma2 device."""
|
|
self._name = name
|
|
self._device: OpenWebIfDevice = device
|
|
self._device.mac_address = about["info"]["ifaces"][0]["mac"]
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device."""
|
|
return self._name
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return the unique ID for this entity."""
|
|
return self._device.mac_address
|
|
|
|
@property
|
|
def state(self) -> MediaPlayerState:
|
|
"""Return the state of the device."""
|
|
return (
|
|
MediaPlayerState.OFF
|
|
if self._device.status.in_standby
|
|
else MediaPlayerState.ON
|
|
)
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return True if the device is available."""
|
|
return not self._device.is_offline
|
|
|
|
async def async_turn_off(self) -> None:
|
|
"""Turn off media player."""
|
|
await self._device.turn_off()
|
|
|
|
async def async_turn_on(self) -> None:
|
|
"""Turn the media player on."""
|
|
await self._device.turn_on()
|
|
|
|
@property
|
|
def media_title(self):
|
|
"""Title of current playing media."""
|
|
return self._device.status.currservice.station
|
|
|
|
@property
|
|
def media_series_title(self):
|
|
"""Return the title of current episode of TV show."""
|
|
return self._device.status.currservice.name
|
|
|
|
@property
|
|
def media_channel(self):
|
|
"""Channel of current playing media."""
|
|
return self._device.status.currservice.station
|
|
|
|
@property
|
|
def media_content_id(self):
|
|
"""Service Ref of current playing media."""
|
|
return self._device.status.currservice.serviceref
|
|
|
|
@property
|
|
def is_volume_muted(self):
|
|
"""Boolean if volume is currently muted."""
|
|
return self._device.status.muted
|
|
|
|
@property
|
|
def media_image_url(self):
|
|
"""Picon url for the channel."""
|
|
return self._device.picon_url
|
|
|
|
async def async_set_volume_level(self, volume: float) -> None:
|
|
"""Set volume level, range 0..1."""
|
|
await self._device.set_volume(int(volume * 100))
|
|
|
|
@property
|
|
def volume_level(self):
|
|
"""Volume level of the media player (0..1)."""
|
|
return (
|
|
self._device.status.volume / 100
|
|
if self._device.status.volume is not None
|
|
else None
|
|
)
|
|
|
|
async def async_media_stop(self) -> None:
|
|
"""Send stop command."""
|
|
await self._device.send_remote_control_action(RemoteControlCodes.STOP)
|
|
|
|
async def async_media_play(self) -> None:
|
|
"""Play media."""
|
|
await self._device.send_remote_control_action(RemoteControlCodes.PLAY)
|
|
|
|
async def async_media_pause(self) -> None:
|
|
"""Pause the media player."""
|
|
await self._device.send_remote_control_action(RemoteControlCodes.PAUSE)
|
|
|
|
async def async_media_next_track(self) -> None:
|
|
"""Send next track command."""
|
|
await self._device.send_remote_control_action(RemoteControlCodes.CHANNEL_UP)
|
|
|
|
async def async_media_previous_track(self) -> None:
|
|
"""Send next track command."""
|
|
self._device.send_remote_control_action(RemoteControlCodes.CHANNEL_DOWN)
|
|
|
|
async def async_mute_volume(self, mute: bool) -> None:
|
|
"""Mute or unmute."""
|
|
await self._device.toggle_mute()
|
|
|
|
@property
|
|
def source(self):
|
|
"""Return the current input source."""
|
|
return self._device.status.currservice.station
|
|
|
|
@property
|
|
def source_list(self):
|
|
"""List of available input sources."""
|
|
return self._device.source_list
|
|
|
|
async def async_select_source(self, source: str) -> None:
|
|
"""Select input source."""
|
|
await self._device.zap(self._device.sources[source])
|
|
|
|
async def async_update(self) -> None:
|
|
"""Update state of the media_player."""
|
|
await self._device.update()
|
|
|
|
@property
|
|
def extra_state_attributes(self):
|
|
"""Return device specific state attributes.
|
|
|
|
isRecording: Is the box currently recording.
|
|
currservice_fulldescription: Full program description.
|
|
currservice_begin: is in the format '21:00'.
|
|
currservice_end: is in the format '21:00'.
|
|
"""
|
|
if self._device.status.in_standby:
|
|
return {}
|
|
return {
|
|
ATTR_MEDIA_CURRENTLY_RECORDING: self._device.status.is_recording,
|
|
ATTR_MEDIA_DESCRIPTION: self._device.status.currservice.fulldescription,
|
|
ATTR_MEDIA_START_TIME: self._device.status.currservice.begin,
|
|
ATTR_MEDIA_END_TIME: self._device.status.currservice.end,
|
|
}
|