Skip to content

Commit 056e268

Browse files
fabafffabaff
authored
Merge pull request home-assistant#1263 from home-assistant/next
0.31
2 parents 4b98d72 + 2ee6bff commit 056e268

File tree

77 files changed

+1603
-141
lines changed

Some content is hidden

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

77 files changed

+1603
-141
lines changed

‎source/_components/alarm_control_panel.concord232.markdown

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: page
3+
title: "Concord232 Alarm Control Panel"
4+
description: "Instructions how to integrate Interlogix/GE Concord4 with RS-232 Automation Control Module into Home Assistant."
5+
date: 2016-10-11 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: interlogix.png
11+
ha_category: Alarm
12+
ha_release: 0.31
13+
---
14+
15+
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
16+
17+
To enable this, add the following lines to your `configuration.yaml`:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
alarm_control_panel:
22+
- platform: concord232
23+
```
24+
25+
Configuration variables:
26+
27+
- **host** (*Optional*): The host where the concord232 server process is running. Defaults to localhost.
28+
- **port** (*Optional*): The port where the Alarm panel ist listening. Defaults to 5007.
29+

‎source/_components/alexa.markdown

+67-7
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ ha_category: Voice
1212
featured: true
1313
---
1414

15-
There are two ways that you can use Amazon Echo and Home Assistant together.
15+
There are a few ways that you can use Amazon Echo and Home Assistant together.
1616

17-
No matter which method(s) you decide to use, please remember that Amazon Echo requires an active Internet connection to function. If your Internet is down or experiencing issues (or Amazon's infrastructure is having issues), neither of these methods will work.
17+
- [Turning devices on and off](#i-just-want-to-turn-devices-on-and-off-using-echo)
18+
- [Build custom commands to use](#i-want-to-build-custom-commands-to-use-with-echo)
19+
- [Create a new Flash Briefing source](#flash-briefing-skills)
20+
21+
No matter which method(s) you decide to use, please remember that Amazon Echo requires an active Internet connection to function. If your Internet is down or experiencing issues (or Amazon's infrastructure is having issues), none of these methods will work.
1822

1923
Amazon has released [Echosim], a website that simulates the Alexa service in your browser. That way it is easy to test your skills without having access to a physical Amazon Echo.
2024

@@ -62,16 +66,19 @@ Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certif
6266

6367
To get started with Alexa skills:
6468

65-
- Log in to [Amazon developer console](https://developer.amazon.com)
66-
- Go to Apps & Services => Alexa => Alexa Skill Kit - Get Started
67-
- Add a new skill
69+
- Log in to [Amazon developer console][amazon-dev-console]
70+
- Click the Alexa button at the top of the console
71+
- Click the yellow "Add a new skill" button in the top right
72+
- Skill Type: Custom Interaction Model (default)
6873
- Name: Home Assistant
6974
- Invocation name: home assistant (or be creative, up to you)
7075
- Version: 1.0
7176
- Endpoint:
7277
- https
7378
- https://YOUR_HOST/api/alexa?api_password=YOUR_API_PASSWORD
7479

80+
You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one.
81+
7582
### {% linkable_title Configuring your Amazon Alexa skill %}
7683

7784
Alexa works based on intents. Each intent has a name and variable slots. For example, a `LocateIntent` with a slot that contains a `User`. Example intent schema:
@@ -119,7 +126,6 @@ You can use [templates] for the values of `speech/text`, `card/title` and `card/
119126

120127
Actions are using the [Home Assistant Script Syntax] and also have access to the variables from the intent.
121128

122-
[templates]: /topics/templating/
123129
[Home Assistant Script Syntax]: /getting-started/scripts/
124130

125131
Configuring the Alexa component for the above intents would look like this:
@@ -256,7 +262,7 @@ Then add the intent to your Alexa Section in your HA config file:
256262

257263
Now say `Alexa ask homeassistant to run <some script>` and Alexa will run that script for you.
258264

259-
## {% linkable_title Giving Alexa Some Personality%}
265+
## {% linkable_title Giving Alexa Some Personality %}
260266

261267
In the examples above, we told Alexa to say `OK` when she successfully completed the task. This is effective but a little dull! We can again use [templates] to spice things up a little.
262268

@@ -298,3 +304,57 @@ text: !include alexa_confirm.yaml
298304
Alexa will now respond with a random phrase each time. You can use the include for as many different intents as you like so you only need to create the list once.
299305

300306

307+
## {% linkable_title Flash Briefing Skills %}
308+
309+
As of version [0.31][zero-three-one] Home Assistant supports the new [Alexa Flash Briefing Skills API][flash-briefing-api]. A Flash Briefing Skill adds a new Flash Briefing source that is generated by Home Assistant.
310+
311+
### {% linkable_title Configuring a Flash Briefing skill in Home Assistant %}
312+
313+
You can use [templates] for the `title`, `audio`, `text` and `display_url` configuration parameters.
314+
315+
Here's an example configuration of a Flash briefing skill that will tell you who is at home:
316+
317+
```yaml
318+
{% raw %}# Example configuration.yaml entry
319+
alexa:
320+
flash_briefings:
321+
whoishome:
322+
- title: Who's at home?
323+
text: >
324+
{%- if is_state('device_tracker.paulus', 'home') and
325+
is_state('device_tracker.anne_therese', 'home') -%}
326+
You are both home, you silly
327+
{%- else -%}
328+
Anne Therese is at {{ states("device_tracker.anne_therese") }}
329+
and Paulus is at {{ states("device_tracker.paulus") }}
330+
{% endif %}{% endraw %}
331+
```
332+
333+
You can add multiple items for a feed if you want. The Amazon required uid and timestamp will be randomly generated at startup and change at every restart of Home Assistant.
334+
335+
Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats.
336+
337+
### {% linkable_title Configuring your Flash Briefing skill %}
338+
339+
- Log in to [Amazon developer console][amazon-dev-console]
340+
- Click the Alexa button at the top of the console
341+
- Click the yellow "Add a new skill" button in the top right
342+
- Skill Information
343+
- For Skill Type select Flash Briefing Skill API
344+
- You can enter whatever name you want
345+
- Hit next
346+
- Interaction Model
347+
- Nothing to do here
348+
- Configuration
349+
- Add new feed
350+
- For URL, enter `https://YOUR_HOST/api/alexa/flash_briefings/BRIEFING_ID?api_password=YOUR_API_PASSWORD` where `BRIEFING_ID` is the key you entered in your configuration (such as `whoishome` in the above example)
351+
- You can use this [specially sized Home Assistant logo][large-icon] as the Feed Icon
352+
- All other settings are up to you
353+
354+
[amazon-dev-console]: https://developer.amazon.com
355+
[flash-briefing-api]: https://developer.amazon.com/alexa-skills-kit/flash-briefing
356+
[flash-briefing-api-docs]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/flash-briefing-skill-api-feed-reference
357+
[large-icon]: /images/components/alexa/alexa-512x512.png
358+
[small-icon]: /images/components/alexa/alexa-108x108.png
359+
[templates]: /topics/templating/
360+
[zero-three-one]: /blog/2016/10/22/flash-briefing-updater-hacktoberfest/

‎source/_components/binary_sensor.concord232.markdown

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: page
3+
title: "Concord232 Binary Sensor"
4+
description: "Instructions how to integrate Interlogix/GE Concord4 binary sensors into Home Assistant."
5+
date: 2016-10-11 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: interlogix.png
11+
ha_category: Binary sensor
12+
ha_release: 0.31
13+
---
14+
15+
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
16+
17+
To enable this, add the following lines to your `configuration.yaml`:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
binary_sensor:
22+
- platform: concord232
23+
```
24+
25+
Configuration variables:
26+
27+
- **host** (*Optional*): The host where the concord232 server process is running. Defaults to localhost.
28+
- **port** (*Optional*): The port where the Alarm panel ist listening. Defaults to 5007.
29+

‎source/_components/binary_sensor.netatmo.markdown

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: page
3+
title: "Netatmo Binary Sensor"
4+
description: "Instructions how to integrate Netatmo binary sensor into Home Assistant."
5+
date: 2016-09-19 15:10
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: netatmo.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.31
13+
---
14+
15+
### {% linkable_title Basic Configuration %}
16+
17+
The `netatmo` binary sensor platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to get the latest event seen by the camera.
18+
19+
To enable the Netatmo binary sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your binary sensor.
20+
21+
### {% linkable_title Advanced configuration %}
22+
23+
If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
24+
25+
```yaml
26+
# Example configuration.yaml entry
27+
binary_sensor:
28+
platform: netatmo
29+
home: home_name
30+
cameras:
31+
- camera_name1
32+
monitored_conditions:
33+
- Someone known
34+
- Someone unknown
35+
- Motion
36+
```
37+
38+
Configuration variables:
39+
40+
- **home** (*Optional*): Will use the cameras of this home only.
41+
- **cameras** array (*Optional*): Cameras to use. Multiple enties allowed.
42+
- 'camera_name': Name of the camera to display.
43+
- **monitored_conditions** array (*Optional*): List of monitored conditions.
44+
- 'Someone known'
45+
- 'Someone unknown'
46+
- 'Motion'
47+
48+
If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera
49+
50+
<p class='note'>
51+
[Welcome tags](https://www.netatmo.com/product/security/welcome/tags) are not yet supported, but will be in a next update.
52+
</p>

‎source/_components/camera.netatmo.markdown

+6-1
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,15 @@ ha_category: Camera
1212
ha_release: 0.22
1313
---
1414

15+
### {% linkable_title Basic Configuration %}
1516

1617
The `netatmo` camera platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
1718

18-
To enable the Netatmo camera, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`:
19+
To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera.
20+
21+
### {% linkable_title Advanced configuration %}
22+
23+
If you want to select a specific camera, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
1924

2025
```yaml
2126
# Example configuration.yaml entry

‎source/_components/camera.synology.markdown

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: page
3+
title: "Synology Camera"
4+
description: "Instructions how to integrate Synolog Surveillance Station cameras within Home Assistant."
5+
date: 2016-10-13 08:01
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: synology.png
11+
ha_category: Camera
12+
ha_release: 0.31
13+
---
14+
15+
　
16+
The `synology` platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
17+
18+
To enable your Surveillance Station cameras in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Minimum configuration.yaml entry
22+
camera:
23+
- platform: synology
24+
url: SYNOLOGY_URL
25+
username: USERNAME
26+
password: PASSWORD
27+
```
28+
29+
Configuration variables:
30+
31+
- **url** (*Required*): The URL to your synology, including port.
32+
- **username** (*Required*): The username for accessing surveillance station.
33+
- **password** (*Required*): The password for accessing surveillance station.
34+
- **whitelist** (*Optional*): A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omited all cameras are added.
35+
- **verify_ssl** (*Optional*): True to require a valid certificate, False to disable certificate checking. Defaults to `True`.
36+
37+
A full sample configuration for the `synology` platform is shown below:
38+
39+
```yaml
40+
# Example configuration.yaml entry
41+
camera:
42+
- platform: synology
43+
url: https://192.168.1.120:5001
44+
username: USERNAME
45+
password: PASSWORD
46+
verify_ssl: False
47+
```
48+
49+
<p class='note'>
50+
Most users will need to set `valid_ssl` to false unless they have installed a valid SSL certificate in place of the built in self-signed certificate.
51+
</p>

‎source/_components/camera.verisure.markdown

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: page
3+
title: "Verisure Camera"
4+
description: "Instructions how to setup the Verisure cameras within Home Assistant."
5+
date: 2016-10-22 09:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: verisure.png
11+
ha_category: Camera
12+
ha_release: 0.31
13+
---
14+
15+
16+
The `verisure` camera platform allows you to control your [Verisure](https://www.verisure.com/) cameras.
17+
18+
The requirement is that you have setup your [Verisure hub](/components/verisure/).
19+

‎source/_components/climate.netatmo.markdown

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: page
3+
title: "Netatmo Thermostat"
4+
description: "Instructions how to integrate Netatmo thermostat into Home Assistant."
5+
date: 2016-11-10 08:10
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: netatmo.png
11+
ha_category: Climate
12+
ha_release: 0.31
13+
---
14+
15+
### {% linkable_title Basic Configuration %}
16+
17+
The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This component allows you to view the current temperature and setpoint.
18+
19+
To enable the Netatmo thermostat, you first have to set up [netatmo](/components/netatmo/), this will use discovery to add your thermostat.
20+
21+
### {% linkable_title Basic Configuration %}
22+
23+
If you want to select a specific thermostat, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
24+
25+
```yaml
26+
# Example configuration.yaml entry
27+
climate:
28+
platform: netatmo
29+
```
30+
31+
Configuration variables:
32+
33+
- **relay** (*Optional*): Will display the thermostats of this relay only.
34+
- **thermostat** array (*Optional*): Thermostat to use.
35+
- **thermostat_name**: Name of the thermostat to display.
36+
37+
If **relay** and **thermostat** are not provided, all thermostats will be displayed.
38+
39+
```yaml
40+
# Example configuration.yaml entry
41+
climate:
42+
platform: netatmo
43+
relay: relay_name
44+
thermostat:
45+
- thermostat_name
46+
```

‎source/_components/device_tracker.bbox.markdown

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: "Bbox"
4+
description: "Instructions how to integrate Bouygues Bbox routers into Home Assistant."
5+
date: 2016-10-13 23:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: bbox.png
11+
ha_category: Presence Detection
12+
ha_release: "0.31"
13+
---
14+
15+
16+
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://fr.wikipedia.org/wiki/Bbox) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
17+
18+
<p class='note'>
19+
Bbox is a generic name for different hardware routers. The platform has only been tested on a Sagem F@st 5330b because it's the only model the developer owns.
20+
</p>
21+
22+
To use an Bbox router in your installation, add the following to your `configuration.yaml` file:
23+
24+
```yaml
25+
# Example configuration.yaml entry
26+
device_tracker:
27+
- platform: bbox
28+
```
29+
30+
<p class='note warning'>
31+
For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation. And with the default IP configuration (IP of the router must be 192.168.1.254).
32+
</p>
33+
34+
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
35+

0 commit comments

Comments
 (0)