jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/updater/index.html
Travis CI 933563f0be Site updated at 2017-06-17 20:00:42 UTC
2017-06-17 20:00:42 +00:00

205 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Updater - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Detecting when Home Assistant updates are available.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/updater/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Updater">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/updater/">
<meta property="og:type" content="article">
<meta property="og:description" content="Detecting when Home Assistant updates are available.">
<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="Updater">
<meta name="twitter:description" content="Detecting when Home Assistant updates are available.">
<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>
<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">
Updater
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">updater</code> component will check daily for new releases. It will show a badge in the frontend if a new version was found.</p>
<p>The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the timezone, Python version and operating system information. No identifiable information (i.e. IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91">source code</a>. For further information about the Updater’s data please check the <a href="/docs/backend/updater/">detailed overview</a>.</p>
<p>To integrate this into Home Assistant, add the following section to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">updater</span><span class="pi">:</span>
</code></pre>
</div>
<p>If you choose not to share any information when checking for updates, you can add <code class="highlighter-rouge">reporting: False</code>.</p>
<p>It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add <code class="highlighter-rouge">include_used_components: True</code>.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"components"</span><span class="err">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"apcupsd"</span><span class="p">,</span><span class="w">
</span><span class="s2">"api"</span><span class="p">,</span><span class="w">
</span><span class="s2">"automation"</span><span class="p">,</span><span class="w">
</span><span class="s2">"binary_sensor"</span><span class="p">,</span><span class="w">
</span><span class="s2">"binary_sensor.zwave"</span><span class="p">,</span><span class="w">
</span><span class="s2">"camera"</span><span class="p">,</span><span class="w">
</span><span class="s2">"camera.uvc"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config.core"</span><span class="p">,</span><span class="w">
</span><span class="err">...</span><span class="w">
</span><span class="p">]</span><span class="w">
</span></code></pre>
</div>
<h3><a class="title-link" name="notification" href="#notification"></a> Notification</h3>
<p>For an added bonus, an automation component can be created to send a message with a notifier when that state of this component’s entity changes.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Update</span><span class="nv"> </span><span class="s">Available</span><span class="nv"> </span><span class="s">Notifications'</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">updater.updater</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.notify</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Update</span><span class="nv"> </span><span class="s">for</span><span class="nv"> </span><span class="s">Home</span><span class="nv"> </span><span class="s">Assistant</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">available.'</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/updater.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
<h1 class="title delta">Category Other</h1>
<ul class='divided'>
<li>
<a href='/components/browser/'>Browser</a>
</li>
<li>
<a href='/components/config/'>Config</a>
</li>
<li>
<a href='/components/configurator/'>Configurator</a>
</li>
<li>
<a href='/components/demo/'>Demo platforms</a>
</li>
<li>
<a href='/components/discovery/'>Discovery</a>
</li>
<li>
<a href='/components/feedreader/'>Feedreader</a>
</li>
<li>
<a href='/components/frontend/'>Frontend</a>
</li>
<li>
<a href='/components/http/'>HTTP</a>
</li>
<li>
<a href='/components/ha/'>Home Assistant 0.47</a>
</li>
<li>
<a href='/components/introduction/'>Introduction</a>
</li>
<li>
<a href='/components/keyboard_remote/'>Keyboard Remote</a>
</li>
<li>
<a href='/components/logger/'>Logger</a>
</li>
<li>
<a href='/components/mqtt_eventstream/'>MQTT Eventstream</a>
</li>
<li>
<a href='/components/persistent_notification/'>Persistent notification</a>
</li>
<li>
<a href='/components/plant/'>Plant monitor</a>
</li>
<li>
<a href='/components/upnp/'>UPnP</a>
</li>
<li>
Updater
</li>
<li>
<a href='/components/zeroconf/'>Zeroconf/Avahi/Bonjour</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink