Site updated at 2016-09-11 01:34:03 UTC
This commit is contained in:
parent
99424b497c
commit
f143c60d71
311 changed files with 4596 additions and 1607 deletions
|
@ -78,6 +78,55 @@
|
|||
|
||||
|
||||
|
||||
<article class="listing">
|
||||
<header>
|
||||
|
||||
<h1 class="beta">
|
||||
<a href="/blog/2016/04/17/updated-documentation/">Updated documentation</a>
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
<div class="meta clearfix">
|
||||
<time datetime="2016-04-17T06:09:00+00:00" pubdate data-updated="true"><i class="icon-calendar"></i> April 17, 2016</time>
|
||||
<span class="byline author vcard"><i class='icon-user'></i> Paulus Schoutsen</span>
|
||||
<span><i class='icon-time'></i> 1 minute reading time</span>
|
||||
<span>
|
||||
<i class="icon-tags"></i>
|
||||
<ul class="tags unstyled">
|
||||
|
||||
|
||||
<li>Website</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</span>
|
||||
|
||||
<a class='comments'
|
||||
href="/blog/2016/04/17/updated-documentation/#disqus_thread"
|
||||
>Comments</a>
|
||||
|
||||
</div>
|
||||
|
||||
</header>
|
||||
|
||||
|
||||
<div class="entry-content clearfix">
|
||||
<p>One of the main complaints that we receive is something along the lines “I read that X is possible yet I am unable to find it on the website.”. This post is to announce that we have taken the first steps to improve it by revamping the <a href="/getting-started/">getting started</a> and <a href="/developers/">developers</a> sections. It’s still a work in progress but we now have a solid foundation to build on for the future 👍.</p>
|
||||
|
||||
<p>Our documentation has been going through various phases. Initially it was just the README in our GitHub repository. I discovered Jekyll and GitHub pages in December 2014 and created home-assistant.io. I more or less broke the README in 5 pages and <a href="/blog/2014/12/18/website-launched/">called it a website</a>. Back then we had a whopping <a href="https://github.com/home-assistant/home-assistant.io/blob/86bb2df430ce267ab2123d51592d3f068ae509b5/source/components/index.markdown">11 components</a>.</p>
|
||||
|
||||
<p>As Home Assistant grew, so did our documentation. <a href="https://github.com/fabaff">Fabian Affolter</a> does an amazing job in making sure there is at least a documentation stub for each new feature that lands. And that’s quite a feat given our <a href="https://home-assistant.io/blog/categories/release-notes/">frequent releases</a>! But despite all the efforts, the documentation outgrew our existing documentation organisation.</p>
|
||||
|
||||
<p>Today it has been almost 1.5 years since we started the website. We now have <a href="/components/">264 components and platforms</a> under our belt and have been honored with 1.5 million page views ✨. And hopefully we now also have documentation that our community deserves.</p>
|
||||
|
||||
<p>Finally, if you see some content that could use more clarifcation or is outdated, don’t hesitate to use the ‘Edit in GitHub’ link that is present on each page.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</article>
|
||||
<hr>
|
||||
|
||||
<article class="listing">
|
||||
<header>
|
||||
|
||||
|
@ -737,109 +786,6 @@ Hold your NFC tag against the belly of Garfield to unlock the alarm.
|
|||
|
||||
|
||||
|
||||
</div>
|
||||
</article>
|
||||
<hr>
|
||||
|
||||
<article class="listing">
|
||||
<header>
|
||||
|
||||
<h1 class="beta">
|
||||
<a href="/blog/2016/02/12/classifying-the-internet-of-things/">Classifying the Internet of Things</a>
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
<div class="meta clearfix">
|
||||
<time datetime="2016-02-12T06:31:00+00:00" pubdate data-updated="true"><i class="icon-calendar"></i> February 12, 2016</time>
|
||||
<span class="byline author vcard"><i class='icon-user'></i> Paulus Schoutsen</span>
|
||||
<span><i class='icon-time'></i> seven minutes reading time</span>
|
||||
<span>
|
||||
<i class="icon-tags"></i>
|
||||
<ul class="tags unstyled">
|
||||
|
||||
|
||||
<li>Internet-of-Things</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</span>
|
||||
|
||||
<a class='comments'
|
||||
href="/blog/2016/02/12/classifying-the-internet-of-things/#disqus_thread"
|
||||
>Comments</a>
|
||||
|
||||
</div>
|
||||
|
||||
</header>
|
||||
|
||||
|
||||
<div class="entry-content clearfix">
|
||||
<p>The core of home automation is knowing what’s going on. The faster we know about a state change, the better we can serve the user. If you want to have your lights to turn on when you arrive at home, it doesn’t help if it only knows about it after you’ve already opened the door and manually (!!) turned on the light.</p>
|
||||
|
||||
<p>Each smart device consists of the ‘normal’ device and the piece that makes it ‘smart’: the connectivity. The connectivity part of a device can consists of either control, state or both.</p>
|
||||
|
||||
<p>State describes what a device is up to right now. For example, a light can be on with a red color and a medium brightness.</p>
|
||||
|
||||
<p>Control is about controlling the smart device by sending commands via an API. These commands can vary from configuring how a device works till mimicking how a user would interact with a device. A media player can allow skipping to the next track and a sensor could allow to configure its sensitivity or polling interval.</p>
|
||||
|
||||
<p>The Home Assistant APIs are setup to be as convenient as possible. However, a network is always as weak as it’s weakest link. In our case these are the integrations. Take for example controlling a light that does not report state. The only state Home Assistant can report on after sending a command is the assumed state: what do we expect the state of the light to be if the command worked.</p>
|
||||
|
||||
<p>We want our users to get the best home automation experience out there and this starts with making sure they have devices that work well with Home Assistant. That’s why we will start applying the following classifiers to our integrations:</p>
|
||||
|
||||
<p><a name="classifiers"></a></p>
|
||||
<table>
|
||||
<tr>
|
||||
<th colspan="2">Classifier</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><i class="icon-adjust"></i></td>
|
||||
<td style="white-space: nowrap;">Assumed State</td>
|
||||
<td>
|
||||
We are unable to get the state of the device. Best we can do is to assume the state based on our last command.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><i class="icon-cloud-upload"></i></td>
|
||||
<td>Cloud Polling</td>
|
||||
<td>
|
||||
Integration of this device happens via the cloud and requires an active internet connection. Polling the state means that an update might be noticed later.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><i class="icon-cloud-download"></i></td>
|
||||
<td>Cloud Push</td>
|
||||
<td>
|
||||
Integration of this device happens via the cloud and requires an active internet connection. Home Assistant will be notified as soon as a new state is available.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><i class="icon-download-alt"></i></td>
|
||||
<td>Local Polling</td>
|
||||
<td>
|
||||
Offers direct communication with device. Polling the state means that an update might be noticed later.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><i class="icon-upload-alt"></i></td>
|
||||
<td>Local Push</td>
|
||||
<td>
|
||||
Offers direct communication with device. Home Assistant will be notified as soon as a new state is available.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>The background to how we got to these classifiers can be read after the break.</p>
|
||||
|
||||
|
||||
|
||||
<a class="btn pull-right" href="/blog/2016/02/12/classifying-the-internet-of-things/#read-more">Read on →</a>
|
||||
|
||||
</div>
|
||||
</article>
|
||||
<hr>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue