Skip to content

Commit 2537be4

Browse files
balloobballoob
authored
Merge pull request #2747 from fabaff/release-0-46
0.46
2 parents f663f36 + 850284c commit 2537be4

33 files changed

+488
-132
lines changed

‎source/_components/arlo.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: page
3+
title: "Arlo"
4+
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
5+
date: 2017-05-30 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: arlo.png
11+
ha_category: Hub
12+
ha_release: 0.46
13+
---
14+
15+
The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.
16+
17+
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
arlo:
22+
username: you@example.com
23+
password: secret
24+
```
25+
26+
Configuration variables:
27+
28+
- **username** (*Required*): The username for accessing your Arlo account.
29+
- **password** (*Required*): The password for accessing your Arlo account.
30+
31+
It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.
32+
33+
Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/).

‎source/_components/binary_sensor.workday.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ automation:
4444
alias: Turn on heater on workdays
4545
trigger:
4646
platform: time
47-
after: '08:00:00'
47+
at: '08:00:00'
4848
condition:
4949
condition: state
5050
entity_id: 'binary_sensor.workday_sensor'

‎source/_components/camera.arlo.markdown

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: page
3+
title: "Arlo Camera"
4+
description: "Instructions how to integrate your Netgear Arlo cameras within Home Assistant."
5+
date: 2016-05-30 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: arlo.png
11+
ha_category: Camera
12+
ha_release: 0.46
13+
---
14+
15+
To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
16+
17+
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
18+
19+
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
camera:
24+
- platform: arlo
25+
ffmpeg_arguments: '-pred 1 -q:v 2'
26+
```
27+
28+
Configuration variables:
29+
30+
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
31+
32+
**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.

‎source/_components/climate.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Turn auxiliary heater on/off for climate device
4444
automation:
4545
trigger:
4646
platform: time
47-
after: "07:15:00"
47+
at: "07:15:00"
4848
action:
4949
- service: climate.set_aux_heat
5050
data:
@@ -69,7 +69,7 @@ reflecting a situation where the climate device is set to save energy. This may
6969
automation:
7070
trigger:
7171
platform: time
72-
after: "07:15:00"
72+
at: "07:15:00"
7373
action:
7474
- service: climate.set_away_mode
7575
data:
@@ -96,7 +96,7 @@ temporary target temperature. The particular modes available depend on the clima
9696
automation:
9797
trigger:
9898
platform: time
99-
after: "07:15:00"
99+
at: "07:15:00"
100100
action:
101101
- service: climate.set_hold_mode
102102
data:
@@ -122,7 +122,7 @@ Set target temperature of climate device
122122
automation:
123123
trigger:
124124
platform: time
125-
after: "07:15:00"
125+
at: "07:15:00"
126126
action:
127127
- service: climate.set_temperature
128128
data:
@@ -146,7 +146,7 @@ Set target humidity of climate device
146146
automation:
147147
trigger:
148148
platform: time
149-
after: "07:15:00"
149+
at: "07:15:00"
150150
action:
151151
- service: climate.set_humidity
152152
data:
@@ -169,7 +169,7 @@ Set fan operation for climate device
169169
automation:
170170
trigger:
171171
platform: time
172-
after: "07:15:00"
172+
at: "07:15:00"
173173
action:
174174
- service: climate.set_fan_mode
175175
data:
@@ -192,7 +192,7 @@ Set operation mode for climate device
192192
automation:
193193
trigger:
194194
platform: time
195-
after: "07:15:00"
195+
at: "07:15:00"
196196
action:
197197
- service: climate.set_operation_mode
198198
data:
@@ -215,7 +215,7 @@ Set operation mode for climate device
215215
automation:
216216
trigger:
217217
platform: time
218-
after: "07:15:00"
218+
at: "07:15:00"
219219
action:
220220
- service: climate.set_swing_mode
221221
data:

‎source/_components/climate.zwave.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ automation:
4242
- alias: Turn on Heater at 8pm
4343
trigger:
4444
- platform: time
45-
after: "20:00:00"
45+
at: "20:00:00"
4646
action:
4747
- service: climate.set_operation_mode
4848
entity_id: climate.remotec_zxt120_heating_1_id
@@ -61,7 +61,7 @@ automation:
6161
- alias: Turn off Heater at 9pm
6262
trigger:
6363
- platform: time
64-
after: "21:00:00"
64+
at: "21:00:00"
6565
action:
6666
- service: climate.set_operation_mode
6767
entity_id: climate.remotec_zxt120_heating_1_id

‎source/_components/cover.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Set cover position of one or multiple covers.
4141
automation:
4242
trigger:
4343
platform: time
44-
after: "07:15:00"
44+
at: "07:15:00"
4545
action:
4646
- service: cover.set_cover_position
4747
data:
@@ -64,7 +64,7 @@ Set cover tilt position of one or multiple covers.
6464
automation:
6565
trigger:
6666
platform: time
67-
after: "07:15:00"
67+
at: "07:15:00"
6868
action:
6969
- service: cover.set_cover_tilt_position
7070
data:

‎source/_components/device_tracker.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ devicename:
6262
name: Friendly Name
6363
mac: EA:AA:55:E7:C6:94
6464
picture: https://home-assistant.io/images/favicon-192x192.png
65-
gravatar: test@example.com
6665
track: yes
6766
hide_if_away: no
6867
```
@@ -72,7 +71,8 @@ devicename:
7271
| `name` | Host name or "Unnamed Device" | The friendly name of the device |
7372
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
7473
| `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`. |
74+
| `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). |
7575
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
76-
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
76+
| `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
7777
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |
7878
| `consider_home` | [uses platform setting] | Allows you to override the global `consider_home` setting from the platform configuration on a per device level |

‎source/_components/fan.zwave.markdown

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: page
3+
title: "Z-Wave Fan"
4+
description: "Instructions how to setup the Z-Wave Fans within Home Assistant."
5+
date: 2017-05-25 17:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: z-wave.png
11+
ha_category: Fan
12+
---
13+
14+
To get your Z-Wave fans working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).

‎source/_components/light.template.markdown

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
layout: page
3+
title: "Template Light"
4+
description: "Instructions how to integrate Template lights into Home Assistant."
5+
date: 2016-05-18 20:32
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: Light
11+
ha_release: 0.46
12+
ha_iot_class: "Local Push"
13+
logo: home-assistant.png
14+
---
15+
16+
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.
17+
18+
To enable Template lights in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
light:
23+
- platform: template
24+
lights:
25+
theater_lights:
26+
friendly_name: "Theater Lights"
27+
value_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux > 0'}}{% endraw %}"
28+
turn_on:
29+
service: script.theater_lights_on
30+
turn_off:
31+
service: script.theater_lights_off
32+
set_level:
33+
service: script.theater_lights_level
34+
data_template:
35+
volume_level: "{% raw %}{{brightness}}{% endraw %}"
36+
level_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux'}}{% endraw %}"
37+
```
38+
39+
Configuration variables:
40+
41+
- **lights** array (*Required*): List of your lights.
42+
- **friendly_name** (*Optional*): Name to use in the Frontend.
43+
- **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.
44+
- **turn_on** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned on.
45+
- **turn_off** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned off.
46+
- **set_level** (*Optional*): Defines an [action](/getting-started/automation/) to run when the light is given a brightness command.
47+
- **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.
48+
- **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.
49+
50+
51+
## {% linkable_title Considerations %}
52+
53+
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:
54+
{% raw %}'{{ is_state('switch.source', 'on') }}'{% endraw %}
55+
56+
## {% linkable_title Examples %}
57+
58+
In this section you will find some real life examples of how to use this light.
59+
60+
### {% linkable_title Theater Volume Control %}
61+
62+
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
63+
64+
```yaml
65+
light:
66+
- platform: template
67+
lights:
68+
theater_volume:
69+
friendly_name: 'Receiver Volume'
70+
value_template: >-
71+
{% raw %}
72+
{%- if is_state("media_player.receiver", "on") -%}
73+
{%- if states.media_player.receiver.attributes.is_volume_muted -%}
74+
off
75+
{%- else -%}
76+
on
77+
{%- endif -%}
78+
{%- else -%}
79+
off
80+
{%- endif -%}
81+
{% endraw %}
82+
turn_on:
83+
service: media_player.volume_mute
84+
data:
85+
entity_id: media_player.receiver
86+
is_volume_muted: false
87+
turn_off:
88+
service: media_player.volume_mute
89+
data:
90+
entity_id: media_player.receiver
91+
is_volume_muted: true
92+
set_level:
93+
service: media_player.volume_set
94+
data:
95+
entity_id: media_player.receiver
96+
data_template:
97+
volume_level: '{% raw %}{{((brightness / 255 * 100) | int)/100}}{% endraw %}'
98+
level_template: >-
99+
{% raw %}
100+
{%- if is_state("media_player.receiver", "on") -%}
101+
{{(255 * states.media_player.receiver.attributes.volume_level) | int}}
102+
{%- else -%}
103+
0
104+
{%- endif -%}
105+
{% endraw %}
106+
```

‎source/_components/media_player.frontier_silicon.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Configuration variables:
4343
- **port** (*Optional*): The port number. Defaults to 80.
4444
- **password** (*Optional*): PIN code of the Internet Radio. Defaults to 1234.
4545
46+
Some models use a seperate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.
47+
4648
In case your device (friendly name) is called *badezimmer*, an example automation can look something like this:
4749
4850
```yaml

‎source/_components/notify.rest.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Configuration variables:
3333
- **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`.
3434
- **title_param_name** (*Optional*): Parameter name for the title. Defaults to none.
3535
- **target_param_name** (*Optional*): Parameter name for the target. Defaults to none.
36+
- **data** (*Optional*): Dictionary of extra parameters to send to the resource.
37+
- **data_template** (*Optional*): Template dictionary of extra parameters to send to the resource.
3638

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

‎source/_components/notify.smtp.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@ To enable notification by e-mail in your installation, add the following to your
2222
notify:
2323
- name: NOTIFIER_NAME
2424
platform: smtp
25-
server: MAIL_SERVER
25+
sender: YOUR_SENDER
2626
recipient: YOUR_RECIPIENT
2727
```
2828
2929
Configuration variables:
3030
3131
- **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`.
32+
- **sender** (*Required*): E-mail address of the sender.
33+
- **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.
3234
- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`.
3335
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 25.
3436
- **timeout** (*Optional*): The timeout in seconds that the SMTP server is using. Defaults to 5.
35-
- **sender** (*Optional*): E-mail address of the sender.
3637
- **username** (*Optional*): Username for the SMTP account.
3738
- **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.
38-
- **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.
3939
- **starttls** (*Optional*): Enables STARTTLS, eg. True or False. Defaults to False.
4040
- **sender_name** (*Optional*): Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>).
4141
- **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False.

0 commit comments

Comments
 (0)