mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 00:06:51 +00:00
Merge branch 'current' into next
This commit is contained in:
commit
d5d465e7d3
@ -101,8 +101,8 @@ social:
|
|||||||
# Home Assistant release details
|
# Home Assistant release details
|
||||||
current_major_version: 0
|
current_major_version: 0
|
||||||
current_minor_version: 100
|
current_minor_version: 100
|
||||||
current_patch_version: 0
|
current_patch_version: 2
|
||||||
date_released: 2019-10-10
|
date_released: 2019-10-12
|
||||||
|
|
||||||
# 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.
|
||||||
|
@ -100,13 +100,10 @@ module Jekyll
|
|||||||
if minor.length == 1
|
if minor.length == 1
|
||||||
"#{major}.X"
|
"#{major}.X"
|
||||||
else
|
else
|
||||||
"#{major}.#{minor[0]}X"
|
"#{major}.#{minor.chop}X"
|
||||||
end
|
end
|
||||||
}.map { |v|
|
}.map { |v|
|
||||||
sort_key = v[1][-1]["sort_key"]
|
sort_key = v[1][-1]["sort_key"]
|
||||||
if v[0] == "0.X"
|
|
||||||
sort_key = "0.01" # Ensure 0.X is always sorted at bottom.
|
|
||||||
end
|
|
||||||
|
|
||||||
total_new_components = 0
|
total_new_components = 0
|
||||||
|
|
||||||
@ -115,7 +112,7 @@ module Jekyll
|
|||||||
end
|
end
|
||||||
|
|
||||||
{ "label" => v[0], "versions" => v[1], "new_components_count" => total_new_components, "sort_key" => sort_key }
|
{ "label" => v[0], "versions" => v[1], "new_components_count" => total_new_components, "sort_key" => sort_key }
|
||||||
}.sort_by { |v| v["sort_key"] }.reverse
|
}.sort_by { |v| Gem::Version.new(v["sort_key"]) }.reverse
|
||||||
end
|
end
|
||||||
|
|
||||||
# Get version N behind current
|
# Get version N behind current
|
||||||
|
@ -535,7 +535,7 @@ code {
|
|||||||
font-size: 0.8em;
|
font-size: 0.8em;
|
||||||
color: #1990b8;
|
color: #1990b8;
|
||||||
word-spacing: normal;
|
word-spacing: normal;
|
||||||
word-break: break-word;
|
word-break: normal;
|
||||||
word-wrap: normal;
|
word-wrap: normal;
|
||||||
|
|
||||||
-moz-tab-size: 4;
|
-moz-tab-size: 4;
|
||||||
|
@ -86,7 +86,7 @@ hosts:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
ip:
|
ip:
|
||||||
description: Fix ip address for device.
|
description: Fix IP address for device.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
@ -92,7 +92,7 @@ For more information about the configuration including protocols, see the [telld
|
|||||||
|
|
||||||
If you wish to teach a self-learning device in your TellStick configuration:
|
If you wish to teach a self-learning device in your TellStick configuration:
|
||||||
|
|
||||||
Go to Home Assistant [service call](http://hassio.local:8123/dev-service) in Developer tools and select.
|
Go to Home Assistant service call in Developer tools and select.
|
||||||
|
|
||||||
- Service: `hassio.addon_stdin`
|
- Service: `hassio.addon_stdin`
|
||||||
- Enter service Data:
|
- Enter service Data:
|
||||||
|
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Configuration.yaml by cbulock"
|
|
||||||
description: ""
|
|
||||||
ha_category: Example configuration.yaml
|
|
||||||
ha_external_link: https://github.com/cbulock/home-assistant-configs
|
|
||||||
---
|
|
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Configuration.yaml by chriskacerguis"
|
|
||||||
description: ""
|
|
||||||
ha_category: Example configuration.yaml
|
|
||||||
ha_external_link: https://github.com/chriskacerguis/Home-AssistantConfig
|
|
||||||
---
|
|
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Configuration.yaml by Ciquattro"
|
|
||||||
description: ""
|
|
||||||
ha_category: Example configuration.yaml
|
|
||||||
ha_external_link: https://github.com/CiquattroFPV/Homeassistant-Example-Config
|
|
||||||
---
|
|
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Configuration.yaml by René-Marc Simard"
|
|
||||||
description: ""
|
|
||||||
ha_category: Example configuration.yaml
|
|
||||||
ha_external_link: https://github.com/renemarc/home-assistant-config
|
|
||||||
---
|
|
@ -279,6 +279,22 @@ The `for` template(s) will be evaluated when the `value_template` becomes `true`
|
|||||||
Rendering templates with time (`now()`) is dangerous as trigger templates only update based on entity state changes.
|
Rendering templates with time (`now()`) is dangerous as trigger templates only update based on entity state changes.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
As an alternative, providing you include the sensor [time](/integrations/time_date/) in your configuration, you can use the following template:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
automation:
|
||||||
|
trigger:
|
||||||
|
platform: template
|
||||||
|
value_template: "{{ (as_timestamp(states.sensor.time.last_changed) - as_timestamp(states.YOUR.ENTITY.last_changed)) > 300 }}"
|
||||||
|
```
|
||||||
|
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
|
which will evaluate to `True` if `YOUR.ENTITY` changed more than 300 seconds ago.
|
||||||
|
|
||||||
### Time trigger
|
### Time trigger
|
||||||
|
|
||||||
The time trigger is configured to run once at a specific point in time each day.
|
The time trigger is configured to run once at a specific point in time each day.
|
||||||
|
@ -4,7 +4,7 @@ description: "Setting up the basic info of Home Assistant."
|
|||||||
redirect_from: /getting-started/basic/
|
redirect_from: /getting-started/basic/
|
||||||
---
|
---
|
||||||
|
|
||||||
As part of the default onboarding proccess, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You may adjust this during onboarding, or afterwards at Configuration -> General.
|
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You may adjust this during onboarding, or afterwards at Configuration -> General.
|
||||||
|
|
||||||
If you prefer YAML, you can add the following information to your `configuration.yaml`:
|
If you prefer YAML, you can add the following information to your `configuration.yaml`:
|
||||||
|
|
||||||
|
@ -58,7 +58,7 @@ entity_picture:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
icon:
|
icon:
|
||||||
description: "Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://cdn.materialdesignicons.com/4.4.95/)). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
|
description: "Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://cdn.materialdesignicons.com/4.5.95/)). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
assumed_state:
|
assumed_state:
|
||||||
|
@ -82,7 +82,7 @@ homeassistant:
|
|||||||
```
|
```
|
||||||
|
|
||||||
This uses the concept splitting the configuration and will include all files in a directory with the keys representing the filenames.
|
This uses the concept splitting the configuration and will include all files in a directory with the keys representing the filenames.
|
||||||
See the documentation about [splitting the configuration](/docs/configuration/splitting_configuration/) for more information about `!include_dir_named` and other include statements that might be helpful. The benefit of this approach is to pull all configurations required to integrate a system, into one file, rather than accross several.
|
See the documentation about [splitting the configuration](/docs/configuration/splitting_configuration/) for more information about `!include_dir_named` and other include statements that might be helpful. The benefit of this approach is to pull all configurations required to integrate a system, into one file, rather than across several.
|
||||||
|
|
||||||
### Customizing entities with packages
|
### Customizing entities with packages
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ This is useful if you want to have:
|
|||||||
|
|
||||||
#### Subdomain
|
#### Subdomain
|
||||||
|
|
||||||
So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123
|
So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at `http://localhost:8123`
|
||||||
|
|
||||||
Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html) by running if you encounter issues while serving Home Assistant through your proxy:
|
Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html) by running if you encounter issues while serving Home Assistant through your proxy:
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_ws
|
|||||||
$ sudo a2enmod proxy_wstunnel
|
$ sudo a2enmod proxy_wstunnel
|
||||||
```
|
```
|
||||||
|
|
||||||
To be able to access to your Home Assistant instance by using https://home.example.org, add the following file to `/etc/httpd/conf/extra/` as `hass.conf`
|
To be able to access to your Home Assistant instance by using `https://home.example.org`, add the following file to `/etc/httpd/conf/extra/` as `hass.conf`
|
||||||
|
|
||||||
```text
|
```text
|
||||||
<VirtualHost *:443>
|
<VirtualHost *:443>
|
||||||
@ -68,9 +68,9 @@ In case you are getting occasional HTTP 504 error messages ("Gateway Timeout") o
|
|||||||
|
|
||||||
#### Multiple Instance
|
#### Multiple Instance
|
||||||
|
|
||||||
You already have Home Assistant running on http://localhost:8123 and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`
|
You already have Home Assistant running on `http://localhost:8123` and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`
|
||||||
|
|
||||||
You want another instance available at https://countryside.example.org
|
You want another instance available at `https://countryside.example.org`
|
||||||
|
|
||||||
You can either :
|
You can either :
|
||||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
||||||
@ -84,9 +84,9 @@ http:
|
|||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
Start Home Assistant: Now, you have another instance running on http://localhost:8124
|
Start Home Assistant: Now, you have another instance running on `http://localhost:8124`
|
||||||
|
|
||||||
To access this instance by using https://countryside.example.org add to `/etc/httpd/conf/extra/hass.conf`
|
To access this instance by using `https://countryside.example.org` add to `/etc/httpd/conf/extra/hass.conf`
|
||||||
|
|
||||||
```text
|
```text
|
||||||
<VirtualHost *:443>
|
<VirtualHost *:443>
|
||||||
|
@ -48,7 +48,7 @@ Press Enter to Continue
|
|||||||
If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options:
|
If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
address=/mydomain.com/<hass ip>
|
address=/mydomain.com/<hass IP>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Edit your Home Assistant configuration to use your certificates
|
### Edit your Home Assistant configuration to use your certificates
|
||||||
|
@ -13,9 +13,9 @@ This is useful if you want to have:
|
|||||||
|
|
||||||
#### Subdomain
|
#### Subdomain
|
||||||
|
|
||||||
So you already have a working NGINX server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123
|
So you already have a working NGINX server available at example.org. Your Home Assistant is correctly working on this web server and available at `http://localhost:8123`
|
||||||
|
|
||||||
To be able to access to your Home Assistant instance by using https://home.example.org, create file `/etc/nginx/sites-enabled/homeassistant` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
To be able to access to your Home Assistant instance by using `https://home.example.org`, create file `/etc/nginx/sites-enabled/homeassistant` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
server {
|
server {
|
||||||
@ -52,9 +52,9 @@ If you don't want HTTPS, you can change `listen 443 ssl` to `listen 80` or bette
|
|||||||
|
|
||||||
#### Multiple Instance
|
#### Multiple Instance
|
||||||
|
|
||||||
You already have Home Assistant running on http://localhost:8123 and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`.
|
You already have Home Assistant running on `http://localhost:8123` and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`.
|
||||||
|
|
||||||
You want another instance available at https://countryside.example.org
|
You want another instance available at `https://countryside.example.org`
|
||||||
|
|
||||||
You can either :
|
You can either :
|
||||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
||||||
@ -68,9 +68,9 @@ http:
|
|||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
Start Home Assistant: Now, you have another instance running on http://localhost:8124
|
Start Home Assistant: Now, you have another instance running on `http://localhost:8124`
|
||||||
|
|
||||||
To access this instance by using https://countryside.example.org create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
To access this instance by using `https://countryside.example.org` create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
server {
|
server {
|
||||||
|
@ -4,7 +4,7 @@ description: "Setup and first steps for Jupyter Notebooks and Home Assistant."
|
|||||||
redirect_from: /ecosystem/notebooks/installation/
|
redirect_from: /ecosystem/notebooks/installation/
|
||||||
---
|
---
|
||||||
|
|
||||||
To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/getting-started/installation-virtualenv/) in order to properly manage dependencies.
|
To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/docs/installation/virtualenv/) in order to properly manage dependencies.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ pip3 install jupyter matplotlib
|
$ pip3 install jupyter matplotlib
|
||||||
@ -27,7 +27,7 @@ $ jupyter notebook
|
|||||||
[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
|
[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:8888/](http://localhost:8888/) in your browser. Press "New" -> "Python3" to open a new notebook.
|
Open `http://localhost:8888/` in your browser. Press "New" -> "Python3" to open a new notebook.
|
||||||
|
|
||||||
<p class='img'>
|
<p class='img'>
|
||||||
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
||||||
@ -43,5 +43,3 @@ The downloadable version of this notebook is available in the [Home Assistant no
|
|||||||
|
|
||||||
|
|
||||||
As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work.
|
As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work.
|
||||||
|
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ Synology NAS are the perfect companion to running Home Assistant. But by default
|
|||||||
Starting with DSM 6.2.1+, you can create "custom headers" in the Application Portal:
|
Starting with DSM 6.2.1+, you can create "custom headers" in the Application Portal:
|
||||||
* Go to Application Portal and edit your entry
|
* Go to Application Portal and edit your entry
|
||||||
* Click on "custom headers" tab and click the dropdon on the "Create" button
|
* Click on "custom headers" tab and click the dropdon on the "Create" button
|
||||||
* Select "Websocket". This will automaticly add the required headers for websocket to this reverse proxy.
|
* Select "Websocket". This will automatically add the required headers for websocket to this reverse proxy.
|
||||||
* Click "OK". Home Assistant should work now with the reverse proxy.
|
* Click "OK". Home Assistant should work now with the reverse proxy.
|
||||||
|
|
||||||
It's not necessary anymore to change the template anymore since Version DSM 6.2.1. Changing the `Portal.mustache` is not recommended! You should use the following part only if you're using a Version before DSM 6.2.1. on your Synology.
|
It's not necessary anymore to change the template anymore since Version DSM 6.2.1. Changing the `Portal.mustache` is not recommended! You should use the following part only if you're using a Version before DSM 6.2.1. on your Synology.
|
||||||
|
@ -24,7 +24,7 @@ hass --open-ui
|
|||||||
Running these commands will:
|
Running these commands will:
|
||||||
|
|
||||||
- Install Home Assistant
|
- Install Home Assistant
|
||||||
- Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123)
|
- Launch Home Assistant and serve the web interface on `http://localhost:8123`
|
||||||
- the configuration files will be created in /home/{user}/.homeassistant
|
- the configuration files will be created in /home/{user}/.homeassistant
|
||||||
|
|
||||||
|
|
||||||
|
@ -52,22 +52,23 @@ You will need to enable the software collection each time you log on before you
|
|||||||
|
|
||||||
### Systemd with Software Collections
|
### Systemd with Software Collections
|
||||||
|
|
||||||
To autostart Home Assistant using systemd follow the main [instructions](/docs/autostart/systemd/) and adjust the template as follows:
|
To autostart Home Assistant using systemd and a python36 (from SCL) virtual environment, follow the main [instructions](/docs/autostart/systemd/) and adjust the template as follows:
|
||||||
|
|
||||||
|
Filename: `/etc/systemd/system/home-assistant@homeassistant.service`
|
||||||
```txt
|
```txt
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=Home Assistant
|
Description=Home Assistant
|
||||||
After=network.target
|
After=network-online.target
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=simple
|
Type=simple
|
||||||
User=homeassistant
|
# %i means the username is derrived from the filename.
|
||||||
# Make sure the virtualenv Python binary is used
|
User=%i
|
||||||
Environment=VIRTUAL_ENV="/srv/homeassistant"
|
# a python venv for hass exists in /opt/hass/venv
|
||||||
Environment=PATH="$VIRTUAL_ENV/bin:$PATH"
|
ExecStart=/srv/homeassistant/bin/hass
|
||||||
# ExecStart using software collection:
|
|
||||||
ExecStart=/usr/bin/scl enable rh-python36 -- /srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant"
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This works because the Python virtual environment was created using the SCL environment, thus there is no need to activate SCL.
|
||||||
|
@ -36,7 +36,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host,
|
|||||||
$ docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable
|
$ docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
|
Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
@ -51,11 +51,11 @@ netsh interface portproxy add v4tov4 listenaddress=192.168.1.10 listenport=8123
|
|||||||
netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 connectaddress=10.0.50.2 connectport=8123
|
netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 connectaddress=10.0.50.2 connectport=8123
|
||||||
```
|
```
|
||||||
|
|
||||||
This will let you access your Home Assistant portal from <http://localhost:8123>, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container.
|
This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container.
|
||||||
|
|
||||||
### Synology NAS
|
### Synology NAS
|
||||||
|
|
||||||
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/app_packages/Docker>
|
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/packages/Docker>
|
||||||
|
|
||||||
The steps would be:
|
The steps would be:
|
||||||
* Install "Docker" package on your Synology NAS
|
* Install "Docker" package on your Synology NAS
|
||||||
|
@ -25,13 +25,6 @@ pip3 install --upgrade pip
|
|||||||
pip3 install --upgrade virtualenv
|
pip3 install --upgrade virtualenv
|
||||||
```
|
```
|
||||||
|
|
||||||
Create the configuration directory:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mkdir -p /usr/local/homeassistant
|
|
||||||
chown -R homeassistant:homeassistant /usr/local/homeassistant
|
|
||||||
```
|
|
||||||
|
|
||||||
Create the installation directory:
|
Create the installation directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -100,7 +93,7 @@ vi /usr/local/etc/rc.d/homeassistant
|
|||||||
# empty string as this will cause the daemon to run with group wheel.
|
# empty string as this will cause the daemon to run with group wheel.
|
||||||
# Default: homeassistant
|
# Default: homeassistant
|
||||||
# homeassistant_config_dir: Directory where config files are located.
|
# homeassistant_config_dir: Directory where config files are located.
|
||||||
# Default: /usr/home/homeassistant/.homeassistant
|
# Default: /home/homeassistant/.homeassistant
|
||||||
# homeassistant_install_dir: Directory where Home Assistant is installed.
|
# homeassistant_install_dir: Directory where Home Assistant is installed.
|
||||||
# Default: /usr/local/share/homeassistant
|
# Default: /usr/local/share/homeassistant
|
||||||
#
|
#
|
||||||
@ -118,7 +111,7 @@ load_rc_config ${name}
|
|||||||
: ${homeassistant_enable:="NO"}
|
: ${homeassistant_enable:="NO"}
|
||||||
: ${homeassistant_user:="homeassistant"}
|
: ${homeassistant_user:="homeassistant"}
|
||||||
: ${homeassistant_group:="homeassistant"}
|
: ${homeassistant_group:="homeassistant"}
|
||||||
: ${homeassistant_config_dir:="/usr/home/homeassistant/.homeassistant"}
|
: ${homeassistant_config_dir:="/home/homeassistant/.homeassistant"}
|
||||||
: ${homeassistant_install_dir:="/usr/local/share/homeassistant"}
|
: ${homeassistant_install_dir:="/usr/local/share/homeassistant"}
|
||||||
|
|
||||||
command="/usr/sbin/daemon"
|
command="/usr/sbin/daemon"
|
||||||
|
@ -13,7 +13,7 @@ One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2,
|
|||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
|
|
||||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable since some were only designed to provide just enough power to the device it was designed for by the manufacturer. **Do not** try to power the Pi from the USB port on a TV, computer, or similar.
|
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/documentation/faqs/#pi-power) with your Pi. Mobile chargers may not be suitable since some were only designed to provide just enough power to the device it was designed for by the manufacturer. **Do not** try to power the Pi from the USB port on a TV, computer, or similar.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ Additional information is available in this [video](https://www.youtube.com/watc
|
|||||||
|
|
||||||
After initial boot an installer will run in the background, this will download and install the newest version of [hassbian-config](https://github.com/home-assistant/hassbian-scripts) and Home-Assistant, this takes around 10 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
After initial boot an installer will run in the background, this will download and install the newest version of [hassbian-config](https://github.com/home-assistant/hassbian-scripts) and Home-Assistant, this takes around 10 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
||||||
|
|
||||||
Open a browser on a device that's connected to the same network as your Raspberry Pi and point it to Home Assistant at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
Open a browser on a device that's connected to the same network as your Raspberry Pi and point it to Home Assistant at `http://hassbian.local:8123`. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
||||||
|
|
||||||
If you find that the web page is not reachable after 30 minutes or so, check that you have files in `/home/homeassistant/.homeassistant/`, if there are no files in this location then run the installer manually using this command: `sudo systemctl start install_homeassistant.service`.
|
If you find that the web page is not reachable after 30 minutes or so, check that you have files in `/home/homeassistant/.homeassistant/`, if there are no files in this location then run the installer manually using this command: `sudo systemctl start install_homeassistant.service`.
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ Although these installation steps specifically mention a Raspberry Pi, you can g
|
|||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
|
|
||||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used.
|
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/documentation/faqs/#pi-power) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -84,7 +84,7 @@ Start Home Assistant for the first time. This will complete the installation for
|
|||||||
```bash
|
```bash
|
||||||
(homeassistant) $ hass
|
(homeassistant) $ hass
|
||||||
```
|
```
|
||||||
You can now reach your installation on your Raspberry Pi over the web interface on [http://ipaddress:8123](http://ipaddress:8123).
|
You can now reach your installation on your Raspberry Pi over the web interface on `http://ipaddress:8123`.
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
|
@ -22,7 +22,7 @@ The following configuration has been tested on Synology 413j running DSM 6.0-732
|
|||||||
Running these commands will:
|
Running these commands will:
|
||||||
|
|
||||||
- Install Home Assistant
|
- Install Home Assistant
|
||||||
- Enable Home Assistant to be launched on [http://localhost:8123](http://localhost:8123)
|
- Enable Home Assistant to be launched on `http://localhost:8123`
|
||||||
|
|
||||||
Using the Synology webadmin:
|
Using the Synology webadmin:
|
||||||
|
|
||||||
|
@ -20,38 +20,30 @@ The MQTT integration will register the service `mqtt.publish` which allows publi
|
|||||||
You need to include either payload or payload_template, but not both.
|
You need to include either payload or payload_template, but not both.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
topic: home-assistant/light/1/command
|
||||||
"topic": "home-assistant/light/1/command",
|
payload: on
|
||||||
"payload": "on"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```json
|
```yaml
|
||||||
{
|
topic: home-assistant/light/1/state
|
||||||
"topic": "home-assistant/light/1/state",
|
payload_template: {{ states('device_tracker.paulus') }}
|
||||||
"payload_template": "{{ states('device_tracker.paulus') }}"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
`payload` must be a string. If you want to send JSON then you need to format/escape it properly. Like:
|
`payload` must be a string. If you want to send JSON then you need to format/escape it properly. Like:
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
topic: home-assistant/light/1/state
|
||||||
"topic": "home-assistant/light/1/state",
|
payload: "{\"Status\":\"off\", \"Data\":\"something\"}"
|
||||||
"payload":"{\"Status\":\"off\", \"Data\":\"something\"}"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Example of how to use `qos` and `retain`:
|
Example of how to use `qos` and `retain`:
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
topic: home-assistant/light/1/command
|
||||||
"topic": "home-assistant/light/1/command",
|
payload: on
|
||||||
"payload": "on",
|
qos: 2
|
||||||
"qos": 2,
|
retain: true
|
||||||
"retain": true
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
@ -21,7 +21,7 @@ See the [open ports](/docs/security/porosity/) of a Hass.io instance with variou
|
|||||||
|
|
||||||
## HTTP SSL/TLS
|
## HTTP SSL/TLS
|
||||||
|
|
||||||
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibilty**, this is configurable in the [`http` integration](/integrations/http/).
|
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibility**, this is configurable in the [`http` integration](/integrations/http/).
|
||||||
|
|
||||||
## SSH
|
## SSH
|
||||||
|
|
||||||
|
@ -30,22 +30,21 @@ The list of services in the “Service” drop down are automatically populated
|
|||||||
|
|
||||||
When a Service is selected, and if that service requires an `entity_id` to be passed, the “Entity” drop down will automatically be populated with corresponding entities.
|
When a Service is selected, and if that service requires an `entity_id` to be passed, the “Entity” drop down will automatically be populated with corresponding entities.
|
||||||
|
|
||||||
A Service may also require additional input to be passed. It is commonly referred to as “service data”. The service data is only accepted in the JSON format, and it may be optional depending on the service.
|
A Service may also require additional input to be passed. It is commonly referred to as “service data”. The service data is accepted in YAML format, and it may be optional depending on the service.
|
||||||
|
|
||||||
When an entity is selected from the Entity drop down, it automatically populates service data with the corresponding `entity_id`. The service data JSON can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
|
When an entity is selected from the Entity drop down, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
|
||||||
|
|
||||||
To turn on a light bulb, use the following steps:
|
To turn on a light bulb, use the following steps:
|
||||||
1. Select `light.turn_on` from the Service drop down
|
1. Select `light.turn_on` from the Service drop down
|
||||||
2. Select the entity (typically the light bulb) from the Entity drop down (if no entity_id is selected, it turns on ALL lights)
|
2. Select the entity (typically the light bulb) from the Entity drop down (if no entity_id is selected, it turns on ALL lights)
|
||||||
3. If an entity is selected, the service data is populated with basic JSON that will be passed to the service. An additional data can also be passed by updating the JSON as below.
|
3. If an entity is selected, the service data is populated with basic JSON that will be passed to the service. An additional data can also be passed by updating the JSON as below.
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
entity_id: light.bedroom
|
||||||
"entity_id": "light.bedroom",
|
brightness: 255
|
||||||
"brightness": 255,
|
rgb_color: [255, 0, 0]
|
||||||
"rgb_color": [255, 0, 0]
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## States
|
## States
|
||||||
|
|
||||||
This section shows all the available entities, their corresponding state and the attribute values. The state and the attribute information is what Home Assistant sees at run time. To update the entity with a new state, or a new attribute value, click on the entity, scroll to the top, and modify the values, and click on “SET STATE” button.
|
This section shows all the available entities, their corresponding state and the attribute values. The state and the attribute information is what Home Assistant sees at run time. To update the entity with a new state, or a new attribute value, click on the entity, scroll to the top, and modify the values, and click on “SET STATE” button.
|
||||||
@ -60,11 +59,12 @@ This Events section is as basic as it can get. It does only one thing – fires
|
|||||||
To fire an event, simply type the name of the event, and pass the event data in JSON format.
|
To fire an event, simply type the name of the event, and pass the event data in JSON format.
|
||||||
For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as
|
For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{ "state":"on" }
|
state: on
|
||||||
```
|
```
|
||||||
|
|
||||||
If there is an automation that handles that event, it will be automatically triggered. See below:
|
If there is an automation that handles that event, it will be automatically triggered. See below:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- alias: Capture Event
|
- alias: Capture Event
|
||||||
trigger:
|
trigger:
|
||||||
@ -86,19 +86,16 @@ It is a good practice to test the template code in the template editor prior to
|
|||||||
|
|
||||||
For more information about jinja2, visit [jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/)
|
For more information about jinja2, visit [jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/)
|
||||||
|
|
||||||
|
|
||||||
## MQTT
|
## MQTT
|
||||||
|
|
||||||
This section is only visible if the MQTT integration is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/integrations/mqtt/) component.
|
This section is only visible if the MQTT integration is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/integrations/mqtt/) component.
|
||||||
|
|
||||||
Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button.
|
Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button.
|
||||||
|
|
||||||
|
|
||||||
## Logs
|
## Logs
|
||||||
|
|
||||||
This section displays `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs.
|
This section displays `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs.
|
||||||
|
|
||||||
|
|
||||||
## Info
|
## Info
|
||||||
|
|
||||||
The Information tab simply provides information about the current installed version, [system health](/integrations/system_health/) (if enabled), additional links and credits.
|
The Information tab simply provides information about the current installed version, [system health](/integrations/system_health/) (if enabled), additional links and credits.
|
||||||
|
@ -69,6 +69,10 @@ After defining your network key, follow these steps to add (include) a secure Z-
|
|||||||
3. Activate your device to be included by following the instructions provided with the device
|
3. Activate your device to be included by following the instructions provided with the device
|
||||||
4. With the device in its final location, run a *Heal Network*
|
4. With the device in its final location, run a *Heal Network*
|
||||||
|
|
||||||
|
<div class='note warning'>
|
||||||
|
Secure devices require additional bandwidth, and too many secure devices can slow down your Z-Wave network. We recommend only using secure inclusion for devices that require it, such as locks.
|
||||||
|
</div>
|
||||||
|
|
||||||
## Removing Devices
|
## Removing Devices
|
||||||
|
|
||||||
To remove (exclude) a Z-Wave device from your system:
|
To remove (exclude) a Z-Wave device from your system:
|
||||||
|
@ -195,7 +195,7 @@ Triple tap on|2|4
|
|||||||
|
|
||||||
Many Zooz Zen26/27 switches that have been sold do not have firmware 2.0+. Contact Zooz to obtain the over the air firmware update instructions and new user manual for the switches.
|
Many Zooz Zen26/27 switches that have been sold do not have firmware 2.0+. Contact Zooz to obtain the over the air firmware update instructions and new user manual for the switches.
|
||||||
|
|
||||||
Once the firmware is updated, the the new configuration paramters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options (depending on your model of switch):
|
Once the firmware is updated, the the new configuration parameters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options (depending on your model of switch):
|
||||||
|
|
||||||
Zen26 (On/Off Switch):
|
Zen26 (On/Off Switch):
|
||||||
```xml
|
```xml
|
||||||
@ -329,7 +329,7 @@ For Zooz switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CE
|
|||||||
</CommandClass>
|
</CommandClass>
|
||||||
```
|
```
|
||||||
|
|
||||||
Go to the Z-Wave Network Management section in the Home Assistant Configuration, select the node which has just been updated and enable the scene support configuration paramter.
|
Go to the Z-Wave Network Management section in the Home Assistant Configuration, select the node which has just been updated and enable the scene support configuration parameter.
|
||||||
|
|
||||||
Once this is complete, you should see the following `zwave.scene_activated` events:
|
Once this is complete, you should see the following `zwave.scene_activated` events:
|
||||||
|
|
||||||
|
@ -1,20 +1,19 @@
|
|||||||
/*
|
/*
|
||||||
Cache-Control: public, max-age: 0, s-max-age=3600, must-revalidate
|
Cache-Control: public, max-age: 0, s-maxage=3600, must-revalidate
|
||||||
Content-Security-Policy: form-action https:
|
Content-Security-Policy: form-action https:
|
||||||
Feature-Policy: vibrate 'none'; geolocation 'none'; midi 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; speaker 'none'; vibrate 'none'; payment 'none'
|
Feature-Policy: vibrate 'none'; geolocation 'none'; midi 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; speaker 'none'; vibrate 'none'; payment 'none'
|
||||||
Referrer-Policy: strict-origin-when-cross-origin
|
Referrer-Policy: no-referrer-when-downgrade
|
||||||
X-Content-Type-Options: nosniff
|
X-Content-Type-Options: nosniff
|
||||||
X-Frame-Options: DENY
|
|
||||||
X-XSS-Protection: 1; mode=block
|
X-XSS-Protection: 1; mode=block
|
||||||
/*.css
|
/*.css
|
||||||
Cache-Control: public, max-age: 604800, s-max-age=604800
|
Cache-Control: public, max-age: 604800, s-maxage=604800
|
||||||
/*.js
|
/*.js
|
||||||
Cache-Control: public, max-age: 604800, s-max-age=604800
|
Cache-Control: public, max-age: 604800, s-maxage=604800
|
||||||
/assets/*
|
/assets/*
|
||||||
Cache-Control: public, max-age: 0, s-max-age=604800, must-revalidate
|
Cache-Control: public, max-age: 0, s-maxage=604800, must-revalidate
|
||||||
/fonts/*
|
/fonts/*
|
||||||
Cache-Control: public, max-age: 1800, s-max-age=604800, must-revalidate
|
Cache-Control: public, max-age: 1800, s-maxage=604800, must-revalidate
|
||||||
/images/*
|
/images/*
|
||||||
Cache-Control: public, max-age: 1800, s-max-age=604800, must-revalidate
|
Cache-Control: public, max-age: 1800, s-maxage=604800, must-revalidate
|
||||||
/static/*
|
/static/*
|
||||||
Cache-Control: public, max-age: 1800, s-max-age=604800, must-revalidate
|
Cache-Control: public, max-age: 1800, s-maxage=604800, must-revalidate
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="icons">
|
<div class="icons">
|
||||||
<a rel="me" href='https://twitter.com/home_assistant' title="Twitter"><i class="icon-twitter"></i></a>
|
<a rel="me" href='https://twitter.com/home_assistant' title="Twitter"><i class="icon-twitter"></i></a>
|
||||||
<a rel="me" href='https://facebook.com/homeassistantio' title="Facebook"><i class="icon-facebook"></i></a>
|
<a rel="me" href='https://www.facebook.com/homeassistantio' title="Facebook"><i class="icon-facebook"></i></a>
|
||||||
<a rel="me" href='https://github.com/home-assistant/home-assistant' title="GitHub"><i class="icon-github"></i></a>
|
<a rel="me" href='https://github.com/home-assistant/home-assistant' title="GitHub"><i class="icon-github"></i></a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -26,7 +26,7 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class='grid__item one-third lap-one-half palm-one-whole'>
|
<div class='grid__item one-third lap-one-half palm-one-whole'>
|
||||||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the
|
Website powered by <a href='https://jekyllrb.com/'>Jekyll</a> and the
|
||||||
<a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.
|
<a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.
|
||||||
Hosted by <a href='https://www.netlify.com/'>Netlify</a>.
|
Hosted by <a href='https://www.netlify.com/'>Netlify</a>.
|
||||||
</div>
|
</div>
|
||||||
|
@ -10,7 +10,7 @@ ha_release: 0.95
|
|||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental
|
AdGuard Home is a network-wide ad- and tracker-blocking DNS server with parental
|
||||||
control (adult content blocking) capabilities. The `adguard` integration allows
|
control (adult content blocking) capabilities. The `adguard` integration allows
|
||||||
you to control and monitor your AdGuard Home instance in Home Assistant.
|
you to control and monitor your AdGuard Home instance in Home Assistant.
|
||||||
|
|
||||||
@ -19,7 +19,7 @@ you to control and monitor your AdGuard Home instance in Home Assistant.
|
|||||||
Menu: **Configuration** -> **Integrations**.
|
Menu: **Configuration** -> **Integrations**.
|
||||||
|
|
||||||
Click on the `+` sign to add an integration and click on **AdGuard Home**.
|
Click on the `+` sign to add an integration and click on **AdGuard Home**.
|
||||||
Follow the configuration flow, after finishing, the AdGuard Home
|
After completing the configuration flow, the AdGuard Home
|
||||||
integration will be available.
|
integration will be available.
|
||||||
|
|
||||||
## Sensors
|
## Sensors
|
||||||
@ -49,8 +49,8 @@ The integration will create a number of switches:
|
|||||||
These switches allow you to automate things easily. For example, one could
|
These switches allow you to automate things easily. For example, one could
|
||||||
write an automation to turn off Safe Search after the kids' bedtime.
|
write an automation to turn off Safe Search after the kids' bedtime.
|
||||||
|
|
||||||
The "AdGuard Protection" switch, is a master switch. It will turn off and
|
The "AdGuard Protection" switch is a master switch. It will turn off and
|
||||||
bypass all AdGuard feature, regardless if they are switched on or not.
|
bypass all AdGuard features, regardless of whether they are switched on or not.
|
||||||
|
|
||||||
<div class="note">
|
<div class="note">
|
||||||
Turning off Query Log will result in all sensors not receiving updates anymore.
|
Turning off Query Log will result in all sensors not receiving updates anymore.
|
||||||
@ -63,8 +63,8 @@ These services allow one to manage filter subscriptions in AdGuard Home.
|
|||||||
Using these services in automations could be helpful to block certain
|
Using these services in automations could be helpful to block certain
|
||||||
sites/domains at certain times.
|
sites/domains at certain times.
|
||||||
|
|
||||||
For example, you could create a custom filter list blocking social media sites,
|
For example, you could create a custom filter list that blocks social media sites
|
||||||
during the day and release them during the evening, using a simple automation.
|
during the day and releases them during the evening.
|
||||||
|
|
||||||
### Service `add_url`
|
### Service `add_url`
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ Amazon provides a Smart Home API for richer home automation control. It takes
|
|||||||
considerable effort to configure. The easy solution is to use
|
considerable effort to configure. The easy solution is to use
|
||||||
[Home Assistant Cloud](/integrations/cloud/).
|
[Home Assistant Cloud](/integrations/cloud/).
|
||||||
|
|
||||||
However, config Amazon Alexa Smart Home Skill is not a easy job, you have to allow
|
However, config Amazon Alexa Smart Home Skill is not an easy job, you have to allow
|
||||||
your Home Assistant accessible from Internet, and you need to create Amazon Developer
|
your Home Assistant accessible from Internet, and you need to create Amazon Developer
|
||||||
account and an Amazon Web Service account.
|
account and an Amazon Web Service account.
|
||||||
|
|
||||||
@ -168,7 +168,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
|
|||||||
* `Access Token URI`: https://[YOUR HOME ASSISTANT URL:PORT]/auth/token
|
* `Access Token URI`: https://[YOUR HOME ASSISTANT URL:PORT]/auth/token
|
||||||
* `Client ID`:
|
* `Client ID`:
|
||||||
- https://pitangui.amazon.com/ if you are in US
|
- https://pitangui.amazon.com/ if you are in US
|
||||||
- https://layla.amazon.com/ if you are in EU
|
- https://layla.amazon.co.uk/ if you are in EU
|
||||||
- https://alexa.amazon.co.jp/ if you are in JP and AU (not verified yet)
|
- https://alexa.amazon.co.jp/ if you are in JP and AU (not verified yet)
|
||||||
|
|
||||||
The trailing slash is important here.
|
The trailing slash is important here.
|
||||||
|
@ -202,4 +202,4 @@ camera:
|
|||||||
|
|
||||||
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
|
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
|
||||||
|
|
||||||
You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json
|
You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json`
|
||||||
|
@ -56,7 +56,7 @@ power_on_enabled:
|
|||||||
|
|
||||||
When you set **power_on_enabled** as True, you have to turn on your TV on the first time with the remote.
|
When you set **power_on_enabled** as True, you have to turn on your TV on the first time with the remote.
|
||||||
Then you will be able to turn on with Home Assistant.
|
Then you will be able to turn on with Home Assistant.
|
||||||
Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on when you turn off the TV and your TV could consumes more power.
|
Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on when you turn off the TV and your TV could consume more power.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ binary_sensor:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
resource:
|
resource:
|
||||||
description: IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10.
|
description: IP address and schema of the device that is exposing an aREST API, e.g., `http://192.168.1.10`.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
pin:
|
pin:
|
||||||
@ -46,7 +46,7 @@ name:
|
|||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as `return_value`.
|
Accessing the URL `http://IP_ADDRESS/digital/PIN_NUMBER` should give you the state of the pin inside a JSON response as `return_value`.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ curl -X GET http://192.168.0.5/digital/9
|
$ curl -X GET http://192.168.0.5/digital/9
|
||||||
@ -89,7 +89,7 @@ sensor:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
resource:
|
resource:
|
||||||
description: "IP address and schema of the device that is exposing an aREST API, e.g., https://192.168.1.10."
|
description: "IP address and schema of the device that is exposing an aREST API, e.g., `https://192.168.1.10`."
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
@ -145,7 +145,7 @@ monitored_variables:
|
|||||||
|
|
||||||
The variables in the `monitored_variables` array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. [Ethernet](https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino) for an Arduino with Ethernet shield). In those sketches are two variables (`temperature` and `humidity`) available which will act as endpoints.
|
The variables in the `monitored_variables` array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. [Ethernet](https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino) for an Arduino with Ethernet shield). In those sketches are two variables (`temperature` and `humidity`) available which will act as endpoints.
|
||||||
|
|
||||||
Accessing one of the endpoints (eg. http://192.168.1.10/temperature) will give you the value inside a JSON response.
|
Accessing one of the endpoints (eg. `http://192.168.1.10/temperature`) will give you the value inside a JSON response.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}
|
{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}
|
||||||
@ -165,7 +165,7 @@ The root will give you a JSON response that contains all variables and their cur
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
`return_value` contains the sensor's data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/).
|
`return_value` contains the sensor's data in a JSON response for a given pin (eg. `http://192.168.1.10/analog/2/` or `http://192.168.1.10/digital/7/`).
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
|
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
|
||||||
|
@ -34,7 +34,7 @@ password:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
host:
|
host:
|
||||||
description: The ip-address of the server that is running the Asterisk PBX
|
description: The IP-address of the server that is running the Asterisk PBX
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
port:
|
port:
|
||||||
|
@ -11,8 +11,6 @@ ha_release: 0.7
|
|||||||
Please see the [docs section](/docs/automation/) for in-depth
|
Please see the [docs section](/docs/automation/) for in-depth
|
||||||
documentation on how to use the automation component.
|
documentation on how to use the automation component.
|
||||||
|
|
||||||
Starting with 0.28 your automation rules can be controlled with the frontend.
|
|
||||||
|
|
||||||
<p class='img'>
|
<p class='img'>
|
||||||
<img src='{{site_root}}/images/screenshots/automation-switches.png' />
|
<img src='{{site_root}}/images/screenshots/automation-switches.png' />
|
||||||
</p>
|
</p>
|
||||||
@ -33,3 +31,12 @@ automation:
|
|||||||
- platform: state
|
- platform: state
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
automation:
|
||||||
|
```
|
||||||
|
@ -72,7 +72,7 @@ region_name:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
credential_name:
|
credential_name:
|
||||||
description: A reference to a `aws` credential. Notify platform will use the `default profile` defined in `~/.aws` if none of `credential_name`, `aws_access_key_id`, or `profile_name` was given.
|
description: A reference to an `aws` credential. Notify platform will use the `default profile` defined in `~/.aws` if none of `credential_name`, `aws_access_key_id`, or `profile_name` was given.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
aws_access_key_id:
|
aws_access_key_id:
|
||||||
|
@ -238,7 +238,7 @@ binary_sensor:
|
|||||||
|
|
||||||
### Device Tracker sensor with Latitude and Longitude Attributes
|
### Device Tracker sensor with Latitude and Longitude Attributes
|
||||||
|
|
||||||
This example shows how to combine an non-GPS (e.g. NMAP) and GPS device tracker while still including latitude and longitude attributes
|
This example shows how to combine a non-GPS (e.g. NMAP) and GPS device tracker while still including latitude and longitude attributes
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -204,8 +204,8 @@ sensor:
|
|||||||
To get the station ID for any BOM station:
|
To get the station ID for any BOM station:
|
||||||
- Find your station on these maps: [NSW](http://www.bom.gov.au/nsw/observations/map.shtml), [QLD](http://www.bom.gov.au/qld/observations/map.shtml), [VIC](http://www.bom.gov.au/vic/observations/map.shtml), [WA](http://www.bom.gov.au/wa/observations/map.shtml), [SA](http://www.bom.gov.au/sa/observations/map.shtml), [TAS](http://www.bom.gov.au/tas/observations/map.shtml), [ACT](http://www.bom.gov.au/act/observations/canberramap.shtml), [NT](http://www.bom.gov.au/nt/observations/map.shtml).
|
- Find your station on these maps: [NSW](http://www.bom.gov.au/nsw/observations/map.shtml), [QLD](http://www.bom.gov.au/qld/observations/map.shtml), [VIC](http://www.bom.gov.au/vic/observations/map.shtml), [WA](http://www.bom.gov.au/wa/observations/map.shtml), [SA](http://www.bom.gov.au/sa/observations/map.shtml), [TAS](http://www.bom.gov.au/tas/observations/map.shtml), [ACT](http://www.bom.gov.au/act/observations/canberramap.shtml), [NT](http://www.bom.gov.au/nt/observations/map.shtml).
|
||||||
- alternatively, from the [BOM website](http://www.bom.gov.au/), navigate to State -> Observations -> Latest Observations -> Choose the station.
|
- alternatively, from the [BOM website](http://www.bom.gov.au/), navigate to State -> Observations -> Latest Observations -> Choose the station.
|
||||||
- The URL will look like: http://www.bom.gov.au/products/IDx60801/[station].shtml
|
- The URL will look like `http://www.bom.gov.au/products/IDx60801/[station].shtml`
|
||||||
- For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`.
|
- For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`.
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
station:
|
station:
|
||||||
|
@ -113,5 +113,5 @@ version of the name will be used as the name of the entity.
|
|||||||
With the default of "Buienradar loop" the entity name becomes
|
With the default of "Buienradar loop" the entity name becomes
|
||||||
`camera.buienradar_loop`.
|
`camera.buienradar_loop`.
|
||||||
|
|
||||||
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
|
_[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
|
||||||
> Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission.
|
Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission._
|
||||||
|
@ -23,13 +23,13 @@ Generate a Client ID and Client Secret on
|
|||||||
|
|
||||||
1. Follow the wizard using the following information.
|
1. Follow the wizard using the following information.
|
||||||
1. When it gets to the point of asking _Which API are you using?_ just click cancel.
|
1. When it gets to the point of asking _Which API are you using?_ just click cancel.
|
||||||
1. Under APIs & Services > Credentials, click on the tab 'OAuth consent screen'.
|
1. Under APIs & Services (left sidebar) > Credentials, click on the tab 'OAuth consent screen'.
|
||||||
1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest "Home-Assistant".
|
1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest "Home-Assistant".
|
||||||
1. Save this page. You don't have to fill out anything else there.
|
1. Save this page. You don't have to fill out anything else there.
|
||||||
1. Click 'Create credentials' -> OAuth client ID.
|
1. Under APIs & Services > Credentials, click 'Create credentials' > OAuth client ID.
|
||||||
1. Set the Application type to 'Other' and give this credential set a name then click Create.
|
1. Set the Application type to 'Other' and give this credential set a name then click 'Create'.
|
||||||
1. Copy the client ID and secret to a text editor temporarily as you will need to put these in your `configuration.yaml` file.
|
1. Copy the client ID and secret to a text editor temporarily as you will need to put these in your `configuration.yaml` file.
|
||||||
1. Under "API's and Services" (left sidebar), click on "Library." Search for "Google Calendar API" and enable it if it isn't already enabled automatically through this process.
|
1. Under APIs and Services > Library, search for "Google Calendar API" and enable it if it isn't already enabled automatically through this process.
|
||||||
|
|
||||||
If you will be adding more scopes than just the "Google Calendar API" to the OAuth for this application, you will need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google.
|
If you will be adding more scopes than just the "Google Calendar API" to the OAuth for this application, you will need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google.
|
||||||
|
|
||||||
|
@ -134,8 +134,6 @@ Turn on camera. Not all camera models support this service, please consult indiv
|
|||||||
|
|
||||||
A simple way to test if you have set up your `camera` platform correctly, is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
|
A simple way to test if you have set up your `camera` platform correctly, is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
entity_id: camera.living_room_camera
|
||||||
"entity_id": "camera.living_room_camera"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
@ -13,7 +13,7 @@ You can enable the Cast integration by going to the Integrations page inside the
|
|||||||
|
|
||||||
## Home Assistant Cast
|
## Home Assistant Cast
|
||||||
|
|
||||||
Home Assistant has its own Cast application to show the Home Assistant UI. You can load it on your Chromecast by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI or by using the `cast.show_lovelace_ui` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on.
|
Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI, or by calling the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -22,19 +22,6 @@ Home Assistant has its own Cast application to show the Home Assistant UI. You c
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Home Assistant Cast
|
|
||||||
|
|
||||||
The Cast integration allows you to start Home Assistant Cast on any Chromecast device, using the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"entity_id": "media_player.office_display_4",
|
|
||||||
"view_path": "lights"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Advanced use
|
|
||||||
|
|
||||||
Note that Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `base_url` for [the `http` integration](/integrations/http/).
|
Note that Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `base_url` for [the `http` integration](/integrations/http/).
|
||||||
|
|
||||||
## Advanced use
|
## Advanced use
|
||||||
|
@ -10,6 +10,10 @@ ha_iot_class: Cloud Push
|
|||||||
|
|
||||||
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa and Google Assistant. [Learn more.](/cloud)
|
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa and Google Assistant. [Learn more.](/cloud)
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry to enable the cloud component
|
# Example configuration.yaml entry to enable the cloud component
|
||||||
cloud:
|
cloud:
|
||||||
|
@ -8,7 +8,7 @@ ha_category:
|
|||||||
ha_release: 0.48
|
ha_release: 0.48
|
||||||
---
|
---
|
||||||
|
|
||||||
The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st)
|
The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-tr)/[Q450](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-tr)/[Q600](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st)
|
||||||
ventilation units from Home Assistant. You need a [ComfoConnect LAN C](http://www.zehnder.co.uk/products-and-systems/comfortable-indoor-ventilation/ms-comfoair-q/ideal-control#node-21233)
|
ventilation units from Home Assistant. You need a [ComfoConnect LAN C](http://www.zehnder.co.uk/products-and-systems/comfortable-indoor-ventilation/ms-comfoair-q/ideal-control#node-21233)
|
||||||
bridge to connect the unit to your local network.
|
bridge to connect the unit to your local network.
|
||||||
|
|
||||||
|
@ -43,7 +43,7 @@ code:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
mode:
|
mode:
|
||||||
description: audible/silent if defined, specifies wether Alarm Panel should be audible or silent when armed in Home Mode.
|
description: audible/silent if defined, specifies whether Alarm Panel should be audible or silent when armed in Home Mode.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
default: audible
|
default: audible
|
||||||
|
@ -10,7 +10,7 @@ ha_qa_scale: internal
|
|||||||
|
|
||||||
The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant.
|
The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant.
|
||||||
|
|
||||||
To enable the configuration panel, add the following to your `configuration.yaml` file:
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -23,7 +23,7 @@ cover:
|
|||||||
automatic_add: true
|
automatic_add: true
|
||||||
```
|
```
|
||||||
|
|
||||||
Launch your homeassistant and go the website (e.g http://localhost:8123). Push your remote and your device should be added.
|
Launch your homeassistant and go the website (e.g `http://localhost:8123`). Push your remote and your device should be added.
|
||||||
|
|
||||||
Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend. Then you should update your configuration to:
|
Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend. Then you should update your configuration to:
|
||||||
|
|
||||||
|
@ -126,6 +126,7 @@ Currently supported devices as device triggers:
|
|||||||
|
|
||||||
- Hue Dimmer Remote
|
- Hue Dimmer Remote
|
||||||
- Hue Tap
|
- Hue Tap
|
||||||
|
- Symfonisk Sound Controller
|
||||||
- Trådfri On/Off Switch
|
- Trådfri On/Off Switch
|
||||||
- Trådfri Open/Close Remote
|
- Trådfri Open/Close Remote
|
||||||
- Trådfri Remote Control
|
- Trådfri Remote Control
|
||||||
@ -382,15 +383,18 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define
|
|||||||
|
|
||||||
### Verified supported lights
|
### Verified supported lights
|
||||||
|
|
||||||
- IKEA Trådfri bulb E14 WS opal 400lm
|
- IKEA Trådfri bulb E14 WS Opal 400lm
|
||||||
- IKEA Trådfri Bulb E27 WS Opal 980lm
|
- IKEA Trådfri Bulb E27 WS Opal 980lm
|
||||||
- IKEA Trådfri Bulb E27 WS Opal 1000lm
|
- IKEA Trådfri Bulb E27 WS Opal 1000lm
|
||||||
|
- IKEA Trådfri Bulb E27 WS & RGB Opal 600lm
|
||||||
- IKEA Trådfri Bulb GU10 W 400lm
|
- IKEA Trådfri Bulb GU10 W 400lm
|
||||||
|
- IKEA Trådfri FLOALT LED light panel
|
||||||
- OSRAM Flex RGBW
|
- OSRAM Flex RGBW
|
||||||
- OSRAM Gardenpole RGBW
|
- OSRAM Gardenpole RGBW
|
||||||
- Philips Hue White A19
|
- Philips Hue White A19
|
||||||
- Philips Hue White Ambiance A19
|
- Philips Hue White Ambiance A19
|
||||||
- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013
|
- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013
|
||||||
|
- Philips Hue LightStrip Plus
|
||||||
- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84
|
- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84
|
||||||
- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM
|
- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM
|
||||||
|
|
||||||
@ -465,5 +469,6 @@ The `entity_id` name will be `switch.device_name`, where `device_name` is define
|
|||||||
### Verified supported switches
|
### Verified supported switches
|
||||||
|
|
||||||
- Innr SP120
|
- Innr SP120
|
||||||
|
- Osram Lightify plug
|
||||||
- Osram Outdoor plug
|
- Osram Outdoor plug
|
||||||
- Heiman siren
|
- Heiman siren
|
||||||
|
@ -15,17 +15,17 @@ Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with
|
|||||||
|
|
||||||
Using Dialogflow will be easy to create conversations like:
|
Using Dialogflow will be easy to create conversations like:
|
||||||
|
|
||||||
> User: What is the temperature at home?
|
_User: What is the temperature at home?_
|
||||||
>
|
|
||||||
> Bot: The temperature is 34 degrees
|
|
||||||
|
|
||||||
> User: Turn on the light
|
_Bot: The temperature is 34 degrees_
|
||||||
>
|
|
||||||
> Bot: In which room?
|
_User: Turn on the light_
|
||||||
>
|
|
||||||
> User: In the kitchen
|
_Bot: In which room?_
|
||||||
>
|
|
||||||
> Bot: Turning on kitchen light
|
_User: In the kitchen_
|
||||||
|
|
||||||
|
_Bot: Turning on kitchen light_
|
||||||
|
|
||||||
To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute.
|
To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute.
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ logo: discogs.png
|
|||||||
ha_iot_class: Cloud Polling
|
ha_iot_class: Cloud Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection.
|
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
@ -84,3 +84,5 @@ You can tag any user inside a channel by using their user ID in the message like
|
|||||||
For more information about creating and authorizing bots, visit the [OAuth2 information page](https://discordapp.com/developers/docs/topics/oauth2)
|
For more information about creating and authorizing bots, visit the [OAuth2 information page](https://discordapp.com/developers/docs/topics/oauth2)
|
||||||
|
|
||||||
To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/).
|
To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
|
||||||
|
Images are uploaded to Discord when a message is sent. As such, a local path to the image is required (i.e. `/config/www/garage.jpg` as opposed to `/local/garage.jpg`), and updating an image after sending it in a message will not update the message in Discord.
|
||||||
|
@ -23,6 +23,7 @@ The configuration loosely follows the tensorflow configuration. To enable this p
|
|||||||
image_processing:
|
image_processing:
|
||||||
- platform: doods
|
- platform: doods
|
||||||
url: "http://<my doods server>:8080"
|
url: "http://<my doods server>:8080"
|
||||||
|
detector: default
|
||||||
source:
|
source:
|
||||||
- entity_id: camera.front_yard
|
- entity_id: camera.front_yard
|
||||||
```
|
```
|
||||||
@ -47,7 +48,7 @@ url:
|
|||||||
type: string
|
type: string
|
||||||
detector:
|
detector:
|
||||||
description: The DOODS detector to use
|
description: The DOODS detector to use
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
confidence:
|
confidence:
|
||||||
description: The default confidence for any detected objects where not explicitly set
|
description: The default confidence for any detected objects where not explicitly set
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: "Ecobee"
|
title: "Ecobee"
|
||||||
description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant."
|
description: "Instructions for how to integrate ecobee thermostats and sensors within Home Assistant."
|
||||||
logo: ecobee.png
|
logo: ecobee.png
|
||||||
ha_category:
|
ha_category:
|
||||||
- Sensor
|
- Sensor
|
||||||
@ -13,11 +13,11 @@ ha_release: 0.9
|
|||||||
ha_iot_class: Cloud Poll
|
ha_iot_class: Cloud Poll
|
||||||
---
|
---
|
||||||
|
|
||||||
The `ecobee` integration lets you control thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats and remote sensors.
|
The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||||
|
|
||||||
## Preliminary Step
|
## Preliminary Step
|
||||||
|
|
||||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, first, you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that, perform the following steps.
|
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, your thermostat must be registered on ecobee's website (which you likely would have already done while installing your thermostat). Once you have done that, perform the following steps.
|
||||||
|
|
||||||
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
|
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
|
||||||
2. Log in with your ecobee credentials.
|
2. Log in with your ecobee credentials.
|
||||||
@ -25,7 +25,7 @@ You will need to obtain an API key from ecobee's [developer site](https://www.ec
|
|||||||
4. Fill in the fields.
|
4. Fill in the fields.
|
||||||
5. Click **save**.
|
5. Click **save**.
|
||||||
|
|
||||||
Now login to the regular consumer portal and in the hamburger menu, there will be a new option **Developer**. Now we can create an Application to link to Home Assistant.
|
Log in to the regular consumer portal, and click the overflow menu button in the upper right. You will see a new option named **Developer**. Now we can create the Application to hook up to Home Assistant.
|
||||||
|
|
||||||
1. Select the **Developer** option from the hamburger menu.
|
1. Select the **Developer** option from the hamburger menu.
|
||||||
2. Select **Create New**.
|
2. Select **Create New**.
|
||||||
@ -34,15 +34,15 @@ Now login to the regular consumer portal and in the hamburger menu, there will b
|
|||||||
5. You don't need an Application Icon or Detailed Description.
|
5. You don't need an Application Icon or Detailed Description.
|
||||||
6. Click **Create**.
|
6. Click **Create**.
|
||||||
|
|
||||||
Now under the Name and Summary Section, you will have an API key. Copy this key as you will need it in the steps that follow. Click the **X** to close the Developer section.
|
Under the Name and Summary Section, you will now have an API key. Copy this key and use it in your configuration section below. Click the **X** to close the Developer section.
|
||||||
|
|
||||||
## Configuring the Integration
|
## Configuring the Integration
|
||||||
|
|
||||||
To configure the ecobee integration in Home Assistant, you can either use the **Configuration** -> **Integrations** menu, or add an entry to `configuration.yaml`.
|
To configure the ecobee integration in Home Assistant, you can either use the **Configuration** > **Integrations** menu, or add an entry to `configuration.yaml`.
|
||||||
|
|
||||||
### Setup via the Integrations menu
|
### Setup via the Integrations menu
|
||||||
|
|
||||||
1. In the **Configuration** -> **Integrations** menu, click **+** and then select `ecobee` from the pop-up menu.
|
1. In the **Configuration** > **Integrations** menu, click **+** and then select `ecobee` from the pop-up menu.
|
||||||
2. In the pop-up box, enter the API key you obtained from ecobee.com.
|
2. In the pop-up box, enter the API key you obtained from ecobee.com.
|
||||||
3. In the next pop-up box, you will be presented with a unique four-character PIN code which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, and clicking **Validate** and then **Add Application** in the bottom right.
|
3. In the next pop-up box, you will be presented with a unique four-character PIN code which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, and clicking **Validate** and then **Add Application** in the bottom right.
|
||||||
4. After authorizing the App on ecobee.com, return to Home Assistant and hit **Submit**. If the authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant.
|
4. After authorizing the App on ecobee.com, return to Home Assistant and hit **Submit**. If the authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant.
|
||||||
@ -57,11 +57,9 @@ ecobee:
|
|||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
```
|
```
|
||||||
|
|
||||||
[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. In the **Configuration** -> **Integrations** menu, hit **Configure** next to the discovered `ecobee` entry, and continue to authorize the App per the Integration menu instructions above.
|
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
api_key:
|
api_key:
|
||||||
description: Your ecobee API key. This is only needed for the initial setup of the integration. Once registered it can be removed. If you revoke the key in the ecobee portal, you will need to remove the existing `ecobee` configuration in the **Integrations** menu, update this, and then configure the Integration again.
|
description: Your ecobee API key. This is only needed for the initial setup of the integration. Once registered it can be removed. If you revoke the key in the ecobee portal, you will need to remove the existing `ecobee` configuration in the **Integrations** menu, update this, and then configure the integration again.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
@ -71,9 +69,19 @@ api_key:
|
|||||||
<img src='{{site_root}}/images/screenshots/ecobee-thermostat-card.png' />
|
<img src='{{site_root}}/images/screenshots/ecobee-thermostat-card.png' />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. In the **Configuration** > **Integrations** menu, hit **Configure** next to the discovered `ecobee` entry, and continue to authorize the App per the Integration menu instructions above.
|
||||||
|
|
||||||
|
The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
|
||||||
|
|
||||||
|
The PIN can be found in the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in the States developer tool.
|
||||||
|
|
||||||
|
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this, you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant.
|
||||||
|
|
||||||
|
Once you enter the PIN on the ecobee site, wait approximately 5 minutes, and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view.
|
||||||
|
|
||||||
## Notifications
|
## Notifications
|
||||||
|
|
||||||
To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can set up this integration to send messages to your Ecobee device.
|
To get your ecobee notifications working with Home Assistant, you must first have the main ecobee integration loaded and running. Once you have that configured, you can set up this integration to send messages to your ecobee device.
|
||||||
|
|
||||||
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
|
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -98,7 +106,7 @@ To use notifications, please see the [getting started with automation page](/get
|
|||||||
|
|
||||||
### Concepts
|
### Concepts
|
||||||
|
|
||||||
The Ecobee Thermostat supports the following key concepts.
|
The ecobee thermostat supports the following key concepts.
|
||||||
|
|
||||||
The _target temperature_ is the temperature that the device attempts
|
The _target temperature_ is the temperature that the device attempts
|
||||||
to achieve. The target temperature is either determined by the
|
to achieve. The target temperature is either determined by the
|
||||||
@ -113,7 +121,7 @@ limits).
|
|||||||
|
|
||||||
A _climate_ is a predefined or user-defined set of presets that the
|
A _climate_ is a predefined or user-defined set of presets that the
|
||||||
thermostat aims to achieve. The ecobee thermostat provides three predefined
|
thermostat aims to achieve. The ecobee thermostat provides three predefined
|
||||||
climates: Home, Away, and Sleep. The user can define additional climates.
|
climates: Home, Away, and Sleep. Ecobee refers to these as _comfort settings_. The user can define additional climates.
|
||||||
|
|
||||||
A _preset_ is an override of the target temperature defined in the
|
A _preset_ is an override of the target temperature defined in the
|
||||||
currently active climate. The temperature targeted in the preset mode may be
|
currently active climate. The temperature targeted in the preset mode may be
|
||||||
@ -122,30 +130,30 @@ climate (home, away, sleep, etc.), or it may be derived from a vacation
|
|||||||
defined by the thermostat. All holds are temporary. Temperature and
|
defined by the thermostat. All holds are temporary. Temperature and
|
||||||
climate holds expire when the thermostat transitions to the next climate
|
climate holds expire when the thermostat transitions to the next climate
|
||||||
defined in its program. A vacation hold starts at the beginning of the
|
defined in its program. A vacation hold starts at the beginning of the
|
||||||
defined vacation period, and expires when the vacation period ends.
|
defined vacation period and expires when the vacation period ends.
|
||||||
|
|
||||||
When in _away preset_, the target temperature is permanently overridden by
|
When in _away preset_, the target temperature is permanently overridden by
|
||||||
the target temperature defined for the away climate. The away preset is a
|
the target temperature defined for the away climate. The away preset is a
|
||||||
simple way to emulate a vacation mode.
|
simple way to emulate a vacation mode.
|
||||||
|
|
||||||
The _HVAC mode_ of the device is the currently active operational
|
The _HVAC mode_ of the device is the currently active operational
|
||||||
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
|
modes that the ecobee thermostat provides: heat, auxHeatOnly, cool,
|
||||||
auto, and off.
|
auto, and off.
|
||||||
|
|
||||||
## Attributes
|
## Attributes
|
||||||
|
|
||||||
The Ecobee climate entity has some extra attributes to represent the state of the thermostat.
|
The ecobee climate entity has some extra attributes to represent the state of the thermostat.
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| ------------------- | ------------------------------------------------------------------------------------- |
|
| ---- | ----------- |
|
||||||
| `fan` | If the fan is currently on or off: `on` / `off`. |
|
| `fan` | If the fan is currently on or off: `on` / `off`.
|
||||||
| `climate_mode` | This is the climate mode that is active, or would be active if no override is active. |
|
| `climate_mode` | This is the climate mode that is active, or would be active if no override is active.
|
||||||
| `equipment_running` | This is a comma seperated list of equipment that is currently running. |
|
| `equipment_running` | This is a comma-separated list of equipment that is currently running.
|
||||||
| `fan_min_on_time` | The minimum amount of minutes that the fan will be on when it's turned on. |
|
| `fan_min_on_time` | The minimum amount of time (in minutes) that the fan will run per hour. This is determined by the minimum fan runtime setting which can be changed in the ecobee app or on the thermostat itself.
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
Besides the standard services provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra services are provided by the Ecobee integration:
|
Besides the standard services provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra services are provided by the ecobee integration:
|
||||||
|
|
||||||
- `ecobee.create_vacation`
|
- `ecobee.create_vacation`
|
||||||
- `ecobee.delete_vacation`
|
- `ecobee.delete_vacation`
|
||||||
@ -159,13 +167,13 @@ Creates a vacation on the selected ecobee thermostat.
|
|||||||
| Service data attribute | Optional | Description |
|
| Service data attribute | Optional | Description |
|
||||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `entity_id` | no | ecobee thermostat on which to create the vacation |
|
| `entity_id` | no | ecobee thermostat on which to create the vacation |
|
||||||
| `vacation_name` | no | Name of the vacation to create; must be unique on the thermostat |
|
| `vacation_name` | no | Name of the vacation to create. Must be unique on the thermostat |
|
||||||
| `cool_temp` | no | Cooling temperature during the vacation |
|
| `cool_temp` | no | Cooling temperature during the vacation |
|
||||||
| `heat_temp` | no | Heating temperature during the vacation |
|
| `heat_temp` | no | Heating temperature during the vacation |
|
||||||
| `start_date` | yes | Date the vacation starts in YYYY-MM-DD format |
|
| `start_date` | yes | Date the vacation starts in YYYY-MM-DD format |
|
||||||
| `start_time` | yes | Time the vacation starts, in the local time of the thermostat, in the 24-hour format HH:MM:SS |
|
| `start_time` | yes | Time the vacation starts in the local time zone. Must be in 24-hour format (HH:MM:SS) |
|
||||||
| `end_date` | yes | Date the vacation ends in YYYY-MM-DD format (14 days from now if not provided) |
|
| `end_date` | yes | Date the vacation ends in YYYY-MM-DD format (14 days from now if not provided) |
|
||||||
| `end_time` | yes | Time the vacation ends, in the local time of the thermostat, in the 24-hour format HH:MM:SS |
|
| `end_time` | yes | Time the vacation ends in the local time zone. Must be in 24-hour format (HH:MM:SS) |
|
||||||
| `fan_mode` | yes | Fan mode of the thermostat during the vacation (auto or on) (auto if not provided) |
|
| `fan_mode` | yes | Fan mode of the thermostat during the vacation (auto or on) (auto if not provided) |
|
||||||
| `fan_min_on_time` | yes | Minimum number of minutes to run the fan each hour (0 to 60) during the vacation (0 if not provided) |
|
| `fan_min_on_time` | yes | Minimum number of minutes to run the fan each hour (0 to 60) during the vacation (0 if not provided) |
|
||||||
|
|
||||||
@ -189,7 +197,7 @@ Resumes the currently active schedule.
|
|||||||
|
|
||||||
### Service `ecobee.set_fan_min_on_time`
|
### Service `ecobee.set_fan_min_on_time`
|
||||||
|
|
||||||
Sets the minimum amount of time that the fan will run.
|
Sets the minimum amount of time that the fan will run per hour.
|
||||||
|
|
||||||
| Service data attribute | Optional | Description |
|
| Service data attribute | Optional | Description |
|
||||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
@ -23,7 +23,7 @@ Windows is not supported because Home Assistant uses `ProactorEventLoop` which d
|
|||||||
|
|
||||||
This integration opens an unauthenticated API on the host, allowing anything on the local network to access
|
This integration opens an unauthenticated API on the host, allowing anything on the local network to access
|
||||||
your Home Assistant instance through the automations you create with emulated Roku as the trigger.
|
your Home Assistant instance through the automations you create with emulated Roku as the trigger.
|
||||||
Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)
|
Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's IP or DNS name)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -9,8 +9,8 @@ ha_iot_class: Cloud Polling
|
|||||||
---
|
---
|
||||||
|
|
||||||
The `flunearyou` sensor platform allows users in the United States and its
|
The `flunearyou` sensor platform allows users in the United States and its
|
||||||
territories to get information regarding reported flu symptoms from Flu Near
|
territories to get information regarding reported flu symptoms from [Flu Near
|
||||||
You. The platform can return user-reported information as well reports from the
|
You](https://flunearyou.org/). The platform can return user-reported information as well reports from the
|
||||||
Center for Disease Control (CDC).
|
Center for Disease Control (CDC).
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -41,7 +41,7 @@ automatic_add:
|
|||||||
default: false
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
devices:
|
devices:
|
||||||
description: A list of devices with their ip address.
|
description: A list of devices with their IP address.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
|
@ -43,7 +43,7 @@ The following statistics will be exposed as attributes.
|
|||||||
|is_linked |True if the FritzBox is physically linked to the provider |
|
|is_linked |True if the FritzBox is physically linked to the provider |
|
||||||
|is_connected |True if the FritzBox has established an internet-connection |
|
|is_connected |True if the FritzBox has established an internet-connection |
|
||||||
|wan_access_type |Connection-type, can be `DSL` or `Cable` |
|
|wan_access_type |Connection-type, can be `DSL` or `Cable` |
|
||||||
|external_ip |External ip address |
|
|external_ip |External IP address |
|
||||||
|uptime |Uptime in seconds |
|
|uptime |Uptime in seconds |
|
||||||
|bytes_sent |Bytes sent |
|
|bytes_sent |Bytes sent |
|
||||||
|bytes_received |Bytes received |
|
|bytes_received |Bytes received |
|
||||||
|
@ -8,7 +8,7 @@ ha_qa_scale: internal
|
|||||||
ha_release: 0.7
|
ha_release: 0.7
|
||||||
---
|
---
|
||||||
|
|
||||||
This offers the official frontend to control Home Assistant.
|
This offers the official frontend to control Home Assistant. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -25,11 +25,11 @@ camera:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
still_image_url:
|
still_image_url:
|
||||||
description: "The URL your camera serves the image on, e.g., http://192.168.1.21:2112/. Can be a [template](/topics/templating/)."
|
description: "The URL your camera serves the image on, e.g., `http://192.168.1.21:2112/`. Can be a [template](/topics/templating/)."
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
stream_source:
|
stream_source:
|
||||||
description: "The URL your camera serves the live stream on, e.g., rtsp://192.168.1.21:554/."
|
description: "The URL your camera serves the live stream on, e.g., `rtsp://192.168.1.21:554/`."
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
|
@ -64,27 +64,26 @@ You need to create an API Key with the [Google Cloud API Console](https://consol
|
|||||||
|
|
||||||
1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
|
1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
|
||||||
1. Add/Import a project and give it a name.
|
1. Add/Import a project and give it a name.
|
||||||
2. Click on the `Home Control` card, select the `Smart home` recommendation.
|
2. Click on the `Smart Home` card, select the `Smart home` recommendation.
|
||||||
3. Click `Build your Action`, select `Add Action(s)`, and click `Add your first action`. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable.
|
3. Click `Build your Action`, select `Add Action(s)`. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant` in the `Fulfillment URL` box, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable.
|
||||||
4. Click `Done`. Then click on `Overview`, which will lead you back to the app details screen.
|
4. Click `Save`. Then click on `Overview`, which will lead you back to the app details screen.
|
||||||
2. `Account linking` is required for your app to interact with Home Assistant. Set this up under the `Quick Setup` section.
|
2. `Account linking` is required for your app to interact with Home Assistant. Set this up under the `Quick Setup` section.
|
||||||
1. Leave it at the default `No, I only want to allow account creation on my website` and select Next.
|
1. Leave it at the default `No, I only want to allow account creation on my website` and select `Next`.
|
||||||
2. For the `Linking type` select `OAuth` and `Authorization Code`.
|
2. For the `Linking type` select `OAuth` and `Authorization Code`. Click `Next`
|
||||||
3. Client ID: `https://oauth-redirect.googleusercontent.com/`, the trailing slash is important.
|
3. Client ID: `https://oauth-redirect.googleusercontent.com/`, the trailing slash is important.
|
||||||
4. Client Secret: Anything you like, Home Assistant doesn't need this field.
|
4. Client Secret: Anything you like, Home Assistant doesn't need this field.
|
||||||
5. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/authorize`.
|
5. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/authorize`.
|
||||||
6. Token URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/token`.
|
6. Token URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/token`. Click `Next`
|
||||||
7. Configure your client: Type `email` and click `Add scope`, then type `name` and click `Add scope` again.
|
7. Configure your client: Type `email` and click `Add scope`, then type `name` and click `Add scope` again.
|
||||||
8. Do **NOT** check `Google to transmit clientID and secret via HTTP basic auth header`.
|
8. Do **NOT** check `Google to transmit clientID and secret via HTTP basic auth header`. Click `Next`
|
||||||
9. Testing instructions: Enter anything. It doesn't matter since you won't submit this app.
|
9. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. Click `Save`
|
||||||
|
|
||||||
<img src='/images/integrations/google_assistant/accountlinking.png' alt='Screenshot: Account linking'>
|
<img src='/images/integrations/google_assistant/accountlinking.png' alt='Screenshot: Account linking'>
|
||||||
3. Under `Build your Action` click `Add Action(s)`.
|
|
||||||
1. Under `Fulfillment` fill in this URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`.
|
3. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App.
|
||||||
4. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App.
|
4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below.
|
||||||
5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below.
|
5. Open the Google Home app and goto `Account` most right icon.
|
||||||
6. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`.
|
6. Click `+ Set up or add`, `+ Set up device`, 'New devices', choose your home and click `Next` click `Have something...`you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.
|
||||||
7. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.
|
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
@ -242,7 +241,7 @@ Here are the modes that are currently available:
|
|||||||
|
|
||||||
### Troubleshooting the request_sync service
|
### Troubleshooting the request_sync service
|
||||||
|
|
||||||
The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443) from Home Control and relink.
|
The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlenest/answer/7126338) from Home Control and relink.
|
||||||
|
|
||||||
The request_sync service may fail with a 404 if the project_id of the Homegraph API differs from the project_id of the Actions SDK found in the preferences of your project on [Actions on Google console](https://console.actions.google.com). Resolve this by:
|
The request_sync service may fail with a 404 if the project_id of the Homegraph API differs from the project_id of the Actions SDK found in the preferences of your project on [Actions on Google console](https://console.actions.google.com). Resolve this by:
|
||||||
|
|
||||||
|
@ -10,14 +10,16 @@ ha_iot_class: Cloud Polling
|
|||||||
|
|
||||||
The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
|
The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
|
||||||
|
|
||||||
## Configuration
|
## Setup
|
||||||
|
|
||||||
You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s).
|
You first need to create an additional Google account and share your location with that account. This integration will use that account to fetch the location of your device(s).
|
||||||
|
|
||||||
1. You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
|
1. You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
|
||||||
2. You need to use the cookies from that account after you have properly authenticated which you can retrieve with either [Export cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies-txt/?src=search) for firefox (make sure that "Prefix HttpOnly cookies" is unchecked) or [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg?hl=en-US) for chrome.
|
2. You need to use the cookies from that account after you have properly authenticated which you can retrieve with either [Export cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies-txt/?src=search) for Firefox (make sure that "Prefix HttpOnly cookies" is unchecked) or [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg?hl=en-US) for Chrome/Chromium.
|
||||||
3. Save the cookie file to your Home Assistant configuration directory with the following name: `.google_maps_location_sharing.cookies.` followed by the slugified username of the NEW Google account.
|
3. Save the cookie file to your Home Assistant configuration directory with the following name: `.google_maps_location_sharing.cookies.` followed by the slugified username of the NEW Google account. Make sure to use the `.com` TLD (e.g., maps.google.com), otherwise the cookie won't be able to provide a valid session.
|
||||||
- For example: if your email was `location.tracker@gmail.com`, the filename would be: `.google_maps_location_sharing.cookies.location_tracker_gmail_com`.
|
- For example: If your email address was `location.tracker@gmail.com`, the filename would be: `.google_maps_location_sharing.cookies.location_tracker_gmail_com`.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
|
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -225,9 +225,9 @@ Reconnects the hangouts bot.
|
|||||||
|
|
||||||
## Advanced
|
## Advanced
|
||||||
|
|
||||||
### Automatic reconnect after ip change
|
### Automatic reconnect after IP change
|
||||||
|
|
||||||
The hangouts integration can't detect if your ip address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem.
|
The hangouts integration can't detect if your IP address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem.
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ The `here_travel_time` sensor provides travel time from the [HERE Routing API](h
|
|||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
You need to register for an API key by following the instructions [here](https://developer.here.com/documentation/routing/topics/introduction.html?create=Freemium-Basic&keepState=true&step=account).
|
You need to register for an API key (REST & XYZ HUB API/CLI) by following the instructions [here](https://developer.here.com/documentation/routing/topics/introduction.html?create=Freemium-Basic&keepState=true&step=account).
|
||||||
|
|
||||||
HERE offers a Freemium Plan which includes 250.000 free Transactions per month. For the Routing API, one transaction equals one request with one starting point (no multi stop). More information can be found [here](https://developer.here.com/faqs#payment-subscription)
|
HERE offers a Freemium Plan which includes 250.000 free Transactions per month. For the Routing API, one transaction equals one request with one starting point (no multi stop). More information can be found [here](https://developer.here.com/faqs#payment-subscription)
|
||||||
|
|
||||||
@ -74,7 +74,7 @@ name:
|
|||||||
type: string
|
type: string
|
||||||
default: "HERE Travel Time"
|
default: "HERE Travel Time"
|
||||||
mode:
|
mode:
|
||||||
description: "You can choose between: `bicycle`, `car`, `pedestrian`, `publicTransport`, `publicTransportTimeTable` or `truck`. The default is `car`. For public transport `publicTransportTimetable` is recommended. You can find more information on the modes [here](https://developer.here.com/documentation/routing/topics/transport-modes.html) and on the public modes [here](https://developer.here.com/documentation/routing/topics/public-transport-routing.html)"
|
description: "You can choose between: `bicycle`, `car`, `pedestrian`, `publicTransport`, `publicTransportTimeTable` or `truck`. The default is `car`. For public transport `publicTransportTimeTable` is recommended. You can find more information on the modes [here](https://developer.here.com/documentation/routing/topics/transport-modes.html) and on the public modes [here](https://developer.here.com/documentation/routing/topics/public-transport-routing.html)"
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
default: "car"
|
default: "car"
|
||||||
|
@ -14,8 +14,7 @@ component for storing the data and uses the same database setting.
|
|||||||
If any entities are excluded from being recorded,
|
If any entities are excluded from being recorded,
|
||||||
no history will be available for these entities.
|
no history will be available for these entities.
|
||||||
|
|
||||||
To enable the history option in your installation,
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Basic configuration.yaml entry
|
# Basic configuration.yaml entry
|
||||||
|
@ -188,6 +188,6 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
The `/dev-template` page of your home-assistant UI can help you check if the values for `start`, `end` or `duration` are correct. If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.
|
The `/developer-tools/template` page of your home-assistant UI can help you check if the values for `start`, `end` or `duration` are correct. If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
@ -16,7 +16,7 @@ ha_release: 0.68
|
|||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The [HomeKit](https://developer.apple.com/homekit/) controller integration allows you to use accessories with the "Works with HomeKit" logo with Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
|
The [HomeKit](https://developer.apple.com/homekit/) controller integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
|
||||||
|
|
||||||
The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) component.
|
The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) component.
|
||||||
|
|
||||||
@ -37,38 +37,44 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
|
|
||||||
HomeKit IP accessories for these device types may work with some caveats:
|
HomeKit IP accessories for these device types may work with some caveats:
|
||||||
|
|
||||||
- If the device is WiFi based and has no physical controls or screen then you may need an Apple HomeKit device like an iPhone or iPad to get the accessory onto your WiFi network. For example, for a Koogeek LS1 you must add the accessory to HomeKit on your iOS device, then remove it from the iOS device. This leaves the LS1 in an unpaired state but still on your WiFi. Then Home Assistant can find it and pair with it.
|
- If the device is WiFi based and has no physical controls or screen then you may need an Apple HomeKit device like an iPhone or iPad to get the accessory onto your WiFi network. For example, for a Koogeek LS1 you must add the accessory to HomeKit on your iOS device, then remove it from the iOS device. This leaves the LS1 in an unpaired state but still on your WiFi. Home Assistant can then find it and pair with it.
|
||||||
- You need to know the HomeKit PIN. There is no way to recover this if you do not have it. You will need to contact the manufacturer to see what options you have.
|
- You need to know the HomeKit PIN. There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have.
|
||||||
|
|
||||||
Home Assistant does not currently support HomeKit BLE.
|
Home Assistant does not currently support HomeKit BLE.
|
||||||
|
|
||||||
|
<div class='note'>
|
||||||
|
|
||||||
|
HomeKit Controller might detect some HomeKit devices on your network that are not currently supported by this integration. One such example is HomeKit displays (such as Vizio TVs which have been updated with HomeKit support). These devices might pair with Home Assistant if you go through the pairing process, but no entity will be created, and you won't be able to control these devices with Home Assistant. However, pairing the device with Home Assistant *will* remove the persistent notification generated when Home Assistant finds new devices.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### I don't have a HomeKit PIN
|
### I don't have a HomeKit PIN
|
||||||
|
|
||||||
When you buy a certified HomeKit enabled device the PIN maybe with the instructions or on a sticker on the side or under the accessory.
|
When you buy a certified HomeKit-enabled device, the PIN might be in the instructions or on a sticker on the accessory itself.
|
||||||
|
|
||||||
Devices with screens like thermostats may not have PIN codes in the packaging at all. Every time you click on "Configure" in the Home Assistant front end your accessory will generate a new pairing code and show it on the display.
|
Devices with screens like thermostats may not have PIN codes in the packaging at all. Every time you click on "Configure" in the Home Assistant frontend, your accessory will generate a new pairing code and show it on the display.
|
||||||
|
|
||||||
If your device doesn't have a display and got HomeKit support after it was released you may not have a pairing code. Dealing with this is manufacturer specific. Some manufacturers allow you to see the pairing code in their iOS app. Others force you to use their app to configure HomeKit and don't let you have the pairing pin - right now you won't be able to use HomeKit controller with those devices.
|
If your device doesn't have a display and received HomeKit support after it was released, you may not have a pairing code. Dealing with this is manufacturer specific. Some manufacturers allow you to see the pairing code in their iOS app. Others force you to use their app to configure HomeKit and don't let you have the pairing pin - right now you won't be able to use HomeKit Controller with those devices.
|
||||||
|
|
||||||
If you have lost your PIN code then you may not be able to repair your accessory. You should contact the manufacturer to see if there is anything you can do.
|
If you have lost your PIN code, then you may not be able to pair your accessory. You should contact the manufacturer to see if there is anything you can do.
|
||||||
|
|
||||||
### My accessory isn't updating straight away
|
### My accessory isn't updating straight away
|
||||||
|
|
||||||
This is normal - HomeKit controller is currently a local polling based integration. It polls your accessory for its latest state once a minute.
|
This is normal - HomeKit controller is currently a local polling based integration. It polls your accessory for its latest state once per minute.
|
||||||
|
|
||||||
### Home Assistant cannot discover my device
|
### Home Assistant cannot discover my device
|
||||||
|
|
||||||
For IP accessories, Home Assistant can only find devices that are already on the same network as your device. If an accessory is WiFi based and has no user interface for joining it to your Wifi network you will need an Apple HomeKit controller device (an iPhone or iPad). You should pair it with the controller and then remove the pairing in the UI (but do not reset the accessory itself). This will leave the accessory on your WiFi network but in an unpaired state, and then Home Assistant can find it.
|
For IP accessories, Home Assistant can only find devices that are already on the same network as your device. If an accessory is WiFi based and has no user interface for joining it to your Wifi network, you will need an Apple HomeKit controller device (an iPhone or iPad). You should pair it with the controller and then remove the pairing in the UI (but do not reset the accessory itself). This will leave the accessory on your WiFi network but in an unpaired state, and then Home Assistant can find it.
|
||||||
|
|
||||||
Home Assistant can only find accessories that aren't already paired. Even if you reset your Home Assistant configuration the accessory will still think it is paired and you won't be able to use it with Home Assistant. You should reset the accessory according to the manufacturer instructions. Some devices have a "Reset HomeKit" option, and some may require a full reset.
|
Home Assistant can only find accessories that aren't already paired. Even if you reset your Home Assistant configuration, the accessory will still think it is paired and you won't be able to use it with Home Assistant. You should reset the accessory according to the manufacturer's instructions. Some devices have a "Reset HomeKit" option, and some may require a full reset.
|
||||||
|
|
||||||
### HomeKit controller is finding devices on my network even though I don't have any Apple device
|
### HomeKit controller is finding devices on my network even though I don't have any Apple devices
|
||||||
|
|
||||||
This is completely normal. Unlike many other commercial IoT offerings the HomeKit protocol is a local and offline protocol that does not rely on the Apple ecosystem to function. You do not need an Apple online account to use a "Works with HomeKit" device. Some WiFi devices may need an iOS briefly to get them onto your WiFi but other than that you do not need any Apple hardware on your network either.
|
This is completely normal. Unlike many other commercial IoT offerings, the HomeKit protocol is a local and offline protocol that does not rely on the Apple ecosystem to function. You do not need an Apple online account to use a "Works with HomeKit" device. Some WiFi devices may need an iOS device briefly to get them onto your WiFi, but other than that you do not need any Apple hardware on your network.
|
||||||
|
|
||||||
Many IoT devices are getting a post-launch HomeKit upgrade. This might mean your device starts showing in Home Assistant as a `homekit_controller` device even though when you bought it without HomeKit support. If maybe this is a better choice for you than a native integration. For example, a lot of climate devices have an online-only API and a HomeKit API. The HomeKit one might not expose all of the settings and controls you are used to but won't break if your internet connection goes down or the cloud service goes away.
|
Many IoT devices are getting a post-launch HomeKit upgrade. This might mean your device starts showing in Home Assistant as a `homekit_controller` device even though when you bought it without HomeKit support. This might be a better choice for you than a native integration. For example, many climate devices have an online-only API and a HomeKit API. The HomeKit one might not expose all of the settings and controls you are used to, but it also won't break if your Internet connection goes down or the cloud service goes away.
|
||||||
|
|
||||||
### I have a warning in my logs about HomeKit controller skipping updates
|
### I have a warning in my logs about HomeKit controller skipping updates
|
||||||
|
|
||||||
@ -78,10 +84,10 @@ You may say a log entry that looks like this:
|
|||||||
HomeKit controller update skipped as previous poll still in flight
|
HomeKit controller update skipped as previous poll still in flight
|
||||||
```
|
```
|
||||||
|
|
||||||
In these cases it's unlikely that HomeKit controller itself is directly responsible. This is a safety feature to avoid overloading your HomeAssistant instance. It means that Home Assistant tried to poll your accessory but the previous poll was still happening. This means it is taking over 1 minute to poll your accessory. This could be caused by a number of things:
|
In these cases it's unlikely that HomeKit controller itself is directly responsible. This is a safety feature to avoid overloading your Home Assistant instance. It means that Home Assistant tried to poll your accessory but the previous poll was still happening. This means it is taking over 1 minute to poll your accessory. This could be caused by a number of things:
|
||||||
|
|
||||||
- You have too many blocking synchronous integrations for your Home Assistant instance. All synchronous integrations share a thread pool and if there are lots of tasks to run on it they will queued, causing delays. In the worst cases this queue can build up faster than it can be emptied. Faster hardware may help, but you may need to disable some integrations.
|
- You have too many blocking synchronous integrations for your Home Assistant instance. All synchronous integrations share a thread pool, and if there are lots of tasks to run on it they will queued, which will cause delays. In the worst cases this queue can build up faster than it can be emptied. Faster hardware may help, but you may need to disable some integrations.
|
||||||
- Your network connection to an accessory is poor and HomeKit controller is unable to reach the accessory reliably. This will likely require a change to your network setup to improve WiFi coverage or replace damaged cabling etc.
|
- Your network connection to an accessory is poor and HomeKit Controller is unable to reach the accessory reliably. This will likely require a change to your network setup to improve WiFi coverage or replace damaged cabling.
|
||||||
- There is a problem with the actual accessory and this may be causing intermittent network issues.
|
- There is a problem with the accessory itself which is causing intermittent network issues.
|
||||||
|
|
||||||
In these cases HomeKit controller will skip polling to avoid a build up of back pressure in your instance.
|
In these cases, HomeKit Controller will skip polling to avoid a buildup of back pressure in your instance.
|
||||||
|
@ -94,7 +94,7 @@ callback_ip:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
callback_port:
|
callback_port:
|
||||||
description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
|
description: Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.).
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
resolvenames:
|
resolvenames:
|
||||||
|
@ -8,7 +8,7 @@ ha_iot_class: Assumed State
|
|||||||
ha_release: 0.34
|
ha_release: 0.34
|
||||||
---
|
---
|
||||||
|
|
||||||
The `hook` integration allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant.
|
The `hook` integration allows you to control the Hook Smart Home Hub from within Home Assistant.
|
||||||
|
|
||||||
Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://amzn.to/2WVZdGG).
|
Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://amzn.to/2WVZdGG).
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ HTML5 push notifications **do not** work on iOS.
|
|||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
|
|
||||||
The GCM configuration option is deprecated and will stop working in April 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to delete `html5_push_registrations.conf` and [re-enable the notifications in your browser](#setting-up-your-browser).
|
The GCM configuration option is deprecated and stopped working in May 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to delete `html5_push_registrations.conf` and [re-enable the notifications in your browser](#setting-up-your-browser).
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -218,7 +218,7 @@ In this section you'll find some real-life examples of how to use this sensor, b
|
|||||||
|
|
||||||
#### Using Python request module
|
#### Using Python request module
|
||||||
|
|
||||||
As already shown on the [API](/developers/rest_api/) page, it's very simple to use Python and the [Requests](http://docs.python-requests.org/en/latest/) module for the interaction with Home Assistant.
|
As already shown on the [API](/developers/rest_api/) page, it's very simple to use Python and the [Requests](https://requests.kennethreitz.org//en/latest/) module for the interaction with Home Assistant.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
response = requests.post(
|
response = requests.post(
|
||||||
|
@ -11,18 +11,18 @@ featured: true
|
|||||||
ha_release: "0.60"
|
ha_release: "0.60"
|
||||||
---
|
---
|
||||||
|
|
||||||
Philips Hue support is integrated into Home Assistant as a Hub that can drive the light & sensor platforms. The preferred way to setup the Philips Hue platform is by enabling the [discovery component](/integrations/discovery/).
|
Philips Hue support is integrated into Home Assistant as a hub that can drive the light and sensor platforms. The preferred way to set up the Philips Hue platform is by enabling the [discovery component](/integrations/discovery/).
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
- Light
|
- Lights
|
||||||
- Motion sensors (including temperature & light level sensors)
|
- Motion sensors (including temperature and light level sensors)
|
||||||
|
|
||||||
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
|
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the States developer tool ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue bridge in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
|
||||||
|
|
||||||
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the Address of the Hue Bridge. If the IP address for the Hue Bridge changes, you will need to register the Hue Bridge with Home Assistant again. To avoid this you may set up DHCP registration for your Hue Bridge, so that it always has the same IP address.
|
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP address of the bridge. If the IP address for the bridge changes, you will need to register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your Hue bridge so that it always has the same IP address.
|
||||||
|
|
||||||
Once registration is complete you should see the Hue lights listed as `light` entities, Hue presence sensors listed as `binary_sensor` entites, Hue temperature and light level sensors listed as `sensor` entities. If you don't you may have to restart Home Assistant once more.
|
Once registration is complete you should see the Hue lights listed as `light` entities, the Hue motion sensors listed as `binary_sensor` entities, and the Hue temperature and light level sensors (which are built in to the motion sensors) listed as `sensor` entities. If you don't, you may have to restart Home Assistant once more.
|
||||||
|
|
||||||
If you want to enable the integration without relying on the [discovery component](/integrations/discovery/), add the following lines to your `configuration.yaml` file:
|
If you want to enable the integration without relying on the [discovery component](/integrations/discovery/), add the following lines to your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -35,7 +35,7 @@ hue:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
host:
|
host:
|
||||||
description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` integration to discover Hue bridges.
|
description: The IP address of the bridge (e.g., 192.168.1.10). Required if not using the `discovery` integration to discover Hue bridges.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
allow_unreachable:
|
allow_unreachable:
|
||||||
@ -44,7 +44,7 @@ allow_unreachable:
|
|||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
filename:
|
filename:
|
||||||
description: Make this unique if specifying multiple Hue hubs.
|
description: Make this unique if specifying multiple Hue bridges.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
allow_hue_groups:
|
allow_hue_groups:
|
||||||
@ -67,7 +67,7 @@ hue:
|
|||||||
|
|
||||||
### Multiple Hue bridges
|
### Multiple Hue bridges
|
||||||
|
|
||||||
Multiple Hue bridges work transparently with discovery, you don't have to do anything. If you prefer to configure them manually and use multiple Hue bridges then it's needed that you provide a configuration file for every bridge. The bridges can't share a single configuration file.
|
Multiple Hue bridges work transparently with discovery, so you don't have to do anything special to set them up. If you prefer to configure them manually and use multiple Hue bridges, then you need to provide a configuration file for every bridge. The bridges can't share a single configuration file.
|
||||||
|
|
||||||
Add `filename` to your Hue configuration entry in your `configuration.yaml` file:
|
Add `filename` to your Hue configuration entry in your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -83,23 +83,23 @@ hue:
|
|||||||
|
|
||||||
### Using Hue Groups in Home Assistant
|
### Using Hue Groups in Home Assistant
|
||||||
|
|
||||||
The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously.
|
The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously.
|
||||||
|
|
||||||
These Hue Groups can be a `Luminaire`, `Lightsource`, `LightGroup` or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API, or the mobile app. A bulb can only exist in one `Room`, but can exist in multiple `LightGroup`. The `LightGroup` can be useful to link certain bulbs together since.
|
These Hue groups can be a `Luminaire`, `Lightsource`, `LightGroup`, or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API or the mobile app. A bulb can only exist in one `Room`, but can exist in more than one `LightGroup`. The `LightGroup` can be useful if you want to link certain bulbs together.
|
||||||
|
|
||||||
The 2nd generation Hue app only allows to create a `Room`. You need to use the first generation app or the API to create a `LightGroup`.
|
The 2nd generation Hue app only has the ability to create a `Room`. You need to use the first generation app or the API to create a `LightGroup`.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
To create a `LightGroup` named `Ceiling lights` that contains the lights 1, 2 and 3, execute the following command:
|
To create a `LightGroup` named `Ceiling lights` that contains the lights 1, 2, and 3, execute the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http://<bridge>/api/<username>/groups
|
$ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http://<bridge>/api/<username>/groups
|
||||||
```
|
```
|
||||||
|
|
||||||
The `<username>` is the string that is used to register Home Assistant on the bridge, you can find it in the `core.config_entries` file in your configuration\.storage path. `<bridge>` is the IP address or hostname of your Hue bridge.
|
The `<username>` is the string that is used to register Home Assistant on the bridge. You can find it in the `core.config_entries` file in your configuration\.storage path. `<bridge>` is the IP address or hostname of your Hue bridge.
|
||||||
|
|
||||||
You can find out the ids of your lights by executing the following command:
|
You can find the IDs of your lights by executing the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ curl http://<bridge>/api/<username>/lights
|
$ curl http://<bridge>/api/<username>/lights
|
||||||
@ -108,17 +108,17 @@ $ curl http://<bridge>/api/<username>/lights
|
|||||||
Home Assistant will automatically detect your new `LightGroup` and add it to the interface.
|
Home Assistant will automatically detect your new `LightGroup` and add it to the interface.
|
||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
To support Hue Light Groups, your bridge needs to have at least firmware 1.13 (released on June 3, 2016).
|
To support Hue light groups, your bridge needs to have at least firmware 1.13 (released on June 3, 2016).
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website.
|
More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website.
|
||||||
|
|
||||||
### Using Hue Scenes in Home Assistant
|
### Using Hue Scenes in Home Assistant
|
||||||
|
|
||||||
The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named.
|
The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them—many that you've never used, and almost all very poorly named.
|
||||||
|
|
||||||
To avoid user interface overload we don't expose scenes directly. Instead there is a hue.hue_activate_scene service which can be used by `automation` or `script` components.
|
To avoid user interface overload, we don't expose scenes directly. Instead there is a hue.hue_activate_scene service which can be used by `automation` or `script` components.
|
||||||
This will have all the bulbs transitioned at once, instead of one at a time using standard scenes in Home Assistant.
|
This will have all the bulbs transitioned at once, instead of one at a time like when using standard scenes in Home Assistant.
|
||||||
|
|
||||||
For instance:
|
For instance:
|
||||||
|
|
||||||
@ -134,23 +134,23 @@ script:
|
|||||||
|
|
||||||
| Service data attribute | Optional | Description |
|
| Service data attribute | Optional | Description |
|
||||||
| ---------------------- | -------- | ----------- |
|
| ---------------------- | -------- | ----------- |
|
||||||
| `group_name` | no | The group/room name of the lights. Find this in the Hue official app.
|
| `group_name` | no | The group/room name of the lights. Find this in the official Hue app.
|
||||||
| `scene_name` | no | The name of the scene. Find this in the Hue official app.
|
| `scene_name` | no | The name of the scene. Find this in the official Hue app.
|
||||||
|
|
||||||
*Note*: `group_name` is not linked to Home Assistant group name.
|
*Note*: `group_name` is not a reference to a Home Assistant group name. It can only be the name of a group/room in the Hue app.
|
||||||
|
|
||||||
### Finding Group and Scene Names
|
### Finding Group and Scene Names
|
||||||
|
|
||||||
How do you find these names?
|
How do you find these names?
|
||||||
|
|
||||||
The easiest way to do this is only use the scenes from the 2nd generation Hue app. That is organized by room (group) and scene Name. Use the values of room name and scene name that you see in the app. You can test these work on the `dev-service` console of your Home Assistant instance.
|
The easiest way to do this is to only use the scenes from the 2nd generation Hue app, which is organized by room (group) and scene name. Use the values of room name and scene name that you see in the app. You can test that these work by using the `dev-service` console of your Home Assistant instance.
|
||||||
|
|
||||||
Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together but it's sufficient to get values that you can test in the `dev-service` console.
|
Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together, but it is sufficient to get values that you can test in the `dev-service` console.
|
||||||
|
|
||||||
### Caveats
|
### Caveats
|
||||||
|
|
||||||
The Hue API doesn't activate scenes directly, only on a Hue Group (typically rooms, especially if using the 2nd gen app). But Hue Scenes don't actually reference their group. So heuristic matching is used.
|
The Hue API doesn't activate scenes directly; rather, they must be associated with a Hue group (typically rooms, especially if using the 2nd gen app). But Hue scenes don't actually reference their group. So heuristic matching is used.
|
||||||
|
|
||||||
Neither group names or scene names are guaranteed unique in Hue. If you are getting non deterministic behavior, adjust your Hue scenes via the App to be more identifying.
|
Neither group names nor scene names are guaranteed unique in Hue. If you are observing unexpected behavior from calling Hue scenes in Home Assistant, make the names of your Hue scenes more specific in the Hue app.
|
||||||
|
|
||||||
The Hue hub has limited spaces for scenes, and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on "Least Recently Used".
|
The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on the scenes that are "least recently used."
|
||||||
|
@ -76,7 +76,7 @@ automation:
|
|||||||
effect: "Full color mood blobs"
|
effect: "Full color mood blobs"
|
||||||
```
|
```
|
||||||
|
|
||||||
To have the lights playing a effect when pausing, idle or turn off a media player like plex you can use this example:
|
To have the lights playing an effect when pausing, idle or turn off a media player like plex you can use this example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- alias: Set hyperion effect after playback
|
- alias: Set hyperion effect after playback
|
||||||
|
@ -31,20 +31,23 @@ For example, set the body of the IFTTT webhook to:
|
|||||||
|
|
||||||
You then need to consume that incoming information with the following automation:
|
You then need to consume that incoming information with the following automation:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
automation:
|
automation:
|
||||||
- id: this_is_the_automation_id
|
- id: this_is_the_automation_id
|
||||||
alias: The optional automation alias
|
alias: The optional automation alias
|
||||||
trigger:
|
trigger:
|
||||||
platform: event
|
- event_data:
|
||||||
event_type: ifttt_webhook_received
|
|
||||||
event_data:
|
|
||||||
action: call_service
|
action: call_service
|
||||||
|
event_type: ifttt_webhook_received
|
||||||
|
platform: event
|
||||||
|
condition: []
|
||||||
action:
|
action:
|
||||||
service_template: '{% raw %}{{ trigger.event.data.service }}{% endraw %}'
|
- data_template:
|
||||||
data_template:
|
entity_id: '{{ trigger.event.data.entity_id }}'
|
||||||
entity_id: '{% raw %}{{ trigger.event.data.entity_id }}{% endraw %}'
|
service_template: '{{ trigger.event.data.service }}'
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
## Sending events to IFTTT
|
## Sending events to IFTTT
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ ha_iot_class: Local Push
|
|||||||
---
|
---
|
||||||
|
|
||||||
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
|
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
|
||||||
The ISY994 controller is manufactured by [Universal Devices](https://www.universal-devices.com/residential/isy994i-series/).
|
The ISY994 controller is manufactured by [Universal Devices](https://www.universal-devices.com/smarthome).
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
@ -44,7 +44,7 @@ isy994:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
host:
|
host:
|
||||||
description: The host entry should be in full URL format, e.g., http://192.168.10.100:80
|
description: The host entry should be in full URL format, e.g., `http://192.168.10.100:80`
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
username:
|
username:
|
||||||
|
@ -33,7 +33,7 @@ These are the steps to take:
|
|||||||
3. Fill in the form. You can put almost anything in the fields, they just need to be populated:
|
3. Fill in the form. You can put almost anything in the fields, they just need to be populated:
|
||||||
* App Name: Home Assistant
|
* App Name: Home Assistant
|
||||||
* Description: Home Assistant
|
* Description: Home Assistant
|
||||||
* Privacy Policy: http://localhost/
|
* Privacy Policy: `http://localhost/`
|
||||||
* Check all permission boxes
|
* Check all permission boxes
|
||||||
* Hit Save
|
* Hit Save
|
||||||
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources), click on "Home Assistant", copy your client ID and client Secret and paste into the Home Assistant configuration block in the previous section.
|
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources), click on "Home Assistant", copy your client ID and client Secret and paste into the Home Assistant configuration block in the previous section.
|
||||||
|
@ -8,7 +8,7 @@ ha_iot_class: Configurable
|
|||||||
ha_release: 0.8
|
ha_release: 0.8
|
||||||
---
|
---
|
||||||
|
|
||||||
The `mqtt` light platform with lets you control your MQTT enabled lights through one of the supported message schemas.
|
The `mqtt` light platform lets you control your MQTT enabled lights through one of the supported message schemas.
|
||||||
|
|
||||||
## Comparison of light MQTT schemas
|
## Comparison of light MQTT schemas
|
||||||
|
|
||||||
|
@ -37,7 +37,7 @@ lightwave:
|
|||||||
name: Torch socket
|
name: Torch socket
|
||||||
```
|
```
|
||||||
|
|
||||||
Where `192.168.1.2` is the ip address of your Lightwave hub.
|
Where `192.168.1.2` is the IP address of your Lightwave hub.
|
||||||
Each `switch` or `light` requires an `id` and a `name`. The `id` takes the form `R#D#` where `R#` is the room number and `D#` is the device number.
|
Each `switch` or `light` requires an `id` and a `name`. The `id` takes the form `R#D#` where `R#` is the room number and `D#` is the device number.
|
||||||
|
|
||||||
`lights` and `switches` are optional but one of these must be present.
|
`lights` and `switches` are optional but one of these must be present.
|
||||||
|
@ -17,8 +17,7 @@ the `recorder` integration for storing the data. This means that if the
|
|||||||
PostgreSQL as data store, the `logbook` integration does not use the default
|
PostgreSQL as data store, the `logbook` integration does not use the default
|
||||||
SQLite database to store data.
|
SQLite database to store data.
|
||||||
|
|
||||||
To enable the logbook in your installation,
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -8,7 +8,7 @@ ha_qa_scale: internal
|
|||||||
ha_release: 0.56
|
ha_release: 0.56
|
||||||
---
|
---
|
||||||
|
|
||||||
This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/integrations/device_tracker/) documentation.
|
This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/integrations/device_tracker/) documentation. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -27,7 +27,7 @@ api_key:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
language:
|
language:
|
||||||
description: The language to use. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well. For the supported languages check the list of [available languages](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/integrations/microsoft/tts.py#L20).
|
description: The language to use. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well. For the supported languages check the list of [available languages](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/microsoft/tts.py#L20).
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
default: "`en-us`"
|
default: "`en-us`"
|
||||||
|
@ -25,7 +25,7 @@ camera:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
mjpeg_url:
|
mjpeg_url:
|
||||||
description: The URL your camera serves the video on, e.g., http://192.168.1.21:2112/
|
description: The URL your camera serves the video on, e.g., `http://192.168.1.21:2112/`
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
still_image_url:
|
still_image_url:
|
||||||
|
@ -16,8 +16,7 @@ If you are a mobile app developer, see the [developer documentation](https://dev
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
This integration is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration.
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
If that is the case, the following example shows you how to enable this integration manually:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -9,7 +9,7 @@ ha_release: 0.38
|
|||||||
ha_qa_scale: internal
|
ha_qa_scale: internal
|
||||||
---
|
---
|
||||||
|
|
||||||
The `moon` sensor platform is tracking the moon phases.
|
The `moon` integration is tracking the moon phases.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@ -23,3 +23,7 @@ sensor:
|
|||||||
|
|
||||||
This sensor will return one of the following values:
|
This sensor will return one of the following values:
|
||||||
`new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` .
|
`new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` .
|
||||||
|
|
||||||
|
<p class='img'>
|
||||||
|
<img src='/images/screenshots/more-info-dialog-moon.png' />
|
||||||
|
</p>
|
||||||
|
@ -39,14 +39,6 @@ token:
|
|||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
### Service `open`
|
|
||||||
|
|
||||||
This will unlatch the door, ie. open it (provided this works with your type of door).
|
|
||||||
|
|
||||||
| Service data attribute | Optional | Description |
|
|
||||||
| ---------------------- | -------- | ----------- |
|
|
||||||
| `entity_id` | yes | String or list of strings that point at `entity_id`s Nuki Locks.
|
|
||||||
|
|
||||||
### Service `lock_n_go`
|
### Service `lock_n_go`
|
||||||
|
|
||||||
This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app.
|
This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app.
|
||||||
|
@ -56,23 +56,23 @@ password:
|
|||||||
|
|
||||||
This component will create these sensors:
|
This component will create these sensors:
|
||||||
|
|
||||||
- `article_cache`: Number of cached articles.
|
- `nzbget_article_cache`: Article cache size in MB.
|
||||||
- `average_download_rate`: Average download rate
|
- `nzbget_average_speed`: Average download rate since server start in MB/s.
|
||||||
- `download_paused`: Paused downloads
|
- `nzbget_download_paused`: Whether downloading is paused.
|
||||||
- `download_rate`: Current download rate
|
- `nzbget_speed`: Current download rate in MB/s.
|
||||||
- `download_size`: The size to download
|
- `nzbget_queue_size`: Remaining size to download in MB.
|
||||||
- `free_disk_space`: Free disk space at the storage location of NZBGet
|
- `nzbget_disk_free`: Free disk space at the storage location of NZBGet.
|
||||||
- `post_paused`: Paused posts
|
- `nzbget_post_processing_paused`: Whether post processing is paused.
|
||||||
- `remaining_size`: Remaining size to download
|
- `nzbget_uptime`: NZBGet server uptime.
|
||||||
- `uptime`: Uptime of NZBGet
|
- `nzbget_size`: Amount of data downloaded since server start in MB.
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
Available services:
|
Available services:
|
||||||
|
|
||||||
- `pause`: Pause the download queue.
|
- `pause`: Pause the download queue.
|
||||||
- `resume`: Resume the download queue.
|
- `resume`: Resume the download queue.
|
||||||
- `set_speed`: Set the download queue speed limit.
|
- `set_speed`: Set the download queue speed limit.
|
||||||
|
|
||||||
### Service `nzbget/set_speed`
|
### Service `nzbget/set_speed`
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ You can manage persons via the UI from the person page inside the configuration
|
|||||||
|
|
||||||
## Configuring the `person` integration via the Home Assistant configuration panel
|
## Configuring the `person` integration via the Home Assistant configuration panel
|
||||||
|
|
||||||
If you prefer to use the configuration panel to configure the `person` integration simply add one line to your `configuration.yaml` file and restart Home Assistant.
|
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
person:
|
person:
|
||||||
@ -93,7 +93,7 @@ By following the instructions on the [customizing entities](/docs/configuration/
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
customize:
|
customize:
|
||||||
person.ada6789:
|
person.ada:
|
||||||
entity_picture: "/local/ada.jpg"
|
entity_picture: "/local/ada.jpg"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -34,10 +34,8 @@ hass.bus.fire(name, { "wow": "from a Python script!" })
|
|||||||
- Start Home Assistant
|
- Start Home Assistant
|
||||||
- Call service `python_script.hello_world` with parameters
|
- Call service `python_script.hello_world` with parameters
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
name: you
|
||||||
"name": "you"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Calling Services
|
## Calling Services
|
||||||
@ -54,8 +52,9 @@ if entity_id is not None:
|
|||||||
```
|
```
|
||||||
The above `python_script` can be called using the following JSON as an input.
|
The above `python_script` can be called using the following JSON as an input.
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{"entity_id": "light.bedroom", "rgb_color": [255, 0, 0] }
|
entity_id: light.bedroom
|
||||||
|
rgb_color: [255, 0, 0]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documenting your Python scripts
|
## Documenting your Python scripts
|
||||||
|
@ -80,7 +80,7 @@ sensors:
|
|||||||
default: false
|
default: false
|
||||||
type: string
|
type: string
|
||||||
class:
|
class:
|
||||||
description: The [class](components/binary_sensor) or binary_sensor. Only applicable to binary_sensors.
|
description: The [class](/integrations/binary_sensor/#device-class) or binary_sensor. Only applicable to binary_sensors.
|
||||||
required: false
|
required: false
|
||||||
default: door
|
default: door
|
||||||
type: string
|
type: string
|
||||||
|
@ -8,7 +8,7 @@ ha_iot_class: Local Polling
|
|||||||
ha_release: 0.7.6
|
ha_release: 0.7.6
|
||||||
---
|
---
|
||||||
|
|
||||||
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/) or [3M Filtrete](http://www.radiothermostat.com/filtrete/products/). Your thermostat must have the Wi-Fi module installed and connected to your network.
|
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/) or [3M Filtrete](https://www.filtrete.com/). Your thermostat must have the Wi-Fi module installed and connected to your network.
|
||||||
|
|
||||||
The underlying library supports:
|
The underlying library supports:
|
||||||
|
|
||||||
|
@ -105,3 +105,26 @@ This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.ra
|
|||||||
|
|
||||||
Switches are automatically added for all available zones of configured controllers.
|
Switches are automatically added for all available zones of configured controllers.
|
||||||
|
|
||||||
|
## Services
|
||||||
|
|
||||||
|
The Rain Bird switch platform exposes a service to start a single irrigation for a given duration.
|
||||||
|
|
||||||
|
| Service | Description |
|
||||||
|
| ------- | ----------- |
|
||||||
|
| rainbird.start_irrigation | Set a duration state attribute for a switch and turn the irrigation on.|
|
||||||
|
|
||||||
|
The service can be used as part of an automation script. For example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml automation entry
|
||||||
|
automation:
|
||||||
|
- alias: Turn irrigation on
|
||||||
|
trigger:
|
||||||
|
platform: time
|
||||||
|
at: '5:30:00'
|
||||||
|
action:
|
||||||
|
service: rainbird.start_irrigation
|
||||||
|
entity_id: switch.sprinkler_1
|
||||||
|
data:
|
||||||
|
duration: 5
|
||||||
|
```
|
@ -14,6 +14,10 @@ The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor
|
|||||||
|
|
||||||
To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
|
To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
|
||||||
|
|
||||||
|
<div class='note'>
|
||||||
|
This integration does not support Reddit's two-factor authentication. If you use two-factor authentication for your Reddit account, create a separate Reddit account without two-factor authentication for use with Home Assistant.
|
||||||
|
</div>
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To enable this platform, add the following to your `configuration.yaml` file:
|
To enable this platform, add the following to your `configuration.yaml` file:
|
||||||
|
@ -23,7 +23,7 @@ If you don't know the name of the stop follow this guide:
|
|||||||
- Now insert the coordinates for the location in the url, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&)
|
- Now insert the coordinates for the location in the url, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&)
|
||||||
- You will now see the 30 stops closest to your location.
|
- You will now see the 30 stops closest to your location.
|
||||||
|
|
||||||
You will se a output like this:
|
You will see an output like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
"StopLocation":[{
|
"StopLocation":[{
|
||||||
|
@ -122,4 +122,4 @@ switch:
|
|||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
|
|
||||||
If you receive an error such as `gpiozero.exc.BadPinFactory: Unable to load any default pin factory!` try changing the pinfactory from `pigpio` to `mock`, this adresses a [known issue](https://www.raspberrypi.org/forums/viewtopic.php?p=1417922).
|
If you receive an error such as `gpiozero.exc.BadPinFactory: Unable to load any default pin factory!` try changing the pinfactory from `pigpio` to `mock`, this addresses a [known issue](https://www.raspberrypi.org/forums/viewtopic.php?p=1417922).
|
||||||
|
@ -9,8 +9,12 @@ ha_release: 0.51
|
|||||||
|
|
||||||
The `roomba` integration allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.
|
The `roomba` integration allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.
|
||||||
|
|
||||||
|
<p class='img'>
|
||||||
|
<img src='/images/screenshots/more-info-dialog-roomba.png' />
|
||||||
|
</p>
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
This platform has only been tested with an iRobot Roomba 980 but should work fine with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
|
This platform has been tested and is confirmed to be working with the iRobot Roomba 980 and 890 models, but should also work fine with any Wi-Fi enabled Roomba like the 690 or the 960.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -8,7 +8,7 @@ ha_qa_scale: internal
|
|||||||
ha_release: 0.7
|
ha_release: 0.7
|
||||||
---
|
---
|
||||||
|
|
||||||
The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script integration will create an entity for each script and allow them to be controlled via services.
|
The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant. These are run when you turn the script on. The script integration will create an entity for each script and allow them to be controlled via services.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
@ -45,7 +45,7 @@ timeframe:
|
|||||||
default: 60
|
default: 60
|
||||||
type: integer
|
type: integer
|
||||||
monitored_conditions:
|
monitored_conditions:
|
||||||
description: One or more conditions to display in the frontend.
|
description: One or more conditions to display in the frontend. See [the Buienradar.nl website](https://www.buienradar.nl/overbuienradar/legenda) for a detailed explanation of each one.
|
||||||
required: true
|
required: true
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user