Site updated at 2017-08-12 20:12:45 UTC

This commit is contained in:
Travis CI 2017-08-12 20:12:46 +00:00
parent e1336d0fd2
commit 177731b69b
614 changed files with 10280 additions and 2298 deletions

View file

@ -74,20 +74,20 @@
</h1>
</header>
<hr class="divider">
<p>This <code class="highlighter-rouge">sonarr</code> sensor platform pulls data from a given Sonarr instance.</p>
<p>To use your <a href="https://sonarr.tv/">Sonarr</a> sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<p>This <code class="highlighter-rouge">sonarr</code> sensor platform pulls data from a given <a href="https://sonarr.tv/">Sonarr</a> instance.</p>
<p>To use your Sonarr sensor in 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.yml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">sonarr</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">PORT</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your Sonarr API key, found in Settings &gt; General in the Sonarr Web UI.</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display on the frontend.
<li><strong>host</strong> (<em>Optional</em>): The host Sonarr is running on. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
<li><strong>port</strong> (<em>Optional</em>): The port Sonarr is running on. Defaults to 8989.</li>
<li><strong>monitored_conditions</strong> array (<em>Optional</em>): Conditions to display on the frontend. Defaults to <code class="highlighter-rouge">upcoming</code>.
<ul>
<li><strong>series</strong>: The number of series in Sonarr.</li>
<li><strong>upcoming</strong>: The number of upcoming episodes.</li>
@ -97,12 +97,10 @@
<li><strong>diskspace</strong>: Available disk space.</li>
</ul>
</li>
<li><strong>host</strong> (<em>Optional</em>): The host Sonarr is running on (Default: localhost).</li>
<li><strong>port</strong> (<em>Optional</em>): The port Sonarr is running on (Default: 8989).</li>
<li><strong>urlbase</strong> (<em>Optional</em>): The base URL Sonarr is running under (Default: /).</li>
<li><strong>days</strong> (<em>Optional</em>): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).</li>
<li><strong>urlbase</strong> (<em>Optional</em>): The base URL Sonarr is running under. Defaults to <code class="highlighter-rouge">/</code>.</li>
<li><strong>days</strong> (<em>Optional</em>): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1.</li>
<li><strong>include_paths</strong> (<em>Optional</em>): Array of filepaths to include when calculating diskspace. Leave blank to include all.</li>
<li><strong>unit</strong>: (<em>Optional</em>): The unit to display disk space in (Default: GB).</li>
<li><strong>unit</strong>: (<em>Optional</em>): The unit to display disk space in. Defaults to GB.</li>
<li><strong>ssl</strong>: boolean (<em>Optional</em>): Whether or not to use SSL for Sonarr.</li>
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
@ -273,6 +271,9 @@
<li>
<a href='/components/sensor.gpsd/'>GPSD</a>
</li>
<li>
<a href='/components/sensor.geizhals/'>Geizhals</a>
</li>
<li>
<a href='/components/sensor.gitter/'>Gitter Sensor</a>
</li>
@ -390,6 +391,9 @@
<li>
<a href='/components/sensor.sensehat/'>Sense HAT</a>
</li>
<li>
<a href='/components/sensor.shodan/'>Shodan Sensor</a>
</li>
<li>
<a href='/components/sensor.sleepiq/'>SleepIQ Sensor</a>
</li>