jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/logbook/index.html
Travis CI 01b474f87c Site updated at 2018-01-28 22:02:31 UTC
2018-01-28 22:02:31 +00:00

265 lines
15 KiB
HTML
Raw Blame History

<!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>Logbook - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to enable the logbook component for Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/logbook/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Logbook">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/logbook/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to enable the logbook component for 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="Logbook">
<meta name="twitter:description" content="Instructions how to enable the logbook component for 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">
Logbook
</h1>
</header>
<hr class="divider">
<p><img src="/images/screenshots/logbook.png" style="margin-left:10px; float: right;" height="100" /> The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. <a href="/demo/">See the demo for a live example</a>. It depends on the <code class="highlighter-rouge">recorder</code> component for storing the data. This means that if the <a href="/components/recorder/"><code class="highlighter-rouge">recorder</code></a> component is set up to use e.g. MySQL or PostgreSQL as data store, the <code class="highlighter-rouge">logbook</code> component does not use the default SQLite database to store data.</p>
<p>To enable the logbook 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.yaml entry</span>
<span class="s">logbook</span><span class="pi">:</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>exclude</strong> (<em>Optional</em>): Configure which components should <strong>not</strong> create logbook entries.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be excluded from creating logbook entries.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be excluded from creating logbook entries.</li>
</ul>
</li>
<li><strong>include</strong> (<em>Optional</em>): Configure which components should create logbook entries.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be included from creating logbook entries.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be included from creating logbook entries.</li>
</ul>
</li>
</ul>
<p>If you want to exclude messages of some entities or domains from the logbook just add the <code class="highlighter-rouge">exclude</code> parameter like:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example of excluding domains and entities from the logbook</span>
<span class="s">logbook</span><span class="pi">:</span>
<span class="s">exclude</span><span class="pi">:</span>
<span class="s">entities</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor.last_boot</span>
<span class="pi">-</span> <span class="s">sensor.date</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sun</span>
<span class="pi">-</span> <span class="s">weblink</span>
</code></pre>
</div>
<p>In case you just want to see messages from some specific entities or domains use the <code class="highlighter-rouge">include</code> configuration:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example to show how to include only the listed domains and entities in the logbook</span>
<span class="s">logbook</span><span class="pi">:</span>
<span class="s">include</span><span class="pi">:</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor</span>
<span class="pi">-</span> <span class="s">switch</span>
<span class="pi">-</span> <span class="s">media_player</span>
</code></pre>
</div>
<p>You can also use the <code class="highlighter-rouge">include</code> list and filter out some entities or domains with an <code class="highlighter-rouge">exclude</code> list. Usually this makes sense if you define domains on the include side and filter out some specific entities.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example of combining include and exclude configurations</span>
<span class="s">logbook</span><span class="pi">:</span>
<span class="s">include</span><span class="pi">:</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor</span>
<span class="pi">-</span> <span class="s">switch</span>
<span class="pi">-</span> <span class="s">media_player</span>
<span class="s">exclude</span><span class="pi">:</span>
<span class="s">entities</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor.last_boot</span>
<span class="pi">-</span> <span class="s">sensor.date</span>
</code></pre>
</div>
<h3><a class="title-link" name="exclude-events" href="#exclude-events"></a> Exclude Events</h3>
<p>Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the <code class="highlighter-rouge">sensor.date</code>to show the current date in the UI, but you do not want a logbook entry for that sensor every day.
To exclude these entities just add them to the <code class="highlighter-rouge">exclude</code> &gt; <code class="highlighter-rouge">entities</code> list in the configuration of the logbook.</p>
<p>To exclude all events from a whole domain add it to the <code class="highlighter-rouge">exclude</code> &gt; <code class="highlighter-rouge">domain</code> list. For instance you use the <code class="highlighter-rouge">sun</code> domain only to trigger automations on the `azimuth attribute, then you possible are not interested in the logbook entries for sun rise and sun set.</p>
<h3><a class="title-link" name="custom-entries" href="#custom-entries"></a> Custom Entries</h3>
<p>It is possible to add custom entries to the logbook by using the script component to fire an event.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">script</span><span class="pi">:</span>
<span class="s">add_logbook_entry</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Add Logbook</span>
<span class="s">sequence</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">logbook.log</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Kitchen</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">is being used</span>
<span class="c1"># Optional</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.kitchen</span>
<span class="s">domain</span><span class="pi">:</span> <span class="s">light</span>
</code></pre>
</div>
</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/logbook.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/logbook.png' />
</div>
<div class='section'>
<h1 class="title delta">Category History</h1>
<ul class='divided'>
<li>
<a href='/components/datadog/'>Datadog</a>
</li>
<li>
<a href='/components/dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/emoncms_history/'>Emoncms history</a>
</li>
<li>
<a href='/components/graphite/'>Graphite</a>
</li>
<li>
<a href='/components/history/'>History</a>
</li>
<li>
<a href='/components/history_graph/'>History Graph</a>
</li>
<li>
<a href='/components/influxdb/'>InfluxDB</a>
</li>
<li>
Logbook
</li>
<li>
<a href='/components/logentries/'>Logentries</a>
</li>
<li>
<a href='/components/prometheus/'>Prometheus</a>
</li>
<li>
<a href='/components/recorder/'>Recorder</a>
</li>
<li>
<a href='/components/shiftr/'>Shiftr.io</a>
</li>
<li>
<a href='/components/splunk/'>Splunk</a>
</li>
<li>
<a href='/components/statsd/'>StatsD</a>
</li>
<li>
<a href='/components/thingspeak/'>ThingSpeak</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>
Reference in a new issue View git blame Copy permalink