home-assistant.github.io/components/sensor.plex/index.html
2016-08-22 08:21:43 +00:00

271 lines
No EOL
10 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>Plex Activity Monitor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="How to add a Plex sensor to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.plex/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Plex Activity Monitor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.plex/">
<meta property="og:type" content="article">
<meta property="og:description" content="How to add a Plex sensor to 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="Plex Activity Monitor">
<meta name="twitter:description" content="How to add a Plex sensor to Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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>
<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='/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>
</ul>
</nav>
</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">
Plex Activity Monitor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">plex</code> sensor platform will monitor activity on a given <a href="https://plex.tv/">Plex Media Server</a>. It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what.</p>
<p>If your Plex server is on the same local network as Home Assistant, all you need to provide in the <code class="highlighter-rouge">configuration.yaml</code> is the host or IP address. If you want to access a remote Plex server, you must provide the Plex username, password, and optionally the server name of the remote Plex server. If no server name is given it will use the first server listed.</p>
<p>If you want to enable the plex sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">plex</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Plex Spy</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.100</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">32400</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">plexuser</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">plexpw</span>
<span class="s">server</span><span class="pi">:</span> <span class="s">MyPlexServer</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): The IP address of your Plex server. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
<li><strong>port</strong> (<em>Optional</em>): The port of your Plex Server. Defaults to 32400.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the Plex server. Defaults to Plex.</li>
<li><strong>username</strong> (<em>Optional</em>): The username for the remote Plex server.</li>
<li><strong>password</strong> (<em>Optional</em>): The password for your given account on the remote Plex server.</li>
<li><strong>server</strong> (<em>Optional</em>): The name of your remote Plex server.</li>
</ul>
</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/sensor.plex.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/plex.png' />
</div>
<div class='section'>
Introduced in release: 0.22
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/media_player.plex/'>
Plex
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Media Player</h1>
<ul class='divided'>
<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.firetv/'>FireTV</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.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 TV</a>
</li>
<li>
<a href='/components/media_player.squeezebox/'>Logitech Squeezebox</a>
</li>
<li>
<a href='/components/media_player.mpchc/'>MPC-HC</a>
</li>
<li>
<a href='/components/media_player.mpd/'>Music Player Daemon (MPD)</a>
</li>
<li>
<a href='/components/media_player.onkyo/'>Onkyo</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.pioneer/'>Pioneer Network Receivers</a>
</li>
<li>
<a href='/components/media_player.plex/'>Plex</a>
</li>
<li>
Plex Activity Monitor
</li>
<li>
<a href='/components/media_player.roku/'>Roku</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.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.universal/'>Universal</a>
</li>
<li>
<a href='/components/media_player.yamaha/'>Yamaha Network Receivers</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>.<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>
</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>
</body>
</html>