Skip to content
Merged

0.46 #2747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8661c80
Update sensor.usps.markdown (#2662)
happyleavesaoc May 19, 2017
d9a5f3b
Add screenshots (#2669)
fabaff May 20, 2017
df5799a
Add raspihats binary_sensor documentation (#2574)
florincosta May 20, 2017
947a5f2
Merge branch 'current' into next
fabaff May 20, 2017
e66a4a2
Embed Ben's video into the post
robbiet480 May 20, 2017
864f839
Changes for #7676 in homeassistant (#2674)
turbokongen May 21, 2017
b871b2b
fix links, add new data from #7689, change example config (#2677)
azogue May 22, 2017
ab9950f
Deprecate automation trigger "state" (#2665)
amelchio May 22, 2017
00516fb
Make 'sender' a requirement (#2686)
fabaff May 23, 2017
264fe45
Template Light Platform documentation (#2661)
cribbstechnologies May 24, 2017
be219c8
Merge branch 'current' into next
balloob May 24, 2017
204b183
Add icon to device_tracker; misc cleanup. (#2709)
antsar May 25, 2017
e24bbff
Add more info about the /api/history/period route (#2699)
bokub May 25, 2017
fd51ccd
Zwave fan documentation (#2712)
emlove May 26, 2017
a35de2a
Add warning
fabaff May 26, 2017
9c411db
digest auth, explicit inline keyboards, more data in events (#2714)
azogue May 26, 2017
7e75b83
Rest Notifier Data Configuration (#2708)
Teagan42 May 29, 2017
41b969c
Update media_player.frontier_silicon.markdown (#2724)
sspans May 29, 2017
7f4b07a
Add initial Rachio docs (#2723)
fabaff May 30, 2017
682ec93
Update harmony markdown (#2432)
everix1992 May 30, 2017
df5bb87
Documentation update for sensor.hp_ilo (#2608)
bjw-s May 31, 2017
565af0d
Add initial benchmark script section
fabaff May 31, 2017
db428a5
Added Netgear Arlo documentation (#2726)
tchellomello May 31, 2017
6cf3cd0
Rename time trigger 'after' to 'at' (#2731)
emlove Jun 2, 2017
152ec0c
Update history_stats doc about the 'from' and 'to' attributes (#2733)
bokub Jun 2, 2017
910824d
Telegram change for 0.46 (#2736)
pvizeli Jun 2, 2017
850284c
Merge branch 'current' into release-0-46
fabaff Jun 3, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions source/_components/arlo.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: page
title: "Arlo"
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
date: 2017-05-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Hub
ha_release: 0.46
---

The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.

To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
arlo:
username: you@example.com
password: secret
```

Configuration variables:

- **username** (*Required*): The username for accessing your Arlo account.
- **password** (*Required*): The password for accessing your Arlo account.

It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.

Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/).
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.workday.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ automation:
alias: Turn on heater on workdays
trigger:
platform: time
after: '08:00:00'
at: '08:00:00'
condition:
condition: state
entity_id: 'binary_sensor.workday_sensor'
Expand Down
32 changes: 32 additions & 0 deletions source/_components/camera.arlo.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
layout: page
title: "Arlo Camera"
description: "Instructions how to integrate your Netgear Arlo cameras within Home Assistant."
date: 2016-05-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Camera
ha_release: 0.46
---

To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).

This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.

Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
camera:
- platform: arlo
ffmpeg_arguments: '-pred 1 -q:v 2'
```

Configuration variables:

- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.

**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation.
16 changes: 8 additions & 8 deletions source/_components/climate.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Turn auxiliary heater on/off for climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_aux_heat
data:
Expand All @@ -69,7 +69,7 @@ reflecting a situation where the climate device is set to save energy. This may
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_away_mode
data:
Expand All @@ -96,7 +96,7 @@ temporary target temperature. The particular modes available depend on the clima
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_hold_mode
data:
Expand All @@ -122,7 +122,7 @@ Set target temperature of climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_temperature
data:
Expand All @@ -146,7 +146,7 @@ Set target humidity of climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_humidity
data:
Expand All @@ -169,7 +169,7 @@ Set fan operation for climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_fan_mode
data:
Expand All @@ -192,7 +192,7 @@ Set operation mode for climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_operation_mode
data:
Expand All @@ -215,7 +215,7 @@ Set operation mode for climate device
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: climate.set_swing_mode
data:
Expand Down
4 changes: 2 additions & 2 deletions source/_components/climate.zwave.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ automation:
- alias: Turn on Heater at 8pm
trigger:
- platform: time
after: "20:00:00"
at: "20:00:00"
action:
- service: climate.set_operation_mode
entity_id: climate.remotec_zxt120_heating_1_id
Expand All @@ -61,7 +61,7 @@ automation:
- alias: Turn off Heater at 9pm
trigger:
- platform: time
after: "21:00:00"
at: "21:00:00"
action:
- service: climate.set_operation_mode
entity_id: climate.remotec_zxt120_heating_1_id
Expand Down
4 changes: 2 additions & 2 deletions source/_components/cover.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Set cover position of one or multiple covers.
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: cover.set_cover_position
data:
Expand All @@ -64,7 +64,7 @@ Set cover tilt position of one or multiple covers.
automation:
trigger:
platform: time
after: "07:15:00"
at: "07:15:00"
action:
- service: cover.set_cover_tilt_position
data:
Expand Down
4 changes: 2 additions & 2 deletions source/_components/device_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ devicename:
name: Friendly Name
mac: EA:AA:55:E7:C6:94
picture: https://home-assistant.io/images/favicon-192x192.png
gravatar: test@example.com
track: yes
hide_if_away: no
```
Expand All @@ -72,7 +71,8 @@ devicename:
| `name` | Host name or "Unnamed Device" | The friendly name of the device |
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. |
| `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). |
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
| `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |
| `consider_home` | [uses platform setting] | Allows you to override the global `consider_home` setting from the platform configuration on a per device level |
14 changes: 14 additions & 0 deletions source/_components/fan.zwave.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: page
title: "Z-Wave Fan"
description: "Instructions how to setup the Z-Wave Fans within Home Assistant."
date: 2017-05-25 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: z-wave.png
ha_category: Fan
---

To get your Z-Wave fans working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
106 changes: 106 additions & 0 deletions source/_components/light.template.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
layout: page
title: "Template Light"
description: "Instructions how to integrate Template lights into Home Assistant."
date: 2016-05-18 20:32
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Light
ha_release: 0.46
ha_iot_class: "Local Push"
logo: home-assistant.png
---

The `template` platform creates lights that combine components and provides the ability to run scripts or invoke services for each of the on, off, and brightness commands of a light.

To enable Template lights in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
light:
- platform: template
lights:
theater_lights:
friendly_name: "Theater Lights"
value_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux > 0'}}{% endraw %}"
turn_on:
service: script.theater_lights_on
turn_off:
service: script.theater_lights_off
set_level:
service: script.theater_lights_level
data_template:
volume_level: "{% raw %}{{brightness}}{% endraw %}"
level_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux'}}{% endraw %}"
```

Configuration variables:

- **lights** array (*Required*): List of your lights.
- **friendly_name** (*Optional*): Name to use in the Frontend.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to get the state of the light. If not provided the component defaults to optimisitc state determination.
- **turn_on** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned on.
- **turn_off** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned off.
- **set_level** (*Optional*): Defines an [action](/getting-started/automation/) to run when the light is given a brightness command.
- **level_template** (*Optional): Defines a [template](/topics/templating/) to get the brightness of the light. If not provided the component defaults to optimisitc brightness determination.
- **entity_id** (*Optional*): Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the light will try to update it's state.


## {% linkable_title Considerations %}

If you are using the state of a platform that takes extra time to load, the template light may get an 'unknown' state during startup. This results in error messages in your log file until that platform has completed loading. If you use is_state() function in your template, you can avoid this situation. For example, you would replace {% raw %}'{{ states.switch.source.state }}'{% endraw %} with this equivalent that returns true/false and never gives an unknown result:
{% raw %}'{{ is_state('switch.source', 'on') }}'{% endraw %}

## {% linkable_title Examples %}

In this section you will find some real life examples of how to use this light.

### {% linkable_title Theater Volume Control %}

This example shows a light that is actually a home theater's volume. This component gives you the flexibility to provide whatever you'd like to send as the payload to the consumer including any scale conversions you may need to make; the media_player component needs a floating point percentage value 0.0-1.0

```yaml
light:
- platform: template
lights:
theater_volume:
friendly_name: 'Receiver Volume'
value_template: >-
{% raw %}
{%- if is_state("media_player.receiver", "on") -%}
{%- if states.media_player.receiver.attributes.is_volume_muted -%}
off
{%- else -%}
on
{%- endif -%}
{%- else -%}
off
{%- endif -%}
{% endraw %}
turn_on:
service: media_player.volume_mute
data:
entity_id: media_player.receiver
is_volume_muted: false
turn_off:
service: media_player.volume_mute
data:
entity_id: media_player.receiver
is_volume_muted: true
set_level:
service: media_player.volume_set
data:
entity_id: media_player.receiver
data_template:
volume_level: '{% raw %}{{((brightness / 255 * 100) | int)/100}}{% endraw %}'
level_template: >-
{% raw %}
{%- if is_state("media_player.receiver", "on") -%}
{{(255 * states.media_player.receiver.attributes.volume_level) | int}}
{%- else -%}
0
{%- endif -%}
{% endraw %}
```
2 changes: 2 additions & 0 deletions source/_components/media_player.frontier_silicon.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ Configuration variables:
- **port** (*Optional*): The port number. Defaults to 80.
- **password** (*Optional*): PIN code of the Internet Radio. Defaults to 1234.

Some models use a seperate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.

In case your device (friendly name) is called *badezimmer*, an example automation can look something like this:

```yaml
Expand Down
2 changes: 2 additions & 0 deletions source/_components/notify.rest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Configuration variables:
- **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`.
- **title_param_name** (*Optional*): Parameter name for the title. Defaults to none.
- **target_param_name** (*Optional*): Parameter name for the target. Defaults to none.
- **data** (*Optional*): Dictionary of extra parameters to send to the resource.
- **data_template** (*Optional*): Template dictionary of extra parameters to send to the resource.

To use notifications, please see the [getting started with automation page](/getting-started/automation/).

6 changes: 3 additions & 3 deletions source/_components/notify.smtp.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ To enable notification by e-mail in your installation, add the following to your
notify:
- name: NOTIFIER_NAME
platform: smtp
server: MAIL_SERVER
sender: YOUR_SENDER
recipient: YOUR_RECIPIENT
```

Configuration variables:

- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **sender** (*Required*): E-mail address of the sender.
- **recipient** (*Required*): E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`.
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 25.
- **timeout** (*Optional*): The timeout in seconds that the SMTP server is using. Defaults to 5.
- **sender** (*Optional*): E-mail address of the sender.
- **username** (*Optional*): Username for the SMTP account.
- **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
- **recipient** (*Required*): E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
- **starttls** (*Optional*): Enables STARTTLS, eg. True or False. Defaults to False.
- **sender_name** (*Optional*): Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>).
- **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False.
Expand Down
Loading