Skip to content

Commit c7abf99

Browse files
committed
Merge branch 'current' into next
2 parents 16e6b2e + caed5e9 commit c7abf99

23 files changed

+219
-109
lines changed

Rakefile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ desc "Generate jekyll site"
5656
task :generate do
5757
raise "### You haven't set anything up yet. First run `rake install` to set up an Octopress theme." unless File.directory?(source_dir)
5858
puts "## Generating Site with Jekyll"
59-
system "compass compile --css-dir #{source_dir}/stylesheets"
60-
system "jekyll build"
59+
success = system "compass compile --css-dir #{source_dir}/stylesheets"
60+
abort("Generating CSS failed") unless success
61+
success = system "jekyll build"
62+
abort("Generating site failed") unless success
6163
end
6264

6365
desc "Watch the site and regenerate when it changes"

_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,9 @@ social:
131131
# Home Assistant release details
132132
current_major_version: 0
133133
current_minor_version: 34
134-
current_patch_version: 0
135-
date_released: 2016-12-03
134+
current_patch_version: 4
135+
date_released: 2016-12-07
136136

137137
# Either # or the anchor link to latest release notes in the blog post.
138138
# Must be prefixed with a # and have double quotes around it.
139-
patch_version_notes: "#"
139+
patch_version_notes: "#release-0344---december-7"

source/_components/binary_sensor.nest.markdown

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,49 @@ ha_release: pre 0.7
1313
---
1414

1515

16-
The `nest` binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com).
16+
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
1717

1818
<p class='note'>
19-
You must have the [Nest component](/components/nest/) configured to use these sensors. A nest thermostat can provide any of the below sensors. A nest protect can only report the 'online' condition.
19+
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` binary sensor will automatically be setup when you do.
2020
</p>
2121

22-
To set it up, add the following information to your `configuration.yaml` file:
22+
To customize which binary sensors are enabled, you can add the following to your `configuration.yaml` file:
2323

2424
```yaml
2525
# Example configuration.yaml entry
2626
binary_sensor:
2727
- platform: nest
2828
monitored_conditions:
2929
- 'fan'
30-
- 'hvac_ac_state'
30+
- 'is_using_emergency_heat'
3131
```
3232
33-
Configuration variables:
33+
If you leave `monitored_conditions` blank, all sensors that are available for your devices will be used.
3434

35-
- **monitored_conditions** array (*Required*): States to monitor.
36-
- 'fan'
37-
- 'hvac_ac_state'
38-
- 'hvac_aux_heater_state'
39-
- 'hvac_heat_x2_state'
40-
- 'hvac_heat_x3_state'
41-
- 'hvac_alt_heat_state'
42-
- 'hvac_alt_heat_x2_state'
43-
- 'hvac_emer_heat_state'
44-
- 'online'
45-
- **scan_interval** (*Optional*): Interval in seconds to scan.
35+
Configuration variables:
4636

37+
- **monitored_conditions** array (*Optional*): States to monitor.
38+
- online
39+
- fan
40+
- is\_using\_emergency\_heat
41+
- is\_locked
42+
- has\_leaf
43+
- motion\_detected
44+
- person\_detected
45+
- sound\_detected
46+
47+
The following conditions are available by device:
48+
49+
- Nest Thermostat:
50+
- online
51+
- fan
52+
- is\_using\_emergency\_heat
53+
- is\_locked
54+
- has\_leaf
55+
- Nest Protect:
56+
- online
57+
- Nest Camera:
58+
- online
59+
- motion\_detected
60+
- person\_detected
61+
- sound\_detected

source/_components/binary_sensor.threshold.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To enable the threshold sensor, add the following lines to your `configuration.y
2626

2727
```yaml
2828
# Example configuration.yaml entry
29-
sensor:
29+
binary_sensor:
3030
- platform: threshold
3131
threshold: 15
3232
type: lower
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: page
3-
title: "Amcrest Camera"
4-
description: "Instructions how to integrate Amcrest camera into Home Assistant."
5-
date: 2016-12-03 08:10
3+
title: "Amcrest IP Camera"
4+
description: "Instructions how to integrate Amcrest IP cameras within Home Assistant."
5+
date: 2016-11-24 10:00
66
sidebar: true
77
comments: false
88
sharing: true
@@ -12,9 +12,9 @@ ha_category: Camera
1212
ha_release: 0.34
1313
---
1414

15-
The `amcrest` platform allows you to watch the live stream of your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
15+
The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
1616

17-
To enable your Amcrest camera in your installation, add the following to your `configuration.yaml` file:
17+
To enable your camera in your installation, add the following to your `configuration.yaml` file:
1818

1919
```yaml
2020
# Example configuration.yaml entry
@@ -27,8 +27,9 @@ camera:
2727
2828
Configuration variables:
2929
30-
- **host** (*Required*): The IP address your camera.
31-
- **port** (*Optional*): The port that the camera is running on. The default is 80.
30+
- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
3231
- **username** (*Required*): The username for accessing your camera.
3332
- **password** (*Required*): The password for accessing your camera.
34-
- **name** (*Optional*): This parameter allows you to override the name of your camera.
33+
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
34+
- **port** (*Optional*): The port that the camera is running on. The default is 80.
35+

source/_components/camera.ffmpeg.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Configuration variables:
3232

3333
### {% linkable_title Image quality %}
3434

35-
You can control the `image quality` with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.
35+
You can control the image quality with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.
3636

3737

3838
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/components/ffmpeg/#troubleshooting).

source/_components/camera.nest.markdown

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,5 @@ ha_release: 0.34
1515
The `nest` platform allows you to watch the live stream of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
1616

1717
<p class='note'>
18-
You must have the [Nest component](/components/nest/) configured to use those thermostats.
18+
You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
1919
</p>
20-
21-
To set it up, add the following information to your `configuration.yaml` file:
22-
23-
```yaml
24-
# Example configuration.yaml entry
25-
camera:
26-
- platform: nest
27-
```

source/_components/climate.nest.markdown

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,9 @@ ha_category: Climate
1515
The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
1616

1717
<p class='note'>
18-
You must have the [Nest component](/components/nest/) configured to use those thermostats.
18+
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` climate component will automatically be setup when you do.
1919
</p>
2020

21-
To set it up, add the following information to your `configuration.yaml` file:
22-
23-
```yaml
24-
# Example configuration.yaml entry
25-
climate:
26-
- platform: nest
27-
```
28-
2921
<p class='img'>
3022
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
3123
</p>

source/_components/device_tracker.gpslogger.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ device_tracker:
2525
2626
- [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger)
2727
28-
To configure GPSLogger, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC`. Make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). Configure that options under "General Options":
28+
To configure GPSLogger, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC`. Make sure to include the API password if you have configured a password in Home Assistant (add `&api_password=<password>` to the end of the URL). Configure that options under "General Options":
2929

3030
- Start on boot: yes
3131
- Start on app launch: yes
@@ -34,7 +34,7 @@ Set the URL under "General Options -> Logging details":
3434

3535
- Log to GPX: no
3636
- Log to KML: no
37-
- Log to custom URL: yes and set `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC` (be sure you include API password (`api_password=<password>`) if needed, or you can also use HTTP Basic authentication `http://<username>:<password>@<ha_server>/api/gpslogger...`)
37+
- Log to custom URL: yes and set `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC` (be sure you include API password (`&api_password=<password>`) if needed, or you can also use HTTP Basic authentication `http://<username>:<password>@<ha_server>/api/gpslogger...`)
3838
- Log to OpenGTS Server: no
3939
- Log to Plain Text: no
4040
- Log to NMEA: no

source/_components/emulated_hue.markdown

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,24 @@ entities. The driving use case behind this functionality is to allow Home Assist
2121

2222
### {% linkable_title Configuration %}
2323

24-
To enable the emulated Hue bridge, add the following to your `configuration.yaml` file:
24+
To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file:
2525

2626
```yaml
27-
# Example configuration.yaml entry
27+
# Amazon Echo example configuration.yaml entry
28+
emulated_hue:
29+
```
30+
31+
```yaml
32+
# Google Home example configuration.yaml entry
2833
emulated_hue:
34+
type: google_home
35+
# Google Home does not work on different ports.
36+
listen_port: 80
2937
```
3038
3139
Configuration variables:
3240
41+
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`.
3342
- **host_ip** (*Optional*): The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own.
3443
- **listen_port** (*Optional*): The port the Hue bridge API web server will run on. If not specified, this defaults to 8300. This can be any free port on your system.
3544
- **off_maps_to_on_domains** (*Optional*): The domains that maps an "off" command to an "on" command.
@@ -86,9 +95,10 @@ The following are attributes that can be applied in the `customize` section:
8695

8796
### {% linkable_title Troubleshooting %}
8897

89-
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
90-
http://`<HA IP Address>`:8300/description.xml - This URL should return a descriptor file in the form of an XML file.
91-
http://`<HA IP Address>`:8300/api/pi/lights - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa.
98+
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
99+
100+
- `http://<HA IP Address>:8300/description.xml` - This URL should return a descriptor file in the form of an XML file.
101+
- `http://<HA IP Address>:8300/api/pi/lights` - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa.
92102

93103

94104
### {% linkable_title License %}

source/_components/media_player.denon.markdown

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,28 @@ Supported devices:
2222
- Denon RCD-N8 (untested)
2323
- Denon RCD-N9 (partial support)
2424
- Denon AVR receivers with Integrated Network support (partial support)
25+
- Denon AVR-X4100W (via denonavr platform)
26+
- Denon AVR receivers (via denonavr platform (untested))
27+
2528

2629
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:
2730

31+
Telnet interface
2832
```yaml
2933
# Example configuration.yaml entry
3034
media_player:
3135
- platform: denon
3236
host: IP_ADDRESS
3337
```
38+
39+
denonavr interface
40+
```yaml
41+
# Example configuration.yaml entry
42+
media_player:
43+
- platform: denonavr
44+
host: IP_ADDRESS
45+
```
46+
3447
Configuration variables:
3548
3649
- **host** (*Required*): IP address of the device. Example: 192.168.1.32
@@ -43,3 +56,5 @@ A few notes:
4356
- To be able to wake up the receiver, activate the "remote" setting in the receiver's settings.
4457
- Play and pause are supported, toggling is not possible.
4558
- Seeking cannot be implemented as the UI sends absolute positions. Only seeking via simulated button presses is possible.
59+
- Additional option the control Denon AVR receivers with a builtin web server is using the HTTP interface with denonavr platform
60+
- denonavr platform supports some additional functionalities like album covers and is supporting more than simultaneous one connection

source/_components/nest.markdown

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,38 @@ featured: true
1414

1515
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a client_id and client_secret.
1616

17+
### {% linkable_title Setting up developer account %}
18+
19+
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
20+
2. Fill in account details:
21+
- The "Company Information" can be anything. We recommend using your name.
22+
3. Submit changes
23+
4. Click "[Products](https://developers.nest.com/products)" at top of page.
24+
5. Click "[Create New Product](https://developers.nest.com/products/new)"
25+
6. Fill in details:
26+
- Product name must be unique. We recommend [email] - Home Assistant.
27+
- The description, users, urls can all be anything you want.
28+
7. For permissions check every box and if it's an option select the read/write option.
29+
- The description requires a specific format to be accepted.
30+
- Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
31+
8. Click "Create Product"
32+
9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below.
33+
10. Once Home Assistant is started, a configurator will pop up asking you to log into your Nest account and copy a PIN code into Home Assistant.
34+
35+
### {% linkable_title Configuration %}
36+
1737
```yaml
1838
# Example configuration.yaml entry
1939
nest:
20-
client_id: ABCD
21-
client_secret: ABCD
40+
client_id: CLIENT_ID
41+
client_secret: CLIENT_SECRET
2242
```
2343
2444
```yaml
2545
# Example configuration.yaml entry to show only devices at your vacation and primary homes
2646
nest:
27-
username: USERNAME
28-
password: PASSWORD
47+
client_id: CLIENT_ID
48+
client_secret: CLIENT_SECRET
2949
structure:
3050
- Vacation
3151
- Primary

source/_components/sensor.broadlink.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: page
33
title: "Broadlink RM2 and A1 sensor"
44
description: "Instructions how to integrate Broadlink RM2 and/or A1 E-air sensors within Home Assistant."
5-
date: 2016-11-08 21:59
5+
date: 2016-12-03 21:59
66
sidebar: true
77
comments: false
88
sharing: true
@@ -13,7 +13,7 @@ ha_release: 0.34
1313
---
1414

1515

16-
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
16+
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
1717
There is currently no support for the cloud API.
1818

1919
To set it up, add the following information to your `configuration.yaml` file:

source/_components/sensor.dsmr.markdown

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
logo: netbeheernederland.jpg
1111
ha_category: Energy
12-
ha_version: 0.34
12+
ha_release: 0.34
1313
ha_iot_class: "Local Push"
1414
---
1515

@@ -31,6 +31,7 @@ This component is known to work for:
3131
- Landis+Gyr E350 (DMSR 4)
3232
- Landis+Gyr ZCF110 / ZM F110 (DSMR 4.2)
3333
- Kaifa E0026
34+
- Kamstrup 382JxC (DSMR 2.2)
3435

3536
And USB serial converters:
3637

@@ -67,3 +68,15 @@ group:
6768
- sensor.power_production_normal
6869
- sensor.gas_consumption
6970
```
71+
72+
[HASSbian](/getting-started/installation-raspberry-pi-image/) users have to give dialout permission to the user `homeassistant`:
73+
74+
```
75+
$ sudo usermod -a -G dialout homeassistant
76+
```
77+
78+
and after that you need to reboot!
79+
80+
```
81+
$ sudo reboot
82+
```

0 commit comments

Comments
 (0)