Merge remote-tracking branch 'origin/next' into rc

This commit is contained in:
Paulus Schoutsen 2018-09-10 14:02:00 +02:00
commit 35c4051be1
364 changed files with 3258 additions and 1627 deletions

View File

@ -5,7 +5,7 @@
## Checklist: ## Checklist:
- [ ] Branch: Fixes, changes and adjustments should be created against `current`. New documentation for platforms/components and features should go to `next`. - [ ] Branch: `next` is for changes and new documentation that will go public with the next [home-assistant](https://github.com/home-assistant/home-assistant) release. Fixes, changes and adjustments for the current release should be created against `current`.
- [ ] The documentation follow the [standards][standards]. - [ ] The documentation follow the [standards][standards].
[standards]: https://home-assistant.io/developers/documentation/standards/ [standards]: https://home-assistant.io/developers/documentation/standards/

View File

@ -148,7 +148,7 @@ date_released: 2018-09-15
# Either # or the anchor link to latest release notes in the blog post. # Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it. # Must be prefixed with a # and have double quotes around it.
# Major release: # Major release:
patch_version_notes: "#" patch_version_notes: "#release-0773---september-3"
# Minor release (Example #release-0431---april-25): # Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments # Date we moved to Discourse for comments

1
credits_generator/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.token

View File

@ -15,14 +15,10 @@ $ npm install
Usage Usage
----- -----
Go to https://github.com/settings/tokens/new and generate a new GitHub personal access token. Go to https://github.com/settings/tokens/new and generate a new GitHub personal access token.
Give the token any name and select the `public_repo` and `read:user` scopes. Give the token any name and select the `public_repo` and `read:user` scopes.
Put the token in this repo in a file named `.token`.
Set the environment variable `GITHUB_TOKEN` to the new token.
```bash
$ export GITHUB_TOKEN=<Your GitHub access token>
```
Run the script. Run the script.

116
credits_generator/package-lock.json generated Normal file
View File

@ -0,0 +1,116 @@
{
"name": "credits_generator",
"version": "1.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
"agent-base": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-2.1.1.tgz",
"integrity": "sha1-1t4Q1a9hMtW9aSQn1G/FOFOQlMc=",
"requires": {
"extend": "3.0.2",
"semver": "5.0.3"
}
},
"async": {
"version": "2.6.1",
"resolved": "https://registry.npmjs.org/async/-/async-2.6.1.tgz",
"integrity": "sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==",
"requires": {
"lodash": "4.17.10"
}
},
"debug": {
"version": "2.6.9",
"resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
"integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
"requires": {
"ms": "2.0.0"
}
},
"extend": {
"version": "3.0.2",
"resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz",
"integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g=="
},
"follow-redirects": {
"version": "0.0.7",
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-0.0.7.tgz",
"integrity": "sha1-NLkLqyqRGqNHVx2pDyK9NuzYqRk=",
"requires": {
"debug": "2.6.9",
"stream-consume": "0.1.1"
}
},
"github": {
"version": "8.2.1",
"resolved": "https://registry.npmjs.org/github/-/github-8.2.1.tgz",
"integrity": "sha1-YWsiEfvNHMhjFmmu1nZT5i61OBY=",
"requires": {
"follow-redirects": "0.0.7",
"https-proxy-agent": "1.0.0",
"mime": "1.6.0",
"netrc": "0.1.4"
}
},
"https-proxy-agent": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz",
"integrity": "sha1-NffabEjOTdv6JkiRrFk+5f+GceY=",
"requires": {
"agent-base": "2.1.1",
"debug": "2.6.9",
"extend": "3.0.2"
}
},
"lodash": {
"version": "4.17.10",
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz",
"integrity": "sha512-UejweD1pDoXu+AD825lWwp4ZGtSwgnpZxb3JDViD7StjQz+Nb/6l093lx4OQ0foGWNRoc19mWy7BzL+UAK2iVg=="
},
"mime": {
"version": "1.6.0",
"resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
"integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg=="
},
"moment": {
"version": "2.22.2",
"resolved": "https://registry.npmjs.org/moment/-/moment-2.22.2.tgz",
"integrity": "sha1-PCV/mDn8DpP/UxSWMiOeuQeD/2Y="
},
"moment-timezone": {
"version": "0.5.21",
"resolved": "https://registry.npmjs.org/moment-timezone/-/moment-timezone-0.5.21.tgz",
"integrity": "sha512-j96bAh4otsgj3lKydm3K7kdtA3iKf2m6MY2iSYCzCm5a1zmHo1g+aK3068dDEeocLZQIS9kU8bsdQHLqEvgW0A==",
"requires": {
"moment": "2.22.2"
}
},
"ms": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
"integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
},
"mu2": {
"version": "0.5.21",
"resolved": "https://registry.npmjs.org/mu2/-/mu2-0.5.21.tgz",
"integrity": "sha1-iIqPD9kOsc/anbgUdvbhmcyeWNM="
},
"netrc": {
"version": "0.1.4",
"resolved": "https://registry.npmjs.org/netrc/-/netrc-0.1.4.tgz",
"integrity": "sha1-a+lPysqNd63gqWcNxGCRTJRHJEQ="
},
"semver": {
"version": "5.0.3",
"resolved": "https://registry.npmjs.org/semver/-/semver-5.0.3.tgz",
"integrity": "sha1-d0Zt5YnNXTyV8TiqeLxWmjy10no="
},
"stream-consume": {
"version": "0.1.1",
"resolved": "https://registry.npmjs.org/stream-consume/-/stream-consume-0.1.1.tgz",
"integrity": "sha512-tNa3hzgkjEP7XbCkbRXe1jpg+ievoa0O4SCFlMOYEscGSS4JJsckGL8swUyAa/ApGU3Ae4t6Honor4HhL+tRyg=="
}
}
}

View File

@ -4,8 +4,12 @@ var fs = require('fs')
, mu = require('mu2') , mu = require('mu2')
, moment = require('moment-timezone'); , moment = require('moment-timezone');
if(!process.env.GITHUB_TOKEN) { let token;
console.error('You must set the GITHUB_TOKEN environment variable to a GitHub personal access token.');
try {
token = fs.readFileSync('.token', 'utf-8').trim();
} catch (err) {
console.error('You must create a .token file that contains a GitHub token.');
return; return;
} }
@ -17,7 +21,7 @@ var github = new GitHubApi({
headers: { 'user-agent': 'Home Assistant Contributors List Updater <hello@home-assistant.io>' } headers: { 'user-agent': 'Home Assistant Contributors List Updater <hello@home-assistant.io>' }
}); });
github.authenticate({ type: 'oauth', token: process.env.GITHUB_TOKEN }); github.authenticate({ type: 'oauth', token: token });
var usersMap = {}; var usersMap = {};

View File

@ -18,6 +18,7 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
"git_branch": "master", "git_branch": "master",
"git_command": "pull", "git_command": "pull",
"git_remote": "origin", "git_remote": "origin",
"git_prune": "false",
"repeat": { "repeat": {
"active": false, "active": false,
"interval": 300 "interval": 300
@ -38,8 +39,9 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
``` ```
- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration) - **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration)
- **git_branch** (*Required*): Branch name of the Git repo, leave this as 'master' if you are unsure. - **git_branch** (*Required*): Branch name of the Git repo. If left empty, the currently checked out branch will be updated. Leave this as 'master' if you are unsure.
- **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure. - **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure.
- **git_prune** (*Required*): If set to true, the add-on will cleanup branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as `false` if you are unsure.
- **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure. - **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure.
* **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files. * **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files.

View File

@ -89,10 +89,11 @@ See the following links for more information:
Add the following configuration to enable ACLs: Add the following configuration to enable ACLs:
1. Set `customize` flag to `true` in your configuration. 1. Set the `active` flag within the `customize` section to `true` in your configuration.
2. Create a file in `/share/mosquitto` named `acl.conf` with the following contents: 2. Create a file in `/share/mosquitto` named `acl.conf` with the following contents:
```text ```text
acl_file /share/mosquitto/accesscontrollist acl_file /share/mosquitto/accesscontrollist
``` ```
3. Create a file in `/share/mosquitto` named `accesscontrollist` and add contents according to your requirements. 3. Create a file in `/share/mosquitto` named `accesscontrollist` and add contents according to your requirements.
The `/share` folder can be found on the host filesystem under `/usr/share/hassio/share`, or via the `Share` folder through SMB (Samba).

View File

@ -0,0 +1,60 @@
---
layout: page
title: "Yale Smart Alarm Control"
description: "Instructions on how to integrate Yale Smart Alarms into Home Assistant."
date: 2018-09-01 11:11
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Alarm
ha_release: 0.78
---
The `yale_smart_alarm` platform provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` (duplicate of home) and `alarm_disarm`.
Currently only one alarm is supported.
To enable, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: yale_smart_alarm
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration variables:
- **name** (*Optional*): Name of device in Home Assistant.
- **username** (*Required*): Username used to sign into the Yale app/web client.
- **password** (*Required*): Password used to sign into the Yale app/web client.
- **area_id** (*Optional*): Area ID of the device when talking to Yale's API if required ('1' by default).
Automation example:
```yaml
automation:
- alias: "Alarm: Disarmed Daytime"
trigger:
platform: state
entity_id: alarm_control_panel.yale_smart_alarm
to: 'disarmed'
condition:
condition: sun
before: sunset
action:
service: scene.turn_on
entity_id: scene.OnDisarmedDaytime
- alias: "Alarm: Armed Away"
trigger:
platform: state
entity_id: alarm_control_panel.yale_smart_alarm
to: 'armed_away'
action:
service: scene.turn_on
entity_id: scene.OnArmedAway
```

View File

@ -8,12 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: apcupsd.png logo: apcupsd.png
ha_category: Hub ha_category: System Monitor
ha_release: 0.13 ha_release: 0.13
--- ---
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device. [APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`: To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml ```yaml
@ -21,8 +23,16 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
apcupsd: apcupsd:
``` ```
Configuration variables: {% configuration %}
host:
- **host** (*Optional*): The hostname/IP address on which the APCUPSd NIS is being served. Defaults to `localhost`. description: The hostname/IP address on which the APCUPSd NIS is being served.
- **port** (*Optional*): The port on which the APCUPSd NIS is listening. Defaults to `3551`. required: false
type: string
default: localhost
port:
description: The port on which the APCUPSd NIS is listening.
required: false
type: int
default: 3551
{% endconfiguration %}

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: apple.png logo: apple.png
ha_category: Hub ha_category: Multimedia
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
ha_release: 0.49 ha_release: 0.49
--- ---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: asterisk.png logo: asterisk.png
ha_category: Other ha_category: Mailbox
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
ha_release: 0.51 ha_release: 0.51
--- ---
@ -19,6 +19,8 @@ To enable the component, a configuration is required in both Home Assistant as w
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server) First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
## {% linkable_title Configuration %}
Once that is complete, add the following entry `configuration.yaml` file: Once that is complete, add the following entry `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: august.png logo: august.png
ha_category: Hub ha_category: Doorbell
ha_release: "0.64" ha_release: "0.64"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: axis.png logo: axis.png
ha_category: Hub ha_category: Camera
ha_release: "0.45" ha_release: "0.45"
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
@ -17,6 +17,8 @@ ha_iot_class: "Local Polling"
Home Assistant will automatically discover their presence on your network. Home Assistant will automatically discover their presence on your network.
## {% linkable_title Configuration %}
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file: You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
```yaml ```yaml
@ -28,8 +30,6 @@ axis:
- camera - camera
``` ```
Configuration variables:
## {% linkable_title Configuration variables %} ## {% linkable_title Configuration variables %}
- **device** (*Required*): Unique name - **device** (*Required*): Unique name

View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
## {% linkable_title Configuration %}
To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file: To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file:
```yaml ```yaml
@ -23,6 +25,10 @@ binary_sensor:
- platform: apcupsd - platform: apcupsd
``` ```
Configuration variables: {% configuration %}
name:
- **name** (*Optional*): Name to use in the front end. description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: arest.png logo: arest.png
ha_category: Binary Sensor ha_category: DIY
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.9 ha_release: 0.9
--- ---
@ -16,6 +16,8 @@ ha_release: 0.9
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
## {% linkable_title Configuration %}
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file: To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: august.png logo: august.png
ha_category: Binary Sensor ha_category: Doorbell
ha_release: "0.64" ha_release: "0.64"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
@ -20,3 +20,4 @@ If you have August Doorbell, once you have enabled the [August component](/compo
* Doorbell ding sensor * Doorbell ding sensor
* Doorbell motion sensor * Doorbell motion sensor
* Doorbell online sensor * Doorbell online sensor

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Binary Sensor ha_category: Environment
ha_release: 0.39 ha_release: 0.39
logo: noaa.png logo: noaa.png
--- ---
@ -18,6 +18,8 @@ This service gives a number 0-100 representing the current likelihood of visible
You can check the attributes of the sensor to see your exact forecast. You can check the attributes of the sensor to see your exact forecast.
## {% linkable_title Configuration %}
To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file: To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Binary Sensor ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.53 ha_release: 0.53
--- ---
@ -18,6 +18,8 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence. This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
## {% linkable_title Configuration %}
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: beaglebone-black.png logo: beaglebone-black.png
ha_category: Binary Sensor ha_category: DIY
ha_release: 0.37 ha_release: 0.37
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## {% linkable_title Configuration %}
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: bloomsky.png logo: bloomsky.png
ha_category: Binary Sensor ha_category: Environment
ha_release: 0.14 ha_release: 0.14
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
@ -17,6 +17,8 @@ The `bloomsky` binary sensor platform allows you to get data from your BloomSky
To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first. To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first.
## {% linkable_title Configuration %}
To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file: To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,12 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: bmw.png logo: bmw.png
ha_category: Binary Sensor ha_category: Car
ha_release: 0.66 ha_release: 0.66
--- ---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. The `bmw_connected_drive` binary sensor platform allows you to import data on your BMW into Home Assistant.
The binary sensors will be automatically configured if `bmw_connected_drive` component is configured. The binary sensors will be automatically configured if `bmw_connected_drive` component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: command_line.png logo: command_line.png
ha_category: Binary Sensor ha_category: Utility
ha_release: 0.12 ha_release: 0.12
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `command_line` binary sensor platform issues specific commands to get data. The `command_line` binary sensor platform issues specific commands to get data.
## {% linkable_title Configuration %}
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets. The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
### {% linkable_title Configuration %}
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ecobee.png logo: ecobee.png
ha_category: Binary Sensor ha_category: Environment
ha_release: 0.9 ha_release: 0.9
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: eight_sleep.png logo: eight_sleep.png
ha_category: Binary Sensor ha_category: Health
ha_release: "0.44" ha_release: "0.44"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
@ -16,4 +16,4 @@ ha_iot_class: "Cloud Polling"
The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/eight_sleep/) configuration on how to setup. Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ffmpeg.png logo: ffmpeg.png
ha_category: Binary Sensor ha_category: Image Processing
ha_release: 0.27 ha_release: 0.27
redirect_from: /components/binary_sensor.ffmpeg/ redirect_from: /components/binary_sensor.ffmpeg/
--- ---
@ -20,10 +20,12 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p> </p>
### {% linkable_title Motion %} ## {% linkable_title Motion %}
FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter. FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter.
## {% linkable_title Configuration %}
To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file: To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ffmpeg.png logo: ffmpeg.png
ha_category: Binary Sensor ha_category: Image Processing
ha_release: 0.27 ha_release: 0.27
--- ---
@ -19,7 +19,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p> </p>
### {% linkable_title Noise %} ## {% linkable_title Configuration %}
To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file: To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: hydrawise_logo.png logo: hydrawise_logo.png
ha_category: Binary Sensor ha_category: Irrigation
ha_release: 0.71 ha_release: 0.71
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
## {% linkable_title Configuration %}
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -15,26 +15,24 @@ ha_iot_class: "Local Polling"
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.
## {% linkable_title Configuration %}
The `knx` component must be configured correctly, see [KNX Component](/components/knx). The `knx` component must be configured correctly, see [KNX Component](/components/knx).
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
binary_sensor: binary_sensor:
- platform: knx - platform: knx
name: "Entrance.Motion.Sensor"
address: '6/0/2' address: '6/0/2'
device_class: 'motion'
#significant_bit: 2
#reset_after: 100
``` ```
Configuration variables: Configuration variables:
- **address** (*Required*): KNX group address of the binary sensor.
- **name** (*Optional*): A name for this device used within Home Assistant. - **name** (*Optional*): A name for this device used within Home Assistant.
- **address**: KNX group address of the binary sensor. - **device_class** (*Optional*): HASS device class e.g., "motion".
- **device_class** (Optional): HASS device class e.g., "motion". - **significant_bit** (*Optional*): Specify which significant bit of the KNX value should be used. Default is 1.
- **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1. - **reset_after** (*Optional*): Reset back to OFF state after specified milliseconds.
- **reset_after** (Optional): Reset back to OFF state after specified milliseconds.
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time. You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.

View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `linode` binary sensor platform allows you to monitor your Linode nodes. The `linode` binary sensor platform allows you to monitor your Linode nodes.
## {% linkable_title Configuration %}
Add the following to your `configuration.yaml` file: Add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,12 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mercedesme.png logo: mercedesme.png
ha_category: Binary Sensor ha_category: Car
ha_iot_class: "Cloud polling" ha_iot_class: "Cloud polling"
ha_release: 0.63 ha_release: 0.63
--- ---
The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant. The `mercedesme` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant.
They will be automatically discovered if the Mercedes me component is loaded. They will be automatically discovered if the Mercedes me component is loaded.

View File

@ -1,6 +1,6 @@
--- ---
layout: page layout: page
title: "MyChevy Binary Sensors" title: "MyChevy Binary Sensor"
description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant." description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant."
date: 2017-08-28 17:00 date: 2017-08-28 17:00
sidebar: true sidebar: true
@ -8,9 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: chevy.png logo: chevy.png
ha_category: Binary Sensor ha_category: Car
ha_release: 0.62 ha_release: 0.62
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
For configuration instructions, see [main component config](/components/mychevy/). The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mysensors.png logo: mysensors.png
ha_category: Binary Sensor ha_category: DIY
ha_release: 0.14 ha_release: 0.14
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---

View File

@ -8,16 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: openuv.jpg logo: openuv.jpg
ha_category: Binary Sensor ha_category: Health
ha_release: 0.76 ha_release: 0.76
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
The `openuv` binary sensor platform allows you to view binary sensor data from The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
[OpenUV](http://openuv.io).
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.
<p class='note'>
You must have the [OpenUV component](/components/openuv/) configured to use
this platform. After configuring that component, binary sensors will
automatically appear.
</p>

View File

@ -8,14 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: pilight.png logo: pilight.png
ha_category: Binary Sensor ha_category: DIY
ha_release: 0.44 ha_release: 0.44
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
## {% linkable_title Configuration %}
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Binary Sensor ha_category: Network
ha_release: 0.43 ha_release: 0.43
--- ---
The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system. The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
## {% linkable_title Configuration %}
To use this sensor in your installation, add the following to your `configuration.yaml` file: To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: rachio.png logo: rachio.png
ha_category: Hub ha_category: Irrigation
ha_iot_class: "Cloud Push" ha_iot_class: "Cloud Push"
ha_release: 0.73 ha_release: 0.73
--- ---
@ -18,9 +18,10 @@ The `rachio` binary sensor platform allows you to view the status of your [Rachi
Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers. Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.
<p class='note'> <p class='note'>
You must have the [Rachio component](/components/rachio/) configured to use this switch. You must have the [Rachio component](/components/rachio/) configured to use this switch.
</p> </p>
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file: To add this platform to your installation, add the following to your `configuration.yaml` file:

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raincloud.jpg logo: raincloud.jpg
ha_category: Binary Sensor ha_category: Irrigation
ha_release: "0.55" ha_release: "0.55"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
## {% linkable_title Configuration %}
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: rainmachine.png logo: rainmachine.png
ha_category: Binary Sensor ha_category: Irrigation
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
ha_release: 0.71 ha_release: 0.71
--- ---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Sensor ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.57 ha_release: 0.57
--- ---
@ -18,7 +18,7 @@ The `random` binary sensor platform is creating random states (`True`, 1, `on` o
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
To enable the random binary sensor, add the following lines to your `configuration.yaml`: To enable the random binary sensor, add the following lines to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raspihats.png logo: raspihats.png
ha_category: Binary Sensor ha_category: DIY
ha_release: 0.44 ha_release: 0.44
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `raspihats` binary sensor platform allows you to read sensor values using the digital inputs of the [raspihats](http://www.raspihats.com/) boards. The `raspihats` binary sensor platform allows you to read sensor values using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file: To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ring.png logo: ring.png
ha_category: Binary Sensor ha_category: Doorbell
ha_release: 0.42 ha_release: 0.42
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Binary Sensor ha_category: DIY
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
## {% linkable_title Configuration %}
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Binary Sensor ha_category: DIY
ha_release: 0.45 ha_release: 0.45
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) .
## {% linkable_title Configuration %}
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file: To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: skybell.png logo: skybell.png
ha_category: Binary Sensor ha_category: Doorbell
ha_release: 0.56 ha_release: 0.56
ha_iot_class: "Cloud Polling" 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). 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).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: sleepiq.png logo: sleepiq.png
ha_category: Binary Sensor ha_category: Health
ha_release: 0.29 ha_release: 0.29
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---

View File

@ -8,12 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: tesla.png logo: tesla.png
ha_category: Binary Sensor ha_category: Car
ha_iot_class: "Cloud polling" ha_iot_class: "Cloud polling"
ha_release: 0.53 ha_release: 0.53
--- ---
The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
They will be automatically discovered if the Tesla component is loaded. They will be automatically discovered if the Tesla component is loaded.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Binary Sensor ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.34 ha_release: 0.34
--- ---
@ -26,6 +26,8 @@ It's an alternative to the template binary sensor's `value_template:` to get the
``` ```
{% endraw %} {% endraw %}
## {% linkable_title Configuration %}
To enable the threshold sensor, add the following lines to your `configuration.yaml`: To enable the threshold sensor, add the following lines to your `configuration.yaml`:
```yaml ```yaml

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Binary Sensor ha_category: Utility
logo: home-assistant.png logo: home-assistant.png
ha_release: 0.28 ha_release: 0.28
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
@ -15,6 +15,8 @@ ha_iot_class: "Local Push"
The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend. The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.
## {% linkable_title Configuration %}
To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file: To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -15,6 +15,8 @@ ha_iot_class: Cloud Polling
The `upcloud` binary sensor platform allows you to monitor your UpCloud servers. The `upcloud` binary sensor platform allows you to monitor your UpCloud servers.
## {% linkable_title Configuration %}
To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file: To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,19 +8,22 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: uptimerobot.png logo: uptimerobot.png
ha_category: Binary Sensor ha_category: System Monitor
ha_release: "0.72" ha_release: "0.72"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
The `uptimerobot` binary_sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com) The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com).
## Example for `configuration.yaml` : ## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry
binary_sensor: binary_sensor:
- platform: uptimerobot - platform: uptimerobot
api_key: u432898-d2507e493b31217e6c64fd35 api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

View File

@ -1,6 +1,6 @@
--- ---
layout: page layout: page
title: "Belkin WeMo Binary Sensors" title: "Belkin WeMo Binary Sensor"
description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant." description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant."
date: 2016-02-20 00:45 date: 2016-02-20 00:45
sidebar: true sidebar: true

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Binary Sensor ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.41 ha_release: 0.41
--- ---

View File

@ -8,15 +8,19 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: bloomsky.png logo: bloomsky.png
ha_category: Hub ha_category: Environment
ha_release: 0.14 ha_release: 0.14
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant. The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant.
## {% linkable_title Setup %}
Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen.
## {% linkable_title Configuration %}
To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml ```yaml
@ -25,6 +29,9 @@ bloomsky:
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
``` ```
Configuration variables: {% configuration %}
api_key:
- **api_key** (*Required*): Your BloomSky API key. description: Your BloomSky API key.
required: true
type: string
{% endconfiguration %}

View File

@ -8,11 +8,11 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: bmw.png logo: bmw.png
ha_category: Hub ha_category: Car
ha_release: 0.64 ha_release: 0.64
--- ---
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. The `bmw_connected_drive` component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.

View File

@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky). The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky).
## {% linkable_title Configuration %}
To enable this camera in your installation, set up the [BloomSky component](/components/bloomsky) with your API key and add the following to your `configuration.yaml` file: To enable this camera in your installation, set up the [BloomSky component](/components/bloomsky) with your API key and add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan. To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan.
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Camera ha_category: DIY
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
ha_release: 0.17 ha_release: 0.17
--- ---
@ -16,6 +16,8 @@ ha_release: 0.17
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file: To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Skybell.com](https://www.skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). To get your [Skybell.com](https://www.skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -1,86 +0,0 @@
---
layout: page
title: "Xiaomi Cameras"
description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant."
date: 2018-06-20 13:00
sidebar: true
comments: false
sharing: true
footer: true
logo: xiaomi.png
ha_category: Camera
ha_release: 0.72
ha_iot_class: "Local Polling"
---
The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant.
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
## {% linkable_title Preparing the Device %}
### {% linkable_title Installing Alternative Firmware %}
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models.
* [Yi 720p](https://github.com/fritz-smh/yi-hack)
* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3)
* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks)
Once installed, please ensure that you have enabled FTP.
<p class='note warning'>
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files.
</p>
<p class='note warning'>
Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video.
</p>
<p class='note warning'>
The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this component retrives the video which was saved 1 minute earlier.
</p>
<p class='note warning'>
If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.
</p>
## {% linkable_title Configuring the Platform %}
To enable the platform, add the following lines to your`configuration.yaml` file:
```yaml
camera:
- platform: xiaomi
name: Camera
host: '192.168.1.100'
model: 'yi'
password: my_password_123
```
Configuration variables:
- **name** (*Required*): A human-friendly name for the camera.
- **host** (*Required*): The IP address or hostname of the camera.
- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang.
- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords.
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`.
- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`.
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).
## {% linkable_title Image quality %}
Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter.
One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size:
```yaml
camera:
- platform: xiaomi
name: My Camera
host: '192.168.1.100'
model: 'xiaofang'
password: my_password_123
path: /home/camera/feed
ffmpeg_arguments: '-vf scale=800:450'
```

View File

@ -62,7 +62,7 @@ Configuration variables:
- **host** (*Required*): The IP address or hostname of the camera. - **host** (*Required*): The IP address or hostname of the camera.
- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. - **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang.
- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. - **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords.
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. - **path** (*Optional*): The path to the raw MP4 files. Defaults to `/media/mmcblk0p1/record`.
- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. - **username** (*Optional*): The user that can access the FTP server. Defaults to `root`.
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). - **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).

View File

@ -31,7 +31,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install
Once installed, please ensure that you have enabled FTP and Telnet on your device. Once installed, please ensure that you have enabled FTP and Telnet on your device.
<p class='note warning'> <p class='note warning'>
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. Currently, version 0.1.4-beta2 of the custom firmware is the highest supported without having to make additional modifications. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. To use higher firmware versions you must also follow [this workaround](https://github.com/shadow-1/yi-hack-v3/issues/129#issuecomment-361723075) to revert back to ftpd.
</p> </p>
<p class='note warning'> <p class='note warning'>

View File

@ -23,11 +23,7 @@ The `daikin` climate platform integrates Daikin air conditioning systems into Ho
Current temperature is displayed. Current temperature is displayed.
<p class='note warning'> ## {% linkable_title Configuration %}
Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. BRP069A42 does not support setting of fan speed or fan swing mode.
</p>
The platform has been integrated with discovery so all your Daikin AC's climate devices can be automatically discovered.
To enable the platform, add the following lines to your `configuration.yaml` file: To enable the platform, add the following lines to your `configuration.yaml` file:

View File

@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.63 ha_release: 0.63
--- ---
The `Melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant. The `melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
The climate platform will be automatically configured if Melissa component is configured. The climate platform will be automatically configured if Melissa component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mysensors.png logo: mysensors.png
ha_category: Climate ha_category: DIY
ha_release: 0.29 ha_release: 0.29
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---

View File

@ -0,0 +1,65 @@
---
layout: page
title: "OpenTherm Gateway"
description: "Control your OpenTherm Gateway from Home Assistant."
date: 2018-08-29 16:23
sidebar: true
comments: false
sharing: true
footer: true
logo: opentherm.png
ha_category: Climate
ha_release: 0.78
ha_iot_class: "Local Push"
---
The `opentherm_gw` climate platform is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
# {% linkable_title Configuration %}
```yaml
# Example configuration.yaml entry
climate:
- platform: opentherm_gw
device: /dev/ttyUSB0
```
{% configuration %}
device:
description: "Path to OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html)."
required: true
type: string
name:
description: The name for the device within Home Assistant.
required: false
type: string
default: OpenTherm Gateway
precision:
description: "The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`."
required: false
type: float
default: "`0.5` for Celsius and `1.0` for Fahrenheit."
floor_temperature:
description: Some thermostats round all temperatures down to the lower value according to their precision. Default behaviour for Home Assistant is to round temperatures to the nearest value. Set this to `True` to override Home Assistant and round to the lower value according to the configured `precision`.
required: false
type: boolean
{% endconfiguration %}
<p class='note'>
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
</p>
# {% linkable_title Example %}
A full configuration example with the OpenTherm Gateway connected to a remote host running `ser2net` looks like the one below.
```yaml
# Full example configuration.yaml entry
climate:
- platform: opentherm_gw
device: socket://otgw.example.org:2345
name: Thermostat
precision: 0.5
floor_temperature: True
```

View File

@ -8,12 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: tesla.png logo: tesla.png
ha_category: Climate ha_category: Car
ha_iot_class: "Cloud push" ha_iot_class: "Cloud push"
ha_release: 0.53 ha_release: 0.53
--- ---
The `Tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant. The `tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant.
The climate platform will be automatically configured if Tesla component is configured. The climate platform will be automatically configured if Tesla component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: cloudflare.png logo: cloudflare.png
ha_category: Utility ha_category: Network
featured: false featured: false
ha_release: 0.74 ha_release: 0.74
--- ---

View File

@ -1,6 +1,6 @@
--- ---
layout: page layout: page
title: "coinbase" title: "Coinbase"
description: "Instructions for how to add Coinbase sensors to Home Assistant." description: "Instructions for how to add Coinbase sensors to Home Assistant."
date: 2017-12-08 17:54 date: 2017-12-08 17:54
sidebar: true sidebar: true
@ -8,6 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: coinbase.png logo: coinbase.png
ha_category: Finance
ha_release: 0.61 ha_release: 0.61
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
@ -17,6 +18,8 @@ The `coinbase` component lets you access account balances and exchange rates fro
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data. You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file: To set it up, add the following information to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -44,7 +44,7 @@ Increments the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.decrement` %} #### {% linkable_title Service `counter.decrement` %}
@ -52,7 +52,7 @@ Decrements the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.reset` %} #### {% linkable_title Service `counter.reset` %}
@ -60,7 +60,7 @@ With this service the counter is reset to its initial value.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### {% linkable_title Use the service %} ### {% linkable_title Use the service %}
@ -69,7 +69,7 @@ Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
```json ```json
{ {
"entity_id": "counter.count0" "entity_id": "counter.my_custom_counter"
} }
``` ```

View File

@ -0,0 +1,22 @@
---
layout: page
title: "Insteon Cover"
description: "Instructions on how to setup the Insteon cover locally within Home Assistant."
date: 2018-08-20 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Cover
ha_iot_class: "Local Push"
ha_version: 0.78
---
The `insteon` cover platform lets you control your [Open/Close Micro Module]
through an INSTEON Modem (PLM and Hub) device connected directly to your system
on a USB, serial port or TCPIP connection. To add support, set up the primary
[insteon] component.
[insteon]: /components/insteon/
[Open/Close Micro Module]: https://www.insteon.com/open-close-micro-module/

0
source/_components/cover.mqtt.markdown Executable file → Normal file
View File

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mysensors.png logo: mysensors.png
ha_category: Cover ha_category: DIY
ha_release: "0.30" ha_release: "0.30"
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---

View File

@ -8,12 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: opengarage.png logo: opengarage.png
ha_category: Cover ha_category: DIY
ha_release: 0.44 ha_release: 0.44
--- ---
The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.
## {% linkable_title Configuration %}
To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file: To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -87,7 +89,7 @@ sensor:
{% endif %} {% endif %}
{% else %} {% else %}
n/a n/a
{% endif %}'{% endraw %} {% endif %}'
group: group:
garage: garage:
@ -104,3 +106,4 @@ customize:
sensor.garage_car_present: sensor.garage_car_present:
icon: mdi:car icon: mdi:car
``` ```
{% endraw %}

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Cover ha_category: DIY
ha_release: 0.23 ha_release: 0.23
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
@ -22,6 +22,8 @@ It uses two pins on the Raspberry Pi.
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
## {% linkable_title Configuration %}
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -13,9 +13,9 @@ ha_iot_class: "Local Push"
logo: home-assistant.png logo: home-assistant.png
--- ---
The `template` platform can create covers that combine components and provides The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover.
the ability to run scripts or invoke services for each of the open, close,
stop, position, and tilt commands of a cover. ## {% linkable_title Configuration %}
To enable Template Covers in your installation, add the following to your To enable Template Covers in your installation, add the following to your
`configuration.yaml` file: `configuration.yaml` file:

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: daikin.png logo: daikin.png
ha_category: Hub ha_category: Climate
ha_release: 0.59 ha_release: 0.59
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
@ -16,11 +16,15 @@ ha_iot_class: "Local Polling"
The `daikin` component integrates Daikin air conditioning systems into Home Assistant. The `daikin` component integrates Daikin air conditioning systems into Home Assistant.
To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your 'configuration.yaml' file: ## {% linkable_title Supported hardware %}
<p class='note warning'> **Only** the european versions of Daikin ACs (models BRP069A41, 42, 43, 45).
Please note, the Daikin platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant.
</p> The model BRP069A42 does not support setting of fan speed or fan swing mode.
Please note that some AC devices may report outside temperature only when they are turned on.
## {% linkable_title Configuration %}
To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file: To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file:
@ -52,7 +56,3 @@ monitored_conditions:
description: The current temperature measured outside the house. description: The current temperature measured outside the house.
{% endconfiguration %} {% endconfiguration %}
<p class='note warning'>
Please note that some AC devices may report outside temperature only when they are turned on.
</p>

View File

@ -29,9 +29,9 @@ See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry. If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Settings** -> **Gateway** -> **Advanced** -> **Authenticate app** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry.
You can add the following to your configuration.yaml file if you are not using the `discovery:` component: You can add the following to your `configuration.yaml` file if you are not using the `discovery:` component:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -79,16 +79,16 @@ logger:
## {% linkable_title Device services %} ## {% linkable_title Device services %}
Available services: `configure`. Available services: `configure` and `deconz.refresh_devices`.
#### {% linkable_title Service `deconz.configure` %} #### {% linkable_title Service `deconz.configure` %}
Set attribute of device in Deconz using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). Set attribute of device in deCONZ using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/).
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|-----------|----------|-------------| |-----------|----------|-------------|
| `field` | No | String representing a specific device in deCONZ. | | `field` | No | String representing a specific device in deCONZ. |
| `entity` | No | String representing a specific HASS entity of a device in deCONZ. | | `entity` | No | String representing a specific Home Assistant entity of a device in deCONZ. |
| `data` | No | Data is a JSON object with what data you want to alter. | | `data` | No | Data is a JSON object with what data you want to alter. |
Field and entity are exclusive, i.e you can only use one in a request. Field and entity are exclusive, i.e you can only use one in a request.
@ -99,9 +99,15 @@ Field and entity are exclusive, i.e you can only use one in a request.
{ "field": "/config", "data": {"permitjoin": 60} } { "field": "/config", "data": {"permitjoin": 60} }
#### {% linkable_title Service `deconz.refresh_devices` %}
Refresh with devices added to deCONZ after Home Assistants latest restart.
Note: deCONZ automatically signals Home Assistant when new sensors are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
## {% linkable_title Remote control devices %} ## {% linkable_title Remote control devices %}
Remote controls (ZHASwitch category) will be not be exposed as a regular entity, but as events named 'deconz_event' with a payload of 'id' and 'event'. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level. Remote controls (ZHASwitch category) will be not be exposed as regular entities, but as events named `deconz_event` with a payload of `id` and `event`. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level.
Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here. Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here.
@ -118,9 +124,9 @@ For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is le
## {% linkable_title Examples %} ## {% linkable_title Examples %}
### {% linkable_title Step up and step down input number with wireless dimmer %} ### {% linkable_title YAML %}
#### YAML #### {% linkable_title Step up and step down input number with wireless dimmer %}
{% raw %} {% raw %}
```yaml ```yaml
@ -171,15 +177,17 @@ automation:
``` ```
{% endraw %} {% endraw %}
#### Appdaemon ### {% linkable_title Appdaemon %}
#### {% linkable_title Appdaemon remote template %}
{% raw %} {% raw %}
```yaml ```yaml
remote_control_living_room: remote_control:
module: remote_control module: remote_control
class: RemoteControl class: RemoteControl
event: deconz_event event: deconz_event
id: dimmer_switch_3 id: dimmer_switch_1
``` ```
```python ```python
@ -204,3 +212,53 @@ class RemoteControl(hass.Hass):
self.log('Button off') self.log('Button off')
``` ```
{% endraw %} {% endraw %}
#### {% linkable_title Appdaemon remote template %}
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
{% raw %}
```yaml
sonos_remote_control:
module: sonos_remote
class: SonosRemote
event: deconz_event
id: sonos_remote
sonos: media_player.sonos
```
{% endraw %}
{% raw %}
```python
import appdaemon.plugins.hass.hassapi as hass
class SonosRemote(hass.Hass):
def initialize(self):
self.sonos = self.args['sonos']
if 'event' in self.args:
self.listen_event(self.handle_event, self.args['event'])
def handle_event(self, event_name, data, kwargs):
if data['id'] == self.args['id']:
if data['event'] == 1002:
self.log('Button toggle')
self.call_service("media_player/media_play_pause", entity_id = self.sonos)
elif data['event'] == 2002:
self.log('Button volume up')
self.call_service("media_player/volume_up", entity_id = self.sonos)
elif data['event'] == 3002:
self.log('Button volume down')
self.call_service("media_player/volume_down", entity_id = self.sonos)
elif data['event'] == 4002:
self.log('Button previous')
self.call_service("media_player/media_previous_track", entity_id = self.sonos)
elif data['event'] == 5002:
self.log('Button next')
self.call_service("media_player/media_next_track", entity_id = self.sonos)
```
{% endraw %}

View File

@ -22,6 +22,7 @@ Available demo platforms:
- [Climate](/components/climate/) (`climate`) - [Climate](/components/climate/) (`climate`)
- [Cover](/components/cover/) (`cover`) - [Cover](/components/cover/) (`cover`)
- [Fan](/components/fan/) (`fan`) - [Fan](/components/fan/) (`fan`)
- [Geo Location](/components/geo_location/) (`geo_location`)
- [Image Processing](/components/image_processing/) (`image_processing`) - [Image Processing](/components/image_processing/) (`image_processing`)
- [Light](/components/light/) (`light`) - [Light](/components/light/) (`light`)
- [Lock](/components/lock/) (`lock`) - [Lock](/components/lock/) (`lock`)

View File

@ -8,18 +8,22 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: automatic.png logo: automatic.png
ha_category: Presence Detection ha_category: Car
ha_release: 0.28 ha_release: 0.28
ha_iot_class: "Cloud Push" ha_iot_class: "Cloud Push"
--- ---
The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service. The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
## {% linkable_title Setup %}
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml.
## {% linkable_title Configuration %}
Once your developer account is created, add the following to your `configuration.yaml` file: Once your developer account is created, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,12 +8,12 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: bmw.png logo: bmw.png
ha_category: Presence Detection ha_category: Car
ha_release: 0.64 ha_release: 0.64
--- ---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. The `bmw_connected_drive` device tracker platform allows you to import data on your BMW into Home Assistant.
The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured. The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured.

View File

@ -8,11 +8,11 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mercedesme.png logo: mercedesme.png
ha_category: Presence Detection ha_category: Car
ha_release: 0.63 ha_release: 0.63
--- ---
The `Mercedes me` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant. The `mercedesme` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant.
The device tracker platform will be automatically configured if Mercedes me component is configured. The device tracker platform will be automatically configured if Mercedes me component is configured.

View File

@ -8,8 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mysensors.png logo: mysensors.png
ha_category: Presence Detection ha_category: DIY
featured: false
ha_release: "0.38" ha_release: "0.38"
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---

View File

@ -8,12 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Presence Detection ha_category: Network
ha_release: 0.36 ha_release: 0.36
--- ---
The `ping` platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work. The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
## {% linkable_title Configuration %}
To use this presence detection in your installation, add the following to your `configuration.yaml` file: To use this presence detection in your installation, add the following to your `configuration.yaml` file:

View File

@ -8,17 +8,19 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ritassist.png logo: ritassist.png
ha_category: Presence Detection ha_category: Car
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
ha_release: 0.76 ha_release: 0.76
--- ---
This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
## {% linkable_title Setup %}
## API key
To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration ## {% linkable_title Configuration %}
To use this device tracker in your installation, add the following to your `configuration.yaml` file: To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -58,7 +60,7 @@ include:
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
## Available Attributes ## {% linkable_title Available attributes %}
| Attribute | Description | | Attribute | Description |
|---|---| |---|---|
@ -78,5 +80,8 @@ See the [device tracker component page](/components/device_tracker/) for instruc
| coolant_temperature | Temperature of the coolant [1] | | coolant_temperature | Temperature of the coolant [1] |
| power_voltage | Power voltage measured by the hardware [1] | | power_voltage | Power voltage measured by the hardware [1] |
| distance_from_home | How far is your vehicle located from your Home Assistant Home location | | distance_from_home | How far is your vehicle located from your Home Assistant Home location |
| current_max_speed | The maximum speed on the road the device is currently on (if available) |
| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. |
[1] Only available on certain cars and hardware revisions. [1] Only available on certain cars and hardware revisions.

View File

@ -8,11 +8,11 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: tesla.png logo: tesla.png
ha_category: Presence Detection ha_category: Car
ha_release: 0.53 ha_release: 0.53
--- ---
The `Tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant. The `tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant.
The device tracker platform will be automatically configured if Tesla component is configured. The device tracker platform will be automatically configured if Tesla component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: volvo.png logo: volvo.png
ha_category: Presence Detection ha_category: Car
ha_release: "0.30" ha_release: "0.30"
--- ---

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Hub ha_category: System Monitor
ha_release: "0.30" ha_release: "0.30"
logo: digital_ocean.png logo: digital_ocean.png
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
@ -16,8 +16,12 @@ ha_iot_class: "Local Polling"
The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
## {% linkable_title Setup %}
Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens).
## {% linkable_title Configuration %}
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: doorbird.png logo: doorbird.png
ha_category: Hub ha_category: Doorbell
ha_release: "0.54" ha_release: "0.54"
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant. The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
## {% linkable_title Configuration %}
To connect your device, add the following to your `configuration.yaml` file: To connect your device, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,13 +8,15 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: duckdns.png logo: duckdns.png
ha_category: Utility ha_category: Network
featured: false featured: false
ha_release: 0.55 ha_release: 0.55
--- ---
With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file: To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: eight_sleep.png logo: eight_sleep.png
ha_category: Hub ha_category: Health
ha_release: "0.44" ha_release: "0.44"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
@ -17,7 +17,7 @@ The `eight_sleep` component allows Home Assistant to fetch data from your [Eight
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component. You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component.

View File

@ -38,17 +38,21 @@ eufy:
name: Smart Switch name: Smart Switch
``` ```
access_token can be obtained by running: `access_token can be obtained by running:
``` ```bash
curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq $ curl -H "Content-Type: application/json" \
-d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' \
https://home-api.eufylife.com/v1/user/email/login \
| jq
``` ```
replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run: replacing USERNAME and PASSWORD with the Eufy username and password. This will give an `access_token`. Then run:
``` ```bash
curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq $ curl -H token:TOKEN -H category:Home \
https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq
``` ```
replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device. replacing TOKEN with the `access_token` from the previous command. This will provide the local_code for each device.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: ffmpeg.png logo: ffmpeg.png
ha_category: Hub ha_category: Image Processing
--- ---
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update.
@ -21,6 +21,8 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p> </p>
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file: To set it up, add the following information to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -22,6 +22,8 @@ This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system m
Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored. Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
## {% linkable_title Configuration %}
To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file: To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file:
{% raw %} {% raw %}

View File

@ -7,13 +7,13 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Utility ha_category: Network
ha_release: 0.67 ha_release: 0.67
--- ---
With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date.
## {% linkable_title Configuration %} ## {% linkable_title Setup %}
You need to determine your update URL or your access token. You need to determine your update URL or your access token.
@ -24,6 +24,8 @@ You need to determine your update URL or your access token.
5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` 5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN`
6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. 6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file: To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -112,10 +112,10 @@ automation:
### {% linkable_title Manual Theme Selection %} ### {% linkable_title Manual Theme Selection %}
When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under **General** called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately. When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (before 0.77 it was in the Configuration panel under **General** called "Set a theme"). You can then choose any installed theme from the dropdown list and it will be applied immediately.
<p class='img'> <p class='img'>
<img src='/images/frontend/choose-theme.png' /> <img src='/images/frontend/user-theme.png' />
Set a theme Set a theme
</p> </p>
@ -137,9 +137,9 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
### {% linkable_title Manual Language Selection %} ### {% linkable_title Manual Language Selection %}
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately. The browser language is automatically detected. To use a different language, go to the user profile menu (before 0.77 it was found in **General** in the Configuration panel) and select one. It will be applied immediately.
<p class='img'> <p class='img'>
<img src='/images/frontend/choose-language.png' /> <img src='/images/frontend/user-language.png' />
Choose a Language Choose a Language
</p> </p>

View File

@ -0,0 +1,16 @@
---
layout: page
title: "Geo Location"
description: "Instructions on how to integrate geo location aware platforms into Home Assistant."
date: 2018-08-27 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Other
ha_release: "0.78"
---
Geo Location aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes.
Entities can have associated geo location coordinates (latitude and longitude) so that they are displayed on the map. The distance from the entity's coordinates to Home Assistant's location can be used for filtering.

View File

@ -157,7 +157,7 @@ If you're not using Linux, you can use sites such as [this one](https://www.brow
a. Go to the settings for the project you created in point 1 in the developer console. a. Go to the settings for the project you created in point 1 in the developer console.
b. Under the gear icon, click `Permissions` b. Under the gear icon, click `Permissions`
c. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role c. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role
d. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 4 d. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 3
8. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project: 8. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project:
a. Go to the [cloud console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) a. Go to the [cloud console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview)
b. Select your project and click Enable Homegraph API b. Select your project and click Enable Homegraph API

View File

@ -8,12 +8,14 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: google_domains.png logo: google_domains.png
ha_category: Utility ha_category: Network
ha_release: 0.57 ha_release: 0.57
--- ---
With the Google Domains component you can keep your Google Domains record up to date. With the Google Domains component you can keep your Google Domains record up to date.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file: To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml

Some files were not shown because too many files have changed in this diff Show More