jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge branch 'current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2016-12-06 23:01:00 -08:00
commit c7abf99d9f
23 changed files with 216 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

45
source/_components/binary_sensor.nest.markdown
View file

@ -13,13 +13,13 @@ ha_release: pre 0.7
---
The `nest` binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com).
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
<p class='note'>
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.
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` binary sensor will automatically be setup when you do.
</p>
To set it up, add the following information to your `configuration.yaml` file:
To customize which binary sensors are enabled, you can add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -27,20 +27,35 @@ binary_sensor:
- platform: nest
monitored_conditions:
- 'fan'
- 'hvac_ac_state'
- 'is_using_emergency_heat'
```
If you leave `monitored_conditions` blank, all sensors that are available for your devices will be used.
Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor.
- 'fan'
- 'hvac_ac_state'
- 'hvac_aux_heater_state'
- 'hvac_heat_x2_state'
- 'hvac_heat_x3_state'
- 'hvac_alt_heat_state'
- 'hvac_alt_heat_x2_state'
- 'hvac_emer_heat_state'
- 'online'
- **scan_interval** (*Optional*): Interval in seconds to scan.
- **monitored_conditions** array (*Optional*): States to monitor.
- online
- fan
- is\_using\_emergency\_heat
- is\_locked
- has\_leaf
- motion\_detected
- person\_detected
- sound\_detected
The following conditions are available by device:
- Nest Thermostat:
- online
- fan
- is\_using\_emergency\_heat
- is\_locked
- has\_leaf
- Nest Protect:
- online
- Nest Camera:
- online
- motion\_detected
- person\_detected
- sound\_detected

2
source/_components/binary_sensor.threshold.markdown
View file

@ -26,7 +26,7 @@ To enable the threshold sensor, add the following lines to your `configuration.y
```yaml
# Example configuration.yaml entry
sensor:
binary_sensor:
- platform: threshold
threshold: 15
type: lower

17
source/_components/camera.amcrest.markdown
View file

@ -1,8 +1,8 @@
---
layout: page
title: "Amcrest Camera"
description: "Instructions how to integrate Amcrest camera into Home Assistant."
date: 2016-12-03 08:10
title: "Amcrest IP Camera"
description: "Instructions how to integrate Amcrest IP cameras within Home Assistant."
date: 2016-11-24 10:00
sidebar: true
comments: false
sharing: true
@ -12,9 +12,9 @@ ha_category: Camera
ha_release: 0.34
---
The `amcrest` platform allows you to watch the live stream of your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
To enable your Amcrest camera in your installation, add the following to your `configuration.yaml` file:
To enable your camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -27,8 +27,9 @@ camera:
Configuration variables:
- **host** (*Required*): The IP address your camera.
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
- **username** (*Required*): The username for accessing your camera.
- **password** (*Required*): The password for accessing your camera.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **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.

2
source/_components/camera.ffmpeg.markdown
View file

@ -32,7 +32,7 @@ Configuration variables:
### {% linkable_title Image quality %}
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`.
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`.
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/components/ffmpeg/#troubleshooting).

10
source/_components/camera.nest.markdown
View file

@ -15,13 +15,5 @@ ha_release: 0.34
The `nest` platform allows you to watch the live stream of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use those thermostats.
You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
</p>
To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: nest
```

10
source/_components/climate.nest.markdown
View file

@ -15,17 +15,9 @@ ha_category: Climate
The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use those thermostats.
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` climate component will automatically be setup when you do.
</p>
To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
climate:
- platform: nest
```
<p class='img'>
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
</p>

4
source/_components/device_tracker.gpslogger.markdown
View file

@ -25,7 +25,7 @@ device_tracker:
- [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger)
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":
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":
- Start on boot: yes
- Start on app launch: yes
@ -34,7 +34,7 @@ Set the URL under "General Options -> Logging details":
- Log to GPX: no
- Log to KML: no
- 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...`)
- 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...`)
- Log to OpenGTS Server: no
- Log to Plain Text: no
- Log to NMEA: no

20
source/_components/emulated_hue.markdown
View file

@ -21,15 +21,24 @@ entities. The driving use case behind this functionality is to allow Home Assist
### {% linkable_title Configuration %}
To enable the emulated Hue bridge, add the following to your `configuration.yaml` file:
To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
# Amazon Echo example configuration.yaml entry
emulated_hue:
```
```yaml
# Google Home example configuration.yaml entry
emulated_hue:
type: google_home
# Google Home does not work on different ports.
listen_port: 80
```
Configuration variables:
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`.
- **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.
- **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.
- **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:
### {% linkable_title Troubleshooting %}
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
http://`<HA IP Address>`:8300/description.xml - This URL should return a descriptor file in the form of an XML file.
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.
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
- `http://<HA IP Address>:8300/description.xml` - This URL should return a descriptor file in the form of an XML file.
- `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.
### {% linkable_title License %}

15
source/_components/media_player.denon.markdown
View file

@ -22,15 +22,28 @@ Supported devices:
- Denon RCD-N8 (untested)
- Denon RCD-N9 (partial support)
- Denon AVR receivers with Integrated Network support (partial support)
- Denon AVR-X4100W (via denonavr platform)
- Denon AVR receivers (via denonavr platform (untested))
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:
Telnet interface
```yaml
# Example configuration.yaml entry
media_player:
- platform: denon
host: IP_ADDRESS
```
denonavr interface
```yaml
# Example configuration.yaml entry
media_player:
- platform: denonavr
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): IP address of the device. Example: 192.168.1.32
@ -43,3 +56,5 @@ A few notes:
- To be able to wake up the receiver, activate the "remote" setting in the receiver's settings.
- Play and pause are supported, toggling is not possible.
- Seeking cannot be implemented as the UI sends absolute positions. Only seeking via simulated button presses is possible.
- Additional option the control Denon AVR receivers with a builtin web server is using the HTTP interface with denonavr platform
- denonavr platform supports some additional functionalities like album covers and is supporting more than simultaneous one connection

28
source/_components/nest.markdown
View file

@ -14,18 +14,38 @@ featured: true
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.
### {% linkable_title Setting up developer account %}
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
2. Fill in account details:
- The "Company Information" can be anything. We recommend using your name.
3. Submit changes
4. Click "[Products](https://developers.nest.com/products)" at top of page.
5. Click "[Create New Product](https://developers.nest.com/products/new)"
6. Fill in details:
- Product name must be unique. We recommend [email] - Home Assistant.
- The description, users, urls can all be anything you want.
7. For permissions check every box and if it's an option select the read/write option.
- The description requires a specific format to be accepted.
- Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
8. Click "Create Product"
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.
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.
### {% linkable_title Configuration %}
```yaml
# Example configuration.yaml entry
nest:
client_id: ABCD
client_secret: ABCD
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
```
```yaml
# Example configuration.yaml entry to show only devices at your vacation and primary homes
nest:
username: USERNAME
password: PASSWORD
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
structure:
- Vacation
- Primary

4
source/_components/sensor.broadlink.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "Broadlink RM2 and A1 sensor"
description: "Instructions how to integrate Broadlink RM2 and/or A1 E-air sensors within Home Assistant."
date: 2016-11-08 21:59
date: 2016-12-03 21:59
sidebar: true
comments: false
sharing: true
@ -13,7 +13,7 @@ ha_release: 0.34
---
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
There is currently no support for the cloud API.
To set it up, add the following information to your `configuration.yaml` file:

15
source/_components/sensor.dsmr.markdown
View file

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: netbeheernederland.jpg
ha_category: Energy
ha_version: 0.34
ha_release: 0.34
ha_iot_class: "Local Push"
---
@ -31,6 +31,7 @@ This component is known to work for:
- Landis+Gyr E350 (DMSR 4)
- Landis+Gyr ZCF110 / ZM F110 (DSMR 4.2)
- Kaifa E0026
- Kamstrup 382JxC (DSMR 2.2)
And USB serial converters:
@ -67,3 +68,15 @@ group:
- sensor.power_production_normal
- sensor.gas_consumption
```
[HASSbian](/getting-started/installation-raspberry-pi-image/) users have to give dialout permission to the user `homeassistant`:
```
$ sudo usermod -a -G dialout homeassistant
```
and after that you need to reboot!
```
$ sudo reboot
```

40
source/_components/sensor.nest.markdown
View file

@ -13,13 +13,13 @@ ha_release: pre 0.7
---
The `nest` sensor platform let you monitor sensors connected to your [Nest](https://nest.com) thermostat and/or your Nest Protect Smoke Alarm.
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use those sensors.
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` binary sensor will automatically be setup when you do.
</p>
To set it up, add the following information to your `configuration.yaml` file:
To customize which sensors are enabled, you can add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -30,29 +30,21 @@ sensor:
- 'target'
```
If you leave `monitored_conditions` blank, all sensors that are available for your devices will be included.
Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor.
- **monitored_conditions** array (*Optional*): States to monitor.
The following conditions can be monitored with a Nest Thermostat or Protect.
- 'battery_level'
The following conditions are available by device:
The following conditions can be monitored with a Nest Thermostat only.
- 'temperature'
- 'target'
- 'humidity'
- 'operation_mode'
- 'last_ip'
- 'local_ip'
- 'last_connection'
- 'weather_condition'
- 'weather_temperature'
- 'weather_humidity'
- 'wind_speed'
- 'wind_direction'
The following conditions can be monitored with a Nest Protect only.
- 'co_status'
- 'smoke_status'
- Nest Thermostat:
- humidity
- operation\_mode
- temperature
- target
- Nest Protect:
- co\_status
- smoke\_status
- Nest Camera: none

2
source/_components/sensor.synologydsm.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: synologydsm.png
logo: synology.png
ha_category: Sensor
ha_release: 0.32
ha_iot_class: depends

8
source/_components/switch.template.markdown
View file

@ -27,7 +27,7 @@ switch:
- platform: template
switches:
skylight:
value_template: {% raw %}'{{ is_state('sensor.skylight', 'on') }}'{% endraw %}
value_template: {% raw %}"{{ is_state('sensor.skylight', 'on') }}"{% endraw %}
turn_on:
service: switch.turn_on
entity_id: switch.skylight_open
@ -64,7 +64,7 @@ switch:
- platform: template
switches:
copy:
value_template: {% raw %}'{{ is_state('switch.source', 'on') }}'{% endraw %}
value_template: {% raw %}"{{ is_state('switch.source', 'on') }}"{% endraw %}
turn_on:
service: switch.turn_on
entity_id: switch.source
@ -83,7 +83,7 @@ switch:
switches:
blind:
friendly_name: 'Blind'
value_template: {% raw %}'{{ is_state_attr("switch.blind_toggle", "sensor_state", "on") }}'{% endraw %}
value_template: {% raw %}"{{ is_state_attr('switch.blind_toggle', 'sensor_state', 'on') }}"{% endraw %}
turn_on:
service: switch.toggle
entity_id: switch.blind_toggle
@ -102,7 +102,7 @@ switch:
switches:
skylight:
friendly_name: 'Skylight'
value_template: {% raw %}'{{ is_state('sensor.skylight.state', 'on') }}'{% endraw %}
value_template: {% raw %}"{{ is_state('sensor.skylight.state', 'on') }}"{% endraw %}
turn_on:
service: switch.turn_on
entity_id: switch.skylight_open