Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.42 #2388

Merged
merged 43 commits into from
Apr 8, 2017
Merged

0.42 #2388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
d6fac22
Adding documentation of expire_after for mqtt sensor to expire outdat…
micw Mar 23, 2017
dbea60b
Merge branch 'release-0-41' into next
balloob Mar 24, 2017
065a2d6
Added service description (#2319)
PetePriority Mar 24, 2017
aa626f8
Update Emby docs (#2274)
mezz64 Mar 24, 2017
9640faf
Update Honeywell US documentation (#2057)
titilambert Mar 24, 2017
8e24861
Merge branch 'current' into next
fabaff Mar 25, 2017
3e06754
Update switch.tplink.markdown (#2335)
rytilahti Mar 26, 2017
f45ea82
Add switch example and list of supported devices (#2312)
fabaff Mar 26, 2017
52f426b
Add unit of measurement (#2337)
fabaff Mar 26, 2017
090d7dd
Documentation for new MVG sensor (#2311)
DavidMStraub Mar 26, 2017
e449146
Update ha_release
fabaff Mar 16, 2017
9ad153b
Update ha_release
fabaff Mar 26, 2017
7286ed2
Update for 0.42
fabaff Mar 26, 2017
2459f59
Clarify hash in Google Calendar search term (#2305)
agross Mar 26, 2017
96dc21a
Update hikvision docs for NVR support (#2340)
mezz64 Mar 27, 2017
51ca0c4
Update z-wave.markdown (#2321)
turbokongen Mar 29, 2017
8c8b44b
Added documentation changes for ZM external trigger (#2350)
anpetrov Mar 30, 2017
8da0dfa
Revert "Added documentation changes for ZM external trigger (#2350)" …
balloob Mar 31, 2017
175f612
Remove references to deprecated `new_devices_group` (#2355)
Mar 31, 2017
119d0f9
Linkable reference for rflink debug logging. (#2354)
Mar 31, 2017
03c579a
Added documentation for Ring binary sensor (#2231)
tchellomello Mar 31, 2017
527a888
Lockitron page (#2339)
aarya123 Mar 31, 2017
e60798d
Update light.limitlessled.markdown (#2329)
quadportnick Mar 31, 2017
28c12b7
Add documentation for Lyft sensor (#2304)
drkp Mar 31, 2017
8da09ab
Added SSL guide to cookbook (#2269)
Mar 31, 2017
e5a7397
Merge branch 'current' into next
fabaff Mar 31, 2017
72d5b67
Fix file name and location
fabaff Mar 31, 2017
4eb8f9a
Format and style, add to menu
fabaff Mar 31, 2017
06f2f03
Updated Ring component documentation (#2366)
tchellomello Apr 1, 2017
eaf8147
Minimize the configuration sample
fabaff Apr 1, 2017
c4ea556
Use default format for configuration variables
fabaff Apr 1, 2017
5d14395
Update title
fabaff Apr 1, 2017
0db3aa2
TotalConnect documentation (#2372)
craigjmidwinter Apr 4, 2017
4ba577a
Added documentation and logo for eddystone_temperature platform. (#2334)
citruz Apr 5, 2017
6f8db0a
Rename zwave nodes by node ID instead of entity ID (#2382)
emlove Apr 5, 2017
ce71b24
Update fido sensor documentation (#2256)
titilambert Apr 5, 2017
adf9506
Update lets_encrypt.markdown (#2387)
Apr 6, 2017
520805d
Added temperature variables since pyhydroquebec 1.1.0 (#2370)
diogos88 Apr 6, 2017
bdc3a02
Merge branch 'current' into next
fabaff Apr 6, 2017
da05d9a
Merge remote-tracking branch 'origin/current' into release-0-42
balloob Apr 8, 2017
2f52a6a
Add homeassistant automation platform docs
balloob Apr 8, 2017
8e42c08
add crimereports doc (#2062)
happyleavesaoc Apr 8, 2017
f0b5f37
Release 0.42
balloob Apr 8, 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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ source/stylesheets/screen.css
vendor
node_modules
source/.jekyll-metadata
*.iml
.idea/
6 changes: 3 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,10 @@ social:

# Home Assistant release details
current_major_version: 0
current_minor_version: 41
current_minor_version: 42
current_patch_version: 0
date_released: 2017-03-25
date_released: 2017-04-08

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
#patch_version_notes: "#release-0411---march-xx"
patch_version_notes: "#"
31 changes: 31 additions & 0 deletions source/_components/alarm_control_panel.totalconnect.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: page
title: "Honeywell TotalConnect Alarm Control Panel"
description: "Instructions how to integrate TotalConnect alarms into Home Assistant."
date: 2017-04-02 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: honeywell-tc.png
ha_category: Alarm
ha_release: 0.42
---

The `totalconnect` platform provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies

To enable this, add the following lines to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
alarm_control_panel:
platform: totalconnect
username: YOUR_USERNAME
password: YOUR_PASSWORD
```

Configuration variables:
- **name** (*Optional*): Name of device in HomeAssistant
- **username** (*Required*): Username used to sign into the TotalConnect app/web client.
- **password** (*Required*): Password used to sign into the TotalConnect app/web client.

40 changes: 33 additions & 7 deletions source/_components/binary_sensor.hikvision.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ ha_release: 0.35
ha_iot_class: "Local Push"
---

The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera](http://www.hikvision.com/) and presents the camera events to Home Assistant as binary sensors with either an "off" or "on" state.
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state.

The platform will automatically add all sensors to Home Assistant that are configured within the camera interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.

For example, if you configure a camera with the name "Front Porch" that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:

Expand All @@ -24,7 +24,16 @@ binary_sensor.front_porch_motion
binary_sensor.front_port_line_crossing
```

This platform should work with all Hikvision cameras, and has been confirmed to work with the following models:
When used with a NVR device the sensors will be appeneded with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:

```
binary_sensor.home_motion_1
binary_sensor.home_motion_2
binary_sensor.home_line_crossing_1
binary_sensor.home_line_crossing_2
```

This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
- DS-2CD3132-I
- DS-2CD2232-I5
- DS-2CD2032-I
Expand Down Expand Up @@ -55,7 +64,6 @@ Configuration options for a Hikvision Sensor:

Supported sensor/event types are:
- Motion
- IO Trigger
- Line Crossing
- Field Detection
- Video Loss
Expand All @@ -70,9 +78,27 @@ Supported sensor/event types are:
- Bad Video
- PIR Alarm
- Face Detection
- Scene Change Detection


Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:

```yaml
binary_sensor:
platform: hikvision
host: 192.168.X.X
port: 80
ssl: False
username: user
password: pass
customize:
motion:
delay: 30
line_crossing:
ignored: True
```

Example of a configuration in your `configuration.yaml` that utilizes the customize options:
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:

```yaml
binary_sensor:
Expand All @@ -83,8 +109,8 @@ binary_sensor:
username: user
password: pass
customize:
sensor_name_1:
motion_1:
delay: 30
sensor_name_2:
field_detection_2:
ignored: True
```
34 changes: 34 additions & 0 deletions source/_components/binary_sensor.ring.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: page
title: "Ring Binary Sensor"
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
date: 2017-04-01 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Binary Sensor
ha_release: 0.42
---

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

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

```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: ring
monitored_conditions:
- ding
- motion
```

Configuration variables:

- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **ding**: Return a boolean value when the doorbell button was pressed.
- **motion**: Return a boolean value when a moviment was detected by the Ring doorbell.

Currently only doorbells are supported by this sensor.
4 changes: 3 additions & 1 deletion source/_components/binary_sensor.workday.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ ha_release: 0.41

The `workday` binary sensor indicates, whether the current day is a workday or not. It allows specifying, which days of the week counts as workdays and also uses the python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays.

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

```yaml
# Example configuation.yaml entry
binary_sensor:
Expand All @@ -32,8 +34,8 @@ Configuration variables:

Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. The keyword `holiday` is used for public holidays identified by the holidays module.


Example usage for automation:

```yaml
automation:
alias: Turn on heater on workdays
Expand Down
2 changes: 1 addition & 1 deletion source/_components/calendar.google.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ From this we will end up with the binary sensors `calendar.test_unimportant` and

But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.

**Note**: If you use a `#` sign for search then wrap it up. It's better to be safe!
**Note**: If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.


### {% linkable_title Sensor attributes %}
Expand Down
4 changes: 3 additions & 1 deletion source/_components/climate.honeywell.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Configuration variables:

- **username** (*Required*): The username of an user with access.
- **password** (*Required*): The password for your given admin account.
- **away_temperature** (*Optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
- **region** (*Optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.
- **scan_interval**(*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 120 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell.
- **away_temperature** (*Optional*) (*only for eu region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
- **cool_away_temperature** (*Optional*) (*only for us region*): Cooling setpoint when away mode is on. If omitted it defaults to 30.0 deg C.
- **heat_away_temperature** (*Optional*) (*only for us region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
4 changes: 2 additions & 2 deletions source/_components/ha.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: page
title: "Home Assistant 0.41"
title: "Home Assistant 0.42"
description: ""
date: 2016-12-16 17:00
sidebar: true
Expand All @@ -9,7 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: 0.41
ha_release: 0.42
---

Details about the latest release can always be found at:
Expand Down
9 changes: 5 additions & 4 deletions source/_components/light.limitlessled.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ light:
type: rgbw
name: Bathroom
- host: 192.168.1.11
bridge_led: True
groups:
- number: 1
name: Living Room & Hall
- number: 1
type: bridge-led
name: Bridge Light
```

Configuration variables:
Expand All @@ -47,11 +49,10 @@ Configuration variables:
- **host** (*Required*): IP address of the device, eg. `192.168.1.32`
- **version** (*Optional*): Bridge version (default is `6`). Don't use if you aren't sure.
- **port** (*Optional*): Bridge port. Defaults to 5987.
- **bridge_led** (*Optional*): If True, the bridge led can be controlled. (Only supported for newer bridges with integrated led)
- **groups** array (*Required*): The list of available groups.
- **number** (*Required*): Group number (`1`-`4`). Corresponds to the group number on the remote.
- **number** (*Required*): Group number (`1`-`4`). Corresponds to the group number on the remote. These numbers may overlap only if the type is different.
- **name** (*Required*): Any name you'd like. Must be unique among all configured groups.
- **type** (*Optional*): Type of group. Choose either `rgbww`, `rgbw` or `white`. `rgbw` is the default if you don't specify this entry.
- **type** (*Optional*): Type of group. Choose either `rgbww`, `rgbw`, `white`, or `bridge-led`. `rgbw` is the default if you don't specify this entry. Use `bridge-led` to control the built-in LED of newer WiFi bridges.

### {% linkable_title Properties %}

Expand Down
15 changes: 2 additions & 13 deletions source/_components/light.rflink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,6 @@ First you have to set up your [rflink hub](/components/rflink/).

After configuring the RFLink hub lights will be automatically discovered and added.

New/unknown lights can be assigned to a default group automatically by specifying the `new_devices_group` option with a group name. If the group doesn't exist it will be created.

For example:

```yaml
# Example configuration.yaml entry
sensor:
platform: rflink
new_devices_group: "New Rflink Lights"
```

RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.

Once the ID of a light is known it can be used to configure the light in HA, for example to add it to a different group, hide it or configure a nice name.
Expand All @@ -49,8 +38,8 @@ light:

Configuration variables:

- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to HA if detected (default: True).
- **devices** (*Optional*): A list of devices with their name to use in the frontend.
- **new_devices_group** (*Optional*): Create group to add new/unknown devices to.
- **device_defaults**: (*Optional*)
- **fire_event** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
Expand Down Expand Up @@ -105,7 +94,7 @@ By default new lights are assigned the `switchable` type. Protocol supporting di

Lights are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods:

- Configure a `new_devices_group` for lights and optionally add it to a different `view`.
- Disable automatically adding of unconfigured new sensors (set `automatic_add` to `false`).
- Hide unwanted devices using [customizations](/getting-started/customizing-devices/)
- [Ignore devices on a platform level](/components/rflink/#ignoring-devices)

Expand Down
31 changes: 31 additions & 0 deletions source/_components/lock.lockitron.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: page
title: "Lockitron Lock"
description: "Instructions how to integrate Lockitron locks into Home Assistant."
date: 2017-03-24 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lockitron.png
ha_category: Lock
ha_iot_class: "Cloud Polling"
ha_release: "0.42"
---

The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant.
In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you.
Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you).

```yaml
lock:
- platform: lockitron
access_token: asdf
id: fdsa
```

Configuration variables:

- **access_token** (*Required*): The usernThe security token provided by Lockitron to lock and unlock your lock.
- **id** (*Required*): The lock id given by Lockitron (should be a GUID).

9 changes: 5 additions & 4 deletions source/_components/media_player.emby.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ footer: true
logo: emby.png
ha_category: Media Player
ha_release: "0.32"
ha_iot_class: "Local Polling"
ha_iot_class: "Local Push"
---


Expand All @@ -28,7 +28,8 @@ media_player:

Configuration variables:

- **host** (*Required*): The host name or address of the device that is running Emby.
- **host** (*Optional*): The host name or address of the device that is running Emby. Defaults to ```localhost```.
- **api_key** (*Required*): The api-key you would like home-assistant to use to authenticate.
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
- **port** (*Optional*): The port number. Defaults to 8096.
- **ssl** (*Optional*): True if you want to connect with https/wss. Your SSL certificate must be valid. Default is False.
- **port** (*Optional*): The port number. Defaults to 8096 with SSL set to False and 8920 with SSL set to True.
- **auto_hide** (*Optional*): True if you want to automatically hide devices that are unavailable from the Home Assistant Interface. Defaults to False.
9 changes: 9 additions & 0 deletions source/_components/media_player.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
| `entity_id` | yes | Target a specific media player. Defaults to all. |
| `volume_level` | no | Float for volume level |

#### {% linkable_title Service `media_player/volume_transition` %}

| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|
| `entity_id` | yes | Target a specific media player. Defaults to all. |
| `volume_level` | no | Float for volume level |
| `transition` | no | Integer for transition time in seconds |


#### {% linkable_title Service `media_player/media_seek` %}

| Service data attribute | Optional | Description |
Expand Down
24 changes: 24 additions & 0 deletions source/_components/rflink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,27 @@ If you find a device is recognized differently, with different protocols or the
- The platform implementions take care of creating new devices (if enabled) for unsees incoming packet id's.
- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entitiy logic is maintained in this main component.

### {% linkable_title Debug logging %}

For debugging purposes or context when investigating issues you can enable debug logging for Rflink with the following config snippet:

```yaml
logger:
default: error
logs:
rflink: debug
homeassistant.components.rflink: debug
```

This will give you output looking like this:

```
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: 20;00;Nod
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: o RadioFrequencyLink - R
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: FLink Gateway V1.1 - R45
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: ;
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got packet: 20;00;Nodo RadioFrequencyLink - RFLink Gateway V1.1 - R45;
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] decoded packet: {'firmware': 'RFLink Gateway', 'revision': '45', 'node': 'gateway', 'protocol': 'unknown', 'hardware': 'Nodo RadioFrequencyLink', 'version': '1.1'}
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got event: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
17-03-07 20:12:05 DEBUG (MainThread) [homeassistant.components.rflink] event of type unknown: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
```
Loading