From 25b3ac85bc7e49e700e059d078e5839ba2fc93df Mon Sep 17 00:00:00 2001 From: Travis CI Date: Tue, 4 Oct 2016 19:04:47 +0000 Subject: [PATCH] Site updated at 2016-10-04 19:04:47 UTC --- atom.xml | 2 +- blog/categories/community/atom.xml | 2 +- blog/categories/device-tracking/atom.xml | 2 +- blog/categories/esp8266/atom.xml | 2 +- blog/categories/how-to/atom.xml | 2 +- blog/categories/ibeacons/atom.xml | 2 +- blog/categories/internet-of-things/atom.xml | 2 +- blog/categories/iot-data/atom.xml | 2 +- blog/categories/micropython/atom.xml | 2 +- blog/categories/mqtt/atom.xml | 2 +- blog/categories/organisation/atom.xml | 2 +- blog/categories/owntracks/atom.xml | 2 +- blog/categories/presence-detection/atom.xml | 2 +- .../public-service-announcement/atom.xml | 2 +- blog/categories/release-notes/atom.xml | 2 +- blog/categories/survey/atom.xml | 2 +- blog/categories/talks/atom.xml | 2 +- blog/categories/technology/atom.xml | 2 +- blog/categories/user-stories/atom.xml | 2 +- blog/categories/video/atom.xml | 2 +- blog/categories/website/atom.xml | 2 +- developers/architecture_components/index.html | 26 ++++++------ developers/development/index.html | 10 ++--- developers/development_environment/index.html | 41 +++++++++++-------- sitemap.xml | 30 +++++++------- 25 files changed, 78 insertions(+), 71 deletions(-) diff --git a/atom.xml b/atom.xml index f1713e5c7d..5fd0b62f0e 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/community/atom.xml b/blog/categories/community/atom.xml index 2634fad691..940cb1cc5d 100644 --- a/blog/categories/community/atom.xml +++ b/blog/categories/community/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Community | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/device-tracking/atom.xml b/blog/categories/device-tracking/atom.xml index 670c20cfe9..2ebaff57ee 100644 --- a/blog/categories/device-tracking/atom.xml +++ b/blog/categories/device-tracking/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Device-Tracking | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/esp8266/atom.xml b/blog/categories/esp8266/atom.xml index da020a1fdf..6fb5d6edbc 100644 --- a/blog/categories/esp8266/atom.xml +++ b/blog/categories/esp8266/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: ESP8266 | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/how-to/atom.xml b/blog/categories/how-to/atom.xml index 26d3745a99..7a89d4bad4 100644 --- a/blog/categories/how-to/atom.xml +++ b/blog/categories/how-to/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: How-To | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/ibeacons/atom.xml b/blog/categories/ibeacons/atom.xml index c73ecfab4b..85219af89d 100644 --- a/blog/categories/ibeacons/atom.xml +++ b/blog/categories/ibeacons/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: iBeacons | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/internet-of-things/atom.xml b/blog/categories/internet-of-things/atom.xml index 58fc2de22a..bf3f3c0a7f 100644 --- a/blog/categories/internet-of-things/atom.xml +++ b/blog/categories/internet-of-things/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Internet-of-Things | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/iot-data/atom.xml b/blog/categories/iot-data/atom.xml index 68a2eaf159..281b5bcd32 100644 --- a/blog/categories/iot-data/atom.xml +++ b/blog/categories/iot-data/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: IoT-Data | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/micropython/atom.xml b/blog/categories/micropython/atom.xml index a11a1a7e86..3719700249 100644 --- a/blog/categories/micropython/atom.xml +++ b/blog/categories/micropython/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Micropython | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/mqtt/atom.xml b/blog/categories/mqtt/atom.xml index f46c6f04fb..d250e27193 100644 --- a/blog/categories/mqtt/atom.xml +++ b/blog/categories/mqtt/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: MQTT | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/organisation/atom.xml b/blog/categories/organisation/atom.xml index d239588ca6..2a83c6c676 100644 --- a/blog/categories/organisation/atom.xml +++ b/blog/categories/organisation/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Organisation | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/owntracks/atom.xml b/blog/categories/owntracks/atom.xml index 7c4f584457..372cda5d83 100644 --- a/blog/categories/owntracks/atom.xml +++ b/blog/categories/owntracks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: OwnTracks | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/presence-detection/atom.xml b/blog/categories/presence-detection/atom.xml index 628efe7386..8d378d9cb1 100644 --- a/blog/categories/presence-detection/atom.xml +++ b/blog/categories/presence-detection/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Presence-Detection | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/public-service-announcement/atom.xml b/blog/categories/public-service-announcement/atom.xml index 47f16bd18c..65bb923810 100644 --- a/blog/categories/public-service-announcement/atom.xml +++ b/blog/categories/public-service-announcement/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Public-Service-Announcement | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml index 47f24f317b..c03efc64f6 100644 --- a/blog/categories/release-notes/atom.xml +++ b/blog/categories/release-notes/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Release-Notes | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/survey/atom.xml b/blog/categories/survey/atom.xml index d51d388b9a..9a6dc57397 100644 --- a/blog/categories/survey/atom.xml +++ b/blog/categories/survey/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Survey | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/talks/atom.xml b/blog/categories/talks/atom.xml index cf3b664494..2f3c8a75ec 100644 --- a/blog/categories/talks/atom.xml +++ b/blog/categories/talks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Talks | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/technology/atom.xml b/blog/categories/technology/atom.xml index 491d1872d0..fa1aa2db00 100644 --- a/blog/categories/technology/atom.xml +++ b/blog/categories/technology/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Technology | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml index 96fe83ba36..226ca8e41f 100644 --- a/blog/categories/user-stories/atom.xml +++ b/blog/categories/user-stories/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: User-Stories | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/video/atom.xml b/blog/categories/video/atom.xml index 08ea5c8e45..6d197aca70 100644 --- a/blog/categories/video/atom.xml +++ b/blog/categories/video/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Video | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/blog/categories/website/atom.xml b/blog/categories/website/atom.xml index 016dd43ff3..56f3de3d7f 100644 --- a/blog/categories/website/atom.xml +++ b/blog/categories/website/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Website | Home Assistant]]> - 2016-10-04T18:59:17+00:00 + 2016-10-04T19:03:05+00:00 https://home-assistant.io/ diff --git a/developers/architecture_components/index.html b/developers/architecture_components/index.html index 88263fa25e..039e969c87 100644 --- a/developers/architecture_components/index.html +++ b/developers/architecture_components/index.html @@ -89,30 +89,28 @@
-

Home Assistant can be extended by components. Each component is responsible for a specific domain within Home Assistant. Components can listen for or trigger events, offer services and maintain states. Components are written in Python and can do all the goodness that Python has to offer. Out of the box, Home Assistant offers a bunch of built-in components.

+

Home Assistant can be extended with components. Each component is responsible for a specific domain within Home Assistant. Components can listen for or trigger events, offer services, and maintain states. Components are written in Python and can do all the goodness that Python has to offer. Out of the box, Home Assistant offers a bunch of built-in components.

Diagram showing interaction between components and the Home Assistant core. -Diagram showing interaction between components and the Home Assistant core. +Diagram showing interaction between components and the Home Assistant core

-

We can differentiate between two different types of components within Home Assistant.

+

There are two types of components within Home Assistant: components that interact with an Internet-of-Things domain, and components that respond to events that happen within Home Assistant. Read on to learn about each type!

-

Components that interact with an Internet of Things domain

+

Components that interact with an Internet-of-Things domain

-

These components will track devices within a specific domain and consist of a core part and platform-specific logic. These components make their information available via the State Machine and the Event Bus. The component will also register services in the Service Registry to expose control of the devices.

+

These components track devices within a specific domain and consist of a core part and platform-specific logic. These components make their information available via the State Machine and the Event Bus. The components also register services in the Service Registry to expose control of the devices.

-

For example, one of the built-in components is the switch component. This component is responsible for interaction with different types of switches.

+

For example, the built-in switch component is responsible for interaction with different types of switches. A platform provides support for a particular kind or brand of device. For example, a switch could use a WeMo or Orvibo platform, and a light component might interact with the Hue or LiFX platform.

-

A platform provides support for a particular kind/brand of device. For example, a switch could use a WeMo or Orvibo platform, and a light component might interact with the Hue or LiFX platform.

- -

If you are planning to add support for a new platform, please check out the add new platform section.

+

If you want to add support for a new platform, check out the add new platform section.

Components that respond to events that happen within Home Assistant

These components provide small pieces of home automation logic or services that do common tasks within your house.

-

For example the device_sun_light_trigger component tracks the state of devices and the sun to make sure that the lights are turned on when it gets dark and there are people home. The component uses logic along the following lines:

+

For example, the device_sun_light_trigger component tracks the state of devices and the sun to make sure that the lights are turned on when it gets dark and people are home. The component uses logic like this:

    In the event that device 'Paulus Nexus 5' changes to the 'Home' state:
       If the sun has set and the lights are not on:
@@ -129,20 +127,20 @@ Diagram showing interaction between components and the Home Assistant core.
         Turn on the lights
-

An extended example of a home automation component can be found here.

+

Look here for an extended example of a home automation component.

The full picture

-

When we put all the different pieces of Home Assistant together we see that we match pretty close to the initial sketched home automation overview. The smart home AI is not implemented yet and therefore omitted from the following picture.

+

When we put all the different pieces of Home Assistant together, it’s a close match for the initial home automation overview sketch. The smart home AI is not implemented yet, so it’s not included in this picture.

- Overview of the full Home Assistant architecture with a couple of loaded components and platforms. + Overview of the full Home Assistant architecture with a couple of loaded components and platforms

-

The platform logic for components uses 3rd party Python libraries to communicate with the devices. This is done so that we can leverage great device libraries that are out there in the Python community.

+

The platform logic for components uses third-party Python libraries to communicate with the devices so we can leverage the great device libraries in the Python community.

diff --git a/developers/development/index.html b/developers/development/index.html index b1d70d3523..fb8fc339ef 100644 --- a/developers/development/index.html +++ b/developers/development/index.html @@ -89,14 +89,14 @@
-

Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses Python 3 for the backend and Polymer (Web components) for the frontend.

+

Home Assistant is built from the ground up to be easily extensible using components. Home Assistant uses Python 3 for the backend and Polymer (Web components) for the frontend.

-

Home Assistant is open-source and MIT licensed. The source can be found here:

+

Home Assistant is open-source and MIT-licensed. Here are links to the source::

diff --git a/developers/development_environment/index.html b/developers/development_environment/index.html index 5585ee0e57..9e825c0c29 100644 --- a/developers/development_environment/index.html +++ b/developers/development_environment/index.html @@ -89,28 +89,37 @@
-

You will need to set up a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to get setup. -Visit the the Home Assistant repository first and click fork in the top right.

+

You’ll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.

-

We suggest that you setup a virtual environment using venv before running the setup script.

+
    +
  1. Visit the the Home Assistant repository and click “fork.”
    2. +
-
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
-$ cd home-assistant
-$ git remote add upstream https://github.com/home-assistant/home-assistant.git
-$ script/setup
-
-
-

On Windows you can use python setup.py develop instead of the setup script.

+
    +
  • Consider setting up a virtual environment using venv before running the setup script.
    • +
-

After following these steps, running hass will invoke your local installation.

+

bash + $ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git + $ cd home-assistant + $ git remote add upstream https://github.com/home-assistant/home-assistant.git + $ script/setup +

+
    +
  • On Windows, you can use python setup.py develop instead of the setup script.
    • +
+ +
    +
  1. Run hass to invoke your local installation.
    2. +

Developing on Windows

-

If you are using Windows as a development platform ensure you have the correct Microsoft Visual C++ build tools installed. Please check the Windows Compilers section on the Python website for details. Validation using tox will fail if this is not done correctly.

+

If you are using Windows as a development platform, make sure that you have the correct Microsoft Visual C++ build tools installed. Check the Windows Compilers section on the Python website for details. Validation using tox will fail if this is not done correctly.

-

Ensure you install or upgrade the Setuptools Python package. It contains compatibility improvements and adds automatic use of compilers:

-
pip install --upgrade setuptools
-
-
+

Also, make sure to install or upgrade the Setuptools Python package – it contains compatibility improvements and adds automatic use of compilers: + bash + pip install --upgrade setuptools +

diff --git a/sitemap.xml b/sitemap.xml index 9895bc1448..4c100e500b 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2113,62 +2113,62 @@ https://home-assistant.io/demo/frontend.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/index.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-event.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-info.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-service.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-state.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-template.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-history.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-iframe.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-logbook.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/demo/panels/ha-panel-map.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:26+00:00 https://home-assistant.io/googlef4f3693c209fe788.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:27+00:00 https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:27+00:00 https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:27+00:00 https://home-assistant.io/static/mdi-demo.html -2016-10-04T18:58:35+00:00 +2016-10-04T19:02:27+00:00