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

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

58
components/influxdb/index.html
View file

@ -3,17 +3,14 @@
<!--[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>InfluxDB - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Record events in InfluxDB.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/influxdb/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="InfluxDB">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Record events in InfluxDB.">
<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="InfluxDB">
<meta name="twitter:description" content="Record events in InfluxDB.">
<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="/docs/">Docs</a></li>
@ -64,47 +53,28 @@
</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">
InfluxDB
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">influxdb</code> component makes it possible to transfer all state changes to an external <a href="https://influxdb.com/">InfluxDB</a> database. For more details, <a href="/blog/2015/12/07/influxdb-and-grafana/">see the blog post on InfluxDB</a>.</p>
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
<p>The default InfluxDB configuration doesn’t enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven’t made any configuration changes, 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">influxdb</span><span class="pi">:</span>
</code></pre>
</div>
<p>You will still need to create a database named <code class="highlighter-rouge">home_assistant</code> via InfluxDB’s web interface or command line. For instructions how to create a database check the <a href="https://docs.influxdata.com/influxdb/v1.0/introduction/getting_started/#creating-a-database">InfluxDB documentation</a> relevant to the version you have installed.</p>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): IP address of your database host, e.g. 192.168.1.10. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
<li><strong>port</strong> (<em>Optional</em>): Port to use. Defaults to 8086.</li>
@ -119,11 +89,8 @@
<li><strong>whitelist</strong> (<em>Optional</em>): List of the entities (only) that will be logged to InfluxDB. If not set, all entities will be logged. Values set by the <strong>blacklist</strong> option will prevail.</li>
<li><strong>tags</strong> (<em>Optional</em>): Tags to mark the data.</li>
</ul>
<h2><a class="title-link" name="data-migration" href="#data-migration"></a> Data migration</h2>
<p>Starting with 0.36 the InfluxDB component has a new schema to store values in the InfluxDB databases.</p>
<ul>
<li>There will no longer be any tags/fields named <code class="highlighter-rouge">time</code>.</li>
<li>All numeric fields (int/float/bool) will be stored as float inside InfluxDB database.</li>
@ -132,11 +99,8 @@
<li>Fields named <code class="highlighter-rouge">value</code> will always be stored as float.</li>
<li>Fields named <code class="highlighter-rouge">state</code> will always be stored as string.</li>
</ul>
<h3><a class="title-link" name="migration-script" href="#migration-script"></a> Migration script</h3>
<p>If you need to migrate your database, you may require to run the <code class="highlighter-rouge">influxdb_migrator</code> script. Run the script after upgrade to 0.36 but before the first regular start of <code class="highlighter-rouge">hass</code> version 0.36.</p>
<p>These are the steps the script will perform:</p>
<ol>
<li>Create a new database (called <code class="highlighter-rouge">DBNAME__old</code>) to store old data.</li>
@ -147,16 +111,13 @@
<li>Send group of points to <code class="highlighter-rouge">DBNAME</code> database.</li>
<li>Delete the <code class="highlighter-rouge">DBNAME__old</code> database if needed.</li>
</ol>
<p>Example to run the script:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script influxdb_migrator <span class="se">\</span>
-H IP_INFLUXDB_HOST -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD <span class="se">\</span>
-d INFLUXDB_DB_NAME
</code></pre>
</div>
<p>Script arguments:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>required arguments:
-d dbname, --dbname dbname InfluxDB database name
@ -174,7 +135,6 @@ optional arguments:
-D, --delete Delete old database
</code></pre>
</div>
<ul>
<li>If you run the script with only the <code class="highlighter-rouge">-h</code> option, you will get a help printout with a short explanation of the different options.</li>
<li>The host option defaults to <code class="highlighter-rouge">'127.0.0.1'</code>.</li>
@ -182,11 +142,8 @@ optional arguments:
<li>You should be able to omit username and password if InfluxDB authentication is disabled, which it is by default.</li>
<li>The step option defaults to <code class="highlighter-rouge">1000</code>.</li>
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">influxdb</span><span class="pi">:</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.190</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">20000</span>
@ -207,18 +164,10 @@ optional arguments:
<span class="s">source</span><span class="pi">:</span> <span class="s">hass</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/influxdb.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -274,13 +223,10 @@ optional arguments:
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -290,7 +236,6 @@ optional arguments:
<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 />
@ -302,7 +247,6 @@ optional arguments:
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -310,4 +254,4 @@ optional arguments:
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>