From ef61c0c3a4f3246879c8c088af3529bd58005dd5 Mon Sep 17 00:00:00 2001
From: Benoit Louy <benoit.louy@fastmail.com>
Date: Thu, 9 Aug 2018 13:58:16 -0400
Subject: [PATCH] Add PJLink media player platform (#15083)
* add pjlink media player component
* retrieve pjlink device name from projector if name isn't specified in configuration
* update .coveragerc
* fix style
* add missing docstrings
* address PR comments from @MartinHjelmare
* fix code style
* use snake case string for source names
* add missing period at the end of comment string
* rewrite method as function
* revert to use source name provided by projector
---
.coveragerc | 1 +
.../components/media_player/pjlink.py | 157 ++++++++++++++++++
requirements_all.txt | 3 +
3 files changed, 161 insertions(+)
create mode 100644 homeassistant/components/media_player/pjlink.py
diff --git a/.coveragerc b/.coveragerc
index 1e358cd7791..f06e9356d21 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -537,6 +537,7 @@ omit =
homeassistant/components/media_player/pandora.py
homeassistant/components/media_player/philips_js.py
homeassistant/components/media_player/pioneer.py
+ homeassistant/components/media_player/pjlink.py
homeassistant/components/media_player/plex.py
homeassistant/components/media_player/roku.py
homeassistant/components/media_player/russound_rio.py
diff --git a/homeassistant/components/media_player/pjlink.py b/homeassistant/components/media_player/pjlink.py
new file mode 100644
index 00000000000..5d3122256ea
--- /dev/null
+++ b/homeassistant/components/media_player/pjlink.py
@@ -0,0 +1,157 @@
+"""
+Support for controlling projector via the PJLink protocol.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/media_player.pjlink/
+"""
+import logging
+
+import voluptuous as vol
+
+from homeassistant.components.media_player import (
+ SUPPORT_TURN_OFF, SUPPORT_TURN_ON, SUPPORT_VOLUME_MUTE,
+ SUPPORT_SELECT_SOURCE, PLATFORM_SCHEMA, MediaPlayerDevice)
+from homeassistant.const import (
+ STATE_OFF, STATE_ON, CONF_HOST,
+ CONF_NAME, CONF_PASSWORD, CONF_PORT)
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['pypjlink2==1.2.0']
+
+_LOGGER = logging.getLogger(__name__)
+
+CONF_ENCODING = 'encoding'
+
+DEFAULT_PORT = 4352
+DEFAULT_ENCODING = 'utf-8'
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+ vol.Required(CONF_HOST): cv.string,
+ vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
+ vol.Optional(CONF_NAME): cv.string,
+ vol.Optional(CONF_ENCODING, default=DEFAULT_ENCODING): cv.string,
+ vol.Optional(CONF_PASSWORD): cv.string,
+})
+
+SUPPORT_PJLINK = SUPPORT_VOLUME_MUTE | \
+ SUPPORT_TURN_ON | SUPPORT_TURN_OFF | SUPPORT_SELECT_SOURCE
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+ """Set up the PJLink platform."""
+ host = config.get(CONF_HOST)
+ port = config.get(CONF_PORT)
+ name = config.get(CONF_NAME)
+ encoding = config.get(CONF_ENCODING)
+ password = config.get(CONF_PASSWORD)
+
+ if 'pjlink' not in hass.data:
+ hass.data['pjlink'] = {}
+ hass_data = hass.data['pjlink']
+
+ device_label = "{}:{}".format(host, port)
+ if device_label in hass_data:
+ return
+
+ device = PjLinkDevice(host, port, name, encoding, password)
+ hass_data[device_label] = device
+ add_devices([device], True)
+
+
+def format_input_source(input_source_name, input_source_number):
+ """Format input source for display in UI."""
+ return "{} {}".format(input_source_name, input_source_number)
+
+
+class PjLinkDevice(MediaPlayerDevice):
+ """Representation of a PJLink device."""
+
+ def __init__(self, host, port, name, encoding, password):
+ """Iinitialize the PJLink device."""
+ self._host = host
+ self._port = port
+ self._name = name
+ self._password = password
+ self._encoding = encoding
+ self._muted = False
+ self._pwstate = STATE_OFF
+ self._current_source = None
+ with self.projector() as projector:
+ if not self._name:
+ self._name = projector.get_name()
+ inputs = projector.get_inputs()
+ self._source_name_mapping = \
+ {format_input_source(*x): x for x in inputs}
+ self._source_list = sorted(self._source_name_mapping.keys())
+
+ def projector(self):
+ """Create PJLink Projector instance."""
+ from pypjlink import Projector
+ projector = Projector.from_address(self._host, self._port,
+ self._encoding)
+ projector.authenticate(self._password)
+ return projector
+
+ def update(self):
+ """Get the latest state from the device."""
+ with self.projector() as projector:
+ pwstate = projector.get_power()
+ if pwstate == 'off':
+ self._pwstate = STATE_OFF
+ else:
+ self._pwstate = STATE_ON
+ self._muted = projector.get_mute()[1]
+ self._current_source = \
+ format_input_source(*projector.get_input())
+
+ @property
+ def name(self):
+ """Return the name of the device."""
+ return self._name
+
+ @property
+ def state(self):
+ """Return the state of the device."""
+ return self._pwstate
+
+ @property
+ def is_volume_muted(self):
+ """Return boolean indicating mute status."""
+ return self._muted
+
+ @property
+ def source(self):
+ """Return current input source."""
+ return self._current_source
+
+ @property
+ def source_list(self):
+ """Return all available input sources."""
+ return self._source_list
+
+ @property
+ def supported_features(self):
+ """Return projector supported features."""
+ return SUPPORT_PJLINK
+
+ def turn_off(self):
+ """Turn projector off."""
+ with self.projector() as projector:
+ projector.set_power('off')
+
+ def turn_on(self):
+ """Turn projector on."""
+ with self.projector() as projector:
+ projector.set_power('on')
+
+ def mute_volume(self, mute):
+ """Mute (true) of unmute (false) media player."""
+ with self.projector() as projector:
+ from pypjlink import MUTE_AUDIO
+ projector.set_mute(MUTE_AUDIO, mute)
+
+ def select_source(self, source):
+ """Set the input source."""
+ source = self._source_name_mapping[source]
+ with self.projector() as projector:
+ projector.set_input(*source)
diff --git a/requirements_all.txt b/requirements_all.txt
index 6ec99e84953..c6b4898dc4c 100644
--- a/requirements_all.txt
+++ b/requirements_all.txt
@@ -984,6 +984,9 @@ pyotp==2.2.6
# homeassistant.components.weather.openweathermap
pyowm==2.9.0
+# homeassistant.components.media_player.pjlink
+pypjlink2==1.2.0
+
# homeassistant.components.sensor.pollen
pypollencom==2.1.0
--
GitLab