jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2018-01-05 12:30:34 UTC

Browse source
This commit is contained in:
Travis CI 2018-01-05 12:30:35 +00:00
parent 97ba109053
commit a482bba217
31 changed files with 347 additions and 157 deletions
Download patch file Download diff file Expand all files Collapse all files

86
components/recorder/index.html
View file

@ -82,24 +82,63 @@
<span class="s">recorder</span><span class="pi">:</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>purge_interval</strong> (<em>Optional</em>): (days) Enable scheduled purge of older events and states. The purge task runs every x days from when the <code class="highlighter-rouge">recorder component</code> is first enabled. If a scheduled purge is missed (e.g. if Home Assistant was not running) then the schedule will resume soon after Home Assistant restarts. You can use <a href="#service-purge">service</a> call <code class="highlighter-rouge">recorder.purge</code> when required without impacting the purge schedule.</li>
<li><strong>purge_keep_days</strong> (<em>Required with <code class="highlighter-rouge">purge_interval</code></em>): Specify number of history days to keep in recorder database after purge.</li>
<li><strong>exclude</strong> (<em>Optional</em>): Configure which components should be excluded from recordings.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be excluded from recordings.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be excluded from recordings.</li>
</ul>
</li>
<li><strong>include</strong> (<em>Optional</em>): Configure which components should be included in recordings. If set, all other entities will not be recorded.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be included from recordings.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be included from recordings.</li>
</ul>
</li>
<li><strong>db_url</strong> (<em>Optional</em>): The URL which point to your database.</li>
</ul>
<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="recorder" href="#recorder"></a> recorder</dt>
<dd>
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">Enables the recorder component. Only allowed once.</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="db_url" href="#db_url"></a> db_url</dt>
<dd>
<p class="desc"><span class="type">(<span class="url">URL</span>)</span><span class="required">(Optional)</span><span class="description">The URL which points to your database.</span></p>
</dd>
<dt><a class="title-link" name="purge_interval" href="#purge_interval"></a> purge_interval</dt>
<dd>
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Inclusive)</span><span class="description">Enable scheduled purge of older events and states. The purge task runs every <code class="highlighter-rouge">purge_interval</code> days from when the <code class="highlighter-rouge">recorder component</code> is first enabled. If a scheduled purge is missed (e.g if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the <a href="#service-purge">service</a> call <code class="highlighter-rouge">purge</code> when required without impacting the purge schedule. If <code class="highlighter-rouge">purge_interval</code> is set, <code class="highlighter-rouge">purge_keep_days</code> needs to be set as well.</span></p>
</dd>
<dt><a class="title-link" name="purge_keep_days" href="#purge_keep_days"></a> purge_keep_days</dt>
<dd>
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Inclusive)</span><span class="description">Specify the number of history days to keep in recorder database after purge. If <code class="highlighter-rouge">purge_interval</code> is set, <code class="highlighter-rouge">purge_keep_days</code> needs to be set as well.</span></p>
</dd>
<dt><a class="title-link" name="exclude" href="#exclude"></a> exclude</dt>
<dd>
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Optional)</span><span class="description">Configure which components should be excluded</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="domains" href="#domains"></a> domains</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">List</span>)</span><span class="required">(Optional)</span><span class="description">The list of domains to be excluded from recordings.</span></p>
</dd>
<dt><a class="title-link" name="entities" href="#entities"></a> entities</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">List</span>)</span><span class="required">(Optional)</span><span class="description">The list of entity ids to be excluded from recordings.</span></p>
</dd>
</dl>
</dd>
<dt><a class="title-link" name="include" href="#include"></a> include</dt>
<dd>
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Optional)</span><span class="description">Configure which components should be included in recordings. If set, all other entities will not be recorded.</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="domains" href="#domains"></a> domains</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">List</span>)</span><span class="required">(Optional)</span><span class="description">The list of domains to be included in the recordings.</span></p>
</dd>
<dt><a class="title-link" name="entities" href="#entities"></a> entities</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">List</span>)</span><span class="required">(Optional)</span><span class="description">The list of entity ids to be included in the recordings.</span></p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</div>
<p>Define domains and entities to <code class="highlighter-rouge">exclude</code> (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like <code class="highlighter-rouge">weblink</code>) or rarely change (<code class="highlighter-rouge">updater</code> or <code class="highlighter-rouge">automation</code>).</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with exclude</span>
<span class="s">recorder</span><span class="pi">:</span>
@ -151,7 +190,16 @@
<span class="s">keep_days</span><span class="pi">:</span> <span class="s">5</span>
</code></pre>
</div>
<h2>Custom database engines</h2>
<h3><a class="title-link" name="restore-state" href="#restore-state"></a> Restore State</h3>
<p>If the <code class="highlighter-rouge">recorder</code> component is activated then some components support <code class="highlighter-rouge">restore_state</code> which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support <code class="highlighter-rouge">restore_state</code>:</p>
<ul>
<li><a href="/components/input_boolean/#restore-state"><code class="highlighter-rouge">input_boolean</code></a></li>
<li><a href="/components/input_number/#restore-state"><code class="highlighter-rouge">input_number</code></a></li>
<li><a href="/components/input_select/#restore-state"><code class="highlighter-rouge">input_select</code></a></li>
<li><a href="/components/input_datetime/#restore-state"><code class="highlighter-rouge">input_datetime</code></a></li>
<li><a href="/components/input_text/#restore-state"><code class="highlighter-rouge">input_text</code></a></li>
</ul>
<h2><a class="title-link" name="custom-database-engines" href="#custom-database-engines"></a> Custom database engines</h2>
<table>
<thead>
<tr>