diff --git a/_config.yml b/_config.yml index 344268f346b..e97eb763572 100644 --- a/_config.yml +++ b/_config.yml @@ -101,8 +101,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 100 -current_patch_version: 0 -date_released: 2019-10-10 +current_patch_version: 2 +date_released: 2019-10-12 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/plugins/filters.rb b/plugins/filters.rb index aa136bf2925..4976c732fc1 100644 --- a/plugins/filters.rb +++ b/plugins/filters.rb @@ -100,13 +100,10 @@ module Jekyll if minor.length == 1 "#{major}.X" else - "#{major}.#{minor[0]}X" + "#{major}.#{minor.chop}X" end }.map { |v| 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 @@ -115,7 +112,7 @@ module Jekyll end { "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 # Get version N behind current diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index 5db79363d7c..09d7e804da7 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -535,7 +535,7 @@ code { font-size: 0.8em; color: #1990b8; word-spacing: normal; - word-break: break-word; + word-break: normal; word-wrap: normal; -moz-tab-size: 4; @@ -556,4 +556,4 @@ code { border: 1px solid #ddd; border-radius: 0.4em; padding: .1em .4em -} +} \ No newline at end of file diff --git a/source/_addons/dhcp_server.markdown b/source/_addons/dhcp_server.markdown index f3b8a0eb961..8a19901d0b9 100644 --- a/source/_addons/dhcp_server.markdown +++ b/source/_addons/dhcp_server.markdown @@ -86,7 +86,7 @@ hosts: required: true type: string ip: - description: Fix ip address for device. + description: Fix IP address for device. required: true type: string {% endconfiguration %} diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index ddd4f9e844e..c618bd9f03b 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -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: -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` - Enter service Data: diff --git a/source/_cookbook/configuration_yaml_by_cbulock.markdown b/source/_cookbook/configuration_yaml_by_cbulock.markdown deleted file mode 100644 index bf5d94ca225..00000000000 --- a/source/_cookbook/configuration_yaml_by_cbulock.markdown +++ /dev/null @@ -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 ---- diff --git a/source/_cookbook/configuration_yaml_by_chriskacerguis.markdown b/source/_cookbook/configuration_yaml_by_chriskacerguis.markdown deleted file mode 100644 index b82a2830aab..00000000000 --- a/source/_cookbook/configuration_yaml_by_chriskacerguis.markdown +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Configuration.yaml by chriskacerguis" -description: "" -ha_category: Example configuration.yaml -ha_external_link: https://github.com/chriskacerguis/Home-AssistantConfig ---- diff --git a/source/_cookbook/configuration_yaml_by_ciquattrofpv.markdown b/source/_cookbook/configuration_yaml_by_ciquattrofpv.markdown deleted file mode 100644 index f9bfa2c35b1..00000000000 --- a/source/_cookbook/configuration_yaml_by_ciquattrofpv.markdown +++ /dev/null @@ -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 ---- diff --git a/source/_cookbook/configuration_yaml_by_renemarc.markdown b/source/_cookbook/configuration_yaml_by_renemarc.markdown deleted file mode 100644 index f43f6281155..00000000000 --- a/source/_cookbook/configuration_yaml_by_renemarc.markdown +++ /dev/null @@ -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 ---- diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index a3189cc8200..adf436e668d 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -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. + +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 The time trigger is configured to run once at a specific point in time each day. diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index ff2bf2c2943..3cfa87fc8a1 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -4,7 +4,7 @@ description: "Setting up the basic info of Home Assistant." 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`: diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 5974a419d58..04eea1c2158 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -58,7 +58,7 @@ entity_picture: required: false type: string 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 type: string assumed_state: diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index 880dce51a88..d3ba7e9dba0 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -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. -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 diff --git a/source/_docs/ecosystem/apache.markdown b/source/_docs/ecosystem/apache.markdown index 295b64f588c..2c535697c12 100644 --- a/source/_docs/ecosystem/apache.markdown +++ b/source/_docs/ecosystem/apache.markdown @@ -14,7 +14,7 @@ This is useful if you want to have: #### 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: @@ -22,7 +22,7 @@ Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_ws $ 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 @@ -68,9 +68,9 @@ In case you are getting occasional HTTP 504 error messages ("Gateway Timeout") o #### 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 : * 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 diff --git a/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown b/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown index 4ecb0bf29c8..dfe03dd62d8 100644 --- a/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown +++ b/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown @@ -48,12 +48,12 @@ Press Enter to Continue If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options: ```text -address=/mydomain.com/ +address=/mydomain.com/ ``` ### Edit your Home Assistant configuration to use your certificates -The [`http`](/integrations/http/) section must contain the full path to the needed files. +The [`http`](/integrations/http/) section must contain the full path to the needed files. ```yaml http: diff --git a/source/_docs/ecosystem/nginx_subdomain.markdown b/source/_docs/ecosystem/nginx_subdomain.markdown index 49bd7ff8ca8..c749b49d5ee 100644 --- a/source/_docs/ecosystem/nginx_subdomain.markdown +++ b/source/_docs/ecosystem/nginx_subdomain.markdown @@ -13,9 +13,9 @@ This is useful if you want to have: #### 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 server { @@ -52,9 +52,9 @@ If you don't want HTTPS, you can change `listen 443 ssl` to `listen 80` or bette #### 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 : * 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 server { diff --git a/source/_docs/ecosystem/notebooks/installation.markdown b/source/_docs/ecosystem/notebooks/installation.markdown index 08600ada88d..0afed74486d 100644 --- a/source/_docs/ecosystem/notebooks/installation.markdown +++ b/source/_docs/ecosystem/notebooks/installation.markdown @@ -4,7 +4,7 @@ description: "Setup and first steps for Jupyter Notebooks and Home Assistant." 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 $ 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). ``` -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.

@@ -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. - - diff --git a/source/_docs/ecosystem/synology.markdown b/source/_docs/ecosystem/synology.markdown index bfb3986552f..d9df9e24cf4 100644 --- a/source/_docs/ecosystem/synology.markdown +++ b/source/_docs/ecosystem/synology.markdown @@ -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: * Go to Application Portal and edit your entry * 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. 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. diff --git a/source/_docs/installation/armbian.markdown b/source/_docs/installation/armbian.markdown index f26dfca7c2b..3c61119fc87 100644 --- a/source/_docs/installation/armbian.markdown +++ b/source/_docs/installation/armbian.markdown @@ -24,7 +24,7 @@ hass --open-ui Running these commands will: - 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 diff --git a/source/_docs/installation/centos.markdown b/source/_docs/installation/centos.markdown index 38a0d1aba1c..de9a401d718 100644 --- a/source/_docs/installation/centos.markdown +++ b/source/_docs/installation/centos.markdown @@ -52,22 +52,23 @@ You will need to enable the software collection each time you log on before you ### 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 [Unit] Description=Home Assistant -After=network.target +After=network-online.target [Service] Type=simple -User=homeassistant -# Make sure the virtualenv Python binary is used -Environment=VIRTUAL_ENV="/srv/homeassistant" -Environment=PATH="$VIRTUAL_ENV/bin:$PATH" -# ExecStart using software collection: -ExecStart=/usr/bin/scl enable rh-python36 -- /srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" +# %i means the username is derrived from the filename. +User=%i +# a python venv for hass exists in /opt/hass/venv +ExecStart=/srv/homeassistant/bin/hass [Install] 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. diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index d5430e0c6bc..027ae1c2fd8 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -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 ``` -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 @@ -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 ``` -This will let you access your Home Assistant portal from , 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 -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 +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 The steps would be: * Install "Docker" package on your Synology NAS diff --git a/source/_docs/installation/freenas.markdown b/source/_docs/installation/freenas.markdown index 08c2a4109a0..0e854549c12 100644 --- a/source/_docs/installation/freenas.markdown +++ b/source/_docs/installation/freenas.markdown @@ -25,13 +25,6 @@ pip3 install --upgrade pip 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: ```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. # Default: homeassistant # 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. # Default: /usr/local/share/homeassistant # @@ -118,7 +111,7 @@ load_rc_config ${name} : ${homeassistant_enable:="NO"} : ${homeassistant_user:="homeassistant"} : ${homeassistant_group:="homeassistant"} -: ${homeassistant_config_dir:="/usr/home/homeassistant/.homeassistant"} +: ${homeassistant_config_dir:="/home/homeassistant/.homeassistant"} : ${homeassistant_install_dir:="/usr/local/share/homeassistant"} command="/usr/sbin/daemon" diff --git a/source/_docs/installation/hassbian/installation.markdown b/source/_docs/installation/hassbian/installation.markdown index b10fe4f6afa..a5cfce1bf89 100644 --- a/source/_docs/installation/hassbian/installation.markdown +++ b/source/_docs/installation/hassbian/installation.markdown @@ -13,7 +13,7 @@ One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2,

-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.
@@ -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`. -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`. diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index 982fd32faac..485b30c93ef 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -14,7 +14,7 @@ Although these installation steps specifically mention a Raspberry Pi, you can g
-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.
@@ -84,7 +84,7 @@ Start Home Assistant for the first time. This will complete the installation for ```bash (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`.
diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index e2e640fffff..cb39fdbf175 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -22,7 +22,7 @@ The following configuration has been tested on Synology 413j running DSM 6.0-732 Running these commands will: - 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: diff --git a/source/_docs/mqtt/service.markdown b/source/_docs/mqtt/service.markdown index d714c1c12b3..5ad15fa9dbf 100644 --- a/source/_docs/mqtt/service.markdown +++ b/source/_docs/mqtt/service.markdown @@ -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.
-```json -{ - "topic": "home-assistant/light/1/command", - "payload": "on" -} +```yaml +topic: home-assistant/light/1/command +payload: on ``` {% raw %} -```json -{ - "topic": "home-assistant/light/1/state", - "payload_template": "{{ states('device_tracker.paulus') }}" -} +```yaml +topic: home-assistant/light/1/state +payload_template: {{ states('device_tracker.paulus') }} ``` {% endraw %} `payload` must be a string. If you want to send JSON then you need to format/escape it properly. Like: -```json -{ - "topic": "home-assistant/light/1/state", - "payload":"{\"Status\":\"off\", \"Data\":\"something\"}" -} +```yaml +topic: home-assistant/light/1/state +payload: "{\"Status\":\"off\", \"Data\":\"something\"}" ``` Example of how to use `qos` and `retain`: -```json -{ - "topic": "home-assistant/light/1/command", - "payload": "on", - "qos": 2, - "retain": true -} +```yaml +topic: home-assistant/light/1/command +payload: on +qos: 2 +retain: true ``` diff --git a/source/_docs/security.markdown b/source/_docs/security.markdown index bdb36dd7582..d06d22e1a37 100644 --- a/source/_docs/security.markdown +++ b/source/_docs/security.markdown @@ -21,7 +21,7 @@ See the [open ports](/docs/security/porosity/) of a Hass.io instance with variou ## 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 diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 1f128177525..5e2e0ed8096 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -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. -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: 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) 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 -{ - "entity_id": "light.bedroom", - "brightness": 255, - "rgb_color": [255, 0, 0] -} +```yaml +entity_id: light.bedroom +brightness: 255 +rgb_color: [255, 0, 0] ``` + ## 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. @@ -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. For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as -```json -{ "state":"on" } +```yaml +state: on ``` If there is an automation that handles that event, it will be automatically triggered. See below: + ```yaml - alias: Capture Event 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/) - ## 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. 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 This section displays `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs. - ## Info The Information tab simply provides information about the current installed version, [system health](/integrations/system_health/) (if enabled), additional links and credits. diff --git a/source/_docs/z-wave/adding.markdown b/source/_docs/z-wave/adding.markdown index 9fc6f3dc704..126a495fcdd 100644 --- a/source/_docs/z-wave/adding.markdown +++ b/source/_docs/z-wave/adding.markdown @@ -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 4. With the device in its final location, run a *Heal Network* +
+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. +
+ ## Removing Devices To remove (exclude) a Z-Wave device from your system: diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 6ed30e45d2c..f58e205f810 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -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. -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): ```xml @@ -329,7 +329,7 @@ For Zooz switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CE ``` -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: diff --git a/source/_headers b/source/_headers index fc8bb7936c7..61d96baf8a7 100644 --- a/source/_headers +++ b/source/_headers @@ -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: 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-Frame-Options: DENY X-XSS-Protection: 1; mode=block /*.css - Cache-Control: public, max-age: 604800, s-max-age=604800 + Cache-Control: public, max-age: 604800, s-maxage=604800 /*.js - Cache-Control: public, max-age: 604800, s-max-age=604800 + Cache-Control: public, max-age: 604800, s-maxage=604800 /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/* - Cache-Control: public, max-age: 1800, s-max-age=604800, must-revalidate + Cache-Control: public, max-age: 1800, s-maxage=604800, must-revalidate /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/* - Cache-Control: public, max-age: 1800, s-max-age=604800, must-revalidate + Cache-Control: public, max-age: 1800, s-maxage=604800, must-revalidate diff --git a/source/_includes/site/footer.html b/source/_includes/site/footer.html index 2f2328a9569..64f21919d5b 100644 --- a/source/_includes/site/footer.html +++ b/source/_includes/site/footer.html @@ -8,7 +8,7 @@
- +
@@ -26,7 +26,7 @@
- Website powered by Jekyll and the + Website powered by Jekyll and the Oscalite theme. Hosted by Netlify.
diff --git a/source/_integrations/adguard.markdown b/source/_integrations/adguard.markdown index c3749d519d4..486ccc30c1b 100644 --- a/source/_integrations/adguard.markdown +++ b/source/_integrations/adguard.markdown @@ -10,7 +10,7 @@ ha_release: 0.95 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 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**. 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. ## 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 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 -bypass all AdGuard feature, regardless if they are switched on or not. +The "AdGuard Protection" switch is a master switch. It will turn off and +bypass all AdGuard features, regardless of whether they are switched on or not.
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 sites/domains at certain times. -For example, you could create a custom filter list blocking social media sites, -during the day and release them during the evening, using a simple automation. +For example, you could create a custom filter list that blocks social media sites +during the day and releases them during the evening. ### Service `add_url` @@ -105,7 +105,7 @@ Refresh all filter subscriptions in AdGuard Home. | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------- | -| `force` | Yes | Force update (bypasses AdGuard Home throttling). | +| `force` | Yes | Force update (bypasses AdGuard Home throttling). | By default, `force` is set to `false`. Forcing an update bypasses AdGuard Home's throttling logic, so use with care. diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 2d8d2720bb2..416a4e947da 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -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 [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 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 * `Client ID`: - 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) The trailing slash is important here. diff --git a/source/_integrations/android_ip_webcam.markdown b/source/_integrations/android_ip_webcam.markdown index ba061946ef5..3d13b52a815 100644 --- a/source/_integrations/android_ip_webcam.markdown +++ b/source/_integrations/android_ip_webcam.markdown @@ -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. -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` diff --git a/source/_integrations/aquostv.markdown b/source/_integrations/aquostv.markdown index bf4770c9171..2ac9d50ab56 100644 --- a/source/_integrations/aquostv.markdown +++ b/source/_integrations/aquostv.markdown @@ -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. 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.
diff --git a/source/_integrations/arest.markdown b/source/_integrations/arest.markdown index 5c76d7ab19f..4cfe510e6cf 100644 --- a/source/_integrations/arest.markdown +++ b/source/_integrations/arest.markdown @@ -33,7 +33,7 @@ binary_sensor: {% configuration %} 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 type: string pin: @@ -46,7 +46,7 @@ name: type: string {% 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 $ curl -X GET http://192.168.0.5/digital/9 @@ -89,7 +89,7 @@ sensor: {% configuration %} 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 type: string 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. -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 {"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 {"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true} diff --git a/source/_integrations/asterisk_mbox.markdown b/source/_integrations/asterisk_mbox.markdown index 31a8f5ab2ae..7c702b3a58f 100644 --- a/source/_integrations/asterisk_mbox.markdown +++ b/source/_integrations/asterisk_mbox.markdown @@ -34,7 +34,7 @@ password: required: true type: string 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 type: string port: diff --git a/source/_integrations/automation.markdown b/source/_integrations/automation.markdown index 9306cd54a3b..33e487071e1 100644 --- a/source/_integrations/automation.markdown +++ b/source/_integrations/automation.markdown @@ -11,8 +11,6 @@ ha_release: 0.7 Please see the [docs section](/docs/automation/) for in-depth documentation on how to use the automation component. -Starting with 0.28 your automation rules can be controlled with the frontend. -

@@ -33,3 +31,12 @@ automation: - 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: +``` diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown index 259f8053a2f..8325a46dc5a 100644 --- a/source/_integrations/aws.markdown +++ b/source/_integrations/aws.markdown @@ -72,7 +72,7 @@ region_name: required: true type: string 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 type: string aws_access_key_id: diff --git a/source/_integrations/binary_sensor.template.markdown b/source/_integrations/binary_sensor.template.markdown index 381493deffb..b8fa12ad0bb 100644 --- a/source/_integrations/binary_sensor.template.markdown +++ b/source/_integrations/binary_sensor.template.markdown @@ -238,7 +238,7 @@ binary_sensor: ### 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 %} ```yaml diff --git a/source/_integrations/bom.markdown b/source/_integrations/bom.markdown index 5d0dacef237..ba8d6710074 100644 --- a/source/_integrations/bom.markdown +++ b/source/_integrations/bom.markdown @@ -204,8 +204,8 @@ sensor: 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). - 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 - - For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`. +- 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`. {% configuration %} station: diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown index db479bdb477..3db8a463997 100644 --- a/source/_integrations/buienradar.markdown +++ b/source/_integrations/buienradar.markdown @@ -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 `camera.buienradar_loop`. -[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. +_[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._ diff --git a/source/_integrations/calendar.google.markdown b/source/_integrations/calendar.google.markdown index fb2ade2bd60..15d67f27e32 100644 --- a/source/_integrations/calendar.google.markdown +++ b/source/_integrations/calendar.google.markdown @@ -23,13 +23,13 @@ Generate a Client ID and Client Secret on 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. 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. Save this page. You don't have to fill out anything else there. -1. Click 'Create credentials' -> OAuth client ID. -1. Set the Application type to 'Other' and give this credential set a name then click Create. +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. 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. diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown index d59c1cacebe..04848b97c3c 100644 --- a/source/_integrations/camera.markdown +++ b/source/_integrations/camera.markdown @@ -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 service developer tool icon **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 -{ - "entity_id": "camera.living_room_camera" -} +```yaml +entity_id: camera.living_room_camera ``` diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index 4894da7624e..eff0317b1ac 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -13,7 +13,7 @@ You can enable the Cast integration by going to the Integrations page inside the ## 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 { @@ -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/). ## Advanced use diff --git a/source/_integrations/cloud.markdown b/source/_integrations/cloud.markdown index 34c539b38c4..e643ee603b1 100644 --- a/source/_integrations/cloud.markdown +++ b/source/_integrations/cloud.markdown @@ -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) +## 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 to enable the cloud component cloud: diff --git a/source/_integrations/comfoconnect.markdown b/source/_integrations/comfoconnect.markdown index 1ab6097aa18..54a8545aa0b 100644 --- a/source/_integrations/comfoconnect.markdown +++ b/source/_integrations/comfoconnect.markdown @@ -8,7 +8,7 @@ ha_category: 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) bridge to connect the unit to your local network. diff --git a/source/_integrations/concord232.markdown b/source/_integrations/concord232.markdown index 80ef881b4bf..d785bbdea6d 100644 --- a/source/_integrations/concord232.markdown +++ b/source/_integrations/concord232.markdown @@ -43,7 +43,7 @@ code: required: false type: string 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 type: string default: audible diff --git a/source/_integrations/config.markdown b/source/_integrations/config.markdown index b94ae06d59a..4b7942af226 100644 --- a/source/_integrations/config.markdown +++ b/source/_integrations/config.markdown @@ -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. -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 # Example configuration.yaml entry diff --git a/source/_integrations/cover.rfxtrx.markdown b/source/_integrations/cover.rfxtrx.markdown index 43a150ffe53..21da46532d5 100644 --- a/source/_integrations/cover.rfxtrx.markdown +++ b/source/_integrations/cover.rfxtrx.markdown @@ -23,7 +23,7 @@ cover: 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: diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index 33ac85f3cf3..abacadf5046 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -126,6 +126,7 @@ Currently supported devices as device triggers: - Hue Dimmer Remote - Hue Tap +- Symfonisk Sound Controller - Trådfri On/Off Switch - Trådfri Open/Close Remote - 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 -- 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 1000lm +- IKEA Trådfri Bulb E27 WS & RGB Opal 600lm - IKEA Trådfri Bulb GU10 W 400lm +- IKEA Trådfri FLOALT LED light panel - OSRAM Flex RGBW - OSRAM Gardenpole RGBW - Philips Hue White A19 - Philips Hue White Ambiance A19 - 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 - 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 - Innr SP120 +- Osram Lightify plug - Osram Outdoor plug - Heiman siren diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown index dcbf52bcd44..39634189b37 100644 --- a/source/_integrations/dialogflow.markdown +++ b/source/_integrations/dialogflow.markdown @@ -15,17 +15,17 @@ Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with Using Dialogflow will be easy to create conversations like: - > User: What is the temperature at home? - > - > Bot: The temperature is 34 degrees +_User: What is the temperature at home?_ - > User: Turn on the light - > - > Bot: In which room? - > - > User: In the kitchen - > - > Bot: Turning on kitchen light +_Bot: The temperature is 34 degrees_ + +_User: Turn on the light_ + +_Bot: In which room?_ + +_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. diff --git a/source/_integrations/discogs.markdown b/source/_integrations/discogs.markdown index fa6af02d26e..d2b58f61764 100644 --- a/source/_integrations/discogs.markdown +++ b/source/_integrations/discogs.markdown @@ -8,7 +8,7 @@ logo: discogs.png 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 diff --git a/source/_integrations/discord.markdown b/source/_integrations/discord.markdown index ccff715d00d..15d5024a48d 100644 --- a/source/_integrations/discord.markdown +++ b/source/_integrations/discord.markdown @@ -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) 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. diff --git a/source/_integrations/doods.markdown b/source/_integrations/doods.markdown index 53088e5a9d8..f5d59569ed7 100644 --- a/source/_integrations/doods.markdown +++ b/source/_integrations/doods.markdown @@ -23,6 +23,7 @@ The configuration loosely follows the tensorflow configuration. To enable this p image_processing: - platform: doods url: "http://:8080" + detector: default source: - entity_id: camera.front_yard ``` @@ -47,7 +48,7 @@ url: type: string detector: description: The DOODS detector to use - required: false + required: true type: string confidence: description: The default confidence for any detected objects where not explicitly set diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index 80ec0bec1ab..34311394ca6 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -1,6 +1,6 @@ --- 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 ha_category: - Sensor @@ -13,11 +13,11 @@ ha_release: 0.9 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 -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/). 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. 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. 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. 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 -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 -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. 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. @@ -57,11 +57,9 @@ ecobee: 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 %} 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 type: string {% endconfiguration %} @@ -71,9 +69,19 @@ 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. + +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 -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: @@ -98,7 +106,7 @@ To use notifications, please see the [getting started with automation page](/get ### 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 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 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 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 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 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 the target temperature defined for the away climate. The away preset is a simple way to emulate a vacation mode. 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. ## 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 | -| ------------------- | ------------------------------------------------------------------------------------- | -| `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. | -| `equipment_running` | This is a comma seperated 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. | +| Name | Description | +| ---- | ----------- | +| `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. +| `equipment_running` | This is a comma-separated list of equipment that is currently running. +| `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 -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.delete_vacation` @@ -159,13 +167,13 @@ Creates a vacation on the selected ecobee thermostat. | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `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 | | `heat_temp` | no | Heating temperature during the vacation | | `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_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_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` -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 | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ | diff --git a/source/_integrations/emulated_roku.markdown b/source/_integrations/emulated_roku.markdown index 46a2f87700e..5f0c7a46728 100644 --- a/source/_integrations/emulated_roku.markdown +++ b/source/_integrations/emulated_roku.markdown @@ -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 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) diff --git a/source/_integrations/flunearyou.markdown b/source/_integrations/flunearyou.markdown index 0507379e805..4407c9241b0 100644 --- a/source/_integrations/flunearyou.markdown +++ b/source/_integrations/flunearyou.markdown @@ -9,8 +9,8 @@ ha_iot_class: Cloud Polling --- The `flunearyou` sensor platform allows users in the United States and its -territories to get information regarding reported flu symptoms from Flu Near -You. The platform can return user-reported information as well reports from the +territories to get information regarding reported flu symptoms from [Flu Near +You](https://flunearyou.org/). The platform can return user-reported information as well reports from the Center for Disease Control (CDC). ## Configuration diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown index d5fae9524c1..edc02e1ae93 100644 --- a/source/_integrations/flux_led.markdown +++ b/source/_integrations/flux_led.markdown @@ -41,7 +41,7 @@ automatic_add: default: false type: boolean devices: - description: A list of devices with their ip address. + description: A list of devices with their IP address. required: false type: list keys: diff --git a/source/_integrations/fritzbox_netmonitor.markdown b/source/_integrations/fritzbox_netmonitor.markdown index 8d4feec89ba..bf841ec1c1c 100644 --- a/source/_integrations/fritzbox_netmonitor.markdown +++ b/source/_integrations/fritzbox_netmonitor.markdown @@ -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_connected |True if the FritzBox has established an internet-connection | |wan_access_type |Connection-type, can be `DSL` or `Cable` | -|external_ip |External ip address | +|external_ip |External IP address | |uptime |Uptime in seconds | |bytes_sent |Bytes sent | |bytes_received |Bytes received | diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index 508ae23f407..a059eb35475 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -8,7 +8,7 @@ ha_qa_scale: internal 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 # Example configuration.yaml entry diff --git a/source/_integrations/generic_ip_camera.markdown b/source/_integrations/generic_ip_camera.markdown index 8ea0e420c1d..e701055785c 100644 --- a/source/_integrations/generic_ip_camera.markdown +++ b/source/_integrations/generic_ip_camera.markdown @@ -25,11 +25,11 @@ camera: {% configuration %} 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 type: string 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 type: string name: diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index f487ddce307..c3a277e9bf3 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -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. Add/Import a project and give it a name. - 2. Click on the `Home Control` 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. - 4. Click `Done`. Then click on `Overview`, which will lead you back to the app details screen. + 2. Click on the `Smart Home` card, select the `Smart home` recommendation. + 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 `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. - 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`. + 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`. Click `Next` 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. 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. - 8. Do **NOT** check `Google to transmit clientID and secret via HTTP basic auth header`. - 9. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. + 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. Click `Save` 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`. -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. -5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. -6. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`. -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. + +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. 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. 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.
@@ -242,7 +241,7 @@ Here are the modes that are currently available: ### 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: diff --git a/source/_integrations/google_maps.markdown b/source/_integrations/google_maps.markdown index 40603019494..7c9d18a78a2 100644 --- a/source/_integrations/google_maps.markdown +++ b/source/_integrations/google_maps.markdown @@ -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). -## 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). -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. -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. - - For example: if your email was `location.tracker@gmail.com`, the filename would be: `.google_maps_location_sharing.cookies.location_tracker_gmail_com`. +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. 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 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: diff --git a/source/_integrations/hangouts.markdown b/source/_integrations/hangouts.markdown index 970c177dedf..b21e4819208 100644 --- a/source/_integrations/hangouts.markdown +++ b/source/_integrations/hangouts.markdown @@ -17,7 +17,7 @@ There is currently support for the following device types within Home Assistant: ## Setup the integration via the frontend Menu: *Configuration* -> *Integrations* - + Configure the integration: * Enter your **Google Mail Address** and **Password** * In the authentication form there is an Optional Field: **Authorization Code** which should only be used if you get an invalid login error with email and password (see note below for details). @@ -225,9 +225,9 @@ Reconnects the hangouts bot. ## 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 %} diff --git a/source/_integrations/here_travel_time.markdown b/source/_integrations/here_travel_time.markdown index e93da66fa16..1d483c70c0d 100644 --- a/source/_integrations/here_travel_time.markdown +++ b/source/_integrations/here_travel_time.markdown @@ -13,7 +13,7 @@ The `here_travel_time` sensor provides travel time from the [HERE Routing API](h ## 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) @@ -74,7 +74,7 @@ name: type: string default: "HERE Travel Time" 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 type: string default: "car" diff --git a/source/_integrations/history.markdown b/source/_integrations/history.markdown index e2fbb7e0e8d..dd740ee6fb1 100644 --- a/source/_integrations/history.markdown +++ b/source/_integrations/history.markdown @@ -14,8 +14,7 @@ component for storing the data and uses the same database setting. If any entities are excluded from being recorded, no history will be available for these entities. -To enable the history option in your installation, -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 # Basic configuration.yaml entry diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown index ef743ab46eb..6038fbd4c10 100644 --- a/source/_integrations/history_stats.markdown +++ b/source/_integrations/history_stats.markdown @@ -188,6 +188,6 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
- 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.
diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown index 84f694fd8cf..05c90c88149 100644 --- a/source/_integrations/homekit_controller.markdown +++ b/source/_integrations/homekit_controller.markdown @@ -16,7 +16,7 @@ ha_release: 0.68 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. @@ -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: -- 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. -- 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. +- 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. In this case, you will need to contact the manufacturer to see what options you have. Home Assistant does not currently support HomeKit BLE. +
+ + 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. + +
+ ## Troubleshooting ### 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 -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 -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 @@ -78,10 +84,10 @@ You may say a log entry that looks like this: 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. -- 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. -- There is a problem with the actual accessory and this may be causing intermittent network issues. +- 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. +- 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. diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index 2fb9b297ea5..e78c30c89d9 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -94,7 +94,7 @@ callback_ip: required: false type: string 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 type: integer resolvenames: diff --git a/source/_integrations/hook.markdown b/source/_integrations/hook.markdown index 152da2f657a..94e046e9d91 100644 --- a/source/_integrations/hook.markdown +++ b/source/_integrations/hook.markdown @@ -8,7 +8,7 @@ ha_iot_class: Assumed State 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). diff --git a/source/_integrations/html5.markdown b/source/_integrations/html5.markdown index d36a05a7160..08aa479bfc7 100644 --- a/source/_integrations/html5.markdown +++ b/source/_integrations/html5.markdown @@ -17,7 +17,7 @@ HTML5 push notifications **do not** work on iOS.
-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).
diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown index 4909b2caaf5..f6d572b5bc3 100644 --- a/source/_integrations/http.markdown +++ b/source/_integrations/http.markdown @@ -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 -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 response = requests.post( diff --git a/source/_integrations/hue.markdown b/source/_integrations/hue.markdown index 6340af2a2fb..b1e36814b1b 100644 --- a/source/_integrations/hue.markdown +++ b/source/_integrations/hue.markdown @@ -11,18 +11,18 @@ featured: true 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: -- Light -- Motion sensors (including temperature & light level sensors) +- Lights +- 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: @@ -35,7 +35,7 @@ hue: {% configuration %} 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 type: string allow_unreachable: @@ -44,7 +44,7 @@ allow_unreachable: type: boolean default: false filename: - description: Make this unique if specifying multiple Hue hubs. + description: Make this unique if specifying multiple Hue bridges. required: false type: string allow_hue_groups: @@ -67,7 +67,7 @@ hue: ### 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: @@ -83,23 +83,23 @@ hue: ### 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: -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 $ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http:///api//groups ``` -The `` 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. `` is the IP address or hostname of your Hue bridge. +The `` 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. `` 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 $ curl http:///api//lights @@ -108,17 +108,17 @@ $ curl http:///api//lights Home Assistant will automatically detect your new `LightGroup` and add it to the interface.
- 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).
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 -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. -This will have all the bulbs transitioned at once, instead of one at a time using standard scenes in Home Assistant. +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 like when using standard scenes in Home Assistant. For instance: @@ -134,23 +134,23 @@ script: | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `group_name` | no | The group/room name of the lights. Find this in the Hue official app. -| `scene_name` | no | The name of the scene. 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 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 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 -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." diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown index 5b85e62de74..1d6424fdfe0 100644 --- a/source/_integrations/hyperion.markdown +++ b/source/_integrations/hyperion.markdown @@ -76,7 +76,7 @@ automation: 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 - alias: Set hyperion effect after playback diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index 9f4f82e14d1..20067909284 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -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: +{% raw %} ```yaml automation: - id: this_is_the_automation_id alias: The optional automation alias trigger: - platform: event - event_type: ifttt_webhook_received - event_data: + - event_data: action: call_service + event_type: ifttt_webhook_received + platform: event + condition: [] action: - service_template: '{% raw %}{{ trigger.event.data.service }}{% endraw %}' - data_template: - entity_id: '{% raw %}{{ trigger.event.data.entity_id }}{% endraw %}' + - data_template: + entity_id: '{{ trigger.event.data.entity_id }}' + service_template: '{{ trigger.event.data.service }}' ``` +{% endraw %} ## Sending events to IFTTT diff --git a/source/_integrations/isy994.markdown b/source/_integrations/isy994.markdown index 26b3f65af65..9bde4e8c6d1 100644 --- a/source/_integrations/isy994.markdown +++ b/source/_integrations/isy994.markdown @@ -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 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: @@ -44,7 +44,7 @@ isy994: {% configuration %} 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 type: string username: diff --git a/source/_integrations/lametric.markdown b/source/_integrations/lametric.markdown index 09cbab06ed5..7d0345b5913 100644 --- a/source/_integrations/lametric.markdown +++ b/source/_integrations/lametric.markdown @@ -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: * App Name: Home Assistant * Description: Home Assistant - * Privacy Policy: http://localhost/ + * Privacy Policy: `http://localhost/` * Check all permission boxes * 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. @@ -134,4 +134,4 @@ If you have more than one La Metric device, you can specify which will receive t icon: 'i51' ``` - If target is not specified, all LaMetric devices will be notified. \ No newline at end of file + If target is not specified, all LaMetric devices will be notified. diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index af995f7addd..508628c401f 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -8,7 +8,7 @@ ha_iot_class: Configurable 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 diff --git a/source/_integrations/lightwave.markdown b/source/_integrations/lightwave.markdown index 08e2e70caca..393cb671659 100644 --- a/source/_integrations/lightwave.markdown +++ b/source/_integrations/lightwave.markdown @@ -37,7 +37,7 @@ lightwave: 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. `lights` and `switches` are optional but one of these must be present. diff --git a/source/_integrations/logbook.markdown b/source/_integrations/logbook.markdown index ef13971c9c0..72c4c7263c3 100644 --- a/source/_integrations/logbook.markdown +++ b/source/_integrations/logbook.markdown @@ -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 SQLite database to store data. -To enable the logbook in your installation, -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 # Example configuration.yaml entry diff --git a/source/_integrations/map.markdown b/source/_integrations/map.markdown index 38e1d59c243..294f544bbc8 100644 --- a/source/_integrations/map.markdown +++ b/source/_integrations/map.markdown @@ -8,7 +8,7 @@ ha_qa_scale: internal 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 # Example configuration.yaml entry diff --git a/source/_integrations/microsoft.markdown b/source/_integrations/microsoft.markdown index d578523350a..0a2cd4c28f6 100644 --- a/source/_integrations/microsoft.markdown +++ b/source/_integrations/microsoft.markdown @@ -27,7 +27,7 @@ api_key: required: true type: string 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 type: string default: "`en-us`" diff --git a/source/_integrations/mjpeg.markdown b/source/_integrations/mjpeg.markdown index 2f9ccd4884d..33383a68061 100644 --- a/source/_integrations/mjpeg.markdown +++ b/source/_integrations/mjpeg.markdown @@ -25,7 +25,7 @@ camera: {% configuration %} 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 type: string still_image_url: diff --git a/source/_integrations/mobile_app.markdown b/source/_integrations/mobile_app.markdown index 74ff070dc85..ff2053ee573 100644 --- a/source/_integrations/mobile_app.markdown +++ b/source/_integrations/mobile_app.markdown @@ -16,8 +16,7 @@ If you are a mobile app developer, see the [developer documentation](https://dev ## Configuration -This integration is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration. -If that is the case, the following example shows you how to enable this integration manually: +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 diff --git a/source/_integrations/moon.markdown b/source/_integrations/moon.markdown index 3d90dadeec1..28b08bd1133 100644 --- a/source/_integrations/moon.markdown +++ b/source/_integrations/moon.markdown @@ -9,7 +9,7 @@ ha_release: 0.38 ha_qa_scale: internal --- -The `moon` sensor platform is tracking the moon phases. +The `moon` integration is tracking the moon phases. ## Configuration @@ -23,3 +23,7 @@ sensor: 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` . + +

+ +

diff --git a/source/_integrations/nuki.markdown b/source/_integrations/nuki.markdown index 098c6a76d41..1f6d8e83e88 100644 --- a/source/_integrations/nuki.markdown +++ b/source/_integrations/nuki.markdown @@ -39,14 +39,6 @@ token: ## 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` This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app. diff --git a/source/_integrations/nzbget.markdown b/source/_integrations/nzbget.markdown index 00f8ce07afb..d39e6530796 100644 --- a/source/_integrations/nzbget.markdown +++ b/source/_integrations/nzbget.markdown @@ -56,23 +56,23 @@ password: This component will create these sensors: -- `article_cache`: Number of cached articles. -- `average_download_rate`: Average download rate -- `download_paused`: Paused downloads -- `download_rate`: Current download rate -- `download_size`: The size to download -- `free_disk_space`: Free disk space at the storage location of NZBGet -- `post_paused`: Paused posts -- `remaining_size`: Remaining size to download -- `uptime`: Uptime of NZBGet +- `nzbget_article_cache`: Article cache size in MB. +- `nzbget_average_speed`: Average download rate since server start in MB/s. +- `nzbget_download_paused`: Whether downloading is paused. +- `nzbget_speed`: Current download rate in MB/s. +- `nzbget_queue_size`: Remaining size to download in MB. +- `nzbget_disk_free`: Free disk space at the storage location of NZBGet. +- `nzbget_post_processing_paused`: Whether post processing is paused. +- `nzbget_uptime`: NZBGet server uptime. +- `nzbget_size`: Amount of data downloaded since server start in MB. ## Services -Available services: +Available services: - - `pause`: Pause the download queue. - - `resume`: Resume the download queue. - - `set_speed`: Set the download queue speed limit. +- `pause`: Pause the download queue. +- `resume`: Resume the download queue. +- `set_speed`: Set the download queue speed limit. ### Service `nzbget/set_speed` diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown index 302393871ff..b115523db61 100644 --- a/source/_integrations/person.markdown +++ b/source/_integrations/person.markdown @@ -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 -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 person: @@ -93,7 +93,7 @@ By following the instructions on the [customizing entities](/docs/configuration/ ```yaml customize: - person.ada6789: + person.ada: entity_picture: "/local/ada.jpg" ``` diff --git a/source/_integrations/python_script.markdown b/source/_integrations/python_script.markdown index a7b9a1fa1d0..17c43696999 100644 --- a/source/_integrations/python_script.markdown +++ b/source/_integrations/python_script.markdown @@ -34,10 +34,8 @@ hass.bus.fire(name, { "wow": "from a Python script!" }) - Start Home Assistant - Call service `python_script.hello_world` with parameters -```json -{ - "name": "you" -} +```yaml +name: you ``` ## 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. -```json -{"entity_id": "light.bedroom", "rgb_color": [255, 0, 0] } +```yaml +entity_id: light.bedroom +rgb_color: [255, 0, 0] ``` ## Documenting your Python scripts diff --git a/source/_integrations/qwikswitch.markdown b/source/_integrations/qwikswitch.markdown index 7bda4c69d7b..d5acc814df9 100644 --- a/source/_integrations/qwikswitch.markdown +++ b/source/_integrations/qwikswitch.markdown @@ -80,7 +80,7 @@ sensors: default: false type: string 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 default: door type: string diff --git a/source/_integrations/radiotherm.markdown b/source/_integrations/radiotherm.markdown index 408c1b565ae..c87edb9bbc1 100644 --- a/source/_integrations/radiotherm.markdown +++ b/source/_integrations/radiotherm.markdown @@ -8,7 +8,7 @@ ha_iot_class: Local Polling 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: diff --git a/source/_integrations/rainbird.markdown b/source/_integrations/rainbird.markdown index 07d07ca0966..338f5ff089a 100644 --- a/source/_integrations/rainbird.markdown +++ b/source/_integrations/rainbird.markdown @@ -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. +## 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 +``` \ No newline at end of file diff --git a/source/_integrations/reddit.markdown b/source/_integrations/reddit.markdown index 5a51aa13285..0fe263b79e5 100644 --- a/source/_integrations/reddit.markdown +++ b/source/_integrations/reddit.markdown @@ -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). +
+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. +
+ ## Configuration To enable this platform, add the following to your `configuration.yaml` file: diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown index f985da9a4f3..8d54e29a1d6 100644 --- a/source/_integrations/rejseplanen.markdown +++ b/source/_integrations/rejseplanen.markdown @@ -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&) - 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 "StopLocation":[{ diff --git a/source/_integrations/remote_rpi_gpio.markdown b/source/_integrations/remote_rpi_gpio.markdown index f3fe6b23129..b4e40e7d975 100644 --- a/source/_integrations/remote_rpi_gpio.markdown +++ b/source/_integrations/remote_rpi_gpio.markdown @@ -6,15 +6,15 @@ ha_category: - DIY - Binary Sensor - Switch -ha_release: 0.94 +ha_release: 0.94 ha_iot_class: Local Push --- -The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections. +The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections. The remote RPi and the control computer where Home Assistant is running must be prepared to run remote_rpi_gpio, see details [here](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html). -Note that for virtual environments you may need to set an environment variable when starting the environment to set the pin factory, example: +Note that for virtual environments you may need to set an environment variable when starting the environment to set the pin factory, example: `Environment = GPIOZERO_PIN_FACTORY=pigpio PIGPIO_ADDR=YOUR_RPi_IP_ADDRESS` @@ -122,4 +122,4 @@ switch: ### 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). diff --git a/source/_integrations/roomba.markdown b/source/_integrations/roomba.markdown index 2c7ddccef68..925ae07841d 100644 --- a/source/_integrations/roomba.markdown +++ b/source/_integrations/roomba.markdown @@ -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. +

+ +

+
-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.
## Configuration diff --git a/source/_integrations/script.markdown b/source/_integrations/script.markdown index 09ba6536dcd..846f5e8e54b 100644 --- a/source/_integrations/script.markdown +++ b/source/_integrations/script.markdown @@ -8,7 +8,7 @@ ha_qa_scale: internal 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 diff --git a/source/_integrations/sensor.buienradar.markdown b/source/_integrations/sensor.buienradar.markdown index 4ba6cd9df0a..11d257668f1 100644 --- a/source/_integrations/sensor.buienradar.markdown +++ b/source/_integrations/sensor.buienradar.markdown @@ -45,7 +45,7 @@ timeframe: default: 60 type: integer 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 type: list keys: diff --git a/source/_integrations/snips.markdown b/source/_integrations/snips.markdown index 2abfa970b4c..ebcc67f9548 100644 --- a/source/_integrations/snips.markdown +++ b/source/_integrations/snips.markdown @@ -81,11 +81,11 @@ sudo systemctl start "snips-*" Snips is now ready to take voice commands from the microphone. To trigger the listening, simply say -> Hey Snips +_Hey Snips_ followed by a command, e.g. -> Set the lights to green in the living room +_Set the lights to green in the living room_ As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. diff --git a/source/_integrations/speedtestdotnet.markdown b/source/_integrations/speedtestdotnet.markdown index 4449a58166b..5b93f1e17b1 100644 --- a/source/_integrations/speedtestdotnet.markdown +++ b/source/_integrations/speedtestdotnet.markdown @@ -11,7 +11,7 @@ ha_iot_class: Cloud Polling The `speedtestdotnet` integration uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. -Enabling this integration will automatically create the Speedtest.net Sensors for the monitored conditions (below). +Enabling this integration will automatically create Speedtest.net sensors for the monitored conditions (below). By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run. @@ -83,11 +83,11 @@ action: This integration uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this integration may display. -When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `speedtestdotnet.speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. +When Home Assistant first starts up, the values of the speed test sensors will show as `Unknown`. You can use the service `speedtestdotnet.speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. ## Examples -In this section, you find some real-life examples of how to use this component. +In this section you will find some real-life examples of how to use this component. ### Run periodically @@ -128,8 +128,8 @@ automation: ## Notes -- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. The Raspberry Pi 3+ models comes with a Gigabit LAN adapter which supports a [maximum throughput](https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/) of 300 Mbit/s. +- When running on Raspberry Pi the maximum speed is limited by the LAN adapter. The Raspberry Pi 3+ models come with a Gigabit LAN adapter which supports a [maximum throughput](https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/) of 300 Mbit/s. - Running this integration can have negative effects on the system's performance as it requires a fair amount of memory. -- Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running. -- If ran frequently, this integration has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. -- While running, your network capacity is fully utilized. This may have a negative effect on other devices in use the network such as gaming consoles or streaming boxes. +- Entries under `monitored_conditions` only control which entities are available in Home Assistant, they do not disable conditions from running. +- If run frequently, this integration has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. +- While the speedtest is running your network capacity is fully utilized. This may have a negative effect on other devices using the network such as gaming consoles or streaming boxes. diff --git a/source/_integrations/spotcrime.markdown b/source/_integrations/spotcrime.markdown index dab9f838d3d..0da27a6431d 100644 --- a/source/_integrations/spotcrime.markdown +++ b/source/_integrations/spotcrime.markdown @@ -9,7 +9,7 @@ ha_iot_class: Cloud Polling SpotCrime is no longer handing out API keys to integrate their services.
-The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. +The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](https://www.spotcrime.info). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. ## Configuration diff --git a/source/_integrations/squeezebox.markdown b/source/_integrations/squeezebox.markdown index 0fc30a12769..e9b09617c8e 100644 --- a/source/_integrations/squeezebox.markdown +++ b/source/_integrations/squeezebox.markdown @@ -63,7 +63,7 @@ transporter_toslink: Call a custom Squeezebox JSONRPC API. -See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player= where HOST and PORT are the host name and port for your Logitech Media Server. +See documentation for this interface on `http://HOST:PORT/html/docs/cli-api.html?player=` where HOST and PORT are the host name and port for your Logitech Media Server. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown index 40120087c64..32704541803 100644 --- a/source/_integrations/ssdp.markdown +++ b/source/_integrations/ssdp.markdown @@ -12,7 +12,7 @@ Integrations can opt-in to be found by adding [an SSDP section](https://develope ## Configuration -To integrate this into Home Assistant, add the following section 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 # Example configuration.yaml entry diff --git a/source/_integrations/sun.markdown b/source/_integrations/sun.markdown index 58011a72b26..2c38f4fe31e 100644 --- a/source/_integrations/sun.markdown +++ b/source/_integrations/sun.markdown @@ -17,6 +17,8 @@ below the horizon. The sun can be used within automation as ## 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 sun: diff --git a/source/_integrations/system_health.markdown b/source/_integrations/system_health.markdown index 6535adc1a57..08944ce9c45 100644 --- a/source/_integrations/system_health.markdown +++ b/source/_integrations/system_health.markdown @@ -10,9 +10,10 @@ ha_release: 0.87 The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. -System health is included as part of the [default config](https://www.home-assistant.io/integrations/default_config/) starting with Home Assistant 0.88. If you do not wish to use the default config, you can 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 +# Example configuration.yaml entry system_health: ``` diff --git a/source/_integrations/telegram.markdown b/source/_integrations/telegram.markdown index 7fd7ec795df..d1e32de06e8 100644 --- a/source/_integrations/telegram.markdown +++ b/source/_integrations/telegram.markdown @@ -15,10 +15,10 @@ The `telegram` platform uses [Telegram](https://web.telegram.org) to deliver not The requirements are: - You need a [Telegram bot](https://core.telegram.org/bots). Please follow those [instructions](https://core.telegram.org/bots#6-botfather) to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user. -- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_bot) and define there your API key and the allowed chat ids to interact with. +- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_chatbot) and define there your API key and the allowed chat ids to interact with. - The `chat_id` of an allowed user. -The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.org/botYOUR_API_TOKEN/getUpdates](https://api.telegram.org/botYOUR_API_TOKEN/getUpdates) or to use `$ curl -X GET https://api.telegram.org/botYOUR_API_TOKEN/getUpdates` **after** you have sent the bot a message. Replace `YOUR_API_TOKEN` with your actual token. +The quickest way to retrieve your `chat_id` is visiting `https://api.telegram.org/botYOUR_API_TOKEN/getUpdates` or to use `$ curl -X GET https://api.telegram.org/botYOUR_API_TOKEN/getUpdates` **after** you have sent the bot a message. Replace `YOUR_API_TOKEN` with your actual token. The result set will include your chat ID as `id` in the `chat` section: diff --git a/source/_integrations/broadcast.markdown b/source/_integrations/telegram_broadcast.markdown similarity index 100% rename from source/_integrations/broadcast.markdown rename to source/_integrations/telegram_broadcast.markdown diff --git a/source/_integrations/telegram_bot.markdown b/source/_integrations/telegram_chatbot.markdown similarity index 99% rename from source/_integrations/telegram_bot.markdown rename to source/_integrations/telegram_chatbot.markdown index acd69e31b5b..eb91c44efeb 100644 --- a/source/_integrations/telegram_bot.markdown +++ b/source/_integrations/telegram_chatbot.markdown @@ -10,9 +10,9 @@ ha_iot_class: Cloud Push Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. -This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/integrations/polling) method or with the [webhooks](/integrations/webhooks) one, and trigger events when receiving messages. +This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/integrations/telegram_polling) method or with the [webhooks](/integrations/telegram_webhooks) one, and trigger events when receiving messages. -If you don't need to receive messages, you can use the [broadcast](/integrations/broadcast) platform instead. +If you don't need to receive messages, you can use the [broadcast](/integrations/telegram_broadcast) platform instead. ## Notification services diff --git a/source/_integrations/polling.markdown b/source/_integrations/telegram_polling.markdown similarity index 100% rename from source/_integrations/polling.markdown rename to source/_integrations/telegram_polling.markdown diff --git a/source/_integrations/webhooks.markdown b/source/_integrations/telegram_webhooks.markdown similarity index 100% rename from source/_integrations/webhooks.markdown rename to source/_integrations/telegram_webhooks.markdown diff --git a/source/_integrations/touchline.markdown b/source/_integrations/touchline.markdown index 2a074b9b795..714f000c78a 100644 --- a/source/_integrations/touchline.markdown +++ b/source/_integrations/touchline.markdown @@ -21,7 +21,7 @@ climate: {% configuration %} host: - description: The IP address of your controller, e.g., http://192.168.1.1. + description: The IP address of your controller, e.g., `http://192.168.1.1`. required: false type: string {% endconfiguration %} diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index 1348c36adf8..b2da28f417f 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -197,4 +197,4 @@ For Archer C9 models running firmware version 150811 or later please use the enc See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. -For Archer D9 model the default ip is 192.168.1.1, the username is not necessary and you can leave that field blank. \ No newline at end of file +For Archer D9 model the default IP is 192.168.1.1, the username is not necessary and you can leave that field blank. diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index d3f682afe69..4a43f7baa50 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -1,6 +1,6 @@ --- title: "IKEA Trådfri (Tradfri)" -description: "Access and control your IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge) and via it its connected Zigbee-based devices." +description: "Access and control your IKEA Trådfri Gateway and its connected Zigbee-based devices." featured: true logo: ikea.svg ha_iot_class: Local Polling @@ -13,12 +13,12 @@ ha_category: - Switch --- -The `tradfri` integration support the IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge). The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it and Home Assistant will automatically discover the gateways presence on your local network, if `discovery:` is present in your `configuration.yaml` file. +The `tradfri` integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file. -You will be prompted to configure the gateway through the Home Assistant interface. The configuration process is very simple, when prompted, enter the security key printed on the physical sticker that is on the bottom of the IKEA Trådfri Gateway, then click configure. +You will be prompted to configure the gateway through the Home Assistant interface. The configuration process is very simple: when prompted, enter the security key printed on the sticker on the bottom of the IKEA Trådfri Gateway, then click *configure*.
-If you see an "Unable to connect" message, restart the gateway and try again. Don't forget to assign a permanent IP address to your IKEA Trådfri Gateway in your router / DHCP-server. +If you see an "Unable to connect" message, restart the gateway and try again. Don't forget to assign a permanent IP address to your IKEA Trådfri Gateway on your router or DHCP server.
## Configuration @@ -47,11 +47,11 @@ allow_tradfri_groups: ### Firmware updates -After updating the firmware of your IKEA Trådfri Gateway it might be necessary to repeat the configuration process. Possible errors: `Fatal DTLS error: code 115`. If you encounter problems: -- when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete using trash can icon; -- with manual configuration: delete the `.tradfri_psk.conf` file in your `.homeassistant` directory; +After updating your IKEA Trådfri Gateway firmware it might be necessary to repeat the configuration process. One error you might experience after a firmware update is `Fatal DTLS error: code 115`. If you encounter problems: +- when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete (trash can icon) +- with manual configuration: delete the `.tradfri_psk.conf` file in your `/.homeassistant` directory (`/config` directory if using Hass.io or Docker) -Then restart Home Assistant, when prompted enter the security key and click configure, just like during initial setup. +Then restart Home Assistant. When prompted, enter the security key and click *configure*, just like during initial setup. ### Compilation issues @@ -59,7 +59,7 @@ Then restart Home Assistant, when prompted enter the security key and click conf This does not apply to Hass.io or Docker. -Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf`) if you want to use this component. Also, installing some dependencies might take considerable time (>1 h) on slow devices. +Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf`) if you want to use this component. Also, installing some dependencies might take considerable time (more than one hour) on slow devices. ### Setting the `api_key` diff --git a/source/_integrations/updater.markdown b/source/_integrations/updater.markdown index 0833d8af843..550422bab05 100644 --- a/source/_integrations/updater.markdown +++ b/source/_integrations/updater.markdown @@ -10,7 +10,7 @@ ha_release: 0.8 The `updater` binary sensor will check daily for new releases. The state will be "on" when an update is available. Otherwise, the state will be "off". The newer version, as well as the link to the release notes, are attributes of the updater. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this binary sensor on Hass.io. -The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/integrations/updater). +The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/updater).
@@ -20,7 +20,7 @@ The `updater` binary sensor will wait one hour after startup until it performs t ## Configuration -To integrate this into Home Assistant, add the following section 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 updater: diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown index 07f855340b6..1d1fbccc8dd 100644 --- a/source/_integrations/vizio.markdown +++ b/source/_integrations/vizio.markdown @@ -1,6 +1,6 @@ --- title: "Vizio SmartCast Device" -description: "Instructions on how to integrate Vizio SmartCast TVs and Sound Bars into Home Assistant." +description: "Instructions on how to integrate Vizio SmartCast TVs and sound bars into Home Assistant." logo: vizio-smartcast.png ha_category: - Media Player @@ -8,11 +8,11 @@ ha_release: 0.49 ha_iot_class: Local Polling --- -The `vizio` integration will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs and Sound Bars (2016+ models). +The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models). ## Find your device -Install the command-line tool using `pip` (or you can choose to download it manually): +Install the command line tool using `pip` (or download it manually): ```bash $ pip3 install pyvizio @@ -35,11 +35,11 @@ Find your device using the following command: pyvizio --ip=0 discover ``` -and note it's IP address. If using your IP address by itself does not lead to success, you may need to append `:9000` or `:7345` to it when using it as a parameter in future commands. +and note its IP address. If using the IP address by itself does not work, you may need to append `:9000` or `:7345` to it when using it as a parameter in future commands. ## Pairing -Before adding your device to Home Assistant you may need to pair it manually. For a Sound Bar, it is unclear how the device would notify you of a valid auth token, so it's best to first skip the pairing process entirely, specify a `device_class` of `soundbar` in your configuration, and try interacting with the entity to see if you have any success. If the media player controls aren't working, and if specifying different ports as mentioned above doesn't work, you will need to find a way to get the auth token during this process. +Before adding your device to Home Assistant, you may need to pair it manually. In particular, it is unclear how a sound bar would notify you of a valid auth token. In this case, it might be best to first skip the pairing process entirely, specify a `device_class` of `soundbar` in your configuration, and try interacting with the entity to see if you have any success. If the media player controls aren't working, and if specifying different ports as mentioned above doesn't work, you will need to find a way to obtain the auth token during this process. To obtain an auth token, follow these steps: @@ -63,7 +63,7 @@ Initiation will show you two different values: | Challenge type | Usually it should be `"1"`. If not, use the additional parameter `--ch_type=your_type` in the next step | | Challenge token | Token required to finalize pairing in the next step | -Finally, at this point a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing: +At this point, a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing: ```bash $ pyvizio --ip={ip} --device_type={device_type} pair-finish --token={challenge_token} --pin={pin} @@ -93,7 +93,7 @@ access_token: required: false type: string device_class: - description: The class of your device. Your choices are `tv` or `soundbar` + description: The class of your device. Valid options are `tv` or `soundbar` required: false type: string default: tv @@ -108,12 +108,12 @@ suppress_warning: ### Turning device on -If the `Power Mode` of your device is set to `Eco Mode`, turning the device ON won't work. +If the `Power Mode` of your device is set to `Eco Mode`, turning the device on won't work. ### Changing tracks -Changing tracks works like channels switching. If you have source other than regular TV it might end do nothing. +Changing tracks works like switching channels. If the current input is anything other than regular TV, this command might not do anything. ### Sources -Source list shows all external devices connected to the device through HDMI plus list of internal devices (TV mode, Chrome Cast, etc.). +The source list shows all external devices connected to the Vizio device through HDMI, plus a list of internal devices (TV mode, Chromecast, etc.) diff --git a/source/_integrations/watson_iot.markdown b/source/_integrations/watson_iot.markdown index 87db524ea15..f01c6696e46 100644 --- a/source/_integrations/watson_iot.markdown +++ b/source/_integrations/watson_iot.markdown @@ -14,7 +14,7 @@ with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace To use this component, you first need to register a gateway device type and then a gateway device in your IoT platform instance. For instructions on how to do -this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) +this check the [official documentation](https://cloud.ibm.com/docs/services/IoT?topic=iot-platform-getting-started#IoT_connectGateway) which provides the details on doing this. After you register the gateway device for your home-assistant you'll need 4 pieces of information: diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown index 44f423786cb..2f65bb76550 100644 --- a/source/_integrations/waze_travel_time.markdown +++ b/source/_integrations/waze_travel_time.markdown @@ -10,7 +10,7 @@ ha_release: 0.67 The `waze_travel_time` sensor provides travel time from the [Waze](https://www.waze.com/). -Unit system is set to metric system. +Unit system is by default set to the metric system. ## Configuration @@ -27,11 +27,11 @@ sensor: {% configuration %} origin: - description: Enter the starting address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter an entity id which provides this information in its state, a entity id with latitude and longitude attributes, or zone friendly name. + description: Enter the starting address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name. required: true type: string destination: - description: Enter the destination address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter an entity id which provides this information in its state, a entity id with latitude and longitude attributes, or zone friendly name. + description: Enter the destination address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name. required: true type: string region: @@ -57,7 +57,7 @@ realtime: type: boolean default: true units: - description: "Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`." + description: "Set the unit of measurement for the sensor in metric or imperial, otherwise the default unit of measurement is the same as the unit set in `unit_system:`." required: false type: string vehicle_type: @@ -70,7 +70,7 @@ vehicle_type: Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand. -In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval set to fetch Waze data). +In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval of Waze data fetching). {% raw %} ```yaml @@ -117,11 +117,11 @@ sensor: destination: "725 5th Ave, New York, NY 10022, USA" region: 'US' units: imperial # 'metric' for Metric, 'imperial' for Imperial - vehicle_type: motorcycle # vehicle type used for route + vehicle_type: motorcycle # vehicle type used for routing ``` {% endraw %} -## Using the live map in a iFrame +## Using the live map in an iFrame If you plan to use [Waze's live map](https://developers.google.com/waze/iframe/) in Lovelace [iframe](/lovelace/iframe/) then use diff --git a/source/_integrations/weather.markdown b/source/_integrations/weather.markdown index 55683718b6a..36f03d1c081 100644 --- a/source/_integrations/weather.markdown +++ b/source/_integrations/weather.markdown @@ -8,9 +8,9 @@ ha_qa_scale: internal ha_release: 0.32 --- -The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location. Read the integration documentation for your particular weather provider to learn how to set it up. +The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location. Read the integration documentation for your particular weather provider to learn how to set it up. -Home Assistant currently supports free web services and such which require a registration. +Home Assistant currently supports free web services some of which require registration. ## Condition mapping @@ -30,4 +30,4 @@ The `weather` platform only knows the below listed conditions. The reason for th - 'sunny' - 'windy' - 'windy-variant' -- 'exceptional': +- 'exceptional' diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown index 3b934d18df5..e14a970ad19 100644 --- a/source/_integrations/wemo.markdown +++ b/source/_integrations/wemo.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: type: boolean default: true static: - description: One or more static IP adresses for WeMo to use + description: One or more static IP addresses for WeMo to use required: false type: list {% endconfiguration %} @@ -103,4 +103,4 @@ There are several services which can be used for automations and control of the | `turn_off` | Calling this service will turn the humidifier off (entity_id is required). | `turn_on` | Calling this service will turn the humidifier on and set the speed to the last used speed (defaults to medium, entity_id is required). | `wemo_set_humidity` | Calling this service will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)). -| `wemo_reset_filter_life` | Calling this service will reset the humdifier's filter life back to 100% (entity_id is a required list of 1 or more entities to reset the filter life on). Call this service when you change the filter on your humidifier. \ No newline at end of file +| `wemo_reset_filter_life` | Calling this service will reset the humdifier's filter life back to 100% (entity_id is a required list of 1 or more entities to reset the filter life on). Call this service when you change the filter on your humidifier. diff --git a/source/_integrations/worxlandroid.markdown b/source/_integrations/worxlandroid.markdown index acd2aaf1805..43443c9d00b 100644 --- a/source/_integrations/worxlandroid.markdown +++ b/source/_integrations/worxlandroid.markdown @@ -22,7 +22,7 @@ sensor: {% configuration %} host: - description: The ip address or host name of the mower. + description: The IP address or host name of the mower. required: true type: string pin: diff --git a/source/_integrations/xiaomi.markdown b/source/_integrations/xiaomi.markdown index 0ff19263a7c..b1440866c1d 100644 --- a/source/_integrations/xiaomi.markdown +++ b/source/_integrations/xiaomi.markdown @@ -112,7 +112,7 @@ camera: ``` ## Hostname template -The hostname/ip address can be provided either a value or from the existing entity attributes. +The hostname/IP address can be provided either a value or from the existing entity attributes. ```yaml camera: diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown index 71fa14e6a00..11ff99f2eda 100644 --- a/source/_integrations/yeelight.markdown +++ b/source/_integrations/yeelight.markdown @@ -113,9 +113,9 @@ Per default the bulb limits the amount of requests per minute to 60, a limitatio
Before trying to control your light through Home Assistant, you have to setup your bulb using Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ). -In the bulb property, you have to enable "LAN Mode" (previously called "Developer mode"). LAN mode may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb. +In the bulb property, you have to enable "LAN Control" (previously called "Developer mode"). LAN Control may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb. Determine your bulb IP (using router, software, ping...). -Information on how to enable "LAN Mode" can be found [here](https://getyeti.co/posts/how-to-control-yeelight-and-your-smarthome-with-yeti). +Information on how to enable "LAN Control" can be found [here](https://www.yeelight.com/faqs/lan_control).
diff --git a/source/_integrations/yessssms.markdown b/source/_integrations/yessssms.markdown index 06b79c0be0c..322cde2d07f 100644 --- a/source/_integrations/yessssms.markdown +++ b/source/_integrations/yessssms.markdown @@ -9,7 +9,7 @@ ha_release: 0.57 The `yessssms` platform is using the Austrian mobile operator [Yesss.at](https://yesss.at) and others to send SMS via their web-site. -Currenty some MVNOs (mobile virtual network operators), in the A1 network, that use the kontomanager.at interface work. These are currently (as of version 0.4.0 of [YesssSMS](https://pypi.org/project/YesssSMS/)): +Currently some MVNOs (mobile virtual network operators), in the A1 network, that use the kontomanager.at interface work. These are currently (as of version 0.4.0 of [YesssSMS](https://pypi.org/project/YesssSMS/)): * YESSS * billitel * EDUCOM diff --git a/source/_integrations/zeroconf.markdown b/source/_integrations/zeroconf.markdown index b7119951f2f..7cb0c209973 100644 --- a/source/_integrations/zeroconf.markdown +++ b/source/_integrations/zeroconf.markdown @@ -13,7 +13,7 @@ Integrations can opt-in to be found by adding either [a Zeroconf section](https: ## Configuration -To have Home Assistant scan for integrations using zeroconf and HomeKit, add the following section 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, and you wish to have Home Assistant scan for integrations using zeroconf and HomeKit, the following example shows you how to enable this integration manually: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 3eb095f574d..dc67736d031 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -50,8 +50,11 @@ The custom quirks implementations for zigpy implemented as ZHA Device Handlers f - [ConBee II (a.k.a. ConBee 2) USB adapter from Dresden-Elektronik](https://shop.dresden-elektronik.de/conbee-2.html) - [ConBee USB adapter from Dresden-Elektronik](https://www.dresden-elektronik.de/conbee/) - [RaspBee Raspberry Pi Shield from Dresden-Elektronik](https://www.dresden-elektronik.de/raspbee/) -- ZiGate based radios (via the [zigpy-zigate](https://github.com/doudz/zigpy-zigate) library for zigpy) - - ZiGate USB modules (require firmware 3.1a or later) +- ZiGate based radios (via the [zigpy-zigate](https://github.com/doudz/zigpy-zigate) library for zigpy and require firmware 3.1a or later) + - [ZiGate USB-TTL](https://zigate.fr/produit/zigate-ttl/) + - [ZiGate USB-DIN](https://zigate.fr/produit/zigate-usb-din/) + - [PiZiGate](https://zigate.fr/produit/pizigate-v1-0/) + - [Wifi ZiGate](https://zigate.fr/produit/zigate-pack-wifi-v1-3/) (work in progress) ## Configuration @@ -66,6 +69,11 @@ zha: database_path: /home/homeassistant/.homeassistant/zigbee.db ``` +If you are use ZiGate, you have to use some special usb_path configuration: + - ZiGate USB TTL or DIN: `/dev/ttyUSB0` or `auto` to auto discover the zigate + - PiZigate : `pizigate:/dev/serial0` + - Wifi Zigate : `socket://[IP]:[PORT]` for example `socket://192.168.1.10:9999` + {% configuration %} radio_type: description: One of `ezsp`, `xbee`, `deconz` or `zigate`. @@ -94,10 +102,25 @@ enable_quirks: To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset. -In case you want to add Philips Hue bulbs that have previously been added to another bridge, have a look at: [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/) - ## Troubleshooting +### Add Philips Hue bulbs that have previously been added to another bridge + +Philips Hue bulbs that have previously been added to another bridge won't show up during search. You have to restore your bulbs back to factory settings first. To achieve this, you basically have the following options. + +#### Philips Hue Dimmer Switch + +Using a Philips Hue Dimmer Switch is probably the easiest way to factory-reset your bulbs. For this to work, the remote doesn't have to be paired with your previous bridge. + +1. Turn on your Hue bulb you want to reset +2. Hold the Dimmer Switch near your bulb (< 10 cm) +3. Press and hold the (I)/(ON) and (O)/(OFF) buttons of the Dimmer Switch for about 10 seconds until your bulb starts to blink +4. Your bulb should stop blinking and eventually turning on again. At the same time, a green light on the top left of your remote indicates that your bulb has been successfully reset to factory settings. + +#### hue-thief + +Follow the instructions on [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/) (EZSP-based Zigbee USB stick required) + ### ZHA Start up issue with Home-Assistant Docker/Hass.io installs on linux hosts On Linux hosts ZHA can fail to start during HA startup or restarts because the zigbee USB device is being claimed by the host's modemmanager service. To fix this disable the modemmanger on the host system. diff --git a/source/_lovelace/entity-filter.markdown b/source/_lovelace/entity-filter.markdown index 488c32f59a2..089930c171f 100644 --- a/source/_lovelace/entity-filter.markdown +++ b/source/_lovelace/entity-filter.markdown @@ -23,7 +23,7 @@ entities: description: A list of entity IDs or `entity` objects, see below. type: list state_filter: - required: false + required: true description: List of strings representing states or `filter` objects, see below. type: list card: @@ -84,7 +84,7 @@ value: type: string operator: required: false - description: Operator to use in the comparison. + description: Operator to use in the comparison. Can be `==`, `<=`, `<`, `>=`, `>`, `!=` or `regex`. type: string attribute: required: false diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index 3f3c15dd81f..f0f0efe6858 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -4,7 +4,10 @@ sidebar_label: Markdown description: "Markdown card is used to render markdown" --- -Markdown card is used to render [markdown](http://commonmark.org/help/). +Markdown card is used to render [Markdown](https://commonmark.org/help/). + +The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#/README.md#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`. +

Screenshot of the markdown card @@ -18,7 +21,7 @@ type: type: string content: required: true - description: "Content to render as [markdown](http://commonmark.org/help/). May contain [templates](/docs/configuration/templating/)." + description: "Content to render as [Markdown](https://commonmark.org/help/). May contain [templates](/docs/configuration/templating/)." type: string title: required: false @@ -59,6 +62,8 @@ entities: - light.bed_light - light.ceiling_lights - light.kitchen_lights +state_filter: + - 'on' card: type: markdown content: | diff --git a/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown b/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown index ce5ebc0b797..005e4aff134 100644 --- a/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown +++ b/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown @@ -11,6 +11,6 @@ Home Assistant is now using [YAML](http://yaml.org/) for it's configuration file The new file is named configuration.yaml and if it can't be found in your config directory, Home Assistant will instead try to find the old configuration file, home-assistant.conf. -The home-assistant.conf.example has been replaced with an updated [configuration.yaml.example](https://github.com/home-assistant/home-assistant/blob/dev/config/configuration.yaml.example). +The home-assistant.conf.example has been replaced with an updated configuration.yaml.example. Users of Home Assistant should migrate as the old configuration format is deprecated. diff --git a/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown b/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown index 215e6b59991..aefaddf13c2 100644 --- a/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown +++ b/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown @@ -36,7 +36,7 @@ Maker channel setup: | Field | Value | | ----- | ----- | -| URL | http://xxx.xxx.xxx.xxx:8123/api/services/switch/turn_off?api_password=xxxxxxxx +| URL | `http://xxx.xxx.xxx.xxx:8123/api/services/switch/turn_off?api_password=xxxxxxxx` | METHOD | POST | CONTENT TYPE | application/json | BODY | { "entity_id": "switch.irrigation" } @@ -73,7 +73,7 @@ Maker channel setup: | Field | Value | | ----- | ----- | -| URL | http://xxx.xxx.xxx.xxx:8123/api/services/light/turn_on?api_password=xxxxxxxx +| URL | `http://xxx.xxx.xxx.xxx:8123/api/services/light/turn_on?api_password=xxxxxxxx` | METHOD | POST | CONTENT TYPE | application/json | BODY | { "entity_id": "light.kitchen" } @@ -88,7 +88,7 @@ Maker channel setup: | Field | Value | | ----- | ----- | -| URL | http://xxx.xxx.xxx.xxx:8123/api/services/light/turn_on?api_password=xxxxxxxx +| URL | `http://xxx.xxx.xxx.xxx:8123/api/services/light/turn_on?api_password=xxxxxxxx` | METHOD | POST | CONTENT TYPE | application/json | BODY | { "entity_id": "group.all_lights", "flash":"yes" } diff --git a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown index 02c9c0a916e..918394e923f 100644 --- a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown +++ b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown @@ -24,7 +24,7 @@ After two weeks of hard work I'm proud to announce the release of Home Assistant - Light: [Hyperion](/integrations/hyperion) now supported (@MakeMeASandwich) - Sensor: [aRest](/integrations/arest#sensor) can now also read out pins ([@balloob](https://github.com/balloob)) - Sensor: [Forecast.io](/integrations/darksky) now supports specifying units in `configuration.yaml` ([@balloob](https://github.com/balloob)) - - Thermostat: [Heat Control](/integrations/thermostat.heat_control/) has been completely rewritten ([@balloob](https://github.com/balloob)) + - Thermostat: Heat Control has been completely rewritten ([@balloob](https://github.com/balloob)) - Switch: [Rest](/integrations/switch.rest/) now supported ([@bachp](https://github.com/bachp)) - Media Player: [Plex](/integrations/plex#media-player) can now be auto discovered and configure itself ([@tomduijf](https://github.com/tomduijf)) - [Downloader](/integrations/downloader/) will now treat relative paths based on config dir ([@tomduijf](https://github.com/tomduijf)) diff --git a/source/_posts/2015-11-22-survey-november-2015.markdown b/source/_posts/2015-11-22-survey-november-2015.markdown index 34a8ea42e80..7ba6aaf218a 100644 --- a/source/_posts/2015-11-22-survey-november-2015.markdown +++ b/source/_posts/2015-11-22-survey-november-2015.markdown @@ -19,7 +19,7 @@ Of course most users are running with the [automation](/getting-started/automati The [Alarm control panels](/integrations/alarm_control_panel/) and the [camera component](/integrations/camera/) are both used by around one third of the participants of the survey. It's safe to say that they cover a niche, but they will gain momentum when people discover how they can build alarm systems with Home Assistant. -[Philips Hue](/integrations/hue) is the "winner" in the light category closely followed by [MQTT lights](components/light.mqtt/). [Google Cast](/integrations/cast) and [ Plex](/integrations/plex#media-player) are the top media player platforms. [Pushbullet](/integrations/pushbullet) is by far the most-used [notification platform](/integrations/notify/). If you followed the recent efforts to improve this platform it's comprehensible. +[Philips Hue](/integrations/hue) is the "winner" in the light category closely followed by [MQTT lights](/integrations/light.mqtt/). [Google Cast](/integrations/cast) and [ Plex](/integrations/plex#media-player) are the top media player platforms. [Pushbullet](/integrations/pushbullet) is by far the most-used [notification platform](/integrations/notify/). If you followed the recent efforts to improve this platform it's comprehensible. It's interesting to see that most of the sensor, switch, and thermostat platforms are used. A lot of people seem to be interested in the weather data provided by the [Forecast sensor](/integrations/darksky). The MQTT sensors and switches are deployed in almost 50% of all Home Assistant setups. diff --git a/source/_posts/2015-12-07-influxdb-and-grafana.markdown b/source/_posts/2015-12-07-influxdb-and-grafana.markdown index 99cd2cc3edb..349c9d652c2 100644 --- a/source/_posts/2015-12-07-influxdb-and-grafana.markdown +++ b/source/_posts/2015-12-07-influxdb-and-grafana.markdown @@ -27,7 +27,7 @@ Launch the InfluxDB service. sudo systemctl start influxdb ``` -If everything went well, then the web interface of the database should be accessible at [http://localhost:8083/](http://localhost:8083/). Create a database `home_assistant` to use with Home Assistant either with the web interface or the commandline tool `influx`. +If everything went well, then the web interface of the database should be accessible at `http://localhost:8083/`. Create a database `home_assistant` to use with Home Assistant either with the web interface or the commandline tool `influx`.

@@ -88,7 +88,7 @@ sudo systemctl start grafana-server sudo systemctl status grafana-server ``` -Login with the username `admin` and the password `admin` at [http://localhost:3000/login](http://localhost:3000/login). Now follow the [InfluxDB setup instructions](http://docs.grafana.org/datasources/influxdb/). +Login with the username `admin` and the password `admin` at `http://localhost:3000/login`. Now follow the [InfluxDB setup instructions](http://docs.grafana.org/datasources/influxdb/). Now you can start to create dashboards and graphs. You have various options to get the data from the graph. The next image just shows a screenshot of the setting for a temperature sensor. diff --git a/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown b/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown index 7bf8cedd2a2..d245bfdeb4b 100644 --- a/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown +++ b/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown @@ -100,7 +100,7 @@ http: ssl_key: /etc/letsencrypt/live/hass-example.duckdns.org/privkey.pem ``` -You can now navigate to https://hass-example.duckdns.org and enjoy encryption! +You can now navigate to `https://hass-example.duckdns.org` and enjoy encryption! _Big thanks to Fabian Affolter for his help and feedback on this article._ diff --git a/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown b/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown index dc2be3b841b..4e5a3f5f93e 100644 --- a/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown +++ b/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown @@ -82,7 +82,7 @@ Affected components and platforms: - automation: [numeric_state][automation-numeric-state] [sensor.arest]: /integrations/arest#sensor -[sensor.command]: /integrations/sensor.command_sensor/ +[sensor.command]: /integrations/sensor.command_line/ [sensor.rest]: /integrations/rest [sensor.mqtt]: /integrations/sensor.mqtt/ [switch.mqtt]: /integrations/switch.mqtt/ diff --git a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown index 3e9279a15c2..b39db3f69e0 100644 --- a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown +++ b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown @@ -41,7 +41,7 @@ First release of 2016 and we are on 🔥! The [main repository][github-ha] has p [YR]: /integrations/yr [Locative]: /integrations/locative [sun condition]: /getting-started/automation-condition/#sun-condition -[command_switch]: /integrations/switch.command_switch/ +[command_switch]: /integrations/switch.command_line/ [wemo]: /integrations/wemo [Telldus Live]: /integrations/tellduslive/ [Vera]: /integrations/vera/ diff --git a/source/_posts/2016-04-07-static-website.markdown b/source/_posts/2016-04-07-static-website.markdown index 0ac802ed2a1..7f6eae57c40 100644 --- a/source/_posts/2016-04-07-static-website.markdown +++ b/source/_posts/2016-04-07-static-website.markdown @@ -9,7 +9,7 @@ categories: How-To og_image: /images/blog/2016-04-display/ha-display.png --- -The frontend of Home Assistant is served with the help of a local web server. If you have [customized](/getting-started/devices/#customizing-devices-and-services) your installation you already use this functionality. The content of your folder `www` in your Home Assistant configuration directory (`.homeassistant`) is available under `/local` (eg. [http://localhost:8123/local](https://localhost:8123/local/index.html) for an `index.html` file). +The frontend of Home Assistant is served with the help of a local web server. If you have [customized](/getting-started/devices/#customizing-devices-and-services) your installation you already use this functionality. The content of your folder `www` in your Home Assistant configuration directory (`.homeassistant`) is available under `/local` (eg. `https://localhost:8123/local/index.html` for an `index.html` file). But there is more you can do! You can not only host images for customization there but HTML files or even web applications including CSS and Javascript. @@ -19,11 +19,10 @@ But there is more you can do! You can not only host images for customization the -In the past the buzz word "Smart mirror" was used a couple of times in our [chatroom](https://discord.gg/c5DvZ4e) and even made it into the [issue tracker](https://github.com/home-assistant/home-assistant/issues/1392). The existing solutions ([Smart mirror](http://docs.smart-mirror.io/), [MagicMirror](http://michaelteeuw.nl/tagged/magicmirror), and [HomeMirror](https://github.com/HannahMitt/HomeMirror)) seems to be overkill if you already have Home Assistant running somewhere in your house or apartment. Why not simple display a web page served by Home Assistant on the tablet? No app and no Raspberry Pi running in the background. +In the past the buzz word "Smart mirror" was used a couple of times in our [chatroom](https://discord.gg/c5DvZ4e) and even made it into the [issue tracker](https://github.com/home-assistant/home-assistant/issues/1392). The existing solutions ([Smart mirror](https://docs.smart-mirror.io/), [MagicMirror](https://michaelteeuw.nl/tagged/magicmirror), and [HomeMirror](https://github.com/HannahMitt/HomeMirror)) seems to be overkill if you already have Home Assistant running somewhere in your house or apartment. Why not simple display a web page served by Home Assistant on the tablet? No app and no Raspberry Pi running in the background. -There are plenty of ways to achieve this...[RESTful API](/developers/rest_api/), [Python API](/developers/python_api/), or one of the [history components](/integrations/#history). If it is to be a web page I'm using the [MQTT Eventstream component](/integrations/mqtt_eventstream/) and [mqttws31.js](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.javascript.git/tree/src). +There are plenty of ways to achieve this...[RESTful API](/developers/rest_api/), [Python API](/developers/python_api/), or one of the [history components](/integrations/#history). If it is to be a web page I'm using the [MQTT Eventstream component](/integrations/mqtt_eventstream/) and [Eclipse Paho JavaScript Client](https://www.eclipse.org/paho/clients/js/). -The [HBMQTT](https://pypi.python.org/pypi/hbmqtt) broker provides websockets support for MQTT and mqttws31.js included in web page gives you access to the MQTT messages. It's a matter of minutes. OK, it took a little longer because I'm not a Javascript guy to create the software part that will show details about your environment. The source is available at [https://github.com/fabaff/home-assistant-display](https://github.com/fabaff/home-assistant-display) and the screenshot above shows the result. I guess that every person who is familiar with Javascript would be able to reduce the amount of code and to make it more flexible. Well, it's only a prototype and showcase to include an image in this blog post. +The [HBMQTT](https://pypi.org/pypi/hbmqtt) broker provides websockets support for MQTT and mqttws31.js included in web page gives you access to the MQTT messages. It's a matter of minutes. OK, it took a little longer because I'm not a Javascript guy to create the software part that will show details about your environment. The source is available at [https://github.com/fabaff/home-assistant-display](https://github.com/fabaff/home-assistant-display) and the screenshot above shows the result. I guess that every person who is familiar with Javascript would be able to reduce the amount of code and to make it more flexible. Well, it's only a prototype and showcase to include an image in this blog post. I hope that this little article could give you an idea of extending Home Assistant in an unconventional way. - diff --git a/source/_posts/2016-04-17-updated-documentation.markdown b/source/_posts/2016-04-17-updated-documentation.markdown index 83d4d21e3e8..9294a31cb66 100644 --- a/source/_posts/2016-04-17-updated-documentation.markdown +++ b/source/_posts/2016-04-17-updated-documentation.markdown @@ -10,14 +10,14 @@ categories: Website One of the main complaints that we receive is something along the lines "I read that X is possible yet I am unable to find it on the website.". This post is to announce that we have taken the first steps to improve it by revamping the [getting started] and [developers] sections. It's still a work in progress but we now have a solid foundation to build on for the future 👍. -Our documentation has been going through various phases. Initially it was just the README in our GitHub repository. I discovered Jekyll and GitHub pages in December 2014 and created home-assistant.io. I more or less broke the README in 5 pages and [called it a website]. Back then we had a whopping [11 components](https://github.com/home-assistant/home-assistant.io/blob/86bb2df430ce267ab2123d51592d3f068ae509b5/source/integrations/index.markdown). +Our documentation has been going through various phases. Initially it was just the README in our GitHub repository. I discovered Jekyll and GitHub pages in December 2014 and created home-assistant.io. I more or less broke the README in 5 pages and [called it a website]. Back then we had a whopping 11 components! As Home Assistant grew, so did our documentation. [Fabian Affolter](https://github.com/fabaff) does an amazing job in making sure there is at least a documentation stub for each new feature that lands. And that's quite a feat given our [frequent releases](/blog/categories/release-notes/)! But despite all the efforts, the documentation outgrew our existing documentation organization. Today it has been almost 1.5 years since we started the website. We now have [264 components and platforms] under our belt and have been honored with 1.5 million page views ✨. And hopefully we now also have documentation that our community deserves. [getting started]: /getting-started/ -[developers]: /developers/ +[developers]: https://developers.home-assistant.io/ [called it a website]: /blog/2014/12/18/website-launched/ [264 components and platforms]: /integrations/ diff --git a/source/_posts/2016-05-21-release-020.markdown b/source/_posts/2016-05-21-release-020.markdown index 21b3319391f..ab894fddc31 100644 --- a/source/_posts/2016-05-21-release-020.markdown +++ b/source/_posts/2016-05-21-release-020.markdown @@ -25,7 +25,7 @@ Tons of new supported things in 0.20. - Configurator: allow supplying a link to the user ([@mnestor]) - Media Player: [Roku] now supported ([@bah2830]) - Sensor: [Last.fm] now supported ([@darookee], [@GreenTurtwig]) -- Notify: Amazon Lambda, [SNS], SQS now supported ([@robbiet480]) +- Notify: Amazon Lambda, SNS, SQS now supported ([@robbiet480]) - Light: allow human readable colors in turn_on command ([@robbiet480]) - YAML: new include dir options [`!include_dir_merge_list`] and [`!include_dir_merge_named`] ([@happyleavesaoc]) - Media Player: [LG Netcast TVs] now supported ([@wokar]) @@ -75,7 +75,6 @@ device_tracker: [Nest Protect]: /integrations/nest#sensor [purge days option]: /integrations/recorder/ [Roku]: /integrations/roku#media-player -[SNS]: /integrations/notify.aws_sns/ [supervisord]: /integrations/supervisord [Twilio SMS]: /integrations/twilio_sms [Last.fm]: /integrations/lastfm diff --git a/source/_posts/2016-05-26-ibeacons-how-to-track-things-that-cant-track-themselves-part-ii.markdown b/source/_posts/2016-05-26-ibeacons-how-to-track-things-that-cant-track-themselves-part-ii.markdown index 4446f7eb28f..38be3dbc1a0 100644 --- a/source/_posts/2016-05-26-ibeacons-how-to-track-things-that-cant-track-themselves-part-ii.markdown +++ b/source/_posts/2016-05-26-ibeacons-how-to-track-things-that-cant-track-themselves-part-ii.markdown @@ -128,7 +128,7 @@ Of course you can use both fixed and mobile beacons at the same time. I want my ### Buying Beacons This isn’t a buyer's guide, but I just wanted to mention the iBeacons I’ve been using. I think you should be able to use any iBeacon with HA and OwnTracks. You generally can’t buy beacons in your local electronics shop - so I just wanted to briefly mention the two suppliers I’ve used so far. -I’ve bought quite a few iBeacons from a company called [Blue Sense Networks](http://bluesensenetworks.com/). I work in the tech startup sector in the UK so I partly chose them because they are a local start-up who seemed worth supporting. The products, support and software all seem good. I use a number of their beacons - from a simple USB dongle, to a long range beacon. All their products have batteries that can be changed (or no batteries in the case of the externally powered USB device) - and you can configure all the parameters you’d want to using their software. I had one software issue, support got back to me at a weekend(!) - and the issue was resolved with a software release two days later. +I’ve bought quite a few iBeacons from a company called Blue Sense Networks. I work in the tech startup sector in the UK so I partly chose them because they are a local start-up who seemed worth supporting. The products, support and software all seem good. I use a number of their beacons - from a simple USB dongle, to a long range beacon. All their products have batteries that can be changed (or no batteries in the case of the externally powered USB device) - and you can configure all the parameters you’d want to using their software. I had one software issue, support got back to me at a weekend(!) - and the issue was resolved with a software release two days later. All the beacons seem fine - and the long range unit does work over a longer range than my other beacons. diff --git a/source/_posts/2016-07-28-esp8266-and-micropython-part1.markdown b/source/_posts/2016-07-28-esp8266-and-micropython-part1.markdown index fb6f1d67e6b..04289b0005a 100644 --- a/source/_posts/2016-07-28-esp8266-and-micropython-part1.markdown +++ b/source/_posts/2016-07-28-esp8266-and-micropython-part1.markdown @@ -9,13 +9,13 @@ og_image: /images/blog/2016-07-micropython/social.png --- -The first release of Micropython for ESP8266 was delivered a couple of weeks ago. The [documentation](http://docs.micropython.org/en/latest/esp8266/esp8266_contents.html) covers a lot of ground. This post is providing only a little summary which should get you started. +The first release of Micropython for ESP8266 was delivered a couple of weeks ago. The [documentation](http://docs.micropython.org/en/latest/) covers a lot of ground. This post is providing only a little summary which should get you started. Until a couple of weeks ago, the pre-built MicroPython binary for the ESP8266 was only available to backers of the Kickstarter campaign. This has changed now and it is available to the public for [download](https://micropython.org/download/#esp8266). -The easiest way is to use [esptool.py](https://github.com/themadinventor/esptool) for firmware handling tasks. First erase the flash: +The easiest way is to use [esptool.py](https://github.com/espressif/esptool) for firmware handling tasks. First erase the flash: ```bash $ sudo python esptool.py --port /dev/ttyUSB0 erase_flash @@ -56,7 +56,7 @@ Type "help()" for more information.

-The public build of the firmware may be different than the firmware distributed to the backers of the Kickstarter campaign. Especially in regard of the [available modules](http://docs.micropython.org/en/latest/esp8266/py-modindex.html), turned on debug messages, and alike. Also, the WebREPL may not be started by default. +The public build of the firmware may be different than the firmware distributed to the backers of the Kickstarter campaign. Especially in regard of the [available modules](http://docs.micropython.org/en/latest/esp8266/quickref.html), turned on debug messages, and alike. Also, the WebREPL may not be started by default.
diff --git a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown index 9c60f40e70e..b692820f1ad 100644 --- a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown +++ b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown @@ -283,7 +283,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [@kitcorey]: https://github.com/kitcorey [@andersonshatch]: https://github.com/andersonshatch -[telegram]: /integrations/webhooks/ +[telegram]: /integrations/telegram_webhooks/ [pushsafer]: /integrations/pushsafer [openhome]: /integrations/openhome [ups]: /integrations/ups diff --git a/source/_posts/2017-04-01-thomas-krenn-award.markdown b/source/_posts/2017-04-01-thomas-krenn-award.markdown index 92ba7221fc7..cf6554a9cf3 100644 --- a/source/_posts/2017-04-01-thomas-krenn-award.markdown +++ b/source/_posts/2017-04-01-thomas-krenn-award.markdown @@ -33,6 +33,6 @@ Keep in mind that you may have to pay the fee for customs handling and the impor [LES]: https://www.thomas-krenn.com/en/products/low-energy-systems/les-v2.html [award]: https://www.thomas-krenn.com/de/tkmag/allgemein/zammad-home-assistant-und-freifunk-das-sind-die-gewinner-des-thomas-krenn-awards-2017/ -[forum]: https://community.home-assistant.io/c/contest-2017 +[forum]: https://community.home-assistant.io/t/hardware-contest-2017/42546 [twitter]: https://twitter.com/home_assistant diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown index 74444c2dcc7..ff381ec664f 100644 --- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown +++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown @@ -472,9 +472,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tplink docs]: /integrations/tplink [switch.wake_on_lan docs]: /integrations/wake_on_lan#switch [switch.wemo docs]: /integrations/wemo -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tts.google docs]: /integrations/google_translate [tts.marytts docs]: /integrations/marytts [vera docs]: /integrations/vera/ @@ -494,8 +494,8 @@ Experiencing issues introduced by this release? Please report them in our [issue [recorder docs]: /integrations/recorder/ [switch.hook docs]: /integrations/hook [switch.wemo docs]: /integrations/wemo -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [wemo docs]: /integrations/wemo/ [#7271]: https://github.com/home-assistant/home-assistant/pull/7271 [#7282]: https://github.com/home-assistant/home-assistant/pull/7282 @@ -511,5 +511,5 @@ Experiencing issues introduced by this release? Please report them in our [issue [hassio docs]: /integrations/hassio/ [notify.html5 docs]: /integrations/html5 [notify.telegram docs]: /integrations/telegram -[telegram_bot.polling docs]: /integrations/polling +[telegram_bot.polling docs]: /integrations/telegram_polling [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown b/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown index 85276819db0..3fc78eb00cb 100644 --- a/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown +++ b/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown @@ -69,7 +69,7 @@ sudo systemctl start install_homeassistant.service Wait about 15-20 minutes and voilà you have your Home Assistant on your Raspberry Pi Zero W in 30 minutes. -To try it out, go to [http://hassbian:8123](http://hassbian:8123) or [http://hassbian.local:8123](http://hassbian.local:8123) if you're using Mac. +To try it out, go to `http://hassbian:8123` or `http://hassbian.local:8123` if you're using Mac. For further details about HASSbian, take a look at the [documentation](/docs/installation/hassbian/). diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown index 2bbefe48db5..b4b4636072f 100644 --- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown +++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown @@ -487,9 +487,9 @@ influxdb: [switch.thinkingcleaner docs]: /integrations/thinkingcleaner#switch [switch.wemo docs]: /integrations/wemo [switch.zha docs]: /integrations/zha -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [updater docs]: /integrations/updater/ [vera docs]: /integrations/vera/ [wemo docs]: /integrations/wemo/ diff --git a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown index aa5c2db58a4..fd7684ca022 100644 --- a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown +++ b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown @@ -413,10 +413,10 @@ Experiencing issues introduced by this release? Please report them in our [issue [sensor.wunderground docs]: /integrations/wunderground [sun docs]: /integrations/sun/ [switch.rpi_pfio docs]: /integrations/rpi_pfio#switch -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.services.yaml docs]: /integrations/telegram_bot/#notification-services -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.services.yaml docs]: /integrations/telegram_chatbot/#notification-services +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tradfri docs]: /integrations/tradfri/ [vera docs]: /integrations/vera/ [websocket_api docs]: /integrations/websocket_api/ @@ -434,5 +434,5 @@ Experiencing issues introduced by this release? Please report them in our [issue [device_tracker.ubus docs]: /integrations/ubus [hassio docs]: /integrations/hassio/ [media_player.volumio docs]: /integrations/volumio -[telegram_bot.__init__ docs]: /integrations/telegram_bot/ +[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-06-04-release-46.markdown b/source/_posts/2017-06-04-release-46.markdown index c6cb01e8558..de6ecb3d5ee 100644 --- a/source/_posts/2017-06-04-release-46.markdown +++ b/source/_posts/2017-06-04-release-46.markdown @@ -369,9 +369,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.broadlink docs]: /integrations/broadlink#switch [switch.rachio docs]: /integrations/rachio#switch [switch.rflink docs]: /integrations/switch.rflink/ -[telegram_bot.__init__ docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tellduslive docs]: /integrations/tellduslive/ [upnp docs]: /integrations/upnp/ [zoneminder docs]: /integrations/zoneminder/ diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown index ffca4c6f80d..af58001c4d2 100644 --- a/source/_posts/2017-06-17-release-47.markdown +++ b/source/_posts/2017-06-17-release-47.markdown @@ -547,9 +547,9 @@ automation: [switch.raspihats docs]: /integrations/raspihats#switch [switch.rest docs]: /integrations/switch.rest/ [switch.template docs]: /integrations/switch.template/ -[telegram_bot.__init__ docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [updater docs]: /integrations/updater/ [vera docs]: /integrations/vera/ [volvooncall docs]: /integrations/volvooncall/ diff --git a/source/_posts/2017-07-02-release-48.markdown b/source/_posts/2017-07-02-release-48.markdown index bd01a923669..3021ae20d11 100644 --- a/source/_posts/2017-07-02-release-48.markdown +++ b/source/_posts/2017-07-02-release-48.markdown @@ -504,8 +504,8 @@ light: [switch.verisure docs]: /integrations/verisure [switch.wake_on_lan docs]: /integrations/wake_on_lan#switch [tado docs]: /integrations/tado/ -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tellduslive docs]: /integrations/tellduslive/ [tts docs]: /integrations/tts/ [upnp docs]: /integrations/upnp/ diff --git a/source/_posts/2017-07-16-release-49.markdown b/source/_posts/2017-07-16-release-49.markdown index 6f8201c8916..e7d2c1100b2 100644 --- a/source/_posts/2017-07-16-release-49.markdown +++ b/source/_posts/2017-07-16-release-49.markdown @@ -488,7 +488,7 @@ amcrest: [@maikelwever]: https://github.com/maikelwever [@ypollart]: https://github.com/ypollart [binary_sensor.rfxtrx docs]: /integrations/binary_sensor.rfxtrx/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [#8545]: https://github.com/home-assistant/home-assistant/pull/8545 [#8571]: https://github.com/home-assistant/home-assistant/pull/8571 [#8601]: https://github.com/home-assistant/home-assistant/pull/8601 diff --git a/source/_posts/2017-07-29-release-50.markdown b/source/_posts/2017-07-29-release-50.markdown index 52776a60d82..2c701c3336e 100644 --- a/source/_posts/2017-07-29-release-50.markdown +++ b/source/_posts/2017-07-29-release-50.markdown @@ -417,5 +417,5 @@ conversation: [@n8henrie]: https://github.com/n8henrie [light.tradfri docs]: /integrations/tradfri [media_player.pioneer docs]: /integrations/pioneer -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [zwave docs]: /integrations/zwave/ diff --git a/source/_posts/2017-08-12-release-51.markdown b/source/_posts/2017-08-12-release-51.markdown index 76f8cd2fb65..8ce4edd2269 100644 --- a/source/_posts/2017-08-12-release-51.markdown +++ b/source/_posts/2017-08-12-release-51.markdown @@ -442,7 +442,7 @@ vacuum: [switch.rainmachine docs]: /integrations/rainmachine#switch [switch.wink docs]: /integrations/wink#switch [switch.xiaomi_vacuum docs]: /integrations/vacuum.xiaomi_miio/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [updater docs]: /integrations/updater/ [vacuum docs]: /integrations/vacuum/ [vacuum.demo docs]: /integrations/vacuum.demo/ diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown index 80dc891e302..27abd107487 100644 --- a/source/_posts/2017-09-09-release-53.markdown +++ b/source/_posts/2017-09-09-release-53.markdown @@ -365,7 +365,6 @@ frontend: [climate.knx docs]: /integrations/climate.knx/ [cloud docs]: /integrations/cloud/ [cloud.cloud_api docs]: /integrations/cloud.cloud_api/ -[cloud.const docs]: /integrations/cloud.const/ [cloud.util docs]: /integrations/cloud.util/ [config docs]: /integrations/config/ [config.customize docs]: /integrations/config.customize/ @@ -440,7 +439,7 @@ frontend: [switch.rest docs]: /integrations/switch.rest/ [switch.rfxtrx docs]: /integrations/switch.rfxtrx/ [switch.knx docs]: /integrations/switch.knx/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [tesla docs]: /integrations/tesla/ [tradfri docs]: /integrations/tradfri/ [volvooncall docs]: /integrations/volvooncall/ diff --git a/source/_posts/2017-10-07-release-55.markdown b/source/_posts/2017-10-07-release-55.markdown index ba5cdc2c9ff..ecf114145a2 100644 --- a/source/_posts/2017-10-07-release-55.markdown +++ b/source/_posts/2017-10-07-release-55.markdown @@ -344,7 +344,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [media_player.webostv docs]: /integrations/webostv#media-player [media_player.yamaha_musiccast docs]: /integrations/yamaha_musiccast/ [mqtt_statestream docs]: /integrations/mqtt_statestream/ -[notify.clicksendaudio docs]: /integrations/clicksendaudio/ +[notify.clicksendaudio docs]: /integrations/clicksend_tts/ [notify.discord docs]: /integrations/discord [notify.facebook docs]: /integrations/facebook [notify.simplepush docs]: /integrations/simplepush diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown index 5cb0cba975d..0bb5badf242 100644 --- a/source/_posts/2017-10-21-release-56.markdown +++ b/source/_posts/2017-10-21-release-56.markdown @@ -529,7 +529,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tplink docs]: /integrations/tplink [switch.wink docs]: /integrations/wink#switch [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [tesla docs]: /integrations/tesla/ [toon docs]: /integrations/toon/ [tradfri docs]: /integrations/tradfri/ diff --git a/source/_posts/2017-11-02-secure-shell-tunnel.markdown b/source/_posts/2017-11-02-secure-shell-tunnel.markdown index a46cf131647..75a09c626b7 100644 --- a/source/_posts/2017-11-02-secure-shell-tunnel.markdown +++ b/source/_posts/2017-11-02-secure-shell-tunnel.markdown @@ -55,7 +55,7 @@ Last login: Fri Oct 27 17:50:09 2017 [ha@home-assistant ~]$ ``` -Now you are able to use your frontend on your local system: [http://localhost:8000](http://localhost:8000) +Now you are able to use your frontend on your local system: `http://localhost:8000` Things to keep in mind: @@ -63,5 +63,5 @@ Things to keep in mind: - You need to setup port forwarding on your router. - Don't allow `root` to use SSH. Set `PermitRootLogin no` on the remote system. - Your local port must be above 1024. Only `root` is allowed to forward privileged ports which are below 1024. -- Use [SSH keys for authentication](https://docs-old.fedoraproject.org/en-US/Fedora/14/html/Deployment_Guide/s2-ssh-configuration-keypairs.html) instead of passwords to avoid bruteforce attacks. +- Use [SSH keys for authentication](http://docs.fedoraproject.org//en-US/Fedora/14/html/Deployment_Guide/s2-ssh-configuration-keypairs.html) instead of passwords to avoid bruteforce attacks. diff --git a/source/_posts/2017-11-04-release-57.markdown b/source/_posts/2017-11-04-release-57.markdown index 27bb1bcf342..08a7e03b44b 100644 --- a/source/_posts/2017-11-04-release-57.markdown +++ b/source/_posts/2017-11-04-release-57.markdown @@ -213,7 +213,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Add Sytadin Traffic component ([@gautric] - [#9524]) (new-platform) - media_title property now returns current source ([@etsinko] - [#10120]) ([media_player.monoprice docs]) - Added new Clickatell SMS messaging Notify Platform ([@davlloyd] - [#9775]) ([notify.clickatell docs]) (new-platform) -- update boto3 to 1.4.7 and botocore to 1.7.34 ([@TopdRob] - [#10121]) (notify.aws_lambda docs) ([notify.aws_sns docs]) (notify.aws_sqs docs) ([tts.amazon_polly docs]) +- update boto3 to 1.4.7 and botocore to 1.7.34 ([@TopdRob] - [#10121]) ([tts.amazon_polly docs]) - Add Random binary sensor ([@fabaff] - [#10164]) ([binary_sensor.random docs]) (new-platform) - Add clickatell ([@fabaff] - [#10199]) - Update CODEOWNERS ([@ggravlingen] - [#10198]) @@ -586,7 +586,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [mqtt_statestream docs]: /integrations/mqtt_statestream/ [namecheapdns docs]: /integrations/namecheapdns/ [no_ip docs]: /integrations/no_ip/ -[notify.aws_sns docs]: /integrations/notify.aws_sns/ [notify.clickatell docs]: /integrations/clickatell [notify.sendgrid docs]: /integrations/sendgrid [notify.yessssms docs]: /integrations/yessssms diff --git a/source/_posts/2017-11-12-tor.markdown b/source/_posts/2017-11-12-tor.markdown index a6941a7ea1e..a282666208b 100644 --- a/source/_posts/2017-11-12-tor.markdown +++ b/source/_posts/2017-11-12-tor.markdown @@ -88,7 +88,7 @@ Simply download and install the [Tor Browser](https://www.torproject.org/project Some other clients: - [Orbot](https://guardianproject.info/apps/orbot/) for Android -- [Orfox](https://play.google.com/store/apps/details?id=info.guardianproject.orfox&hl=nl) for Android +- ~~[Orfox](https://play.google.com/store/apps/details?id=info.guardianproject.orfox&hl=nl) for Android~~ Orfox for Android has been deprecated. Please use [Tor Browser for Android](https://www.torproject.org/download/#android). More information about the deprecation [here](https://trac.torproject.org/projects/tor/ticket/29955). - [Onion Browser](https://mike.tig.as/onionbrowser/) for iOS ## Cranking up security @@ -97,4 +97,4 @@ The setup described in this blog post is easy and relatively secure, but anyone This "Stealth"-mode adds an extra layer of security to your Hidden Service by only responding to a client that passes a unique secret cookie as it connects. Obviously, this requires additional configuration on the Tor client applications. -Additional information can be found in the [Tor documentation](/docs/ecosystem/tor/) and the [Tor add-on repository](https://github.com/hassio-addons/addon-tor), including how to setup the "Stealth"-mode. The Tor Project itself provides details about a variaty of topics in their [documentation](https://www.torproject.org/docs/documentation.html.en). +Additional information can be found in the [Tor documentation](/docs/ecosystem/tor/) and the [Tor add-on repository](https://github.com/hassio-addons/addon-tor), including how to setup the "Stealth"-mode. The Tor Project itself provides details about a variety of topics in their [documentation](https://www.torproject.org/docs/documentation.html.en). diff --git a/source/_posts/2017-11-18-release-58.markdown b/source/_posts/2017-11-18-release-58.markdown index c7f91918a36..2b5394d14cd 100644 --- a/source/_posts/2017-11-18-release-58.markdown +++ b/source/_posts/2017-11-18-release-58.markdown @@ -23,7 +23,7 @@ Talking about our translators, we now have 445 people with an account to help wi And because more translations is more better, [@robbiet480] has added the iOS app to Lokalise, our translation management platform. The iOS app is currently supported in 7 different languages. -[Learn more about how to help with translations](/blog/2017/11/05/frontend-translations/) +[Learn more about how to help with translations](/2017/11/06/frontend-translations/) ## Frontend improvements continue @@ -397,7 +397,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [climate.knx docs]: /integrations/climate.knx/ [climate.wink docs]: /integrations/wink#climate [cloud docs]: /integrations/cloud/ -[cloud.const docs]: /integrations/cloud.const/ [config.zwave docs]: /integrations/config.zwave/ [configurator docs]: /integrations/configurator/ [counter docs]: /integrations/counter/ @@ -470,8 +469,8 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.snmp docs]: /integrations/snmp#switch [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [system_log docs]: /integrations/system_log/ -[telegram_bot docs]: /integrations/telegram_bot/ -[telegram_bot.polling docs]: /integrations/polling +[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot.polling docs]: /integrations/telegram_polling [tradfri docs]: /integrations/tradfri/ [tts docs]: /integrations/tts/ [tts.google docs]: /integrations/google_translate diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown index 4ef21ba38d5..5f1c4dede42 100644 --- a/source/_posts/2017-12-17-release-60.markdown +++ b/source/_posts/2017-12-17-release-60.markdown @@ -315,7 +315,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [climate.generic_thermostat docs]: /integrations/generic_thermostat [climate.tado docs]: /integrations/tado [cloud docs]: /integrations/cloud/ -[cloud.const docs]: /integrations/cloud.const/ +[cloud.const docs]: /integrations/cloud/ [config.automation docs]: /integrations/config.automation/ [cover.tellstick docs]: /integrations/tellstick#cover [device_tracker docs]: /integrations/device_tracker/ diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown index eed5ed65952..fba4b0fd1a8 100644 --- a/source/_posts/2018-01-14-release-61.markdown +++ b/source/_posts/2018-01-14-release-61.markdown @@ -760,7 +760,7 @@ Note however, that this feature was replaced by a new ignore_string config optio [switch.transmission docs]: /integrations/transmission [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [timer docs]: /integrations/timer/ [tts.baidu docs]: /integrations/baidu [tts.marytts docs]: /integrations/marytts diff --git a/source/_posts/2018-02-10-release-63.markdown b/source/_posts/2018-02-10-release-63.markdown index fe695202524..bf4ffa649a2 100644 --- a/source/_posts/2018-02-10-release-63.markdown +++ b/source/_posts/2018-02-10-release-63.markdown @@ -651,7 +651,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [@citruz]: https://github.com/citruz [@sdague]: https://github.com/sdague [light.limitlessled docs]: /integrations/limitlessled -[media_player.yamaha docs]: /integrations/yamah +[media_player.yamaha docs]: /integrations/yamaha [sensor.eddystone_temperature docs]: /integrations/eddystone_temperature [sensor.wunderground docs]: /integrations/wunderground [#12392]: https://github.com/home-assistant/home-assistant/pull/12392 diff --git a/source/_posts/2018-02-26-release-64.markdown b/source/_posts/2018-02-26-release-64.markdown index 9944c1634fe..72a5c8cff7e 100644 --- a/source/_posts/2018-02-26-release-64.markdown +++ b/source/_posts/2018-02-26-release-64.markdown @@ -576,7 +576,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.smappee docs]: /integrations/smappee [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [vacuum.xiaomi_miio docs]: /integrations/vacuum.xiaomi_miio/ [vera docs]: /integrations/vera/ [weather.buienradar docs]: /integrations/buienradar diff --git a/source/_posts/2018-03-09-release-65.markdown b/source/_posts/2018-03-09-release-65.markdown index 1c76851490c..a4aa5d24de9 100644 --- a/source/_posts/2018-03-09-release-65.markdown +++ b/source/_posts/2018-03-09-release-65.markdown @@ -644,9 +644,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.xiaomi_aqara docs]: /integrations/switch.xiaomi_aqara/ [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [switch.zha docs]: /integrations/zha -[telegram_bot.broadcast docs]: /integrations/broadcast -[telegram_bot.polling docs]: /integrations/polling -[telegram_bot.webhooks docs]: /integrations/webhooks +[telegram_bot.broadcast docs]: /integrations/telegram_broadcast +[telegram_bot.polling docs]: /integrations/telegram_polling +[telegram_bot.webhooks docs]: /integrations/telegram_webhooks [upcloud docs]: /integrations/upcloud/ [vacuum.xiaomi_miio docs]: /integrations/vacuum.xiaomi_miio/ [weather docs]: /integrations/weather/ diff --git a/source/_posts/2018-03-30-release-66.markdown b/source/_posts/2018-03-30-release-66.markdown index 54616c14a92..8b54fe16309 100644 --- a/source/_posts/2018-03-30-release-66.markdown +++ b/source/_posts/2018-03-30-release-66.markdown @@ -52,7 +52,7 @@ Experiencing issues introduced by this release? Please report them in our [issue ## Breaking Changes -- Refactor Hue: If you specify a bridge in your config, the `host` key is now required and needs to be a valid ip address. Option `allow_in_emulated_hue` has been removed. Exclude the lights via the emulated hue config. Due to the internal changes of how the Hue integration works, any Hue custom component will no longer work. ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change) +- Refactor Hue: If you specify a bridge in your config, the `host` key is now required and needs to be a valid IP address. Option `allow_in_emulated_hue` has been removed. Exclude the lights via the emulated hue config. Due to the internal changes of how the Hue integration works, any Hue custom component will no longer work. ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change) - Z-Wave: In version 0.47, the opt-in `new_entity_ids` configuration was added to Z-Wave to smooth the transition through the change. Support for old entity IDs is now removed, and the configuration is no longer necessary. If you are migrating from 0.63 or higher, your entity IDs will already be stored in the Entity Registry and no changes are required. If not, entity IDs can now be manually configured using the Entity Registry if necessary. ([@armills] - [#12652]) ([zwave docs]) (breaking change) - Spotcrime sensor: This update changes the sensor to require a user supplied API key as a configuration entry. The default key has been removed from the Spotcrime package and has also been modified to accept a user supplied API key.([@jcconnell] - [#12926]) ([sensor.spotcrime docs]) (breaking change) - Smappee sensor: Fixed SI units for current consumption. Total consumption should be in kWh. not kW. ([@vandenberghev] - [#13190]) ([sensor.smappee docs]) (breaking change) @@ -550,7 +550,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.vesync docs]: /integrations/vesync#switches [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [switch.zha docs]: /integrations/zha -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [upcloud docs]: /integrations/upcloud/ [vacuum.xiaomi_miio docs]: /integrations/vacuum.xiaomi_miio/ [weather.darksky docs]: /integrations/weather.darksky/ diff --git a/source/_posts/2018-04-14-release-67.markdown b/source/_posts/2018-04-14-release-67.markdown index 634c64d4189..f92971ab401 100644 --- a/source/_posts/2018-04-14-release-67.markdown +++ b/source/_posts/2018-04-14-release-67.markdown @@ -148,7 +148,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Support color temperature in Homekit ([@morberg] - [#13658]) ([homekit docs]) - Remove unused CONF_WATCHERS ([@robmarkcole] - [#13678]) ([folder_watcher docs]) - Add media type separation for video/movie ([@tadly] - [#13612]) (breaking change) -- Adding configration to disable ip address as a requirement Fixes: #13399 ([@PlanetJ] - [#13692]) ([device_tracker docs]) +- Adding configuration to disable IP address as a requirement Fixes: #13399 ([@PlanetJ] - [#13692]) ([device_tracker docs]) - Tahoma switches ([@ikucuze] - [#13636]) ([tahoma docs]) ([switch.tahoma docs]) (new-platform) - Send XY color for non-osram hue bulbs ([@armills] - [#13665]) ([light.hue docs]) - Update AbodePy version to 0.12.3 ([@MisterWil] - [#13709]) ([abode docs]) diff --git a/source/_posts/2018-05-18-release-70.markdown b/source/_posts/2018-05-18-release-70.markdown index 60cd476658b..1fde7339710 100644 --- a/source/_posts/2018-05-18-release-70.markdown +++ b/source/_posts/2018-05-18-release-70.markdown @@ -432,7 +432,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tahoma docs]: /integrations/tahoma [system_log docs]: /integrations/system_log/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_bot/ +[telegram_bot docs]: /integrations/telegram_chatbot/ [tts docs]: /integrations/tts/ [updater docs]: /integrations/updater/ [weather.bom docs]: /integrations/bom diff --git a/source/_posts/2018-06-04-esphomelib.markdown b/source/_posts/2018-06-04-esphomelib.markdown index f357a0f43ae..73b4e94e19e 100644 --- a/source/_posts/2018-06-04-esphomelib.markdown +++ b/source/_posts/2018-06-04-esphomelib.markdown @@ -67,7 +67,7 @@ switch: name: "Living Room Dehumidifer" pin: GPIO5 ``` -If you now press upload again (this time the ESP doesn't need to be connected via USB, as updates [can be done over WiFi](https://esphomelib.com/esphomeyaml/integrations/ota.html)), you will see a switch show up in Home Assisstant automatically through [MQTT discovery](/docs/mqtt/discovery/). +If you now press upload again (this time the ESP doesn't need to be connected via USB, as updates [can be done over WiFi](https://esphomelib.com/esphomeyaml/integrations/ota.html)), you will see a switch show up in Home Assistant automatically through [MQTT discovery](/docs/mqtt/discovery/).

-Once we have defined our trigger, scroll down to the action section. Make sure the action type is set to "Call Service" and change the service to `light.turn_on`. For this automation we're going to turn on all lights, so let's change the service data to `{ "entity_id": "all" }`. +Once we have defined our trigger, scroll down to the action section. Make sure the action type is set to "Call Service" and change the service to `light.turn_on`. For this automation we're going to turn on all lights, so let's change the service data to: + +```yaml +entity_id: all +```

diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index 75fe7f154ef..053f9845102 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -30,7 +30,7 @@ Now let's make a small change using the configurator: we are going to change the - Click the `configuration.yaml` file (in the `/config/` folder) to load it into the main Configurator edit window. - Find the `homeassistant:` configuration block, which should be the first thing in `configuration.yaml`. In this block, update `name`, `latitude`, `longitude`, `unit_system` and `time_zone` to match yours. - Click the save icon in the top right to commit changes. - - Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on General and click on the "Check Config" button. When it's valid, it will show the text "Configuration valid!". + - Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on "Server Control" and click on the "CHECK CONFIG" button. When it's valid, it will show the text "Configuration valid!". - Now Restart Home Assistant using the "restart" in the Server management section on the same page. In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile.

diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 8f4d5fb91a8..a262396b468 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -36,9 +36,10 @@ The following will take you through the steps required to install Hass.io. - Load the appliance image into your virtual machine software. Choose 64-bit Linux and UEFI boot. 3. Optional - set up the WiFi or static IP. There are two possible places for that: -- On a blank USB stick with Fat32 partition (partition label: "CONFIG"), while in / directory, create `network/my-network` file -- or on Hassio SD card first, bootable partition (might not be auto mounted in Linux) create `CONFIG/network/my-network` file -For the content of this file follow the [HassOS howto][hassos-network]. + - on a blank USB stick with a FAT32 partition having partition label `CONFIG`, while in its root directory, create the `network/my-network` file, or + - on the Hassio SD card's first, bootable partition (labeled `hassio-boot`, might not be auto mounted in Linux) create the `CONFIG/network/my-network` file. + + For the content of this file, follow the [HassOS howto][hassos-network]. 4. For image-based installs insert the SD card (and optional USB stick) into the device. @@ -64,10 +65,6 @@ If you are using a Raspberry Pi please remember to ensure you're using an [appro Now you can [configure][configure] your install. -### Migrating from a non-Hass.io install - -If you copy over your existing Home Assistant configuration, make sure to enable the Hass.io panel by adding either `discovery:` or `hassio:` to your configuration. - ## Updating a Hass.io installation Best practice for updating a Hass.io installation: diff --git a/source/images/screenshots/more-info-dialog-moon.png b/source/images/screenshots/more-info-dialog-moon.png new file mode 100644 index 00000000000..48a2c545816 Binary files /dev/null and b/source/images/screenshots/more-info-dialog-moon.png differ diff --git a/source/images/screenshots/more-info-dialog-roomba.png b/source/images/screenshots/more-info-dialog-roomba.png new file mode 100644 index 00000000000..576411957ac Binary files /dev/null and b/source/images/screenshots/more-info-dialog-roomba.png differ diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index aed4dbe4736..e78645b89d5 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -186,7 +186,7 @@ description: "Changelog of the Lovelace UI." - 🔧 [history graph card]: Fix cache of image between views ## Changes in 0.74.0 -- 📣 [Lovelace card gallery](https://home-assistant-lovelace-gallery.netlify.com/) +- 📣 [Lovelace card gallery](https://www.awesome-ha.com/) - 🔧 Async communication improvements ### Views