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

Site updated at 2017-10-04 05:55:26 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-04 05:55:27 +00:00
parent 6a897ee299
commit 270e531c76
27 changed files with 74 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

13
developers/rest_api/index.html
View file

@ -234,11 +234,11 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
</div>
<h4><a class="title-link" name="get-apihistoryperiodlttimestamp" href="#get-apihistoryperiodlttimestamp"></a> GET /api/history/period/&lt;timestamp&gt;</h4>
<p>Returns an array of state changes in the past. Each object contains further details for the entities.</p>
<p>The <code class="highlighter-rouge">&lt;timestamp&gt;</code> is optional and defaults to 1 day before the time of the request. It determines the beginning of the period.</p>
<p>The <code class="highlighter-rouge">&lt;timestamp&gt;</code> (<code class="highlighter-rouge">YYYY-MM-DDThh:mm:ssTZD</code>) is optional and defaults to 1 day before the time of the request. It determines the beginning of the period.</p>
<p>You can pass the following optional GET parameters:</p>
<ul>
<li><code class="highlighter-rouge">filter_entity_id=&lt;entity_id&gt;</code> to filter on a single entity</li>
<li><code class="highlighter-rouge">end_time=&lt;timestamp&gt;</code> to choose the end of the period (defaults to 1 day)</li>
<li><code class="highlighter-rouge">end_time=&lt;timestamp&gt;</code> to choose the end of the period in URL encoded format (defaults to 1 day).</li>
</ul>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">[</span><span class="w">
</span><span class="p">[</span><span class="w">
@ -258,8 +258,8 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
</span><span class="nt">"unit_of_measurement"</span><span class="p">:</span><span class="w"> </span><span class="s2">"\u00b0C"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"entity_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sensor.weather_temperature"</span><span class="p">,</span><span class="w">
</span><span class="nt">"last_changed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-06T22:15:00+00:00"",
"</span><span class="err">last_updated</span><span class="s2">": "</span><span class="mi">2016-02-06</span><span class="err">T</span><span class="mi">22</span><span class="err">:</span><span class="mi">15</span><span class="err">:</span><span class="mi">00</span><span class="err">+</span><span class="mi">00</span><span class="err">:</span><span class="mi">00</span><span class="s2">""</span><span class="p">,</span><span class="w">
</span><span class="nt">"last_changed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-06T22:15:00+00:00"</span><span class="p">,</span><span class="w">
</span><span class="nt">"last_updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-06T22:15:00+00:00"</span><span class="p">,</span><span class="w">
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-1.9"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">]</span><span class="w">
@ -277,6 +277,11 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?filter_entity_id<span class="o">=</span>sensor.temperature
</code></pre>
</div>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -X GET -H <span class="s2">"x-ha-access: YOUR_PASSWORD"</span> <span class="se">\</span>
-H <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?end_time<span class="o">=</span>2016-12-31T00%3A00%3A00%2B02%3A00
</code></pre>
</div>
<h4><a class="title-link" name="get-apistates" href="#get-apistates"></a> GET /api/states</h4>
<p>Returns an array of state objects. Each state has the following attributes: entity_id, state, last_changed and attributes.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">[</span><span class="w">