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

Site updated at 2017-10-15 21:57:55 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-15 21:57:55 +00:00
parent 8d71b901ea
commit b4480f297a
36 changed files with 176 additions and 113 deletions
Download patch file Download diff file Expand all files Collapse all files

68
components/device_tracker.gpslogger/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>This platform allows you to detect presence using <a href="http://code.mendhak.com/gpslogger/">GPSLogger</a>. GPSLogger is an open source app for <a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">Android</a> that allows users to set up a <code class="highlighter-rouge">GET</code> request to update GPS coordinates. This can be configured with Home Assistant to update your location.</p>
<p>The <code class="highlighter-rouge">gpslogger</code> device tracker platform allows you to detect presence using <a href="http://code.mendhak.com/gpslogger/">GPSLogger</a>. GPSLogger is an open source app for <a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">Android</a> that allows users to set up a <code class="highlighter-rouge">GET</code> request to update GPS coordinates. This can be configured with Home Assistant to update your location.</p>
<p>To integrate GPSLogger in 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="c1"># Example configuration.yaml entry</span>
<span class="s">device_tracker</span><span class="pi">:</span>
@ -82,42 +82,44 @@
</code></pre>
</div>
<h2><a class="title-link" name="setup-on-your-smartphone" href="#setup-on-your-smartphone"></a> Setup on your smartphone</h2>
<ul>
<li><a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">GPSLogger for Android</a></li>
</ul>
<p>To configure GPSLogger, you must set up the app to send a <code class="highlighter-rouge">GET</code> request to your Home Assistant server at</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">http://&lt;ha_server&gt;/api/gpslogger?latitude=%LAT&amp;longitude=%LON&amp;device=%SER&amp;accuracy=%ACC&amp;battery=%BATT&amp;speed=%SPD&amp;direction=%DIR&amp;altitude=%ALT&amp;provider=%PROV&amp;activity=%ACT</span>
<p>Install <a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">GPSLogger for Android</a> on your device.</p>
<p>After the launch, go to <strong>General Options</strong>. Enable <strong>Start on bootup</strong> and <strong>Start on app launch</strong>.</p>
<p class="img">
<img width="300" src="/images/components/gpslogger/settings.png" />
GPSLogger Settings
</p>
<p>Go to <strong>Logging details</strong> and disable <strong>Log to GPX</strong>. <strong>Log to KML</strong>, and <strong>Log to NMEA</strong>. Enable <strong>Log to custom URL</strong>.</p>
<p class="img">
<img width="300" src="/images/components/gpslogger/logging-details.png" />
Logging Details
</p>
<p>Right after enabling, the app will take you to the <strong>Log to custom URL</strong> settings.</p>
<p class="img">
<img width="300" src="/images/components/gpslogger/custom-url.png" />
Log to custom URL details
</p>
<p>The relevant endpoint is: <code class="highlighter-rouge">/api/gpslogger</code></p>
<div class="language-text highlighter-rouge"><pre class="highlight"><code>http://[IP address Home Assistant]:[Port]/api/gpslogger?
latitude=%LAT&amp;longitude=%LON&amp;device=%SER&amp;accuracy=%ACC
&amp;battery=%BATT&amp;speed=%SPD&amp;direction=%DIR
&amp;altitude=%ALT&amp;provider=%PROV&amp;activity=%ACT
</code></pre>
</div>
<p>Make sure to include the API password if you have configured a password in Home Assistant (add <code class="highlighter-rouge">&amp;api_password=&lt;password&gt;</code> to the end of the URL).
You can change your device name by editing “%SER” in this URL (e.g.: &amp;device=user_devicename)
Configure that options under “General Options”:</p>
<p>Add the above URL after you modified it with your settings into the <strong>URL</strong> field. Remove the line breaks as they are only there to make the URL readable here.</p>
<ul>
<li>Start on boot: yes</li>
<li>Start on app launch: yes</li>
<li>It’s HIGHLY recommended to use SSL/TLS.</li>
<li>Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.</li>
<li>Only remove <code class="highlighter-rouge">[Port]</code> if your Home Assistant instance is using port 80. Otherwise set it to 8123.</li>
<li>Click on <strong>Parameters</strong> in the app and you will see all available parameters for the URL. For Home Assistant only the above URL will work.</li>
<li>Make sure to include your <a href="/components/http/">API password</a> if you have configured a password. Add <code class="highlighter-rouge">&amp;api_password=[Your pasword]</code> to the end of the URL.</li>
<li>You can change the name of your device name by replacing <code class="highlighter-rouge">&amp;device=%SER</code> with <code class="highlighter-rouge">&amp;device=[Devicename]</code>.</li>
</ul>
<p>Set the URL under “General Options -&gt; Logging details”:</p>
<ul>
<li>Log to GPX: no</li>
<li>Log to KML: no</li>
<li>Log to custom URL: yes and set
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">http://&lt;ha_server&gt;/api/gpslogger?latitude=%LAT&amp;longitude=%LON&amp;device=%SER&amp;accuracy=%ACC&amp;battery=%BATT&amp;speed=%SPD&amp;direction=%DIR&amp;altitude=%ALT&amp;provider=%PROV&amp;activity=%ACT</span>
</code></pre>
</div>
<p>(be sure you include API password (<code class="highlighter-rouge">&amp;api_password=&lt;password&gt;</code>) if needed, or you can also use HTTP Basic authentication <code class="highlighter-rouge">http://&lt;username&gt;:&lt;password&gt;@&lt;ha_server&gt;/api/gpslogger...</code>)
(You can change your device name by editing “%SER” in this URL (e.g.: &amp;device=user_devicename))</p>
</li>
<li>Log to OpenGTS Server: no</li>
<li>Log to Plain Text: no</li>
<li>Log to NMEA: no</li>
</ul>
<p>You should also tune GPSLogger performance to save your battery under “General Options -&gt; Logging details -&gt; Performance -&gt; Location providers”:</p>
<ul>
<li>GPS: no</li>
<li>Network: no</li>
<li>Passive: yes</li>
</ul>
<p>A request can be forced from the app to test if everything is working fine. A succesfull request will update <code class="highlighter-rouge">known_devices.yaml</code> with device serial number.</p>
<p>If your battery drains fast then you can tune the performence of GPSLogger under <strong>Performance</strong> -&gt; <strong>Location providers</strong></p>
<p class="img">
<img width="300" src="/images/components/gpslogger/performance.png" />
Performance
</p>
<p>A request can be forced from the app to test if everything is working fine. A succesful request will update the <code class="highlighter-rouge">known_devices.yaml</code> file with the device’s serial number.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

4
components/index.html
View file

@ -82,7 +82,7 @@ Support for these components is provided by the Home Assistant community.
<div class="filter-button-group">
<a href='#all' class="btn">All (844)</a>
<a href='#featured' class="btn featured">Featured</a>
<a href='#version/0.55' class="btn added_in_current_version">Added in 0.55 (14)</a>
<a href='#version/0.55' class="btn added_in_current_version">Added in 0.55 (15)</a>
<a href='#version/0.54' class="btn added_one_version_ago">Added in 0.54 (15)</a>
<a href='#version/0.53' class="btn added_two_versions_ago">Added in 0.53 (18)</a>
<a href='#alarm' class="btn">Alarm (17)</a>
@ -432,7 +432,7 @@ var allComponents = [
{url:"/components/sensor.influxdb/", title:"InfluxDB Sensor", cat:"sensor", featured: false, v: "0.32", logo: "influxdb.png"},
{url:"/components/input_boolean/", title:"Input Boolean", cat:"automation", featured: false, v: "0.0", logo: "home-assistant.png"},
{url:"/components/input_datetime/", title:"Input Datetime", cat:"automation", featured: false, v: "0.55", logo: "home-assistant.png"},
{url:"/components/input_number/", title:"Input Number", cat:"automation", featured: false, v: "0.16", logo: "home-assistant.png"},
{url:"/components/input_number/", title:"Input Number", cat:"automation", featured: false, v: "0.55", logo: "home-assistant.png"},
{url:"/components/input_select/", title:"Input Select", cat:"automation", featured: false, v: "0.13", logo: "home-assistant.png"},
{url:"/components/input_text/", title:"Input Text", cat:"automation", featured: false, v: "0.53", logo: "home-assistant.png"},
{url:"/components/notify.instapush/", title:"Instapush", cat:"notifications", featured: false, v: "0.7", logo: "instapush.png"},

2
components/input_number/index.html
View file

@ -235,7 +235,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
Introduced in release: 0.16
Introduced in release: 0.55
</div>
<div class='section'>
<h1 class="title delta">Category Automation</h1>