Skip to content
Merged

0.45 #2657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
106cb51
Experimental support of Marantz receivers (#2489)
scarface-4711 May 5, 2017
fa9718c
Add documentation for the Enviro pHAT sensor (#2557)
imrehg May 5, 2017
370dad3
adding doc for tilt inversion (#2548)
cribbstechnologies May 5, 2017
8f8dc88
Add documentation for Sensibo climate platform (#2546)
andrey-git May 5, 2017
2eab0d5
light-blinkt: add documentation for new light (#2535)
imrehg May 5, 2017
98618fa
document flux_led rgbw mode change (#2472)
wuub May 5, 2017
15bab81
Blink documentation update (#2293)
fronzbot May 5, 2017
2b2d1ba
Add aux heat to ecobee climate (#2286)
titilambert May 5, 2017
bee8ba3
Opencv (#2208)
Teagan42 May 5, 2017
7287d31
Add raspihats component documentation (#2543)
florincosta May 5, 2017
bb47c1d
Update docs for PyPI python-openzwave install
JshWright May 6, 2017
8afb548
Add dlib doc (#2576)
pvizeli May 6, 2017
4039de2
Merge branch 'current' into next
balloob May 6, 2017
56aca24
Add datadog component documentation (#2452)
nunofgs May 7, 2017
6d2624f
update frontend development guide (#2591)
cribbstechnologies May 8, 2017
f90d929
Added documentation for the rpi_pfio platform. (#2597)
basschipper May 10, 2017
68a6187
Telegram Bot doc changes for pull request #7294: Telegram Bot enhance…
azogue May 10, 2017
04c1d83
Add initial myStrom buttons docs (#2429)
fabaff May 10, 2017
fac8820
Add password parameter to uvc component (#2600)
nunofgs May 10, 2017
5c1cfda
Documentation for current_location (#2570)
emlove May 10, 2017
1b46662
Add SSL support to NZBGet sensor (#2616)
tboyce021 May 11, 2017
2bbc81c
Update documentation for PR#7532, supporting multiple regions for end…
tsvi May 12, 2017
42e53e9
Axis documentation (#2549)
Kane610 May 12, 2017
174720a
Add light.lifx_set_state (#2620)
amelchio May 12, 2017
6cb2e46
Update axis.markdown
balloob May 12, 2017
7df2edf
Restructure some of the existing information. Add docs related to th…
gurumitts May 13, 2017
10087da
Add Kira component documentation (#2603)
stu-gott May 13, 2017
61770e1
Added Kodi-specific services doc (#2614)
azogue May 13, 2017
270fe53
Update ha_release and minimize configuration sample
fabaff May 1, 2017
b721594
Update ha_release
fabaff May 10, 2017
1d2321a
Update links
fabaff May 10, 2017
1eed120
Keep sample minimized
fabaff May 10, 2017
79fad1c
Merge branch 'current' into next
balloob May 14, 2017
9bd1781
Document new service sonos_update_alarm
frog32 May 14, 2017
b41d46f
SMTP notify enhancements: full HTML emails and custom `product_name` …
azogue May 15, 2017
bf2abbb
Merge branch 'current' into next
balloob May 15, 2017
039aa46
Merge pull request #2631 from frog32/patch-1
balloob May 15, 2017
e5e3498
Add File sensor docs (#2625)
fabaff May 15, 2017
51597a5
Update for 0.45
fabaff May 14, 2017
e2ef356
Update miflora (#2636)
frog32 May 16, 2017
b198c72
Add info about automation editor
balloob May 16, 2017
651f429
Updated rpi_gpio_pwm docs. (#2647)
soldag May 17, 2017
1bb8aec
Kodi specific service to call Kodi API methods

 (#2635)
azogue May 17, 2017
4cde353
Fix warning
balloob May 18, 2017
4126a67
Added RTSP documentation to Amcrest camera (#2654)
tchellomello May 18, 2017
4fd7b90
Add kelvin/brightness_pct to light.turn_on (#2653)
amelchio May 18, 2017
62be079
Seven segments (#2655)
fabaff May 18, 2017
291f9c8
added documentation for allow_tradfri_groups (#2632)
cnrd May 18, 2017
f4da8b0
Doc for Wink lock services (#2609)
May 18, 2017
d5e7847
Merge branch 'current' into next
fabaff May 18, 2017
80e4274
Prepare for 0.45
fabaff May 19, 2017
7e5a377
Add screenshots (#2669)
fabaff May 20, 2017
88e10f2
Update ha_release
fabaff May 20, 2017
9f3139e
Add raspihats binary_sensor documentation (#2574)
florincosta May 20, 2017
68439a0
Update ha_release
fabaff May 20, 2017
89cc409
Add Lutron caseta cover docs
fabaff May 20, 2017
2d610f1
Add release blog post for 0.45
fabaff May 20, 2017
864ca9e
Added RTSP documentation to Amcrest camera (#2654)
tchellomello May 18, 2017
dedf747
Add link to video
fabaff May 20, 2017
99e20c7
Add more sections
fabaff May 20, 2017
8ed2f10
Fix sentence
fabaff May 20, 2017
06137eb
Add missing links
fabaff May 20, 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
13 changes: 8 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,14 @@ social:

# Home Assistant release details
current_major_version: 0
current_minor_version: 44
current_patch_version: 2
date_released: 2017-05-08
current_minor_version: 45
current_patch_version: 0
date_released: 2017-05-20

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

75 changes: 75 additions & 0 deletions source/_components/axis.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
layout: page
title: "Axis"
description: "Instructions on how to setup devices from Axis Communications within Home Assistant."
date: 2017-04-30 23:04
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Hub
ha_release: "0.45"
---

[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.

Home Assistant will automatically discover their presence on your network.

You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
axis:
m1065lw:
host: IP ADDRESS
username: USERNAME
password: PASSWORD
include:
- camera
- motion
- pir
- audio
- daynight
trigger_time: 0
location: köket
```

## {% linkable_title Dependencies %}

```bash
sudo apt-get install python3-gi gir1.2-gstreamer-1.0
```

Depending on how you run Home Assistant you might be needed to symlink the `gi` module into your environment (e.g. in Hassbian):

```bash
ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/lib/python3.4/site-packages
```

## {% linkable_title Configuration variables %}

- **device** (*Required*): Unique name
- **host** (*Required*): The IP address to your Axis device.
- **username** (*Optional*): The username to your Axis device. Default 'root'.
- **password** (*Optional*): The password to your Axis device. Default 'pass'.
- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0.
- **location** (*Optional*): Physical location of your Axis device. Default not set.

- **include** (*Required*): This cannot be empty else there would be no use adding the device at all.
- **camera**: Stream MJPEG video to Home Assistant
- **motion**: The Built in motion detection in Axis cameras
- **vmd3**: ACAP Motion Detection app which has better algorithms for motion detection
- **pir**: PIR sensor that can trigger on motion
- **sound**: Sound detector
- **daynight**: Certain cameras have day/night mode if they have built-in IR lights
- **tampering**: signals when camera believes that it has been tampered with
- **input**: trigger on whatever you have connected to device input port

<p class='note'>
Any specific levels for triggers needs to be configured on the device.
</p>

<p class='note'>
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.
</p>
28 changes: 28 additions & 0 deletions source/_components/binary_sensor.axis.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: page
title: "Axis Binary Sensor"
description: "Instructions how to integrate Axis binary sensors into Home Assistant."
date: 2017-04-01 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.45"
---

The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.

See the [Axis main component](/components/axis/) for configuration instructions.

The following sensor types are supported:


* Motion detection
* Passive IR motion detection
* Sound detection
* Day/night mode
* Tampering detection
* Input port
70 changes: 70 additions & 0 deletions source/_components/binary_sensor.mystrom.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
layout: page
title: "myStrom Binary Sensor"
description: "Instructions how to integrate myStrom buttons into Home Assistant."
date: 2017-04-14 08:15
sidebar: true
comments: false
sharing: true
footer: true
logo: mystrom.png
ha_category: Binary Sensor
ha_iot_class: "Local Polling"
ha_release: 0.45
---


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:

- `single`: Short push (approx. 1/2 seconds)
- `double`: 2x sequential short pushes (within 2 seconds)
- `long`: Long push (approx. 2 seconds)
- `touch`: Touch of the button's surface (only affective for WiFi Button +)

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.

The buttons will give you feedback with its built-in LED:

- white then green: Pattern was submitted successfully
- white then red: There is a problem with the communication

To use your myStrom WiFi Button in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: mystrom
```

### {% linkable_title Setup of the myStrom Buttons %}

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.

```bash
$ 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]
{
"[MAC address of the button]": {
"type": "button",
"battery": true,
"reachable": true,
"meshroot": false,
"charge": true,
"voltage": 4.292,
"fw_version": "2.26",
"single": "get://[IP address Home Assistant]:8123/api/mystrom?single=[if of the button]",
"double": "",
"long": "",
"touch": ""
}
}
```

A complete command to set the URL for a double click could look like the example below:

```bash
$ curl -d "double=get://192.168.1.3:8123/api/mystrom?double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
```

<p class='note'>
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.
</p>
47 changes: 47 additions & 0 deletions source/_components/binary_sensor.raspihats.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: page
title: "Raspihats Binary Sensor"
description: "Instructions how to integrate Raspihats add-on boards for Raspberry PI into Home Assistant as a binary_sensor."
date: 2017-05-01 04:09
sidebar: true
comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: Binary Sensor
ha_release: 0.44
ha_iot_class: "Local Push"
---

The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.

To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: raspihats
i2c_hats:
- board: DI6acDQ6rly
address: 0x60
channels:
- index: 0
name: PIR Office
invert_logic: true
device_class: motion
- index: 1
name: PIR Bedroom
```

Configuration variables:

- **i2c_hats** (*Optional*): Array of used I2C-HATs.
- **board** (*Required*): The board name [Di16, Di6Rly6, DI16ac, DI6acDQ6rly].
- **address** (*Required*): The board I2C address, hex value.
- **channels** (*Required*): Array of used digital input channels.
- **index** (*Required*): Digital input channel index.
- **name** (*Required*): Friendly name to use for the frontend.
- **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
- **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`

For more details about the `raspihats` add-on boards for Raspberry PI, visit [raspihats.com](http://www.raspihats.com/).
39 changes: 39 additions & 0 deletions source/_components/binary_sensor.rpi_pfio.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: page
title: "PiFace Digital I/O Binary Sensor"
description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a binary sensor."
date: 2016-05-08 15:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_release: 0.45
---

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/) .

To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: rpi_pfio
ports:
0:
name: PIR Office
invert_logic: true
1:
name: Doorbell
settle_time: 50
```

Configuration variables:

- **ports** array (*Required*): Array of used ports.
- **num** (*Required*): Port number.
- **name** (*Required*): Port name.
- **settle_time** (*Optional*): The time in milliseconds for port debouncing. Default is 2 0ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).

11 changes: 7 additions & 4 deletions source/_components/blink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,16 @@ Once loaded, your front end will have the following components:
* A sensor per camera that reports battery level.
* A sensor per camera that reports unread notification (ie. detected motion events).

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.
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.

Services:
There are three services availiabe for the blink platform:
- arm_system
- arm_camera
- snap_picture
- force_update

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

Arm system example
```json
Expand All @@ -50,21 +51,23 @@ Arm system example
}
```

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:
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:
```json
{
"friendly_name": "Living Room",
"device_armed": "False"
}
```

The blink.snap_picture service takes the camera name as the payload and with take a new picture with your camera.
The `blink.snap_picture` service takes the camera name as the payload and with take a new picture with your camera.
```
{
"friendly_name": "Living Room"
}
```

The `blink.force_update` service can simply be called with no payload to force a server update.

Configuration variables:

- **username** (*Required*): Your username to login to Blink
Expand Down
6 changes: 5 additions & 1 deletion source/_components/camera.amcrest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,12 @@ Configuration variables:
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **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*.
- **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*.
- **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*.
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.

**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.

**Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at
[FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`.

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.
17 changes: 17 additions & 0 deletions source/_components/camera.axis.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: page
title: "Axis Camera"
description: "Instructions how to setup Axis cameras within Home Assistant."
date: 2017-05-01 19:09
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Camera
ha_release: "0.45"
---

The `Axis` camera platform allows you to stream video from your [Axis](https://www.axis.com/) cameras.

The requirement is that you have setup your [Axis camera](/components/axis/).
4 changes: 2 additions & 2 deletions source/_components/camera.uvc.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ camera:
Configuration variables:

- **nvr** (*Required*): The IP or hostname of the NVR (Network Video Recorder) server.
- **port** (*Optional*): The port number to use for accessing the NVR.
- **key** (*Required*): The API key available from the NVR web interface.

- **port** (*Optional*): The port number to use for accessing the NVR.
- **password** (*Optional*): The camera password. Defaults to `ubnt` if not given.
14 changes: 14 additions & 0 deletions source/_components/cover.lutron_caseta.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: page
title: "Lutron Caseta Cover"
description: "Instructions how to setup the Lutron Caseta covers within Home Assistant."
date: 2017-05-20 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Cover
---

To get your Lutron Caseta covers working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
Loading