Skip to content

Commit b497fc4

Browse files
fabafffabaff
authored
Merge pull request home-assistant#2657 from home-assistant/release-0-45
0.45
2 parents 295fc5a + 06137eb commit b497fc4

File tree

62 files changed

+2088
-117
lines changed

Some content is hidden

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

62 files changed

+2088
-117
lines changed

‎_config.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,14 @@ social:
140140

141141
# Home Assistant release details
142142
current_major_version: 0
143-
current_minor_version: 44
144-
current_patch_version: 2
145-
date_released: 2017-05-08
143+
current_minor_version: 45
144+
current_patch_version: 0
145+
date_released: 2017-05-20
146146

147147
# Either # or the anchor link to latest release notes in the blog post.
148148
# Must be prefixed with a # and have double quotes around it.
149-
# Example #release-0431---april-25
150-
patch_version_notes: "#release-0442---may-8"
149+
# Major release:
150+
patch_version_notes: "#"
151+
# Minor release (Example #release-0431---april-25):
152+
#patch_version_notes: "#release-0451---may-X"
153+

‎source/_components/axis.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: "Axis"
4+
description: "Instructions on how to setup devices from Axis Communications within Home Assistant."
5+
date: 2017-04-30 23:04
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: axis.png
11+
ha_category: Hub
12+
ha_release: "0.45"
13+
---
14+
15+
[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security related network connected hardware. Sensor API works with firmware 5.50 and newer.
16+
17+
Home Assistant will automatically discover their presence on your network.
18+
19+
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
axis:
24+
m1065lw:
25+
host: IP ADDRESS
26+
username: USERNAME
27+
password: PASSWORD
28+
include:
29+
- camera
30+
- motion
31+
- pir
32+
- audio
33+
- daynight
34+
trigger_time: 0
35+
location: köket
36+
```
37+
38+
## {% linkable_title Dependencies %}
39+
40+
```bash
41+
sudo apt-get install python3-gi gir1.2-gstreamer-1.0
42+
```
43+
44+
Depending on how you run Home Assistant you might be needed to symlink the `gi` module into your environment (e.g. in Hassbian):
45+
46+
```bash
47+
ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/lib/python3.4/site-packages
48+
```
49+
50+
## {% linkable_title Configuration variables %}
51+
52+
- **device** (*Required*): Unique name
53+
- **host** (*Required*): The IP address to your Axis device.
54+
- **username** (*Optional*): The username to your Axis device. Default 'root'.
55+
- **password** (*Optional*): The password to your Axis device. Default 'pass'.
56+
- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0.
57+
- **location** (*Optional*): Physical location of your Axis device. Default not set.
58+
59+
- **include** (*Required*): This cannot be empty else there would be no use adding the device at all.
60+
- **camera**: Stream MJPEG video to Home Assistant
61+
- **motion**: The Built in motion detection in Axis cameras
62+
- **vmd3**: ACAP Motion Detection app which has better algorithms for motion detection
63+
- **pir**: PIR sensor that can trigger on motion
64+
- **sound**: Sound detector
65+
- **daynight**: Certain cameras have day/night mode if they have built-in IR lights
66+
- **tampering**: signals when camera believes that it has been tampered with
67+
- **input**: trigger on whatever you have connected to device input port
68+
69+
<p class='note'>
70+
Any specific levels for triggers needs to be configured on the device.
71+
</p>
72+
73+
<p class='note'>
74+
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality it is enough to create a user belonging to user group viewer.
75+
</p>

‎source/_components/binary_sensor.axis.markdown

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: page
3+
title: "Axis Binary Sensor"
4+
description: "Instructions how to integrate Axis binary sensors into Home Assistant."
5+
date: 2017-04-01 19:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: axis.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Local Push"
13+
ha_release: "0.45"
14+
---
15+
16+
The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.
17+
18+
See the [Axis main component](/components/axis/) for configuration instructions.
19+
20+
The following sensor types are supported:
21+
22+
23+
* Motion detection
24+
* Passive IR motion detection
25+
* Sound detection
26+
* Day/night mode
27+
* Tampering detection
28+
* Input port

‎source/_components/binary_sensor.mystrom.markdown

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: page
3+
title: "myStrom Binary Sensor"
4+
description: "Instructions how to integrate myStrom buttons into Home Assistant."
5+
date: 2017-04-14 08:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: mystrom.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Local Polling"
13+
ha_release: 0.45
14+
---
15+
16+
17+
The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern:
18+
19+
- `single`: Short push (approx. 1/2 seconds)
20+
- `double`: 2x sequential short pushes (within 2 seconds)
21+
- `long`: Long push (approx. 2 seconds)
22+
- `touch`: Touch of the button's surface (only affective for WiFi Button +)
23+
24+
The first usage of the pattern will create the binary sensor for the pattern. If the WiFi Button is pushed one time then a binary sensor for the `single` pattern will be created. The same applies for the other patterns. With the second usage of the pattern the binary sensors become fully functional.
25+
26+
The buttons will give you feedback with its built-in LED:
27+
28+
- white then green: Pattern was submitted successfully
29+
- white then red: There is a problem with the communication
30+
31+
To use your myStrom WiFi Button in your installation, add the following to your `configuration.yaml` file:
32+
33+
```yaml
34+
# Example configuration.yaml entry
35+
binary_sensor:
36+
- platform: mystrom
37+
```
38+
39+
### {% linkable_title Setup of the myStrom Buttons %}
40+
41+
After the Wifi Buttons are connected to your Wireless network, you have three minutes to set the actions for the push patterns. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern.
42+
43+
```bash
44+
$ curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?single%3D[ID of the button]" http://[IP address of the button]/api/v1/device/[MAC address of the button]
45+
{
46+
"[MAC address of the button]": {
47+
"type": "button",
48+
"battery": true,
49+
"reachable": true,
50+
"meshroot": false,
51+
"charge": true,
52+
"voltage": 4.292,
53+
"fw_version": "2.26",
54+
"single": "get://[IP address Home Assistant]:8123/api/mystrom?single=[if of the button]",
55+
"double": "",
56+
"long": "",
57+
"touch": ""
58+
}
59+
}
60+
```
61+
62+
A complete command to set the URL for a double click could look like the example below:
63+
64+
```bash
65+
$ curl -d "double=get://192.168.1.3:8123/api/mystrom?double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
66+
```
67+
68+
<p class='note'>
69+
The firmware version 2.26 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities.
70+
</p>

‎source/_components/binary_sensor.raspihats.markdown

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: page
3+
title: "Raspihats Binary Sensor"
4+
description: "Instructions how to integrate Raspihats add-on boards for Raspberry PI into Home Assistant as a binary_sensor."
5+
date: 2017-05-01 04:09
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raspihats.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.44
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
17+
18+
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
binary_sensor:
23+
- platform: raspihats
24+
i2c_hats:
25+
- board: DI6acDQ6rly
26+
address: 0x60
27+
channels:
28+
- index: 0
29+
name: PIR Office
30+
invert_logic: true
31+
device_class: motion
32+
- index: 1
33+
name: PIR Bedroom
34+
```
35+
36+
Configuration variables:
37+
38+
- **i2c_hats** (*Optional*): Array of used I2C-HATs.
39+
- **board** (*Required*): The board name [Di16, Di6Rly6, DI16ac, DI6acDQ6rly].
40+
- **address** (*Required*): The board I2C address, hex value.
41+
- **channels** (*Required*): Array of used digital input channels.
42+
- **index** (*Required*): Digital input channel index.
43+
- **name** (*Required*): Friendly name to use for the frontend.
44+
- **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
45+
- **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`
46+
47+
For more details about the `raspihats` add-on boards for Raspberry PI, visit [raspihats.com](http://www.raspihats.com/).

‎source/_components/binary_sensor.rpi_pfio.markdown

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: page
3+
title: "PiFace Digital I/O Binary Sensor"
4+
description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a binary sensor."
5+
date: 2016-05-08 15:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: raspberry-pi.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.45
13+
---
14+
15+
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) .
16+
17+
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
binary_sensor:
22+
- platform: rpi_pfio
23+
ports:
24+
0:
25+
name: PIR Office
26+
invert_logic: true
27+
1:
28+
name: Doorbell
29+
settle_time: 50
30+
```
31+
32+
Configuration variables:
33+
34+
- **ports** array (*Required*): Array of used ports.
35+
- **num** (*Required*): Port number.
36+
- **name** (*Required*): Port name.
37+
- **settle_time** (*Optional*): The time in milliseconds for port debouncing. Default is 2 0ms.
38+
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
39+

‎source/_components/blink.markdown

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,16 @@ Once loaded, your front end will have the following components:
3333
* A sensor per camera that reports battery level.
3434
* A sensor per camera that reports unread notification (ie. detected motion events).
3535
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.
36+
Since the cameras are battery operated, the images are only updated in Home Assistant when the user manually forces a new photo. This image can be updated with the `blink.snap_picture` service followed by a `blink.force_update` service call to force Home Assistant to request an update from Blink's servers. If the `blink.force_update` service is not called, the image will be updated within a 180 second interval, set so that automatic server requests don't overwhelm the Blink API. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended.
3737

3838
Services:
3939
There are three services availiabe for the blink platform:
4040
- arm_system
4141
- arm_camera
4242
- snap_picture
43+
- force_update
4344

44-
For arm_system, the value sent can be either "True" or "False" and will arm and disarm the whole blink system, respectively
45+
For `blink.arm_system`, the value sent can be either "True" or "False" and will arm and disarm the whole blink system, respectively
4546

4647
Arm system example
4748
```json
@@ -50,21 +51,23 @@ Arm system example
5051
}
5152
```
5253

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+
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:
5455
```json
5556
{
5657
"friendly_name": "Living Room",
5758
"device_armed": "False"
5859
}
5960
```
6061

61-
The blink.snap_picture service takes the camera name as the payload and with take a new picture with your camera.
62+
The `blink.snap_picture` service takes the camera name as the payload and with take a new picture with your camera.
6263
```
6364
{
6465
"friendly_name": "Living Room"
6566
}
6667
```
6768
69+
The `blink.force_update` service can simply be called with no payload to force a server update.
70+
6871
Configuration variables:
6972
7073
- **username** (*Required*): Your username to login to Blink

‎source/_components/camera.amcrest.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ Configuration variables:
3333
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
3434
- **port** (*Optional*): The port that the camera is running on. The default is 80.
3535
- **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
36-
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. If omitted, it defaults to *mjpeg*.
36+
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *mjpeg*.
37+
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
3738

3839
**Note:** Amcrest cameras with newer firmwares no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager.
3940

41+
**Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at
42+
[FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`.
43+
4044
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.

‎source/_components/camera.axis.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: "Axis Camera"
4+
description: "Instructions how to setup Axis cameras within Home Assistant."
5+
date: 2017-05-01 19:09
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: axis.png
11+
ha_category: Camera
12+
ha_release: "0.45"
13+
---
14+
15+
The `Axis` camera platform allows you to stream video from your [Axis](https://www.axis.com/) cameras.
16+
17+
The requirement is that you have setup your [Axis camera](/components/axis/).

‎source/_components/camera.uvc.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ camera:
2828
Configuration variables:
2929
3030
- **nvr** (*Required*): The IP or hostname of the NVR (Network Video Recorder) server.
31-
- **port** (*Optional*): The port number to use for accessing the NVR.
3231
- **key** (*Required*): The API key available from the NVR web interface.
33-
32+
- **port** (*Optional*): The port number to use for accessing the NVR.
33+
- **password** (*Optional*): The camera password. Defaults to `ubnt` if not given.

‎source/_components/cover.lutron_caseta.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: "Lutron Caseta Cover"
4+
description: "Instructions how to setup the Lutron Caseta covers within Home Assistant."
5+
date: 2017-05-20 09:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: lutron.png
11+
ha_category: Cover
12+
---
13+
14+
To get your Lutron Caseta covers working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).

0 commit comments

Comments
 (0)