From 0af850cbb673bcc3e9179d55e22070959da594b7 Mon Sep 17 00:00:00 2001 From: Sid <27780930+autinerd@users.noreply.github.com> Date: Sat, 23 Dec 2023 16:08:53 +0100 Subject: [PATCH] Restructure enigma2 integration to use async (#104206) Restructure the enigma2 integration to use async --- .../components/enigma2/manifest.json | 2 +- .../components/enigma2/media_player.py | 112 ++++++++++-------- requirements_all.txt | 2 +- 3 files changed, 62 insertions(+), 54 deletions(-) diff --git a/homeassistant/components/enigma2/manifest.json b/homeassistant/components/enigma2/manifest.json index a70d5a05eeb..ab930ba540d 100644 --- a/homeassistant/components/enigma2/manifest.json +++ b/homeassistant/components/enigma2/manifest.json @@ -5,5 +5,5 @@ "documentation": "https://www.home-assistant.io/integrations/enigma2", "iot_class": "local_polling", "loggers": ["openwebif"], - "requirements": ["openwebifpy==3.2.7"] + "requirements": ["openwebifpy==4.0.0"] } diff --git a/homeassistant/components/enigma2/media_player.py b/homeassistant/components/enigma2/media_player.py index 8e24caf1b08..ee788251acb 100644 --- a/homeassistant/components/enigma2/media_player.py +++ b/homeassistant/components/enigma2/media_player.py @@ -1,7 +1,8 @@ """Support for Enigma2 media players.""" from __future__ import annotations -from openwebif.api import CreateDevice +from openwebif.api import OpenWebIfDevice +from openwebif.enums import RemoteControlCodes import voluptuous as vol from homeassistant.components.media_player import ( @@ -63,10 +64,10 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( ) -def setup_platform( +async def async_setup_platform( hass: HomeAssistant, config: ConfigType, - add_devices: AddEntitiesCallback, + async_add_entities: AddEntitiesCallback, discovery_info: DiscoveryInfoType | None = None, ) -> None: """Set up of an enigma2 media player.""" @@ -85,24 +86,26 @@ def setup_platform( config[CONF_DEEP_STANDBY] = DEFAULT_DEEP_STANDBY config[CONF_SOURCE_BOUQUET] = DEFAULT_SOURCE_BOUQUET - device = CreateDevice( + 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], - prefer_picon=config.get(CONF_USE_CHANNEL_ICON), - mac_address=config.get(CONF_MAC_ADDRESS), turn_off_to_deep=config.get(CONF_DEEP_STANDBY), source_bouquet=config.get(CONF_SOURCE_BOUQUET), ) - add_devices([Enigma2Device(config[CONF_NAME], device)], True) + 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 @@ -118,10 +121,11 @@ class Enigma2Device(MediaPlayerEntity): ) _attr_volume_step = 5 / 100 - def __init__(self, name, device): + def __init__(self, name: str, device: OpenWebIfDevice, about: dict) -> None: """Initialize the Enigma2 device.""" self._name = name - self.e2_box = device + self._device: OpenWebIfDevice = device + self._device.mac_address = about["info"]["ifaces"][0]["mac"] @property def name(self): @@ -131,108 +135,114 @@ class Enigma2Device(MediaPlayerEntity): @property def unique_id(self): """Return the unique ID for this entity.""" - return self.e2_box.mac_address + return self._device.mac_address @property def state(self) -> MediaPlayerState: """Return the state of the device.""" - if self.e2_box.is_recording_playback: - return MediaPlayerState.PLAYING - return MediaPlayerState.OFF if self.e2_box.in_standby else MediaPlayerState.ON + 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.e2_box.is_offline + return not self._device.is_offline - def turn_off(self) -> None: + async def async_turn_off(self) -> None: """Turn off media player.""" - self.e2_box.turn_off() + await self._device.turn_off() - def turn_on(self) -> None: + async def async_turn_on(self) -> None: """Turn the media player on.""" - self.e2_box.turn_on() + await self._device.turn_on() @property def media_title(self): """Title of current playing media.""" - return self.e2_box.current_service_channel_name + return self._device.status.currservice.station @property def media_series_title(self): """Return the title of current episode of TV show.""" - return self.e2_box.current_programme_name + return self._device.status.currservice.name @property def media_channel(self): """Channel of current playing media.""" - return self.e2_box.current_service_channel_name + return self._device.status.currservice.station @property def media_content_id(self): """Service Ref of current playing media.""" - return self.e2_box.current_service_ref + return self._device.status.currservice.serviceref @property def is_volume_muted(self): """Boolean if volume is currently muted.""" - return self.e2_box.muted + return self._device.status.muted @property def media_image_url(self): """Picon url for the channel.""" - return self.e2_box.picon_url + return self._device.picon_url - def set_volume_level(self, volume: float) -> None: + async def async_set_volume_level(self, volume: float) -> None: """Set volume level, range 0..1.""" - self.e2_box.set_volume(int(volume * 100)) + await self._device.set_volume(int(volume * 100)) @property def volume_level(self): """Volume level of the media player (0..1).""" - return self.e2_box.volume + return ( + self._device.status.volume / 100 + if self._device.status.volume is not None + else None + ) - def media_stop(self) -> None: + async def async_media_stop(self) -> None: """Send stop command.""" - self.e2_box.set_stop() + await self._device.send_remote_control_action(RemoteControlCodes.STOP) - def media_play(self) -> None: + async def async_media_play(self) -> None: """Play media.""" - self.e2_box.toggle_play_pause() + await self._device.send_remote_control_action(RemoteControlCodes.PLAY) - def media_pause(self) -> None: + async def async_media_pause(self) -> None: """Pause the media player.""" - self.e2_box.toggle_play_pause() + await self._device.send_remote_control_action(RemoteControlCodes.PAUSE) - def media_next_track(self) -> None: + async def async_media_next_track(self) -> None: """Send next track command.""" - self.e2_box.set_channel_up() + await self._device.send_remote_control_action(RemoteControlCodes.CHANNEL_UP) - def media_previous_track(self) -> None: + async def async_media_previous_track(self) -> None: """Send next track command.""" - self.e2_box.set_channel_down() + self._device.send_remote_control_action(RemoteControlCodes.CHANNEL_DOWN) - def mute_volume(self, mute: bool) -> None: + async def async_mute_volume(self, mute: bool) -> None: """Mute or unmute.""" - self.e2_box.mute_volume() + await self._device.toggle_mute() @property def source(self): """Return the current input source.""" - return self.e2_box.current_service_channel_name + return self._device.status.currservice.station @property def source_list(self): """List of available input sources.""" - return self.e2_box.source_list + return self._device.source_list - def select_source(self, source: str) -> None: + async def async_select_source(self, source: str) -> None: """Select input source.""" - self.e2_box.select_source(self.e2_box.sources[source]) + await self._device.zap(self._device.sources[source]) - def update(self) -> None: + async def async_update(self) -> None: """Update state of the media_player.""" - self.e2_box.update() + await self._device.update() @property def extra_state_attributes(self): @@ -243,13 +253,11 @@ class Enigma2Device(MediaPlayerEntity): currservice_begin: is in the format '21:00'. currservice_end: is in the format '21:00'. """ - if self.e2_box.in_standby: + if self._device.status.in_standby: return {} return { - ATTR_MEDIA_CURRENTLY_RECORDING: self.e2_box.status_info["isRecording"], - ATTR_MEDIA_DESCRIPTION: self.e2_box.status_info[ - "currservice_fulldescription" - ], - ATTR_MEDIA_START_TIME: self.e2_box.status_info["currservice_begin"], - ATTR_MEDIA_END_TIME: self.e2_box.status_info["currservice_end"], + 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, } diff --git a/requirements_all.txt b/requirements_all.txt index 0e82fbedfc5..9ab4f780e12 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -1425,7 +1425,7 @@ openhomedevice==2.2.0 opensensemap-api==0.2.0 # homeassistant.components.enigma2 -openwebifpy==3.2.7 +openwebifpy==4.0.0 # homeassistant.components.luci openwrt-luci-rpc==1.1.16