home-assistant.github.io/components/media_player.vizio/index.html
2017-12-17 16:27:07 +00:00

388 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Vizio SmartCast TV - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Vizio SmartCast TV into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/media_player.vizio/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Vizio SmartCast TV">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player.vizio/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Vizio SmartCast TV 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="Vizio SmartCast TV">
<meta name="twitter:description" content="Instructions how to integrate Vizio SmartCast TV 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">
Vizio SmartCast TV
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">vizio</code> component will allow you to control <a href="https://www.vizio.com/smartcast-app">SmartCast</a> compatible TVs (2016+ models).</p>
<h2>Pairing</h2>
<p>Before adding your TV to Home Assistant youll need to pair it manually. To do so follow these steps:</p>
<p>Install the command-line tool using <code class="highlighter-rouge">pip</code> (or you can choose to download it manually):</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install git+https://github.com/vkorn/pyvizio.git@master
</code></pre>
</div>
<p>or</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install -I .
</code></pre>
</div>
<p>Make sure that your TV is on before continuing.</p>
<p>If you dont know IP address of your TV run following command:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pyvizio --ip<span class="o">=</span>0 --auth<span class="o">=</span>0 discover
</code></pre>
</div>
<p>Enter the following command to initiate pairing:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pyvizio --ip<span class="o">={</span>ip<span class="o">}</span> pair
</code></pre>
</div>
<p>Initiation will show you two different values:</p>
<table>
<thead>
<tr>
<th style="text-align: left">Value</th>
<th style="text-align: left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Challenge type</td>
<td style="text-align: left">Usually it should be <code class="highlighter-rouge">"1"</code>. If not, use the additional parameter <code class="highlighter-rouge">--ch_type=your_type</code> in the next step</td>
</tr>
<tr>
<td style="text-align: left">Challenge token</td>
<td style="text-align: left">Token required to finalize pairing in the next step</td>
</tr>
</tbody>
</table>
<p>Finally, at this point a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pyvizio --ip<span class="o">={</span>ip<span class="o">}</span> pair_finish --token<span class="o">={</span>challenge_token<span class="o">}</span> --pin<span class="o">={</span>tv_pin<span class="o">}</span>
</code></pre>
</div>
<p>You will need the authentication token returned by this command to configure Home Assistant.</p>
<h2>Configuration</h2>
<p>To add your Vizio TV 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">vizio</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">access_token</span><span class="pi">:</span> <span class="s">AUTH_TOKEN</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): IP address of your TV.</li>
<li><strong>access_token</strong> (<em>Required</em>): Authentication token you received in the last step of the pairing process.</li>
</ul>
<h2>Notes and limitations</h2>
<h3>Turning TV on</h3>
<p>If the <code class="highlighter-rouge">Power Mode</code> of your TV is set to <code class="highlighter-rouge">Eco Mode</code>, turning the device ON wont work.</p>
<h3>Changing tracks</h3>
<p>Changing tracks works like channels switching. If you have source other than regular TV it might end do nothing.</p>
<h3>Sources</h3>
<p>Source list shows all external devices connected to the TV through HDMI plus list of internal devices (TV mode, Chrome Cast, etc.).</p>
<p class="note">
Vizio SmartCast service is accessible through HTTPS with self-signed certificate. If you have low LOGLEVEL in your Home Assistant configuration, youll see a lot of warnings like this:
<code class="highlighter-rouge">InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised.</code>
You can adjust the log level for <code class="highlighter-rouge">media_player</code> components with the <a href="https://home-assistant.io/components/logger/">logger</a> component, or if you need to keep a low log level for <code class="highlighter-rouge">media_player</code> you could proxy calls to your TV through an NGINX reverse proxy.
If you want to only ignore only this specific <a href="https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings">python urllib3 SSL warning</a>, you will need to run Home Assistant with the python flag <code class="highlighter-rouge">-W</code> or the environment variable <code class="highlighter-rouge">PYTHONWARNINGS</code> set to:
<code class="highlighter-rouge">ignore:Unverified HTTPS request is being made</code>
</p>
</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.vizio.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/vizio-smartcast.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.49
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/vizio.py'>media_player/vizio.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.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>
<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.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>
Vizio SmartCast TV
</li>
<li>
<a href='/components/media_player.volumio/'>Volumio Media Player</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>