home-assistant.github.io/components/media_player.mediaroom/index.html
2018-03-09 18:51:31 +00:00

386 lines
18 KiB
HTML

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Mediaroom - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Mediaroom Set-Top Boxes into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/media_player.mediaroom/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Mediaroom">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player.mediaroom/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Mediaroom Set-Top Boxes into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Mediaroom">
<meta name="twitter:description" content="Instructions how to integrate Mediaroom Set-Top Boxes into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Mediaroom
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">mediaroom</code> component allows you to control a <a href="https://en.wikipedia.org/wiki/Ericsson_Mediaroom">Mediaroom</a> Set-Top Box (STB) from Home Assistant.</p>
<p>To add a Mediaroom STB to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mediaroom</span>
</code></pre>
</div>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="host" href="#host"></a> host</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The hostname or IP address of the device.</span></p>
<p class="default">Default value: Tries to discovery your device.</p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name of the device used in the frontend.</span></p>
<p class="default">Default value: Mediaroom STB</p>
</dd>
<dt><a class="title-link" name="optimistic" href="#optimistic"></a> optimistic</dt>
<dd>
<p class="desc"><span class="type">(<span class="boolean">boolean</span>)</span><span class="required">(Optional)</span><span class="description">In case the component cannot determine the status of the box, consider the box always ON.</span></p>
<p class="default">Default value: false</p>
</dd>
</dl>
</div>
<p>Notice that all parameters are optional, and discovery should configure everything for you.</p>
<h4><a class="title-link" name="using-the-mediaroom-component" href="#using-the-mediaroom-component"></a> Using the Mediaroom component</h4>
<p>The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082.</p>
<p>In most cases (single STB) you just need to setup the <em>platform</em> and discovery will do the rest. In case you have more than one STB you are required to set the <em>host</em> in each one of the entries.</p>
<p>If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the <em>optimistic</em> configuration variable.</p>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="example-press_button-script" href="#example-press_button-script"></a> Example <code class="highlighter-rouge">press_button</code> script</h3>
<p>The <code class="highlighter-rouge">play_media</code> function can be used in scripts to change channels.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example play_media script</span>
<span class="c1">#</span>
<span class="s">press_button</span><span class="pi">:</span>
<span class="s">sequence</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">media_player.play_media</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">media_player.mediaroom_stb</span>
<span class="s">media_content_id</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
<span class="s">media_content_type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">channel"</span>
<span class="c1">### &lt;a class='title-link' name='example-configuration-with-2-stb' href='#example-configuration-with-2-stb'&gt;&lt;/a&gt; Example configuration with 2 STB </span>
<span class="err">```</span><span class="s">yaml</span>
<span class="c1"># Example configuration.yaml entry for 2 STB</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mediaroom</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.64</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Living Room STB</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mediaroom</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.65</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Bedroom STB</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.mediaroom.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/mediaroom.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.63
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/mediaroom.py'>media_player/mediaroom.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/media_player/'>the Media Player component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Media Player</h1>
<ul class='divided'>
<li>
<a href='/components/media_player.anthemav/'>Anthem A/V Receivers</a>
</li>
<li>
<a href='/components/media_player.apple_tv/'>Apple TV Media Player</a>
</li>
<li>
<a href='/components/media_player.bluesound/'>Bluesound</a>
</li>
<li>
<a href='/components/media_player.channels/'>Channels</a>
</li>
<li>
<a href='/components/media_player.clementine/'>Clementine Music Player</a>
</li>
<li>
<a href='/components/media_player.denonavr/'>Denon AVR Network Receivers</a>
</li>
<li>
<a href='/components/media_player.denon/'>Denon Network Receivers</a>
</li>
<li>
<a href='/components/media_player.directv/'>DirecTV</a>
</li>
<li>
<a href='/components/media_player.dunehd/'>DuneHD media players</a>
</li>
<li>
<a href='/components/media_player.emby/'>Emby</a>
</li>
<li>
<a href='/components/media_player.firetv/'>FireTV</a>
</li>
<li>
<a href='/components/media_player.frontier_silicon/'>Frontier Silicon Internet Radios</a>
</li>
<li>
<a href='/components/media_player.cast/'>Google Cast</a>
</li>
<li>
<a href='/components/media_player.gpmdp/'>Google Play Music Desktop Player</a>
</li>
<li>
<a href='/components/media_player.gstreamer/'>Gstreamer</a>
</li>
<li>
<a href='/components/media_player.kodi/'>Kodi</a>
</li>
<li>
<a href='/components/media_player.lg_netcast/'>LG Netcast TV</a>
</li>
<li>
<a href='/components/media_player.webostv/'>LG webOS Smart TV</a>
</li>
<li>
<a href='/components/media_player.openhome/'>Linn / Openhome</a>
</li>
<li>
<a href='/components/media_player.squeezebox/'>Logitech Squeezebox</a>
</li>
<li>
<a href='/components/media_player.ue_smart_radio/'>Logitech UE Smart Radio</a>
</li>
<li>
<a href='/components/media_player.mpchc/'>MPC-HC</a>
</li>
<li>
<a href='/components/media_extractor/'>Media Extractor</a>
</li>
<li>
Mediaroom
</li>
<li>
<a href='/components/media_player.monoprice/'>Monoprice 6-Zone Amplifier</a>
</li>
<li>
<a href='/components/media_player.mpd/'>Music Player Daemon (MPD)</a>
</li>
<li>
<a href='/components/media_player.nad/'>NAD</a>
</li>
<li>
<a href='/components/media_player.nadtcp/'>NAD tcp</a>
</li>
<li>
<a href='/components/media_player.onkyo/'>Onkyo</a>
</li>
<li>
<a href='/components/media_player.liveboxplaytv/'>Orange Livebox Play TV</a>
</li>
<li>
<a href='/components/media_player.panasonic_viera/'>Panasonic Viera TV</a>
</li>
<li>
<a href='/components/media_player.pandora/'>Pandora</a>
</li>
<li>
<a href='/components/media_player.philips_js/'>Philips TV</a>
</li>
<li>
<a href='/components/media_player.pioneer/'>Pioneer Network Receivers</a>
</li>
<li>
<a href='/components/media_player.plex/'>Plex</a>
</li>
<li>
<a href='/components/sensor.plex/'>Plex Activity Monitor</a>
</li>
<li>
<a href='/components/media_player.roku/'>Roku</a>
</li>
<li>
<a href='/components/media_player.russound_rio/'>Russound RIO</a>
</li>
<li>
<a href='/components/media_player.russound_rnet/'>Russound RNET</a>
</li>
<li>
<a href='/components/media_player.samsungtv/'>Samsung Smart TV</a>
</li>
<li>
<a href='/components/media_player.aquostv/'>Sharp Aquos TV</a>
</li>
<li>
<a href='/components/media_player.snapcast/'>Snapcast</a>
</li>
<li>
<a href='/components/media_player.sonos/'>Sonos</a>
</li>
<li>
<a href='/components/media_player.braviatv/'>Sony Bravia TV</a>
</li>
<li>
<a href='/components/media_player.songpal/'>Sony SongPal compatible devices</a>
</li>
<li>
<a href='/components/media_player.soundtouch/'>Soundtouch</a>
</li>
<li>
<a href='/components/media_player.spotify/'>Spotify</a>
</li>
<li>
<a href='/components/media_player.universal/'>Universal</a>
</li>
<li>
<a href='/components/media_player.vlc/'>VLC</a>
</li>
<li>
<a href='/components/media_player.vizio/'>Vizio SmartCast TV</a>
</li>
<li>
<a href='/components/media_player.volumio/'>Volumio Media Player</a>
</li>
<li>
<a href='/components/media_player.xiaomi_tv/'>Xiaomi TV</a>
</li>
<li>
<a href='/components/media_player.yamaha_musiccast/'>Yamaha MusicCast Receivers</a>
</li>
<li>
<a href='/components/media_player.yamaha/'>Yamaha Network Receivers</a>
</li>
<li>
<a href='/components/media_player.ziggo_mediabox_xl/'>Ziggo Mediabox XL</a>
</li>
<li>
<a href='/components/media_player.cmus/'>cmus</a>
</li>
<li>
<a href='/components/media_player.itunes/'>iTunes</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>