diff --git a/_config.yml b/_config.yml index c6dbb537997..d0cf0b4ca15 100644 --- a/_config.yml +++ b/_config.yml @@ -140,13 +140,13 @@ social: # Home Assistant release details current_major_version: 0 -current_minor_version: 46 -current_patch_version: 1 -date_released: 2017-06-09 +current_minor_version: 47 +current_patch_version: 0 +date_released: 2017-06-17 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0461---june-9" +patch_version_notes: "#" # Minor release (Example #release-0431---april-25): diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 39ea85e7d22..ba69ae5c77f 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -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 ``` diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 426fd7f1a6b..a19fafb6459 100755 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -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`. diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index ae2fabf2376..5acb5647dcb 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -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.

-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 diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 688cb0732f8..43706748906 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -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. diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown new file mode 100644 index 00000000000..835464dfd06 --- /dev/null +++ b/source/_components/mailgun.markdown @@ -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:///api/mailgun?api_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. diff --git a/source/_components/notify.group.markdown b/source/_components/notify.group.markdown index f46936ac059..e68b76112e5 100644 --- a/source/_components/notify.group.markdown +++ b/source/_components/notify.group.markdown @@ -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`. diff --git a/source/_components/notify.mailgun.markdown b/source/_components/notify.mailgun.markdown index 52f69b5251e..be571eb2c14 100644 --- a/source/_components/notify.mailgun.markdown +++ b/source/_components/notify.mailgun.markdown @@ -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. diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index 4f950cbb7e0..ddb26a0e7e8 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -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 `/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 `/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 %} diff --git a/source/_components/sensor.ecobee.markdown b/source/_components/sensor.ecobee.markdown new file mode 100644 index 00000000000..0ae2be049bc --- /dev/null +++ b/source/_components/sensor.ecobee.markdown @@ -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/). diff --git a/source/_components/sensor.moldindicator.markdown b/source/_components/sensor.mold_indicator.markdown similarity index 100% rename from source/_components/sensor.moldindicator.markdown rename to source/_components/sensor.mold_indicator.markdown diff --git a/source/_docs/backend/updater.markdown b/source/_docs/backend/updater.markdown index dcdb3cb5433..8551fff955e 100644 --- a/source/_docs/backend/updater.markdown +++ b/source/_docs/backend/updater.markdown @@ -12,6 +12,13 @@ redirect_from: /details/updater/ Starting with 0.31 the [updater component](/components/updater/) sends an optional report about Home Assistant instance. +If you want to opt-in to include component information, add `include_used_components` to your config. This will allow the Home Assistant developers to focus development efforts on the most popular components. + +```yaml +updater: + include_used_components: true +``` + We are only collecting this information to better understand our user base to provide better long term support and feature development. | Name | Description | Example | Data Source | @@ -49,4 +56,4 @@ The server also adds two timestamps to the data: - the original date your instance UUID was first seen - the timestamp of the last time we have seen your instance -There are currently no plans to publicly expose any of this information. If we did do such a thing in the future we would of course notify you in advance. It must also be stated that we will never sell or allow the use of this information for non-Home Assistant purposes. +We will never publicly expose individual gathered data. We might however publish aggregated stats about our user base (example: 70% of all users use Linux). We will never sell or allow the use of this information for non-Home Assistant development purposes. diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index 1cabf9a302d..c00488faef3 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -35,6 +35,7 @@ zwave: Configuration variables: - **usb_path** (*Optional*): The port where your device is connected to your Home Assistant host. +- **network_key** (*Optional*): The 16 byte network key in the form `"0x01,0x02..."` used in order to connect securely to compatible devices. - **config_path** (*Optional*): The path to the Python OpenZWave configuration files. Defaults to the 'config' that is installed by python-openzwave - **autoheal** (*Optional*): Allows disabling auto Z-Wave heal at midnight. Defaults to True. - **polling_interval** (*Optional*): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems. @@ -89,19 +90,7 @@ To add a Z-Wave device to your system, go to the Services menu and select the `z ### {% linkable_title Adding Security Devices %} -Security Z-Wave devices require a network key before being added to the network using the `zwave.add_node_secure` service. You must edit the `options.xml` file, located in your `python-openzwave config_path` to use a network key before adding these devices. - -Edit your `options.xml` file: - -```bash - -``` -Uncomment the line: -```bash -