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

Site updated at 2015-08-27 07:10:52 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-08-27 00:10:52 -07:00
parent 1e8bb05106
commit 790fc51379
60 changed files with 1761 additions and 358 deletions
Download patch file Download diff file Expand all files Collapse all files

8
components/automation.html
View file

@ -133,7 +133,7 @@
</span><span class='line'> state_to: 'below_horizon'
</span><span class='line'>
</span><span class='line'> # Action to be done when trigger activated
</span><span class='line'> execute_service: notify.notify
</span><span class='line'> execute_service: notify.NOTIFIER_NAME
</span><span class='line'> service_data: {"message":"The sun has set"}</span></code></pre></td></tr></table></div></figure>
@ -262,7 +262,7 @@
</span><span class='line'> service_data: {"rgb_color": [255, 0, 0]}
</span><span class='line'>
</span><span class='line'> # Notify the user
</span><span class='line'> execute_service: notify.notify
</span><span class='line'> execute_service: notify.NOTIFIER_NAME
</span><span class='line'> service_data: {"message":"YAY"}</span></code></pre></td></tr></table></div></figure>
@ -309,7 +309,7 @@
</span><span class='line'> state_from: 'above_horizon'
</span><span class='line'> state_to: 'below_horizon'
</span><span class='line'>
</span><span class='line'> execute_service: notify.notify
</span><span class='line'> execute_service: notify.NOTIFIER_NAME
</span><span class='line'> service_data: {"message":"The sun has set"}
</span><span class='line'>
</span><span class='line'>automation 2:
@ -337,7 +337,7 @@
<p class='note'>
All configuration entries have to be sequential. If you have <code>automation:</code>, <code>automation 2:</code> and <code>automation 4:</code> then the last one will not be processed.
All configuration entries have to be sequential. If you have <code>automation:</code>, <code>automation 2:</code> and <code>automation 4:</code> then the last one will not be processed.
</p>

19
components/media_player.cast.html
View file

@ -106,26 +106,21 @@
<p><img src='/images/supported_brands/google_cast.png' class='brand pull-right' />
Google Cast devices will be automatically discovered if you enable <a href="/components/discovery.html">the discovery component</a>.</p>
Google Cast devices will be automatically discovered if you enable <a href="/components/discovery.html">the discovery component</a>. There is a issue where Chromecasts can only be discovered if your device is connected to the same subnet as your Chromecast.</p>
<p>Can also be forced to load by adding the following lines to your <code>configuration.yaml</code>:</p>
<p>Chromecast platform can also be forced to load by adding the following lines to your <code>configuration.yaml</code>:</p>
<figure class='code'><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=''><span class='line'>media_player:
</span><span class='line'> platform: chromecast</span></code></pre></td></tr></table></div></figure>
</span><span class='line'> platform: chromecast
</span><span class='line'> # Optional. Will scan for devices if left out
</span><span class='line'> host: 192.168.1.9</span></code></pre></td></tr></table></div></figure>
<p class='note warning'>
Chromecasts have recently received a new API which is not yet supported by Home Assistant. Therefore we currently can only detect them and do not know what they are up to.
</p>
<p></p>
</article>

6
components/notify.file.html
View file

@ -115,14 +115,20 @@ The file platform allows you to store notifications from Home Assistant as a fil
<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">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">file</span>
</span><span class='line'> <span class="l-Scalar-Plain">filename</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">FILENAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">timestamp</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">1 or 0</span>
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>Setting <code>timestamp</code> to 1 adds a timestamp to every entry.</p>
<p>To use notifications, please see the <a href="/components/automation.html">getting started with automation page</a>.</p>

8
components/notify.html
View file

@ -110,13 +110,15 @@
<p>Home Assistant currently supports a wide range of services for notifications:</p>
<ul>
<li><a href="/components/notify.smtp.html">E-Mail</a></li>
<li><a href="/components/notify.file.html">File</a></li>
<li><a href="/components/notify.instapush.html">Instapush</a></li>
<li><a href="/components/notify.xmpp.html">Jabber (XMPP)</a></li>
<li><a href="/components/notify.nma.html">Notify My Android (NMA)</a></li>
<li><a href="/components/notify.pushbullet.html">PushBullet</a></li>
<li><a href="/components/notify.pushover.html">PushOver</a></li>
<li><a href="/components/notify.smtp.html">E-Mail</a></li>
<li><a href="/components/notify.slack.html">Slack</a></li>
<li><a href="/components/notify.syslog.html">Syslog</a></li>
<li><a href="/components/notify.xmpp.html">Jabber (XMPP)</a></li>
</ul>
@ -142,7 +144,7 @@
</span><span class='line'> state_from: above_horizon
</span><span class='line'> state_to: below_horizon
</span><span class='line'>
</span><span class='line'> execute_service: notify.notify
</span><span class='line'> execute_service: notify.NOTIFIER_NAME
</span><span class='line'> service_data: {"message":"YAY"}</span></code></pre></td></tr></table></div></figure>

6
components/notify.instapush.html
View file

@ -118,8 +118,10 @@ The instapush platform uses <a href="https://instapush.im">Instapush</a> to deli
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
<span class='line-number'>9</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">instapush</span>
</span><span class='line'> <span class="c1"># Get those by creating a new application, event, and tracker on https://instapush.im</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>
@ -129,6 +131,10 @@ The instapush platform uses <a href="https://instapush.im">Instapush</a> to deli
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>To retrieve those values for existing settings, log into your account at <a href="https://instapush.im">https://instapush.im</a> and go to your <strong>Dashboard</strong>. Then click <strong>APPS</strong> tab, choose an app, and check the <strong>Basic Info</strong> section. The <em>Application ID</em> is the <code>api_key</code> and <code>app_secret</code> is the <em>Application Secret</em>.</p>
<p>It&rsquo;s easy to test your Instapush setup outside of Home Assistant. Assuming you have an event <em>notification</em> and a tracker <em>home-assistant</em>, just fire a request and check the Instapush dashboard for a new entry.</p>

6
components/notify.nma.html
View file

@ -115,14 +115,20 @@ The nma platform uses <a href="http://www.notifymyandroid.com/">Notify My Androi
<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">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">nma</span>
</span><span class='line'> <span class="c1"># Get this by registering a new application on http://www.notifymyandroid.com/</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></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>To use notifications, please see the <a href="/components/automation.html">getting started with automation page</a>.</p>

15
components/notify.pushbullet.html
View file

@ -110,14 +110,21 @@ Home Assistant currently supports the awesome <a href="https://www.pushbullet.co
<p>To add PushBullet to your installation, add the following to your <code>configuration.yaml</code> file:</p>
<figure class='code'><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<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>
</pre></td><td class='code'><pre><code class=''><span class='line'>notify:
</span><span class='line'> platform: pushbullet
</span><span class='line'> api_key: YOUR_API_KEY</span></code></pre></td></tr></table></div></figure>
<span class='line-number'>4</span>
</pre></td><td class='code'><pre><code class='yaml'><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">pushbullet</span>
</span><span class='line'> <span class="l-Scalar-Plain">api_key</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_API_KEY</span>
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>For more automation examples, see the <a href="/components/automation.html">getting started with automation page</a>.</p>

8
components/notify.pushover.html
View file

@ -117,8 +117,10 @@ The <a href="https://pushover.net/">PushOver service</a> is a platform for the n
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</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">pushover</span>
</span><span class='line'> <span class="c1"># Get this by registering a new application on https://pushover.net</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>
@ -127,6 +129,10 @@ The <a href="https://pushover.net/">PushOver service</a> is a platform for the n
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<h3>Automation example</h3>
<p>Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your <code>configuration.yaml</code> to be notified when the sun sets.</p>
@ -149,7 +155,7 @@ The <a href="https://pushover.net/">PushOver service</a> is a platform for the n
</span><span class='line'> <span class="l-Scalar-Plain">state_from</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">above_horizon</span>
</span><span class='line'> <span class="l-Scalar-Plain">state_to</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">below_horizon</span>
</span><span class='line'>
</span><span class='line'> <span class="l-Scalar-Plain">execute_service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">notify.notify</span>
</span><span class='line'> <span class="l-Scalar-Plain">execute_service</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">notify.NOTIFIER_NAME</span>
</span><span class='line'> <span class="l-Scalar-Plain">service_data</span><span class="p-Indicator">:</span> <span class="p-Indicator">{</span><span class="s">&quot;message&quot;</span><span class="p-Indicator">:</span><span class="s">&quot;YAY&quot;</span><span class="p-Indicator">}</span>
</span></code></pre></td></tr></table></div></figure>

6
components/notify.slack.html
View file

@ -117,15 +117,19 @@ The slack platform allows you to deliver notifications from Home Assistant to <a
<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">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">slack</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">default_channel</span><span class="p-Indicator">:</span> <span class="s">&#39;#general&#39;</span>
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
</article>

6
components/notify.smtp.html
View file

@ -120,8 +120,10 @@ The smtp platform allows you to deliver notifications from Home Assistant to an
<span class='line-number'>8</span>
<span class='line-number'>9</span>
<span class='line-number'>10</span>
<span class='line-number'>11</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">mail</span>
</span><span class='line'> <span class="l-Scalar-Plain">server</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">MAIL_SERVER</span>
</span><span class='line'> <span class="l-Scalar-Plain">port</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_SMTP_PORT</span>
@ -133,6 +135,10 @@ The smtp platform allows you to deliver notifications from Home Assistant to an
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations.</p>
<p>A combination that will work properly is port 587 and STARTTLS. It&rsquo;s recommanded to enable STARTTLS, if possible.</p>

6
components/notify.syslog.html
View file

@ -116,8 +116,10 @@ The syslog platform allows you to deliver notifications from Home Assistant to t
<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">syslog</span>
</span><span class='line'> <span class="l-Scalar-Plain">facility</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">SYSLOG_FACILITY</span>
</span><span class='line'> <span class="l-Scalar-Plain">option</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">SYSLOG_LOG_OPTION</span>
@ -125,6 +127,10 @@ The syslog platform allows you to deliver notifications from Home Assistant to t
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>The table contains values to use in your <code>configuration.yaml</code> file.</p>
<table>

6
components/notify.xmpp.html
View file

@ -114,8 +114,10 @@ The xmpp platform allows you to deliver notifications from Home Assistant to a <
<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">xmpp</span>
</span><span class='line'> <span class="l-Scalar-Plain">sender</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_JID</span>
</span><span class='line'> <span class="l-Scalar-Plain">password</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR_JABBER_ACCOUNT_PASSWORD</span>
@ -123,6 +125,10 @@ The xmpp platform allows you to deliver notifications from Home Assistant to a <
</span></code></pre></td></tr></table></div></figure>
<p>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>.</p>
<p>All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender.</p>
<p>To use notifications, please see the <a href="/components/automation.html">getting started with automation page</a>.</p>

11
components/verisure.html
View file

@ -107,7 +107,16 @@
<p><img src='/images/supported_brands/verisure.png' class='brand pull-right' /></p>
<p>Home Assistant has support to integrate your <a href="https://www.verisure.com/">Verisure</a> devices. We support hygrometers, smartplugs and thermometers.</p>
<p>Home Assistant has support to integrate your <a href="https://www.verisure.com/">Verisure</a> devices.</p>
<p>We support:</p>
<ul>
<li>Smartplugs</li>
<li>Reading from thermometers and hygrometers integrated in various devices</li>
<li>Reading alarm status</li>
</ul>
<p>Username and password are required. Other variables are optional and allow you to disable certain devices.</p>