222 lines
No EOL
8.9 KiB
HTML
222 lines
No EOL
8.9 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>SABnzbd - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate SABnzbd within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.sabnzbd/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="SABnzbd">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.sabnzbd/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate SABnzbd within 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="SABnzbd">
|
||
<meta name="twitter:description" content="Instructions how to integrate SABnzbd within 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">
|
||
SABnzbd
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">sabnzbd</code> platform will allow you to monitor your downloads with <a href="http://sabnzbd.org">SABnzbd</a> from within Home Assistant and setup automation based on the information.</p>
|
||
|
||
<p>To use SABnzbd with 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">sensor</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">sabnzbd</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">YOUR_SABNZBD_HOST</span>
|
||
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
|
||
<span class="s">monitored_variables</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">current_status'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">speed'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">queue_size'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">queue_remaining'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">disk_size'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">disk_free'</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The host where your SABnzbd instance is running, eg. 192.168.1.32</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port to use whith SABnzbd instance. Defaults to <code class="highlighter-rouge">8080</code>.</li>
|
||
<li><strong>api_key</strong> (<em>Required</em>): Name that will be used in the frontend for the pin.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this SABnzbd instance.</li>
|
||
<li><strong>ssl</strong> (<em>Optional</em>): Use <code class="highlighter-rouge">https</code> instead of <code class="highlighter-rouge">http</code> to connect. Defaults to False.</li>
|
||
<li><strong>monitored_variables</strong> array (<em>Required</em>): List of the monitored variables.
|
||
<ul>
|
||
<li><strong>current_status</strong>: current status of the SABnzbd instance</li>
|
||
<li><strong>speed</strong>: Current speed</li>
|
||
<li><strong>queue_size</strong>: Size of the queue</li>
|
||
<li><strong>queue_remaining</strong>: Remaining elements in the queue</li>
|
||
<li><strong>disk_size</strong>: Disk size of the storage location</li>
|
||
<li><strong>disk_free</strong>: Free disk space at the sotrage location</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<p>Note that this will create sensors under the name ‘sab’ and NOT ‘sabnzbd’ as follows:</p>
|
||
|
||
<div class="highlighter-rouge"><pre class="highlight"><code> - sensor.sab_status
|
||
- sensor.sab_speed
|
||
- sensor.sab_queue
|
||
- sensor.sab_left
|
||
- sensor.sab_disk
|
||
- sensor.sab_disk_free
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>As always, you can determine the names of sensors by looking at the dev-state page <code class="highlighter-rouge">< ></code> in the web interface.</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/sensor.sabnzbd.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/sabnzbd.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: pre 0.7
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Downloading</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/downloader/'>Downloader</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nzbget/'>NZBGet</a>
|
||
</li>
|
||
<li>
|
||
SABnzbd
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.transmission/'>Transmission Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.transmission/'>Transmission Switch</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> |