Merge branch 'master' into next

This commit is contained in:
Paulus Schoutsen 2016-08-16 00:04:26 -07:00
commit bf4390e943
58 changed files with 213 additions and 119 deletions

View File

@ -299,21 +299,6 @@ p.note {
transition-property: transform, opacity;
}
.filter-button-group {
margin-bottom: 16px;
.btn {
margin-right: 8px;
margin-bottom: 8px;
text-decoration: none;
&.current {
background-color: #3A5561;
background-image: linear-gradient(to bottom, #3A5561,#3F6B7D);
}
}
}
#componentContainer {
a {
display: inline-block;
@ -365,6 +350,49 @@ p.note {
}
}
@media only screen and (max-width: $lap-end) {
#components-page {
.filter-button-group {
margin-bottom: 16px;
.btn {
display: inline-block;
margin-right: 8px;
margin-bottom: 8px;
&.current {
background-color: #3A5561;
background-image: linear-gradient(to bottom, #3A5561,#3F6B7D);
}
}
}
}
}
@media only screen and (min-width: $desk-start) {
#components-page {
.filter-button-group {
.featured {
margin: 12px 0;
}
.btn {
display: block;
background: 0;
color: black;
box-shadow: none;
text-shadow: none;
padding: 2px;
&.current {
font-weight: bold;
}
}
}
}
}
.aside-module {
.section {
margin-bottom: 16px;

View File

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Binary Sensor
logo: home-assistant.png
---
The `template` platform supports sensors which breaks out the state and `state_attributes` from other entities.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_category: Downloading
ha_release: pre 0.7
---

View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: foursquare.png
featured: true
ha_category: Other
ha_category: Social
ha_release: 0.26
ha_iot_class: "Cloud Polling and Cloud Push"
---

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo:
logo: home-assistant.png
ha_category: Media Player
featured: false
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Frontend
ha_category: Front end
ha_release: 0.26
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Frontend
ha_category: Front end
ha_release: 0.25
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Organization
ha_category: Automation
ha_release: 0.13
---

View File

@ -8,8 +8,9 @@ comments: false
sharing: true
footer: true
logo: bitcoin.png
ha_category: Sensor
ha_category: Finance
ha_release: pre 0.7
ha_iot_class: "Cloud Polling"
---

View File

@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: System Monitor
ha_release: pre 0.7
ha_iot_class: "Local Push"
---

View File

@ -7,9 +7,9 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Transport
logo: db.png
ha_iot_class: "Local Polling"
ha_iot_class: "Cloud Polling"
ha_release: 0.14
---

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Energy
ha_release: 0.21
ha_iot_class: "Local Polling"
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: efergy.png
ha_category: Sensor
ha_category: Energy
ha_release: pre 0.7
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eliq.png
ha_category: Sensor
ha_category: Energy
ha_release: "0.10"
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: fastdotcom.png
ha_category: Sensor
ha_category: System Monitor
featured: false
ha_release: 0.26
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: fitbit.png
ha_category: Sensor
ha_category: Health
ha_iot_class: "Cloud Polling"
ha_release: 0.19
---

View File

@ -7,9 +7,9 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Finance
logo: fixer-io.png
ha_iot_class: "Local Polling"
ha_iot_class: "Cloud Polling"
ha_release: 0.23
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: glances.png
ha_category: Sensor
ha_category: System Monitor
ha_iot_class: "Local Polling"
ha_release: 0.7.3
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: google_maps.png
ha_category: Sensor
ha_category: Transport
ha_iot_class: "Cloud Polling"
ha_release: 0.19
---

View File

@ -10,11 +10,12 @@ footer: true
logo: gpsd.png
ha_category: Sensor
ha_release: 0.26
ha_iot_class: "Local Polling"
---
The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver.
A requirement is that `gpsd` is installed (`$ sudo dnf -y install gpsd` or `$ sudo apt-get install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested.
A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested.
```bash
$ sudo systemctl status gpsdctl@ttyUSB0.service
@ -55,4 +56,4 @@ Configuration variables:
- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`.
- **port** (*Optional*): The port which GPSD is using. Defaults to 2947.
- **port** (*Optional*): Friendly name to use for the frontend. Default to GPS.
- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: train.png
ha_category: Sensor
ha_category: Transport
ha_iot_class: "Local Polling"
ha_release: 0.17
---

View File

@ -1,7 +1,7 @@
---
layout: page
title: "IMAP Sensor"
description: "Instructions how to integrate IMAP sensors into Home Assistant."
title: "IMAP Unread E-mail"
description: "Instructions how to integrate IMAP unread email into Home Assistant."
date: 2016-07-11 06:00
sidebar: true
comments: false

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: lastfm.png
ha_category: Sensor
ha_category: Social
ha_iot_class: "Cloud Polling"
ha_release: "0.20"
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: loop.png
ha_category: Sensor
ha_category: Energy
ha_release: 0.17
---

View File

@ -9,6 +9,7 @@ sharing: true
footer: true
ha_category: Sensor
ha_release: '0.20'
ha_iot_class: "Local Polling"
---
The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Downloading
logo: nzbget.png
ha_iot_class: "Local Polling"
ha_release: 0.17

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: "ohmconnect.png"
ha_category: Sensor
ha_category: Energy
ha_iot_class: "Cloud Polling"
ha_release: 0.26
---

View File

@ -7,9 +7,9 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Finance
logo: openexchangerates.png
ha_iot_class: "Local Polling"
ha_iot_class: "Cloud Polling"
ha_release: 0.23
---

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Plex Sensor"
title: "Plex Activity Monitor"
description: "How to add a Plex sensor to Home Assistant."
date: 2016-06-3 08:19
sidebar: true
@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: plex.png
ha_category: Sensor
ha_category: Media Player
ha_release: 0.22
---

View File

@ -8,14 +8,15 @@ comments: false
sharing: true
footer: true
logo: sabnzbd.png
ha_category: Sensor
ha_category: Downloading
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
The `sabnzbd` platform will allow you to monitor your downloads with [SABnzbd](http://sabnzbd.org) from within Home Assistant and setup automation based on the information.
To use sabnzbd with your installation, add the following to your `configuration.yaml` file:
To use SABnzbd with your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: speedtest.png
ha_category: Sensor
ha_category: System Monitor
featured: false
ha_release: 0.13
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: steam.png
ha_category: Sensor
ha_category: Social
ha_iot_class: "Cloud Polling"
ha_release: 0.14
---

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: System Monitor
ha_release: "0.20"
---

View File

@ -7,8 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_category: Weather
ha_iot_class: "Cloud Polling"
ha_release: 0.22
---

View File

@ -8,8 +8,8 @@ comments: false
sharing: true
footer: true
logo: train.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_category: Transport
ha_iot_class: "Cloud Polling"
ha_release: pre 0.7
---

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: System Monitor
ha_release: pre 0.7
ha_iot_class: "Local Push"
---

View File

@ -9,6 +9,8 @@ sharing: true
footer: true
ha_category: Sensor
ha_release: 0.12
ha_iot_class: "Local Push"
logo: home-assistant.png
---
The `template` platform supports sensors which breaks out `state_attributes` from other entities.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Calendar
ha_iot_class: "Local Push"
ha_release: pre 0.7
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: torque.png
ha_category: Sensor
ha_category: Transport
ha_release: "0.10"
---

View File

@ -8,8 +8,9 @@ comments: false
sharing: true
footer: true
logo: transmission.png
ha_category: Sensor
ha_category: Downloading
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: twitch.png
ha_category: Sensor
ha_category: Social
ha_release: "0.10"
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: uber.png
ha_category: Sensor
ha_category: Transport
ha_iot_class: "Cloud Polling"
ha_release: 0.16
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Calendar
ha_iot_class: "Local Push"
ha_release: pre 0.7
---

View File

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Automation
logo: home-assistant.png
---
This component can expose regular shell commands as services. Services can be called from a [script] or in [automation].

View File

@ -1,14 +1,15 @@
---
layout: page
title: "Flux Switch"
title: "Flux Light Adjustment"
description: "Instructions how to have switches call command line commands."
date: 2016-06-01 17:41
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Switch
ha_category: Automation
ha_release: 0.21
logo: home-assistant.png
---
The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night.

View File

@ -9,7 +9,8 @@ sharing: true
footer: true
logo: pilight.png
ha_category: Switch
ha_release: pre 0.7
ha_release: 0.26
ha_iot_class: "Local Polling"
---

View File

@ -10,6 +10,7 @@ footer: true
logo: pulseaudio.png
ha_category: Switch
ha_release: 0.16
ha_iot_class: "Local Polling"
---

View File

@ -9,6 +9,8 @@ sharing: true
footer: true
ha_category: Switch
ha_release: 0.13
ha_iot_class: "Local Push"
logo: home-assistant.png
---
The `template` platform creates switches that combine components.

View File

@ -8,8 +8,9 @@ comments: false
sharing: true
footer: true
logo: transmission.png
ha_category: Switch
ha_category: Downloading
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Heat control"
title: "Generic Thermostat"
description: "Turn Home Assistant into a thermostat"
date: 2015-03-23 19:59
sidebar: true

View File

@ -7,8 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo:
ha_category: Other
ha_category: Front end
ha_release: 0.13
---

View File

@ -44,6 +44,16 @@ This release includes code contributed by 31 different people. The biggest chang
- New [pilight] component to control 433 Mz devices ([@DavidLP])
- Sensor: [GPSD] now supported ([@fabaff])
### {% linkable_title Hotfix 0.26.1 - August 14 %}
- Fix serial_pm config validation ([@open-homeautomation])
- Check for existence of system mode on Honeywell thermostats ([@mKeRix])
- Fix unknown unit of measurement for hvac and thermostat component ([@turbokongen])
### {% linkable_title Hotfix 0.26.2 - August 15 %}
- Fix Wemo: have PyWemo play nicely with the latest Requests ([@pavoni])
### {% linkable_title Breaking changes %}
- A new unit system has superseded the temperature unit option in the core configuration. For now it is backwards compatible, but you should update soon:
@ -55,6 +65,8 @@ homeassistant:
unit_system: metric
```
[@pavoni]: https://github.com/pavoni
[@mKeRix]: https://github.com/mKeRix
[@abcminiuser]: https://github.com/abcminiuser
[@balloob]: https://github.com/balloob
[@corbanmailloux]: https://github.com/corbanmailloux

View File

@ -13,47 +13,56 @@ body_id: components-page
regenerate: true
---
{% assign count = site.components | size %}
{% assign nocat = site.components | where: 'ha_category', null | size %}
{% assign tot = count | minus: nocat %}
{% assign components = site.components | sort: 'title' %}
{% assign categories = components | sort: 'ha_category' | map: 'ha_category' | uniq %}
<p class='note'>
Support for these components is provided by the Home Assistant community.
</p>
{% assign components = site.components | sort: 'title' %}
{% assign categories = components | sort: 'ha_category' | map: 'ha_category' | uniq %}
<div class="grid">
<div class="grid__item one-sixth lap-one-whole palm-one-whole">
<div class="filter-button-group">
<a href='#all' class="btn">All</a>
<a href='#featured' class="btn">Featured</a>
<div class="filter-button-group">
<a href='#all' class="btn">All ({{tot}})</a>
<a href='#featured' class="btn featured">Featured</a>
{% for category in categories %}
{% if category and category != 'Other' %}
<a href='#{{ category | slugify }}' class="btn">{{ category }}</a>
{% endif %}
{% endfor %}
{% for category in categories %}
{% if category and category != 'Other' %}
<a href='#{{ category | slugify }}' class="btn">
{{ category }}
({{ components | where: 'ha_category', category | size }})
</a>
{% endif %}
{% endfor %}
<a href='#other' class="btn">Other</a>
</div>
<div id="componentContainer">
{% for component in components %}
{% if component.ha_category %}
<a href='{{ component.url }}'
class='{{ component.ha_category | slugify }}{% if component.featured %} featured{% endif %}'
{% unless component.featured %}style='display: none'{% endunless %}>
<div class='img-container'>
{% if component.logo %}
<img src='/images/supported_brands/{{ component.logo }}'>
{% endif %}
</div>
<div class='title'>{{ component.title }}</div>
<div class='category'>{{ component.ha_category }}</div>
</a>
{% endif %}
{% endfor %}
<a href='#other' class="btn">Other</a>
</div>
</div>
<div class="grid__item five-sixths lap-one-whole palm-one-whole" id="componentContainer">
{% for component in components %}
{% if component.ha_category %}
<a href='{{ component.url }}'
class='{{ component.ha_category | slugify }}{% if component.featured %} featured{% endif %}'
{% unless component.featured %}style='display: none'{% endunless %}>
<div class='img-container'>
{% if component.logo %}
<img src='/images/supported_brands/{{ component.logo }}'>
{% endif %}
</div>
<div class='title'>{{ component.title }}</div>
<div class='category'>{{ component.ha_category }}</div>
</a>
{% endif %}
{% endfor %}
</div>
</div>
{% comment %}
## Pages without categories
{% for component in components %}
{% unless component.ha_category %}
<p>{{ component.title }}</p>

View File

@ -21,20 +21,40 @@ Beside the [voluptuous](https://pypi.python.org/pypi/voluptuous) default types a
To validate plaforms using [MQTT](/components/mqtt/) there are `valid_subscribe_topic` and `valid_publish_topic` present.
Some things to keep in mind:
- Use the constants which are definded in `const.py`.
- Import `PLATFORM_SCHEMA` from parent component and extend it.
- Preferred order is `required` first, then `optional`.
### {% linkable_title Snippets %}
This section contains a couple of snippets for the validation we use.
### {% linkable_title Default name %}
It's common to set a default for a sensor if the user is not providing a name to use.
```python
DEFAULT_NAME = 'Sensor name'
PLATFORM_SCHEMA = vol.Schema({
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
...
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
```
### {% linkable_title Limit the values %}
In certain cases you want to limit the user's input to a couple of options.
```python
DEFAULT_METHOD = 'GET'
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
...
vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(['POST', 'GET']),
```
### {% linkable_title Port %}
As all port numbers are coming out of the range 1 till 65535 a range check should be performed.
@ -42,8 +62,8 @@ As all port numbers are coming out of the range 1 till 65535 a range check shoul
```python
DEFAULT_PORT = 993
PLATFORM_SCHEMA = vol.Schema({
[...]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
...
vol.Optional(CONF_PORT, default=DEFAULT_PORT):
vol.All(vol.Coerce(int), vol.Range(min=1, max=65535)),
```
@ -58,8 +78,8 @@ SENSOR_TYPES = {
'average_download_rate': ('Average Speed', 'MB/s'),
}
PLATFORM_SCHEMA = vol.Schema({
....
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
...
vol.Optional(CONF_MONITORED_VARIABLES, default=[]):
[vol.In(SENSOR_TYPES)],
```

View File

@ -9,20 +9,28 @@ sharing: true
footer: true
---
Home Assistant will create a configuration folder when it is run for the first time. The location of the folder differs between operating systems: on OS X and Linux it's `~/.homeassistant` and on Windows it's `%APPDATA%/.homeassistant`. If you want to use a different folder for configuration, run `hass --config path/to/config`.
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. This file contains YAML code, which is explained briefly below. [An example configuration file is located here](https://github.com/home-assistant/home-assistant/blob/master/config/configuration.yaml.example).
When launched for the first time, Home Assistant will write a default configuration file enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the user interface.
If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/).
The location of the folder differs between operating systems:
<p class='note tip'>
Install colorlog (`$ pip install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings.
</p>
| OS | Path |
| -- | ---- |
| OS X | `~/.homeassistant` |
| Linux | `~/.homeassistant` |
| Windows | `%APPDATA%/.homeassistant` |
If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`.
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. Throughout the documentation you will find snippets that you can add to your configuration file to enable that functionality.
If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).
<p class='note'>
You will have to restart Home Assistant each time you make changes in `configuration.yaml` in order for these to take effect.
You will have to restart Home Assistant for changes to `configuration.yaml` take effect.
</p>
<p class='note tip'>
Install colorlog (`$ pip3 install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings.
</p>
### [Next step: Get familiar with YAML &raquo;](/getting-started/yaml/)

View File

@ -96,7 +96,9 @@ for:
#### {% linkable_title Sun condition %}
The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger](#sun-trigger).
The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger].
[sun_trigger]: /getting-started/automation-trigger/#sun-trigger
```yaml
condition: sun

View File

@ -170,7 +170,7 @@ The *object_id* and *scene_id* of all triggered events can be seen in the consol
#### {% linkable_title Services %}
The Z-Wave component exposes four services to help maintain the network.
The Z-Wave component exposes seven services to help maintain the network.
| Service | Description |
| ------- | ----------- |

View File

@ -15,8 +15,8 @@ hide_github_edit: true
<div class="grid">
<div class="grid__item one-third lap-one-third palm-one-whole">
<div class='current-version material-card text'>
<h1>Current Version: 0.26</h1>
Released: <span class='release-date'>August 13, 2016</span>
<h1>Current Version: 0.26.2</h1>
Released: <span class='release-date'>August 15, 2016</span>
<div class='links'>
<a href='/blog/2016/08/13/foursquare-fast-com-ffmpeg-gpsd/'>Release notes</a>