/
media_player.py
471 lines (402 loc) · 14.5 KB
/
media_player.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
"""Support for interface with an Samsung TV."""
import asyncio
from datetime import timedelta
import logging
import socket
import time
import requests
import json
import voluptuous as vol
from homeassistant.components.media_player import MediaPlayerDevice, PLATFORM_SCHEMA
from homeassistant.components.media_player.const import (
MEDIA_TYPE_CHANNEL,
SUPPORT_NEXT_TRACK,
SUPPORT_PAUSE,
SUPPORT_PLAY,
SUPPORT_PLAY_MEDIA,
SUPPORT_PREVIOUS_TRACK,
SUPPORT_SELECT_SOURCE,
SUPPORT_TURN_OFF,
SUPPORT_TURN_ON,
SUPPORT_VOLUME_MUTE,
SUPPORT_VOLUME_STEP,
SUPPORT_VOLUME_SET,
MEDIA_TYPE_URL,
MEDIA_TYPE_VIDEO,
MEDIA_TYPE_PLAYLIST,
MEDIA_TYPE_MUSIC,
MEDIA_TYPE_APP
)
MEDIA_TYPE_KEY = 'key'
from homeassistant.const import (
CONF_HOST,
CONF_MAC,
CONF_NAME,
CONF_PORT,
CONF_TIMEOUT,
STATE_OFF,
STATE_ON,
)
import homeassistant.helpers.config_validation as cv
from homeassistant.util import dt as dt_util
_LOGGER = logging.getLogger(__name__)
DEFAULT_NAME = "Samsung TV Remote"
DEFAULT_PORT = 55000
DEFAULT_TIMEOUT = 10
KEY_PRESS_TIMEOUT = 1.2
KNOWN_DEVICES_KEY = "samsungtv_known_devices"
SOURCES = {"TV": "KEY_TV", "HDMI": "KEY_HDMI"}
SUPPORT_SAMSUNGTV = (
SUPPORT_PAUSE
| SUPPORT_VOLUME_STEP
| SUPPORT_VOLUME_MUTE
| SUPPORT_VOLUME_SET
| SUPPORT_PREVIOUS_TRACK
| SUPPORT_SELECT_SOURCE
| SUPPORT_NEXT_TRACK
| SUPPORT_TURN_OFF
| SUPPORT_PLAY
| SUPPORT_PLAY_MEDIA
)
CONF_SOURCELIST = "sourcelist"
CONF_APPLIST = "applist"
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_MAC): cv.string,
vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
vol.Optional(CONF_SOURCELIST): cv.string,
vol.Optional(CONF_APPLIST): cv.string,
}
)
def setup_platform(hass, config, add_entities, discovery_info=None):
"""Set up the Samsung TV platform."""
known_devices = hass.data.get(KNOWN_DEVICES_KEY)
if known_devices is None:
known_devices = set()
hass.data[KNOWN_DEVICES_KEY] = known_devices
uuid = None
if config.get(CONF_SOURCELIST) is not None:
sourcelist = json.loads(config.get(CONF_SOURCELIST))
else:
sourcelist = SOURCES
if config.get(CONF_APPLIST) is not None:
applist = config.get(CONF_APPLIST).split(", ")
else:
applist = []
# Is this a manual configuration?
if config.get(CONF_HOST) is not None:
host = config.get(CONF_HOST)
port = config.get(CONF_PORT)
name = config.get(CONF_NAME)
mac = config.get(CONF_MAC)
timeout = config.get(CONF_TIMEOUT)
elif discovery_info is not None:
tv_name = discovery_info.get("name")
model = discovery_info.get("model_name")
host = discovery_info.get("host")
name = f"{tv_name} ({model})"
port = DEFAULT_PORT
timeout = DEFAULT_TIMEOUT
mac = None
udn = discovery_info.get("udn")
if udn and udn.startswith("uuid:"):
uuid = udn[len("uuid:") :]
else:
_LOGGER.warning("Cannot determine device")
return
# Only add a device once, so discovered devices do not override manual
# config.
ip_addr = socket.gethostbyname(host)
if ip_addr not in known_devices:
known_devices.add(ip_addr)
add_entities([SamsungTVDevice(host, port, name, timeout, mac, uuid, sourcelist, applist)])
_LOGGER.info("Samsung TV %s:%d added as '%s'", host, port, name)
else:
_LOGGER.info("Ignoring duplicate Samsung TV %s:%d", host, port)
class SamsungTVDevice(MediaPlayerDevice):
"""Representation of a Samsung TV."""
def __init__(self, host, port, name, timeout, mac, uuid, sourcelist, applist):
"""Initialize the Samsung device."""
from .samsungctl import exceptions
from .samsungctl import Remote
from .samsungctl import Application
from .samsungctl import Upnp
import wakeonlan
# Save a reference to the imported classes
self._exceptions_class = exceptions
self._remote_class = Remote
self._application_class = Application
self._upnp_class = Upnp
self._name = name
self._mac = mac
self._uuid = uuid
self._wol = wakeonlan
self._sourcelist = sourcelist
self._applist = applist
# Assume that the TV is not muted
self._muted = False
self._volume = 0
# Assume that the TV is in Play mode
self._playing = True
self._state = None
self._remote = None
self._upnp = None
self._application = None
self._current_source = None
# Mark the end of a shutdown command (need to wait 15 seconds before
# sending the next command to avoid turning the TV back ON).
self._end_of_power_off = None
# Generate a configuration for the Samsung library
self._config = {
"name": "HomeAssistant",
"description": name,
"id": "ha.component.samsung",
"port": port,
"host": host,
"timeout": timeout,
}
if self._config["port"] in (8001, 8002):
self._config["method"] = "websocket"
else:
self._config["method"] = "legacy"
def update(self):
"""Update state of device."""
if self._config["port"] == 8002:
# retry_count = 1
# for _ in range(retry_count + 1):
try:
r = requests.get("http://{}:9197/dmr".format(self._config['host']), timeout=0.2)
self._state = STATE_ON
# break
except:
self._state = STATE_OFF
else:
self.send_key("KEY")
def get_remote(self):
"""Create or return a remote control instance."""
if self._remote is None:
# We need to create a new instance to reconnect.
self._remote = self._remote_class(self._config)
return self._remote
def get_upnp(self):
"""Create or return a upnp device."""
if self._upnp is None:
# We need to create a new instance to reconnect.
self._upnp = self._upnp_class(self._config)
return self._upnp
def get_application(self):
"""Create or return an application management object."""
if self._application is None:
self._application = self._application_class(self._config)
return self._application
def send_key(self, key):
"""Send a key to the tv and handles exceptions."""
if self._power_off_in_progress() and key not in ("KEY_POWER", "KEY_POWEROFF"):
_LOGGER.info("TV is powering off, not sending command: %s", key)
return
try:
# recreate connection if connection was dead
retry_count = 1
for _ in range(retry_count + 1):
try:
self.get_remote().control(key)
break
except (self._exceptions_class.ConnectionClosed, BrokenPipeError):
# BrokenPipe can occur when the commands is sent to fast
self._remote = None
self._state = STATE_ON
except (
self._exceptions_class.UnhandledResponse,
self._exceptions_class.AccessDenied,
):
# We got a response so it's on.
self._state = STATE_ON
self._remote = None
_LOGGER.debug("Failed sending command %s", key, exc_info=True)
return
except OSError:
self._state = STATE_OFF
self._remote = None
if self._power_off_in_progress():
self._state = STATE_OFF
def launch_app(self, application):
"""Launch an application."""
self.get_application().start(application)
def _power_off_in_progress(self):
return (
self._end_of_power_off is not None
and self._end_of_power_off > dt_util.utcnow()
)
@property
def unique_id(self) -> str:
"""Return the unique ID of the device."""
return self._uuid
@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._state
@property
def is_volume_muted(self):
"""Boolean if volume is currently muted."""
if self._config["port"] == 8002:
self._upnp = self.get_upnp()
self._muted = self._upnp.get_mute()
return self._muted
@property
def volume_level(self):
"""Volume level of the media player (0..1)."""
if self._config["port"] == 8002:
self._upnp = self.get_upnp()
self._volume = int(self._upnp.get_volume()) / 100
return str(self._volume)
@property
def source(self):
"""Name of the current input source."""
if self._config['port'] == 8002:
self._application = self.get_application()
if self._application.current_app() is None:
self._current_source = 'TV/HDMI'
return self._current_source
else:
self._current_source = self._application.current_app()
return self._current_source
else:
return self._current_source
@property
def source_list(self):
"""List of available input sources."""
if self._config['port'] == 8002:
source_list = ['TV/HDMI']
for app in self._applist:
source_list.append(app)
return source_list
else:
return self._sourcelist
@property
def supported_features(self):
"""Flag media player features that are supported."""
if self._mac:
return SUPPORT_SAMSUNGTV | SUPPORT_TURN_ON
return SUPPORT_SAMSUNGTV
def turn_off(self):
"""Turn off media player."""
self._end_of_power_off = dt_util.utcnow() + timedelta(seconds=15)
if self._config["method"] == "websocket":
self.send_key("KEY_POWER")
else:
self.send_key("KEY_POWEROFF")
# Force closing of remote session to provide instant UI feedback
try:
self.get_remote().close()
self._remote = None
except OSError:
_LOGGER.debug("Could not establish connection.")
def volume_up(self):
"""Volume up the media player."""
self.send_key("KEY_VOLUP")
def volume_down(self):
"""Volume down media player."""
self.send_key("KEY_VOLDOWN")
def mute_volume(self, mute):
"""Send mute command."""
self.send_key("KEY_MUTE")
def set_volume_level(self, volume):
"""Set volume level, range 0..1."""
if self._config['port'] == 8002:
self._upnp = self.get_upnp()
self._upnp.set_volume(int(volume*100))
def media_play_pause(self):
"""Simulate play pause media player."""
if self._playing:
self.media_pause()
else:
self.media_play()
def media_play(self):
"""Send play command."""
self._playing = True
self.send_key("KEY_PLAY")
def media_pause(self):
"""Send media pause command to media player."""
self._playing = False
self.send_key("KEY_PAUSE")
def media_next_track(self):
"""Send next track command."""
self.send_key("KEY_FF")
def media_previous_track(self):
"""Send the previous track command."""
self.send_key("KEY_REWIND")
async def async_play_media(self, media_type, media_id, **kwargs):
# Type channel
if media_type == MEDIA_TYPE_CHANNEL:
# media_id should only be a channel number
try:
cv.positive_int(media_id)
except vol.Invalid:
_LOGGER.error('Media ID must be positive integer')
return
for digit in media_id:
await self.hass.async_add_job(self.send_key, 'KEY_' + digit)
await asyncio.sleep(KEY_PRESS_TIMEOUT, self.hass.loop)
# Launch an app
elif media_type == MEDIA_TYPE_APP:
try:
cv.string(media_id)
except vol.Invalid:
_LOGGER.error('Media ID must be a string (ex: "Youtube"')
return
await self.hass.async_add_job(self.launch_app, media_id)
# Send custom key
elif media_type == MEDIA_TYPE_KEY:
try:
cv.string(media_id)
except vol.Invalid:
_LOGGER.error('Media ID must be a string (ex: "KEY_HOME"')
return
await self.hass.async_add_job(self.send_key, media_id)
# Launch stream
elif (media_type == MEDIA_TYPE_URL or media_type == MEDIA_TYPE_MUSIC):
_LOGGER.error("Playing on TV " + str(media_id))
self._upnp = self.get_upnp()
self._upnp.set_current_media(media_id)
self._upnp.play()
# Launch stream
elif (media_type == "application/vnd.apple.mpegurl"):
_LOGGER.error("Playing Stream on TV " + str(media_id))
self._upnp = self.get_upnp()
self._upnp.set_current_media(str(media_id))
self._upnp.play()
else:
_LOGGER.error('Unsupported media type: {type} - {id}'.format(type=media_type, id=media_id))
def turn_on(self):
"""Turn the media player on."""
if self._mac:
self._wol.send_magic_packet(self._mac)
else:
self.send_key("KEY_POWERON")
async def async_select_source(self, source):
"""Select input source."""
if source not in SOURCES:
_LOGGER.error("Unsupported source")
return
await self.hass.async_add_job(self.send_key, SOURCES[source])
def select_source(self, source):
"""Select input source."""
if self._config['port'] == 8002:
if source == 'TV/HDMI':
self.get_application().stop(self._current_source)
else:
self.launch_app(source)
else:
self.send_key(self._sourcelist[source])
def async_select_source(self, source):
"""Select input source.
This method must be run in the event loop and returns a coroutine.
"""
return self.hass.async_add_job(self.select_source, source)