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

Site updated at 2015-10-11 18:39:53 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-10-11 11:39:53 -07:00
parent 3e76cedc44
commit 0cadd801b9
69 changed files with 3597 additions and 2281 deletions
Download patch file Download diff file Expand all files Collapse all files

2
components/device_tracker.actiontec.html
View file

@ -144,7 +144,7 @@ This device tracker needs telnet to be enabled on the router.
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, e.g. 192.168.1.1.</li>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, eg. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
<li><strong>home_interval</strong> (<em>Optional</em>): If the home_interval is set then the component will not let a device be AWAY if it has been HOME in the last home_interval minutes. This is in addition to the 3 minute wait built into the device_tracker component.</li>

9
components/device_tracker.thomson.html
View file

@ -127,6 +127,15 @@ Thomson produced networking equipment (under the brand name SpeedTouch) till 201
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, eg. 192.168.1.1.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <em>admin</em>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
</ul>
<p>See the <a href="/components/device_tracker.html">device tracker component page</a> for instructions how to configure the people to be tracked.</p>

9
components/index.html
View file

@ -216,8 +216,8 @@
</tr>
<tr>
<td></td>
<td><a href='/components/sensor.rfxtrx.html'>RFXtrx</a> sensors monitors values from RFXtrx devices.</td>
<td><a href='/components/rfxtrx.html'><img src='/images/supported_brands/rfxtrx.png' class='brand overview'/></a></td>
<td><a href='/components/rfxtrx.html'>RFXtrx</a> controls and monitors RFXtrx devices.</td>
</tr>
<tr>
@ -582,6 +582,11 @@ the manufacturers of these devices.
<td><a href='/components/notify.xmpp.html'>Jabber (XMPP)</a></td>
</tr>
<tr>
<td><a href='/components/notify.telegram.html'><img src='/images/supported_brands/telegram.png' class='brand overview' /></a></td>
<td><a href='/components/notify.telegram.html'>Telegram</a></td>
</tr>
</table>
</div>

4
components/light.blinksticklight.html
View file

@ -120,7 +120,7 @@ The blinkstick platform let you can control your <a href="https://www.blinkstick
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">light</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">blinksticklight</span>
</span><span class='line'> <span class="l-Scalar-Plain">serial</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">/dev/ttyUSB0</span>
</span><span class='line'> <span class="l-Scalar-Plain">serial</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">BS000795-1.1</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Living Room</span>
</span></code></pre></td></tr></table></div></figure>
@ -128,7 +128,7 @@ The blinkstick platform let you can control your <a href="https://www.blinkstick
<p>Configuration variables:</p>
<ul>
<li><strong>serial</strong> (<em>Required</em>): The port where your stick is connected to.</li>
<li><strong>serial</strong> (<em>Required</em>): The serial number of your stick.</li>
<li><strong>name</strong> (<em>Required</em>): Name of the stick.</li>
</ul>

3
components/media_player.html
View file

@ -114,8 +114,11 @@
<ul>
<li><a href="/components/media_player.cast.html">Chromecasts</a></li>
<li><a href="/components/media_player.denon.html">Denon Network Receivers</a></li>
<li><a href="/components/media_player.itunes.html">iTunes</a></li>
<li><a href="/components/media_player.kodi.html">Kodi</a></li>
<li><a href="/components/media_player.mpd.html">Music Player Daemon</a></li>
<li><a href="/components/media_player.plex.html">Plex</a></li>
<li><a href="/components/media_player.sonos.html">Sonos</a></li>
<li><a href="/components/media_player.squeezebox.html">Squeezebox</a></li>
</ul>

20
components/media_player.plex.html
View file

@ -108,8 +108,9 @@
<p><img src='/images/supported_brands/plex.png' class='brand pull-right' />
The Plex platform allows you to connect a <a href="https://plex.tv">Plex Media Server</a> to Home Assistant.
It will allow you to control media playback and see the current playing item.</p>
The Plex platform allows you to connect a <a href="https://plex.tv">Plex Media Server</a> to Home Assistant. It will allow you to control media playback and see the current playing item.</p>
<p>To add Plex to your installation, add the following to your <code>configuration.yaml</code> file:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
@ -117,17 +118,24 @@ It will allow you to control media playback and see the current playing item.</p
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">media_player</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">plex</span>
</span><span class='line'> <span class="c1"># The name of the backend device (Under Plex Media Server &gt; settings &gt; server)</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">plex_server</span>
</span><span class='line'> <span class="l-Scalar-Plain">user</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">your_username</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">your_secure_password</span>
</span><span class='line'> <span class="l-Scalar-Plain">user</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_USERNAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_PASSWORD</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> <em>Required</em>: The name of the backend device (Under Plex Media Server > settings > server)</li>
<li><strong>user</strong> <em>Required</em>: The username for your Pley server.</li>
<li><strong>password</strong> <em>Required</em>: The password for your Plex server.</li>
</ul>
</article>

209
components/notify.telegram.html Normal file
View file

@ -0,0 +1,209 @@
<!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>Telegram notification support - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to add Telegram notifications to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/notify.telegram.html">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Telegram notification support">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/notify.telegram.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to add Telegram notifications to Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Configuration basics</a></li>
<li><a href='/getting-started/devices.html'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection.html'>Presence detection</a></li>
<li><a href='/getting-started/automation.html'>Automation</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
<li><a href='/components/'>Component overview</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">Credits</a></li>
</ul>
</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">
Telegram Notification Support
</h1>
</header>
<hr class="divider">
<p><img src='/images/supported_brands/telegram.png' class='brand pull-right' />
The telegram platform uses <a href="https://web.telegram.org">Telegram</a> to delivery notifications from Home Assistant to your Android device, your Windows phone, or your iOS device.</p>
<p>The requirement are:</p>
<ul>
<li>You need a <a href="https://core.telegram.org/bots">Telegram bot</a>. Please follow those <a href="https://core.telegram.org/bots#botfather">instructions</a> to create one and get the token. Keep in mind that bots are not allowed to contact users. You need to make the first contactwith your user.</li>
<li>The chat ID of an user</li>
</ul>
<p>An easy way to get your chat ID is described below:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
</pre></td><td class='code'><pre><code class='python'><span class='line'><span class="kn">import</span> <span class="nn">telegram</span>
</span><span class='line'><span class="n">bot</span> <span class="o">=</span> <span class="n">telegram</span><span class="o">.</span><span class="n">Bot</span><span class="p">(</span><span class="n">token</span><span class="o">=</span><span class="s">&#39;YOUR_API_TOKEN&#39;</span><span class="p">)</span>
</span><span class='line'><span class="n">chat_id</span> <span class="o">=</span> <span class="n">bot</span><span class="o">.</span><span class="n">getUpdates</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">chat_id</span>
</span><span class='line'><span class="k">print</span><span class="p">(</span><span class="n">chat_id</span><span class="p">)</span>
</span></code></pre></td></tr></table></div></figure>
<p>To enable Telegram notifications in your installation, add the following to your <code>configuration.yaml</code> file:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">notify</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">NOTIFIER_NAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">telegram</span>
</span><span class='line'> <span class="c1"># Get those by creating a new bot on https://core.telegram.org/bots</span>
</span><span class='line'> <span class="l-Scalar-Plain">api_key</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">ABCDEFGHJKLMNOPQRSTUVXYZ</span>
</span><span class='line'> <span class="l-Scalar-Plain">chat_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_CHAT_ID</span>
</span></code></pre></td></tr></table></div></figure>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code>name</code> allows multiple notifiers to be created.
The default value is <code>notify</code>. The notifier will bind to the service
<code>notify.NOTIFIER_NAME</code>.</li>
<li><strong>api_key</strong> (<em>Required</em>): The API token of your bot.</li>
<li><strong>chat_id</strong> (<em>Required</em>: The chat ID of your user.</li>
</ul>
<p>To use notifications, please see the <a href="/components/automation.html">getting started with automation page</a>.</p>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>

6
components/sensor.arest.html
View file

@ -9,7 +9,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>aREST support - Home Assistant</title>
<title>aREST sensor support - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate aREST sensors within Home Assistant.">
@ -18,7 +18,7 @@
<link rel="canonical" href="https://home-assistant.io/components/sensor.arest.html">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="aREST support">
<meta property="og:title" content="aREST sensor support">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.arest.html/">
<meta property="og:type" content="website">
@ -101,7 +101,7 @@
<header>
<h1 class="title indent">
aREST Support
aREST Sensor Support
</h1>
</header>
<hr class="divider">

2
components/sensor.command_sensor.html
View file

@ -196,7 +196,7 @@ is of interest. Add something similar to your <code>configuration.yaml</code> fi
<h3><a class='title-link' name='use-an-external-script' href='#use-an-external-script'></a> Use an external script</h3>
<p>The example is doing the same as the <a href="/components/sensor.arest.html">aREST sensor</a> but with an external Python script. It should give you an idea about interacting with devices which are exposing a REST API.</p>
<p>The example is doing the same as the <a href="/components/sensor.arest.html">aREST sensor</a> but with an external Python script. It should give you an idea about interacting with devices which are exposing a RESTful API.</p>
<p>The one-line script to retrieve a value is shown below. Of course would it be possible to use this directly in the <code>configuration.yaml</code> file but need extra care about the quotation marks.</p>

4
components/switch.arest.html
View file

@ -108,7 +108,7 @@
<p><img src='/images/supported_brands/arest.png' class='brand pull-right' />
The arest switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the <a href="http://arest.io/">aREST</a> RESTful framework.</p>
The arest switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the <a href="http://arest.io/">aREST</a> RESTful framework.</p>
<p>To use your aREST enabled device in your installation, add the following to your <code>configuration.yaml</code> file:</p>
@ -136,7 +136,7 @@ The arest switch platform allows you to toggle pins of your devices (like Arduin
<p>Configuration variables:</p>
<ul>
<li><strong>resource</strong> (<em>Required</em>): IP address and schema of the device that is exposing an aREST API, e.g. <a href="http://192.168.1.10.">http://192.168.1.10.</a></li>
<li><strong>resource</strong> (<em>Required</em>): IP address and schema of the device that is exposing an aREST API, eg. <a href="http://192.168.1.10.">http://192.168.1.10.</a></li>
<li><strong>pins</strong> (<em>Required</em>): An array with all used pins of your board.
<ul>

32
components/switch.command_switch.html
View file

@ -147,6 +147,12 @@ A switch platform that issues specific commands when it is turned on and off. Th
</ul>
<h2><a class='title-link' name='examples' href='#examples'></a> Examples</h2>
<p>In this section you find some real life examples of how to use this switch.</p>
<h3><a class='title-link' name='arest-device' href='#arest-device'></a> aREST device</h3>
<p>The example below is doing the same as the <a href="/components/switch.arest.html">aREST switch</a>. The commandline tool <code>[curl](http://curl.haxx.se/)</code> is used to toogle a pin which is controllable through REST.</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
@ -166,6 +172,32 @@ A switch platform that issues specific commands when it is turned on and off. Th
</span></code></pre></td></tr></table></div></figure>
<h3><a class='title-link' name='shutdown-your-local-host' href='#shutdown-your-local-host'></a> Shutdown your local host</h3>
<p>This switch will shutdown your system that is hosting Home Assistant.</p>
<p class='note warning'>
This switch will shudown your host immediately, there will be no confirmation.
</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">switch</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">command_switch</span>
</span><span class='line'> <span class="l-Scalar-Plain">switches</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">Home Assistant system shutdown</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="l-Scalar-Plain">offcmd</span><span class="p-Indicator">:</span> <span class="s">&quot;/usr/sbin/poweroff&quot;</span>
</span></code></pre></td></tr></table></div></figure>