Merge pull request #3694 from home-assistant/release-0-56

0.56
home-assistant · Oct 21, 2017 · 8791e6e · 8791e6e
2 parents af57c74 + 09f58f4
commit 8791e6e
Show file tree

Hide file tree

Showing 85 changed files with 3,242 additions and 525 deletions.
diff --git a/_config.yml b/_config.yml
@@ -139,12 +139,12 @@ social:
 
 # Home Assistant release details
 current_major_version: 0
-current_minor_version: 55
-current_patch_version: 1
-date_released: 2017-10-15
+current_minor_version: 56
+current_patch_version: 0
+date_released: 2017-10-21
 
 # Either # or the anchor link to latest release notes in the blog post.
 # Must be prefixed with a # and have double quotes around it.
 # Major release:
-patch_version_notes: "#release-0551---october-15"
+#patch_version_notes: "#release-0551---october-15"
 # Minor release (Example #release-0431---april-25):
diff --git a/sass/custom/_print.scss b/sass/custom/_print.scss
@@ -0,0 +1,39 @@
+@media print {
+
+	/* General Overrides */
+	header div.grid__item nav {
+		display: none;
+	}
+	aside#sidebar {
+		display: none;
+	}
+	.grid__item {
+		display: block;
+		width: 100%;
+	}
+
+	/* Components List */
+	div.filter-button-group {
+		display: none;
+	}
+	.hass-option-cards.show-items {
+		display: block;
+	}
+	.hass-option-cards.show-items a.option-card {
+		display: block;
+		opacity: 1;
+		width: 100%;
+		height: auto;
+		min-height: 80px;
+		margin-bottom: 8px;
+	}
+	.hass-option-cards.show-items a.option-card .img-container {
+		float: left;
+		width: 33%;
+		text-align: center;
+	}
+	.hass-option-cards.show-items a.option-card div.title {
+		height: 1.5em;
+		margin-top: 8px;
+	}
+}
diff --git a/sass/screen.scss b/sass/screen.scss
@@ -2,3 +2,4 @@
 @import 'custom/paulus';
 @import 'custom/component_page';
 @import 'custom/syntax';
+@import 'custom/print';
diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown
@@ -26,6 +26,7 @@ There is currently support for the following device types within Home Assistant:
 - [Lock](/components/cover.abode/): Reports on `Door Locks` and can be used to lock and unlock the door.
 - [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim, change color, or turn the light on and off.
 - [Switch](/components/switch.abode/): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
+- [Sensor](/components/sensor.abode/): Reports on `Temperature`, `Humidity`, and `Light` sensors.
 
 ## {% linkable_title Configuration %}
 

diff --git a/source/_components/alarm_control_panel.arlo.markdown b/source/_components/alarm_control_panel.arlo.markdown
@@ -0,0 +1,31 @@
+---
+layout: page
+title: "Arlo Control Panel"
+description: "Instructions how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant."
+date: 2017-10-05 17:45
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: arlo.png
+ha_category: Alarm
+ha_release: 0.56
+ha_iot_class: "Cloud Polling"
+---
+
+
+The `arlo` control panel platform allows you to control your [Arlo](https://arlo.netgear.com/) base stations.
+
+To get your [Arlo](https://arlo.netgear.com/) base stations working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
+
+Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+alarm_control_panel:
+  - platform: arlo
+```
+
+Configuration variables:
+
+- **home_mode_name**: (*Optional*): Arlo base station does not have a built-in home mode. You can map one of your custom modes to home assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app.
diff --git a/source/_components/alarm_control_panel.egardia.markdown b/source/_components/alarm_control_panel.egardia.markdown
@@ -43,7 +43,7 @@ You can change this, however, using the following procedure. This is a more adva
 
 1. Log in into your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. Also, update the port number 85 or to anything you like. The provided software that you will set up in the next steps runs on port 85 by default. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
-3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
+3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
 4. Once you have the codes, update your `configuration.yaml`:
 ```yaml
 # Example configuration.yaml entry
@@ -61,26 +61,30 @@ alarm_control_panel:
       triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
       ignore: XXXXXXXXXXXXXXXX
 ```
-  Note that for triggered, arm and disarm multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as ignore (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, armhome, triggered) even when system checks occur.
 
-5. Start the `egardiaserver.py` script on boot of your Home Assistant machine, for example by using systemd. To use this method, create a shell script named `egardiaserver.sh` that contains the following:
+Note that for triggered, arm and disarm multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as ignore (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, armhome, triggered) even when system checks occur.
+
+5. Start the `egardiaserver.py` script on boot of your Home Assistant machine, for example by using `systemctl` by `systemd`. To use this method, create a shell script named `egardiaserver.sh` that contains something like the following:
+
 ```bash
-source /srv/homeassistant/homeassistant_venv/bin/activate
-python3 /srv/homeassistant/homeassistant_venv/lib/python3.4/site-packages/pythonegardia/egardiaserver.py -host [YOURHOST] -password '[YOURPASSWORD]' -ssl True > /tmp/egardiaserver.log 2>&1
+$ source /srv/homeassistant/bin/activate
+$ python3 /srv/homeassistant/lib/python3.5/site-packages/pythonegardia/egardiaserver.py -host [YOURHOST] -password '[YOURPASSWORD]' -ssl True > /tmp/egardiaserver.log 2>&1
 ```
 
 Mark it as executable (`$ chmod +x`) and run `sudo nano /lib/systemd/system/egardiaserver.service`. Enter the following into the `egardiaserver.service` file:
+
 ```bash
 [Unit]
 Description=Egardia Server Service
 
 [Service]
-ExecStart=/srv/homeassistant/homeassistant_venv/lib/python3.4/site-packages/pythonegardia/egardiaserver.sh
+ExecStart=/bin/bash /srv/homeassistant/homeassistant_venv/lib/python3.5/site-packages/pythonegardia/egardiaserver.sh
 StandardOutput=journal+console
 
 [Install]
 WantedBy=multi-user.target
 Alias=egardiaserver.service
 ```
+
 Save and then run `sudo systemctl enable egardiaserver.service` and `sudo systemctl start egardiaserver.service`.
 6. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish.
diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown
@@ -21,12 +21,14 @@ The component will accept the following commands from your Alarm Panel via the `
 - `DISARM`
 - `ARM_HOME`
 - `ARM_AWAY`
+- `ARM_NIGHT`
 
 When the state of the manual alarm changes, Home Assistant will publish one of the following states to the `state_topic`:
 
 - 'disarmed'
 - 'armed_home'
 - 'armed_away'
+- 'armed_night'
 - 'pending'
 - 'triggered'
 
@@ -47,6 +49,8 @@ All configuration variables from the base manual alarm platform are available:
 - **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
 - **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
 - **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
+- **armed_home|armed_away|armed_night|triggered** (*Optional*): State specific settings
+  - **pending_time**: State specific pending time override.
 
 Additionally, the following MQTT configuration variables are also available:
 
@@ -56,6 +60,23 @@ Additionally, the following MQTT configuration variables are also available:
 - **payload_disarm** (*Optional*): The payload to disarm this Alarm Panel. Default is "DISARM".
 - **payload_arm_home** (*Optional*): The payload to set armed-home mode on this Alarm Panel. Default is "ARM_HOME".
 - **payload_arm_away** (*Optional*): The payload to set armed-away mode on this Alarm Panel. Default is "ARM_AWAY".
+- **payload_arm_night** (*Optional*): The payload to set armed-night mode on this Alarm Panel. Default is "ARM_NIGHT".
+
+In the config example below, armed_home state will have no pending time and triggered state will have a pending time of 20 seconds whereas armed_away state will have a default pending time of 30 seconds.
+
+```yaml
+# Example configuration.yaml entry
+alarm_control_panel:
+  - platform: manual_mqtt
+    state_topic: home/alarm
+    command_topic: home/alarm/set
+    pending_time: 30
+    armed_home:
+      pending_time: 0
+    triggered:
+      pending_time: 20
+    trigger_time: 4 
+```
 
 ## {% linkable_title Examples %}
 
@@ -70,11 +91,13 @@ To change the state of the alarm, publish one of the following messages to the `
  - `DISARM`
  - `ARM_HOME`
  - `ARM_AWAY`
+ - `ARM_NIGHT`
 
 To receive state updates from HA, subscribe to the `state_topic`. Home Assistant will publish a new message whenever the state changes:
 
  - `disarmed`
  - `armed_home`
  - `armed_away`
+ - `armed_night`
  - `pending`
  - `triggered`
diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown
@@ -31,7 +31,7 @@ Configuration variables:
 
 It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.
 
-Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/).
+Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/).
 
 The Arlo component also provides a service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
 

diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown
@@ -36,3 +36,22 @@ Configuration variables:
   - **name** (*Required*): Name of the sensor.
   - **slave** (*Required*): The number of the slave (Optional for TCP and UDP Modbus).
   - **coil** (*Required*): Coil number.
+  
+It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
+
+### {% linkable_title Full example %}
+
+Example a sensor with a 10 seconds scan interval:
+
+```yaml
+binary_sensor:
+  - platform: modbus
+    scan_interval: 10
+    coils:
+      - name: Sensor1
+        slave: 1
+        coil: 100
+      - name: Sensor2
+        slave: 1
+        coil: 110
+```
diff --git a/source/_components/binary_sensor.netatmo.markdown b/source/_components/binary_sensor.netatmo.markdown
@@ -27,8 +27,7 @@ If you want to select a specific sensor, set discovery to False for [netatmo](/c
 binary_sensor:
   platform: netatmo
   home: home_name
-  timeout: 15
-  offset: 90
+  timeout: 90
   cameras:
     - camera_name1
   welcome_sensors:
@@ -45,8 +44,7 @@ binary_sensor:
 Configuration variables:
 
 - **home** (*Optional*): Will use the cameras of this home only.
-- **timeout** (*Optional*): The Welcome binary sensors will reflect the events from the last X minutes. (default: 15)
-- **offset** (*Optional*): The Presence binary sensors will stay on for X seconds after detection. (default: 90)
+- **timeout** (*Optional*): The Welcome/Presence binary sensors will stay on for X seconds after detection. (default: 90)
 - **cameras** array (*Optional*): Cameras to use. Multiple entities allowed.
     - 'camera_name': Name of the camera to display.
 - **welcome_sensors** array (*Optional*): List of monitored conditions.

diff --git a/source/_components/binary_sensor.skybell.markdown b/source/_components/binary_sensor.skybell.markdown
@@ -0,0 +1,33 @@
+---
+layout: page
+title: "Skybell Binary Sensor"
+description: "Instructions on how to integrate your Skybell HD devices within Home Assistant."
+date: 2017-10-03 16:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: skybell.png
+ha_category: Binary Sensor
+ha_release: 0.56
+ha_iot_class: "Cloud Polling"
+---
+
+To get your [Skybell.com](https://skybell.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
+
+Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+  - platform: skybell
+    monitored_conditions:
+      - button
+      - motion
+```
+
+Configuration variables:
+
+- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
+  - **button**: Return a boolean value when the doorbell button was pressed.
+  - **motion**: Return a boolean value when movement was detected by the Skybell doorbell.
diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown
@@ -183,7 +183,7 @@ Available events are `single`, `double`, `hold`, `long_click_press` and `long_cl
 
 #### {% linkable_title Xiaomi Cube %}
 
-Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`.
+Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The component stores the last action as the attribute `last_action`.
 
 ```yaml
 - alias: Cube event flip90

diff --git a/source/_components/camera.skybell.markdown b/source/_components/camera.skybell.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Skybell Camera"
+description: "Instructions on how to integrate your Skybell HD devices within Home Assistant."
+date: 2017-10-03 16:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: skybell.png
+ha_category: Camera
+ha_release: 0.56
+ha_iot_class: "Cloud Polling"
+---
+
+To get your [Skybell.com](https://skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
+
+Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+camera:
+  - platform: skybell
+```