Merge branch 'current' into next

This commit is contained in:
Paulus Schoutsen 2017-06-17 12:10:33 -07:00
commit 806b740e12
21 changed files with 646 additions and 55 deletions

View file

@ -47,7 +47,7 @@ sensor:
sensors:
furnace_on:
value_template: {% raw %}{{ states.sensor.furnace.state > 2.5 }}{% endraw %}
friendly_name: 'Furnace Running
friendly_name: 'Furnace Running'
device_class: heat
```

View file

@ -37,7 +37,7 @@ Configuration variables:
- **name** (*Optional*): The name of the sensor. Default is `MQTT Cover`.
- **state_topic** (*Optional*): The MQTT topic subscribed to receive sensor values.
- **command_topic** (*Required*): The MQTT topic to publish commands to control the rollershutter.
- **command_topic** (*Optional*): The MQTT topic to publish commands to control the rollershutter.
- **payload_open** (*Optional*): The payload that opens the cover. Default is `OPEN`.
- **payload_close** (*Optional*): The payload that closes the cover. Default is `CLOSE`.
- **payload_stop** (*Optional*): The payload that stops the rollershutter. default is `STOP`.

View file

@ -1,7 +1,7 @@
---
layout: page
title: "Dweet.io"
description: "Record events in InfluxDB."
description: "Transfer events to Dweet.io."
date: 2016-05-07 07:08
sidebar: true
comments: false
@ -24,7 +24,7 @@ The `dweet` component makes it possible to transfer details collected with Home
The publishing interval is limited to 1 second. This means that it's possible to miss fast changes.
</p>
To use the `deweet` component in your installation, add the following to your `configuration.yaml` file:
To use the `dweet` component in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

View file

@ -24,11 +24,12 @@ Most lights do not support all attributes. You can check the platform documentat
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. Else targets all.
| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds.
| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define a xy color and a brightness. If a profile is given and a brightness or xy color then the profile values will be overwritten.
| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state.
| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define a xy color and a brightness. If a profile is given and a brightness then the profile brightness will be overwritten.
| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma separated floats that represent the color in XY.
| `rgb_color` | yes | A list containing three integers representing the rgb color you want the light to be. Three comma separated integers that represent the color in RGB. You can find a great chart here: [Hue Color Chart](http://www.developers.meethue.com/documentation/hue-xy-values)
| `color_temp` | yes | An INT in mireds representing the color temperature you want the light to be.
| `white_value` | yes | Integer between 0 and 255 for how bright a dedicated white LED should be.
| `color_temp` | yes | An integer in mireds representing the color temperature you want the light to be.
| `kelvin` | yes | Alternatively, you can specify the color temperature in Kelvin.
| `color_name` | yes | A human readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/2010/PR-css3-color-20101028/#svg-color) are supported.
| `brightness` | yes | Integer between 0 and 255 for how bright the color should be.

View file

@ -0,0 +1,35 @@
---
layout: page
title: "Mailgun"
description: "Instructions how to add Mailgun mail notifications to Home Assistant."
date: 2017-02-06 16:52
sidebar: true
comments: false
sharing: true
footer: true
logo: mailgun.png
ha_category: Notifications
ha_release: 0.38
---
The component supports push messages and generates events based on inbound data. To use, add a Route set to Store and Notify with a URL of the following form: `https://<domain>/api/mailgun?api_password=<password>`
To send messages, use the [Mailgun notify platform][notify].
[notify]: /components/notify.mailgun/
## {% linkable_title Sample configuration %}
```yaml
# Example configuration.yaml entry
mailgun:
domain: mg.example.com
api_key: token-XXXXXXXXX
sandbox: False
```
Configuration variables:
- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account.

View file

@ -32,5 +32,5 @@ Configuration variables:
- **name** (*Required*): Setting the parameter `name` sets the name of the group.
- **services** (*Required*): A list of all the services to be included in the group.
- **service** (*Required*): The service part of an entity ID, i.e. if you use `notify.html5` normally, just put `html5`.
- **service** (*Required*): The service part of an entity ID, i.e. if you use `notify.html5` normally, just put `html5`. Note that you must put everything in lower case here. Although you might have capitals written in the actual notification services!
- **data** (*Optional*): A dictionary containing parameters to add to all notify payloads. This can be anything that is valid to use in a payload, such as `data`, `message`, `target`, `title`.

View file

@ -1,6 +1,6 @@
---
layout: page
title: "Mailgun"
title: "Mailgun Notify"
description: "Instructions how to add Mailgun mail notifications to Home Assistant."
date: 2017-02-06 16:52
sidebar: true
@ -12,18 +12,23 @@ ha_category: Notifications
ha_release: 0.38
---
The Mailgun notification service allows you to send emails via Mailgun's REST API.
The Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the [Mailgun component] to be set up.
[Mailgun component]: /components/mailgun/
## {% linkable_title Sample configuration %}
```yaml
# Example configuration.yaml entry
mailgun:
domain: mg.example.com
api_key: token-XXXXXXXXX
sandbox: False
notify:
- name: NOTIFIER_NAME
- name: mailgun
platform: mailgun
domain: YOUR_MAILGUN_DOMAIN
token: TOKEN
recipient: RECIPIENT_EMAIL
recipient: me@example.com
```
Configuration variables:
@ -34,21 +39,6 @@ Configuration variables:
- **recipient** (*Required*): The email address of the recipient.
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries.
## {% linkable_title Full configuration %}
A full configuration example for the Mailgun notifier system can look like this:
```yaml
# Example configuration.yaml entry
notify:
- name: mailgun
platform: mailgun
domain: mg.example.com
sanbox: False
token: 'token-XXXXXXXXX'
recipient: me@example.com
```
## {% linkable_title Example automation %}
The following automation reacts to an event by sending out an email with two attachments.

View file

@ -12,7 +12,16 @@ ha_category: Automation
ha_release: 0.47
---
This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment with access to the `hass` object, the service call data as `data` and a logger as `logger`.
This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
| Name | Description |
| ---- | ----------- |
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api]
| `data` | The data passed to the Python Script service call.
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api]
[hass-api]: https://home-assistant.io/developers/development_hass_object/
[logger-api]: https://docs.python.org/3.4/library/logging.html#logger-objects
## {% linkable_title Writing your first script %}

View file

@ -0,0 +1,16 @@
---
layout: page
title: "Ecobee Sensor"
description: "Instructions how to setup the Ecobee sensors within Home Assistant."
date: 2015-11-30 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Binary Sensor
ha_release: 0.9
ha_iot_class: "Local Push"
---
To get your Ecobee sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).