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:
Fabian Affolter 2018-01-21 10:32:57 +01:00
commit 645ed26dc9
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
26 changed files with 308 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_components/calendar.google.markdown
View file

@ -22,7 +22,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co
1. Follow the wizard using the following information.
1. When it gets to the point of asking _Which API are you using?_ just click cancel.
1. Click on the tab 'OAuth consent screen'.
1. Under APIs & Services > Credentials, click on the tab 'OAuth consent screen'.
1. Set 'Product name shown to users' to anything you want. We suggest Home-Assistant.
1. Save this page. You don't have to fill out anything else there.
1. Click 'Create credentials' -> OAuth client ID.

4
source/_components/climate.honeywell.markdown
View file

@ -36,5 +36,5 @@ Configuration variables:
- **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.
- **away_cool_temperature** (*Optional*) (*only for us region*): Cooling setpoint when away mode is on. If omitted it defaults to 30.0 deg C.
- **away_heat_temperature** (*Optional*) (*only for us region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.

16
source/_components/deconz.markdown
View file

@ -31,14 +31,14 @@ deconz:
#### {% linkable_title Supported Device types %}
- [Zigbee Lights](/components/light/deconz/)
- [Humidity Sensors](/components/sensor/deconz/)
- [Light Level Sensors](/components/sensor/deconz/)
- [OpenClose Detectors](/components/binary_sensor/deconz/)
- [Presence Detectors](/components/binary_sensor/deconz/)
- [Pressure Sensors](/components/sensor/deconz/)
- [Switches (Remote Controls)](/components/sensor/deconz/)
- [Temperature Sensors](/components/sensor/deconz/)
- [Zigbee Lights](/components/light.deconz/)
- [Humidity Sensors](/components/sensor.deconz/)
- [Light Level Sensors](/components/sensor.deconz/)
- [OpenClose Detectors](/components/binary_sensor.deconz/)
- [Presence Detectors](/components/binary_sensor.deconz/)
- [Pressure Sensors](/components/sensor.deconz/)
- [Switches (Remote Controls)](/components/sensor.deconz/)
- [Temperature Sensors](/components/sensor.deconz/)
{% configuration %}
host:

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

@ -67,7 +67,7 @@ Add the above URL after you modified it with your settings into the **URL** fiel
- It's HIGHLY recommended to use SSL/TLS.
- Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.
- Only remove `[Port]` if your Home Assistant instance is using port 80. Otherwise set it to 8123.
- Click on **Parameters** in the app and you will see all available parameters for the URL. For Home Assistant only the above URL will work.
- For Home Assistant only the above URL, as written, will work - do not add or remove any parameters.
- Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=[Your pasword]` to the end of the URL.
- You can change the name of your device name by replacing `&device=%SER` with `&device=[Devicename]`.

6
source/_components/device_tracker.owntracks.markdown
View file

@ -14,7 +14,11 @@ ha_release: 0.7.4
---
This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows users to track their location on Android and iOS phones and publish it to an MQTT broker. This platform will connect to the broker and monitor for new locations.
This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows users to track their location on iOS phones and publish it to an MQTT broker. This platform will connect to the broker and monitor for new locations.
<p class='note'>
The Android app for OwnTracks is no longer developed or supported, Zanzito is a drop in replacement for OwnTracks MQTT.
</p>
This component requires [the MQTT component](/components/mqtt/) to be set up and works very well together with [the zone component](/components/zone/).

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

@ -15,6 +15,10 @@ ha_release: 0.55
OwnTracks is a free and open source application that allows you to track your location in Home Assistant. This is a platform that supports OwnTracks via their HTTP publishing method.
<p class='note'>
The Android app for OwnTracks is no longer developed or supported. Consider [GPS Logger](/components/device_tracker.gpslogger/) as an alternative.
</p>
To integrate Owntracks tracking via HTTP in Home Assistant, add the following section to your `configuration.yaml` file:
```yaml

68
source/_components/device_tracker.unifi.markdown
View file

@ -12,7 +12,6 @@ ha_category: Presence Detection
ha_release: 0.14
---
This platform allows you to detect presence by looking at devices connected to a [Ubiquiti](http://ubnt.com/) [Unifi](https://www.ubnt.com/enterprise/#unifi) controller.
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
@ -21,24 +20,63 @@ To use this device tracker in your installation, add the following to your `conf
# Example configuration.yaml entry
device_tracker:
- platform: unifi
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
username: USERNAME
password: PASSWORD
```
Configuration variables:
- **host** (*Optional*): The hostname or IP address of your controller. Defaults to `localhost`.
- **port** (*Optional*): The port of your controller's web interface. Defaults to `8443`.
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.
- **site_id** (*Optional*): Allows you to specify a `site_id` for device tracking. Defaults to `default`. Found in the URL of the controller (i.e. https://CONTROLLER:PORT/manage/site/SITE_ID/dashboard).
- **verify_ssl** (*Optional*): Controls if the SSL certificate running on your Unifi webserver must be trusted by a known Certificate Authority on the server running Home Assistant. Defaults to 'True' but can also be a value that points to your custom cert "path/to/custom_cert.pem".
- **detection_time** (*Optional*): The Unifi component will only return devices that have been seen by the controller in the last 180 seconds. You can adjust this threshold with this variable and accepts seconds or `00:00:00` time formats.
{% configuration %}
username:
description: A user on the controller
type: string
required: true
password:
description: The password for the account
type: string
required: true
host:
description: The hostname or IP address of your controller
default: localhost
type: string
required: false
port:
description: The port of your controller's web interface
default: 8443
type: int
required: false
site_id:
description: For multisite installations, you can specify `site_id` to specify which is used
type: string
required: false
default: default
verify_ssl:
description: Whether to do strict validation on SSL certificates of the Unifi controller. This can be true/false or the path to a locally trusted certificate to use for verification (i.e. "/path/to/custom_cert.pm")
type: boolean or filename
required: false
default: true
detection_time:
description: How long since the last seen time before the device is marked away, specified in seconds.
type: int
required: optional
default: 300
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
<p class='note'>
If you decide to install the Unifi Controller on the same system as your Home Assistant, be aware there may be overlap in ports if you have the MQTT component as well.
### {% linkable_title Configuring Users %}
The Unifi controller allows you to create multiple users on it besides
the main administrator. It is recommended that you create a limited
user that has `read-only` permissions for the Unifi device tracker.
### {% linkable_title Conflicts with MQTT %}
The Unifi controller can either be a dedicated hardware device
(Unifi's cloud key), or as software any Linux system. If you run the
the Unifi controller on the same operating system as Home Assistant
there may be conflicts in ports if you have the MQTT component as
well.
It is recommended that you run the Unifi controller in a dedicate
virtual machine to avoid that situation.
[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
</p>

4
source/_components/discovery.markdown
View file

@ -36,6 +36,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [Samsung TVs](https://home-assistant.io/components/media_player.samsungtv/)
* [Sonos speakers](https://home-assistant.io/components/media_player.sonos/)
* [Telldus Live](https://home-assistant.io/components/tellduslive/)
* [Wink](https://home-assistant.io/components/wink/)
* [Yamaha media player](https://home-assistant.io/components/media_player.yamaha/)
* [Yeelight Sunflower bulb](https://home-assistant.io/components/light.yeelightsunflower/)
@ -79,9 +80,10 @@ Valid values for ignore are:
* `samsung_tv`: Samsung TVs
* `sonos`: Sonos speakers
* `tellduslive`: Telldus Live
* `wink`: Wink Hub
* `yamaha`: Yamaha media player
* `yeelight`: Yeelight Sunflower bulb
<p class='note'>
Home Assistant must be on the same network as the devices for uPnP discovery to work.
If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network.

8
source/_components/group.markdown
View file

@ -22,7 +22,7 @@ By default, every group appears in the HOME tab. If you create a group `default_
group:
default_view:
view: yes
icon: mdi:home
icon: mdi:home
entities:
- group.kitchen
- group.awesome_people
@ -56,7 +56,7 @@ group:
Configuration variables:
- **view** (*Optional*): If yes then the entry will be shown as a view (tab) at the top.
- **view** (*Optional*): If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: yes` cannot be used as entities in other views.
- **name** (*Optional*): Name of the group.
- **icon** (*Optional*): If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text. If it's not a view, then the icon shows when this group is used in another group.
- **control** (*Optional*): Set value to `hidden`. If hidden then the group switch will be hidden.
@ -69,7 +69,7 @@ Example of groups shown as views in the frontend.
If all entities in a group are switches or lights then Home Assistant adds a switch at the top of the card that turns them all on/off at once. If you want to hide this switch, set `control` to `hidden`.
You can create views (tabs) that contain other groups.
You can create views (tabs) that contain other groups (but not other groups which are marked as `view: yes`).
Notice in the example below that in order to refer to the group "Living Room", you use `group.living_room` (lowercase and spaces replaced with underscores).
```yaml
@ -86,7 +86,7 @@ Notice in the example below that in order to refer to the group "Living Room", y
entities:
- group.living_room
- group.bedroom
```
```
## {% linkable_title Default groups %}

3
source/_components/image_processing.seven_segments.markdown
View file

@ -93,6 +93,7 @@ image_processing:
With the help of a [template sensor](/components/sensor.template/), the value can be shown as badge.
{% raw %}
```yaml
sensor:
- platform: template
@ -102,4 +103,4 @@ sensor:
friendly_name: 'Ampere'
unit_of_measurement: 'A'
```
{% endraw %}

9
source/_components/neato.markdown
View file

@ -28,15 +28,6 @@ Configuration variables:
- **username** (*Required*): Username for the Neato account.
- **password** (*Required*): Password for the Neato account.
The Home Assistant Neato platform has not been tested with all models of Botvac.
| BotVac Model | Tested |
| --- | --- |
| Botvac Connected | SUCCESS |
| Botvac D3 Connected (firmware 4.0+) | PARTIALLY WORKING |
| Botvac D5 Connected (firmware 4.0+) | PARTIALLY WORKING |
| Botvac D7 Connected | SUCCESS |
<p class='note'>
After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update here: https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-
</p>

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

@ -26,7 +26,7 @@ To use your BH1750 sensor in your installation, add the following to your `confi
```yaml
# Example configuration.yaml entry
sensor:
- platform: BH1750
- platform: bh1750
```
Configuration variables:

1
source/_components/sensor.gtfs.markdown
View file

@ -24,6 +24,7 @@ Here are some examples:
- [Metropolitan Transit Authority of New York City (MTA)](http://www.bart.gov/schedules/developers/gtfs) - Provides separate data feeds for subway, bus, LIRR and Metro-North of the greater New York City metropolitan region.
- [GBRail.info](http://www.gbrail.info/) - Provides data feeds for most if not all rail companies in Britain.
- [Official Timetable Switzerland](http://www.fahrplanfelder.ch/en/timetable-data.html) - The official timetable data for Switzerland.
- [Public Transport Victoria (Australia)](https://www.data.vic.gov.au/data/dataset/ptv-timetable-and-geographic-information-2015-gtfs) - Official PTV GTFS dataset.
You need to download a GTFS ZIP file and put it into a folder named `gtfs` in your configuration directory. For ease of use, it is suggested that you rename the file to just the agency/data source name (i.e. `bart.zip` instead of `google_transit_20160328_v1.zip`). You can also unzip and place a folder in the `gtfs` folder.

22
source/_components/sensor.lacrosse.markdown
View file

@ -41,7 +41,7 @@ sensor:
{% configuration %}
device:
description: The serial baudrate.
description: The serial device.
required: true
type: string
default: /dev/ttyUSB0
@ -50,6 +50,26 @@ sensor:
required: true
type: int
default: 57600
led:
description: Activate or deactivate the Jeelink LED.
required: false
type: boolean
frequency:
description: Initial frequency in 5kHz steps.
required: false
type: int
datarate:
description: "Set the data rate in kbps. Special values for well-known settings are: `0`: 17.241 kbps, `1`: 9.579 kbps, `2`: 8.842 kbps."
required: false
type: int
toggle_mask:
description: "The following values can be combined bitwise: `1` = 17.241 kbps, `2` = 9.579 kbps, `4` = 8.842 kbps"
required: false
type: int
toggle_interval:
description: Enable the toggle mode and set the interval in seconds.
required: false
type: int
sensors:
description: A list of your sensors.
required: true

2
source/_components/timer.markdown
View file

@ -25,7 +25,7 @@ To add a timer to your installation, add the following to your `configuration.ya
```yaml
# Example configuration.yaml entry
timer:
timer:
laundry:
duration: '00:01:00'
```

19
source/_components/xiaomi_aqara.markdown
View file

@ -222,6 +222,25 @@ This example plays the sound of a dog barking when the button is held down and s
gw_mac: xxxxxxxxxxxx
```
### {% linkable_title Double Click on Smart Button %}
This example toggles the living room lamp on a double click of the button.
```yaml
- alias: Double Click to toggle living room lamp
trigger:
platform: event
event_type: click
event_data:
entity_id: binary_sensor.switch_158d000xxxxxc2
click_type: double
action:
service: light.toggle
data:
entity_id: light.living_room_lamp
```
## {% linkable_title Troubleshooting %}
### {% linkable_title Initial setup problem %}