Adding enigma2 media player (#21271)

* Updated based on review comments

* fix hound

* Update homeassistant/components/media_player/enigma2.py

* Update homeassistant/components/media_player/enigma2.py

* Update homeassistant/components/media_player/enigma2.py

* Update enigma2.py

* Update enigma2.py

* Move file and update docsstring

* Fix path in coverage rc file

* requirements

* Update media_player.py

* Setup discovery for e2

* Handle discovered devices

* Add reqs

* Update for auth for openwebif

* Forget to set DEFAULT_PASSWORD

* Add source selection

* Fix get current source name

* Update pip version

* - adding some extra attributes
- support better recording playback integration

* bump pip version

* Bump pip

* Adding prefer_picon config option

* Updates to move logic into pypi module

* bump pip

* bump pip

* - remove http dependancy.

- rename prefer_picon to use_channel_icon

* Bump pypi to fix toggle bug.

also fix travis

also move setup out of init

.coveragerc

@@ -155,6 +155,7 @@ omit =
     homeassistant/components/elkm1/*
     homeassistant/components/emoncms_history/*
     homeassistant/components/emulated_hue/upnp.py
+    homeassistant/components/enigma2/media_player.py
     homeassistant/components/enocean/*
     homeassistant/components/envisalink/*
     homeassistant/components/esphome/__init__.py

homeassistant/components/discovery/__init__.py

@@ -31,6 +31,7 @@ SERVICE_AXIS = 'axis'
 SERVICE_DAIKIN = 'daikin'
 SERVICE_DECONZ = 'deconz'
 SERVICE_DLNA_DMR = 'dlna_dmr'
+SERVICE_ENIGMA2 = 'enigma2'
 SERVICE_FREEBOX = 'freebox'
 SERVICE_HASS_IOS_APP = 'hass_ios'
 SERVICE_HASSIO = 'hassio'
@@ -68,6 +69,7 @@ SERVICE_HANDLERS = {
     SERVICE_HASSIO: ('hassio', None),
     SERVICE_AXIS: ('axis', None),
     SERVICE_APPLE_TV: ('apple_tv', None),
+    SERVICE_ENIGMA2: ('enigma2', None),
     SERVICE_ROKU: ('roku', None),
     SERVICE_WINK: ('wink', None),
     SERVICE_XIAOMI_GW: ('xiaomi_aqara', None),

homeassistant/components/enigma2/__init__.py

@@ -0,0 +1,18 @@
+"""Support for Enigma2 devices."""
+from homeassistant.components.discovery import SERVICE_ENIGMA2
+from homeassistant.helpers.discovery import load_platform
+from homeassistant.helpers import discovery
+
+DOMAIN = 'enigma2'
+
+
+def setup(hass, config):
+    """Set up the Enigma2 platform."""
+    def device_discovered(service, info):
+        """Handle when an Enigma2 device has been discovered."""
+        load_platform(hass, 'media_player', DOMAIN, info, config)
+
+    discovery.listen(
+        hass, SERVICE_ENIGMA2, device_discovered)
+
+    return True

homeassistant/components/enigma2/media_player.py

@@ -0,0 +1,221 @@
+"""Support for Enigma2 media players."""
+import logging
+import asyncio
+
+import voluptuous as vol
+
+from homeassistant.components.media_player import MediaPlayerDevice
+from homeassistant.helpers.config_validation import (PLATFORM_SCHEMA)
+from homeassistant.components.media_player.const import (
+    SUPPORT_NEXT_TRACK, SUPPORT_PAUSE, SUPPORT_PREVIOUS_TRACK, SUPPORT_TURN_ON,
+    SUPPORT_TURN_OFF, SUPPORT_VOLUME_MUTE, SUPPORT_VOLUME_SET, SUPPORT_STOP,
+    SUPPORT_SELECT_SOURCE, SUPPORT_VOLUME_STEP, MEDIA_TYPE_TVSHOW)
+from homeassistant.const import (
+    CONF_HOST, CONF_NAME, CONF_USERNAME, CONF_PASSWORD, CONF_SSL,
+    STATE_OFF, STATE_ON, STATE_PLAYING, CONF_PORT)
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['openwebifpy==1.2.7']
+
+_LOGGER = logging.getLogger(__name__)
+
+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'
+
+CONF_USE_CHANNEL_ICON = "use_channel_icon"
+
+DEFAULT_NAME = 'Enigma2 Media Player'
+DEFAULT_PORT = 80
+DEFAULT_SSL = False
+DEFAULT_USE_CHANNEL_ICON = False
+DEFAULT_USERNAME = 'root'
+DEFAULT_PASSWORD = 'dreambox'
+
+SUPPORTED_ENIGMA2 = SUPPORT_VOLUME_SET | SUPPORT_VOLUME_MUTE | \
+                    SUPPORT_TURN_OFF | SUPPORT_NEXT_TRACK | SUPPORT_STOP | \
+                    SUPPORT_PREVIOUS_TRACK | SUPPORT_VOLUME_STEP | \
+                    SUPPORT_TURN_ON | SUPPORT_PAUSE | SUPPORT_SELECT_SOURCE
+
+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,
+})
+
+
+def setup_platform(hass, config, add_devices, discovery_info=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
+
+    from openwebif.api import CreateDevice
+    device = \
+        CreateDevice(host=config[CONF_HOST],
+                     port=config.get(CONF_PORT),
+                     username=config.get(CONF_USERNAME),
+                     password=config.get(CONF_PASSWORD),
+                     is_https=config.get(CONF_SSL),
+                     prefer_picon=config.get(CONF_USE_CHANNEL_ICON))
+
+    add_devices([Enigma2Device(config[CONF_NAME], device)], True)
+
+
+class Enigma2Device(MediaPlayerDevice):
+    """Representation of an Enigma2 box."""
+
+    def __init__(self, name, device):
+        """Initialize the Enigma2 device."""
+        self._name = name
+        self.e2_box = device
+
+    @property
+    def name(self):
+        """Return the name of the device."""
+        return self._name
+
+    @property
+    def state(self):
+        """Return the state of the device."""
+        if self.e2_box.is_recording_playback:
+            return STATE_PLAYING
+        return STATE_OFF if self.e2_box.in_standby else STATE_ON
+
+    @property
+    def supported_features(self):
+        """Flag of media commands that are supported."""
+        return SUPPORTED_ENIGMA2
+
+    def turn_off(self):
+        """Turn off media player."""
+        self.e2_box.turn_off()
+
+    def turn_on(self):
+        """Turn the media player on."""
+        self.e2_box.turn_on()
+
+    @property
+    def media_title(self):
+        """Title of current playing media."""
+        return self.e2_box.current_service_channel_name
+
+    @property
+    def media_series_title(self):
+        """Return the title of current episode of TV show."""
+        return self.e2_box.current_programme_name
+
+    @property
+    def media_channel(self):
+        """Channel of current playing media."""
+        return self.e2_box.current_service_channel_name
+
+    @property
+    def media_content_id(self):
+        """Service Ref of current playing media."""
+        return self.e2_box.current_service_ref
+
+    @property
+    def media_content_type(self):
+        """Type of video currently playing."""
+        return MEDIA_TYPE_TVSHOW
+
+    @property
+    def is_volume_muted(self):
+        """Boolean if volume is currently muted."""
+        return self.e2_box.muted
+
+    @property
+    def media_image_url(self):
+        """Picon url for the channel."""
+        return self.e2_box.picon_url
+
+    def set_volume_level(self, volume):
+        """Set volume level, range 0..1."""
+        self.e2_box.set_volume(int(volume * 100))
+
+    def volume_up(self):
+        """Volume up the media player."""
+        self.e2_box.set_volume(int(self.e2_box.volume * 100) + 5)
+
+    def volume_down(self):
+        """Volume down media player."""
+        self.e2_box.set_volume(int(self.e2_box.volume * 100) - 5)
+
+    @property
+    def volume_level(self):
+        """Volume level of the media player (0..1)."""
+        return self.e2_box.volume
+
+    def media_stop(self):
+        """Send stop command."""
+        self.e2_box.set_stop()
+
+    def media_play(self):
+        """Play media."""
+        self.e2_box.toggle_play_pause()
+
+    def media_pause(self):
+        """Pause the media player."""
+        self.e2_box.toggle_play_pause()
+
+    def media_next_track(self):
+        """Send next track command."""
+        self.e2_box.set_channel_up()
+
+    def media_previous_track(self):
+        """Send next track command."""
+        self.e2_box.set_channel_down()
+
+    def mute_volume(self, mute):
+        """Mute or unmute."""
+        self.e2_box.mute_volume()
+
+    @property
+    def source(self):
+        """Return the current input source."""
+        return self.e2_box.current_service_channel_name
+
+    @property
+    def source_list(self):
+        """List of available input sources."""
+        return self.e2_box.source_list
+
+    @asyncio.coroutine
+    def async_select_source(self, source):
+        """Select input source."""
+        self.e2_box.select_source(self.e2_box.sources[source])
+
+    def update(self):
+        """Update state of the media_player."""
+        self.e2_box.update()
+
+    @property
+    def device_state_attributes(self):
+        """Return device specific state attributes."""
+        attributes = {}
+        if not self.e2_box.in_standby:
+            attributes[ATTR_MEDIA_CURRENTLY_RECORDING] = \
+                self.e2_box.status_info['isRecording']
+            attributes[ATTR_MEDIA_DESCRIPTION] = \
+                self.e2_box.status_info['currservice_fulldescription']
+            attributes[ATTR_MEDIA_START_TIME] = \
+                self.e2_box.status_info['currservice_begin']
+            attributes[ATTR_MEDIA_END_TIME] = \
+                self.e2_box.status_info['currservice_end']
+
+        return attributes

requirements_all.txt

@@ -779,6 +779,9 @@ openhomedevice==0.4.2
 # homeassistant.components.air_quality.opensensemap
 opensensemap-api==0.1.5
 
+# homeassistant.components.enigma2.media_player
+openwebifpy==1.2.7
+
 # homeassistant.components.device_tracker.luci
 openwrt-luci-rpc==1.0.5