Skip to content

Commit 0f4eb38

Browse files
balloobballoob
authored
Merge pull request home-assistant#2226 from home-assistant/release-0-40
0.40
2 parents 7e2852f + 783d52c commit 0f4eb38

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1155
-52
lines changed

‎_config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@ social:
127127

128128
# Home Assistant release details
129129
current_major_version: 0
130-
current_minor_version: 39
131-
current_patch_version: 3
132-
date_released: 2017-03-04
130+
current_minor_version: 40
131+
current_patch_version: 0
132+
date_released: 2017-03-11
133133

134134
# Either # or the anchor link to latest release notes in the blog post.
135135
# Must be prefixed with a # and have double quotes around it.
136-
patch_version_notes: "#release-0393---march-4"
136+
patch_version_notes: "#"

‎source/_components/android_ip_webcam.markdown

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: page
3+
title: "Android IP Webcam"
4+
description: "Connect Android devices as IP webcam to Home Assistant"
5+
date: 2017-03-10 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: android_ip_webcam.png
11+
ha_category: Hub
12+
ha_release: "0.40"
13+
---
14+
15+
The Android IP webcam component turns your Android phone into a network camera with multiple viewing options.
16+
17+
It's setup as a mjpeg camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
18+
19+
To set it up, download [the IP Webcam app][app] and add the following information to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
android_ip_webcam:
24+
# This should be the ip of your phone
25+
- host: 192.168.1.10
26+
name: Entrance
27+
```
28+
29+
Configuration variables:
30+
31+
- **host** (*Required*): The ip address where your phone have on network.
32+
- **port** (*Optional*): Default is set 8080. The port where is ip webcam listens.
33+
- **name** (*Optional*): This parameter allows you to override the name of your phone.
34+
- **username** (*Optional*): The username for accessing your phone.
35+
- **password** (*Optional*): The password for accessing your phone.
36+
- **scan_interval** (*Optional*): Default is 10 seconds. Defines the update interval of the phone.
37+
- **auto_discovery** (*Optional*): Default is True. Auto detect which sensors and settings are available for setup.
38+
- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See list of supported sensors.
39+
- **switches** array (*Optional*): Conditions to display settings in the frontend. See list of supported settings.
40+
- **motion_sensor** (*Optional*): Activate motion sensor if auto_discovery is disabled.
41+
42+
### {% linkable_title Supported features %}
43+
44+
Sensors:
45+
46+
- audio_connections
47+
- battery_level
48+
- battery_temp
49+
- battery_voltage
50+
- light
51+
- motion
52+
- pressure
53+
54+
Settings:
55+
56+
- exposure_lock
57+
- ffc
58+
- focus
59+
- gps_active
60+
- night_vision
61+
- overlay
62+
- torch
63+
- whitebalance_lock
64+
- video_recording
65+
66+
[app]: https://play.google.com/store/apps/details?id=com.pas.webcam

‎source/_components/binary_sensor.android_ip_webcam.markdown

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
layout: page
3+
title: "Android IP Webcam Binary Sensor"
4+
description: "Instructions how to integrate binary motion sensors for Android IP webcam within Home Assistant."
5+
date: 2017-03-10 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: android_ip_webcam.png
11+
ha_category: Binary Sensor
12+
ha_release: "0.40"
13+
---
14+
15+
16+
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant.
17+
18+
Devices will be configured automatically. Please refer to the [component](/components/android_ip_webcam/) configuration on how to setup.

‎source/_components/binary_sensor.blink.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: page
3+
title: "Blink Binary Sensor"
4+
description: "Instructions for how to setup Blink binary sensors within Home Assistant."
5+
date: 2017-03-05 22:13
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: blink.png
11+
ha_category: Binary Sensor
12+
ha_release: "0.40"
13+
---
14+
15+
<p class='note'>
16+
To get your Blink binary sensors working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
17+
</p>

‎source/_components/binary_sensor.enocean.markdown

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,28 @@ Configuration variables:
2929
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
3030
- **name** (*Optional*): An identifier for the switch in the frontend.
3131
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
32+
33+
EnOcean binary sensors only generate 'button_pressed' events. The event data has follwing four fields:
34+
35+
- **id**: The ID of the device (see configuration).
36+
- **pushed**: `1` for a button press, `0` for a button release.
37+
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
38+
- **onoff**: `0` or `1` for either side of the rocket.
39+
40+
Sample automation to switch lights on and off:
41+
42+
```yaml
43+
# Example automation to turn lights on/off on button release
44+
automation:
45+
- alias: hall light switches
46+
trigger:
47+
platform: event
48+
event_type: button_pressed
49+
event_data:
50+
id: [0xYY, 0xYY, 0xYY, 0xYY]
51+
pushed: 0
52+
action:
53+
service_template: "{% raw %}{% if trigger.event.data.onoff %} light.turn_on {% else %} light.turn_off {%endif %}{% endraw %}"
54+
data_template:
55+
entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}"
56+
```

‎source/_components/blink.markdown

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
layout: page
3+
title: "Blink"
4+
description: "Instructions for how to integrate Blink camera/security system within Home Assistant."
5+
date: 2017-03-05 22:13
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: blink.png
11+
ha_category: Hub
12+
ha_release: "0.40"
13+
---
14+
15+
The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
16+
17+
You will need your Blink login information (username, usually you email address, and password) to use this module.
18+
19+
To set it up, add the following information to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
blink:
24+
username: YOUR_USERNAME
25+
password: YOUR_PASSWORD
26+
```
27+
28+
Once loaded, your front end will have the following components:
29+
* A camera image for each camera in your system.
30+
* A binary_sensor per camera that indicates whether motion detection is enabled.
31+
* A binary_sensor for the system that indicates if the system is armed or disarmed.
32+
* A sesnor per camera that reports temperature.
33+
* A sensor per camera that reports battery level.
34+
* A sensor per camera that reports unread notification (ie. detected motion events).
35+
36+
Since the cameras are battery operated, the images are only updated in Home Assistant when the user manually forces a new photo. The image can only be updated in Home Assistant every 60 seconds in order to not overwhelm Blink's servers with API requests.
37+
38+
Services:
39+
There are three services availiabe for the blink platform:
40+
- arm_system
41+
- arm_camera
42+
- snap_picture
43+
44+
For arm_system, the value sent can be either "True" or "False" and will arm and disarm the whole blink system, respectively
45+
46+
Arm system example
47+
```json
48+
{
49+
"device_armed": "True"
50+
}
51+
```
52+
53+
Arm camera follows a similar structure, but each indidivual camera can have motion detection enabled or disabled. Because of this, you also need to supply a name. For example, if I have a camera named "Living Room" and I want to turn off motion detection on that camera, I'd call the blink.arm_camera service with the following payload:
54+
```json
55+
{
56+
"friendly_name": "Living Room",
57+
"device_armed": "False"
58+
}
59+
```
60+
61+
The blink.snap_picture service takes the camera name as the payload and with take a new picture with your camera.
62+
```
63+
{
64+
"friendly_name": "Living Room"
65+
}
66+
```
67+
68+
Configuration variables:
69+
70+
- **username** (*Required*): Your username to login to Blink
71+
- **password** (*Required*): Your password to login to Blink
72+
73+
<p class='img'>
74+
<img src='{{site_root}}/images/screenshots/blink_example_frontend.png' />
75+
</p>

‎source/_components/camera.blink.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: page
3+
title: "Blink Camera"
4+
description: "Instructions for how to setup Blink cameras within Home Assistant."
5+
date: 2017-03-05 22:13
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: blink.png
11+
ha_category: Camera
12+
ha_release: "0.40"
13+
---
14+
15+
<p class='note'>
16+
To get your Blink cameras working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
17+
</p>

‎source/_components/climate.ecobee.markdown

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ limits).
3434

3535
A _climate_ is a predefined or user-defined set of states that the
3636
thermostat aims to achieve. The ecobee thermostat provides three predefined
37-
climates: home, away, and sleep. The user can define additional climates.
37+
climates: Home, Away, and Sleep. The user can define additional climates.
3838

3939
A _hold_ is an override of the target temperature defined in the
4040
currently active climate. The temperature targeted in the hold mode may be
41-
explicitly set (temperature hold) or it may be derived from a reference
42-
climate (home or away hold). All holds are temporary. Temperature and
41+
explicitly set (temperature hold), it may be derived from a reference
42+
climate (home, away, sleep, etc.), or it may be derived from a vacation
43+
defined by the thermostat. All holds are temporary. Temperature and
4344
climate holds expire when the thermostat transitions to the next climate
44-
defined in its program.
45+
defined in its program. A vacation hold starts at the beginning of the
46+
defined vacation period, and expires when the vacation period ends.
4547

4648
When in _away mode_, the target temperature is permanently overridden by
4749
the target temperature defined for the away climate. The away mode is a
@@ -59,7 +61,7 @@ The following attributes are provided by the Ecobee Thermostat:
5961
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
6062
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
6163
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
62-
`is_away_mode_on`.
64+
`is_away_mode_on`, `vacation`, `climate_list`.
6365
The attributes `min_temp` and `max_temp` are meaningless constant values.
6466

6567

@@ -136,7 +138,7 @@ Returns the current temperature hold, if any.
136138

137139
| Attribute type | Description |
138140
| ---------------| ----------- |
139-
| String | 'home', 'away', 'temp', None
141+
| String | 'temp', 'vacation', 'home', 'away', etc., None
140142

141143
### {% linkable_title Attribute `current_operation` %}
142144

@@ -164,7 +166,8 @@ Returns the current operation mode of the thermostat.
164166

165167
### {% linkable_title Attribute `mode` %}
166168

167-
Returns the climate currently active on the thermostat.
169+
Returns the climate currently active on the thermostat. The mode
170+
is returned as the user-visible name (rather than the internally used name).
168171

169172
### {% linkable_title Attribute `fan_min_on_time` %}
170173

@@ -187,6 +190,18 @@ Returns the humidity as measured by the thermostat.
187190
| ---------------| ----------- |
188191
| Integer | Current humidity
189192

193+
### {% linkable_title Attribute `vacation` %}
194+
195+
Returns the currently active vacation or `None`.
196+
197+
| Attribute type | Description |
198+
| ---------------| ----------- |
199+
| String | Name of currently active vacation |
200+
201+
### {% linkable_title Attribute `climate_list` %}
202+
203+
Returns the list of climates defined in the thermostat.
204+
190205

191206
## {% linkable_title Services %}
192207

@@ -211,15 +226,19 @@ Turns the away mode on or off for the thermostat.
211226

212227
### {% linkable_title Service `set_hold_mode` %}
213228

214-
Puts the thermostat into the given hold mode. For 'home' and 'away', the
215-
target temperature is taken from the home or away, climate, respectively.
229+
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
230+
and ony other hold based on a reference climate, the
231+
target temperature is taken from the reference climate.
216232
For 'temp', the current temperature is taken as the target temperature.
217233
When None is provided as parameter, the hold_mode is turned off.
234+
It is not possible to set a vacation hold; such hold has to be
235+
defined on the thermostat directly. However, a vacation hold can be
236+
cancelled.
218237

219238
| Service data attribute | Optional | Description |
220239
| ---------------------- | -------- | ----------- |
221240
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
222-
| `hold_mode` | no | 'home', 'away', 'temp', None
241+
| `hold_mode` | no | 'temp', 'home', 'away', 'sleep', etc., None
223242

224243
### {% linkable_title Service `set_temperature` %}
225244

‎source/_components/climate.generic_thermostat.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ Configuration variables:
3535
- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
3636
- **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in it's current state prior to being switched either off or on.
3737
- **tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched either off or on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor goes below 24.5 and it will stop when the sensor goes above 25.5.
38+
- **keep_alive** (*Optional*): Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while.
3839

39-
A full configuration example looks like the one below. `min_cycle_duration` must contains at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
40+
A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
4041

4142
```yaml
4243
# Full example configuration.yaml entry
@@ -51,4 +52,6 @@ climate:
5152
tolerance: 0.3
5253
min_cycle_duration:
5354
seconds: 5
55+
keep_alive:
56+
minutes: 3
5457
```

‎source/_components/config.markdown

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "Config"
4+
description: "Instructions how to setup the configuration panel Home Assistant."
5+
date: 2017-02-24 20:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: home-assistant.png
11+
ha_category: Other
12+
ha_release: 0.39
13+
---
14+
15+
The `config` component is designed to display panels in the frontend to configure and manage parts of Home Assistant.
16+
17+
To enable the configuration panel, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
config:
22+
```
23+
24+
### {% linkable_title Group & Views %}
25+
26+
The **Groups & Views** sections allows you to re-arrange your [groups](/components/group/). Also, you can edit the group's setting and switch between "view" and "group".
27+
28+
<p class='img'>
29+
<img src='{{site_root}}/images/screenshots/group-views.png' />
30+
</p>
31+
32+
33+
### {% linkable_title Server Management %}
34+
35+
This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, and automation, and the Home Assistant process itself. With a single mouse click.
36+
37+
<p class='img'>
38+
<img src='{{site_root}}/images/screenshots/server-management.png' />
39+
</p>
40+
41+

0 commit comments

Comments
 (0)