From 6ead12efbc1222ff1dae70da21a342668acfa720 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 13 Feb 2020 13:39:06 +0100 Subject: [PATCH] Extends textlint Terminology list; part 5 (#12072) * Extends textlint Terminology list; part 5 * Remove walkthrough from textlint * Improve Default Configuration page links --- .textlintrc.json | 25 ++++++++++ source/_cookbook/fail2ban.markdown | 2 +- source/_cookbook/ifttt.manything.markdown | 2 +- .../owntracks_two_mqtt_broker.markdown | 2 +- .../authentication/multi-factor-auth.markdown | 2 +- .../_docs/automation/troubleshooting.markdown | 2 +- source/_docs/autostart/upstart.markdown | 2 +- source/_docs/configuration/packages.markdown | 4 +- source/_docs/configuration/securing.markdown | 2 +- .../splitting_configuration.markdown | 4 +- .../_docs/configuration/templating.markdown | 2 +- source/_docs/ecosystem/appdaemon.markdown | 2 +- source/_docs/ecosystem/appdaemon/api.markdown | 10 ++-- .../ecosystem/appdaemon/running.markdown | 2 +- .../ecosystem/appdaemon/tutorial.markdown | 2 +- source/_docs/ecosystem/haproxy.markdown | 2 +- source/_docs/ecosystem/nginx.markdown | 2 +- source/_docs/ecosystem/tor.markdown | 2 +- source/_docs/installation/docker.markdown | 8 ++-- source/_docs/installation/freenas.markdown | 2 +- source/_docs/installation/synology.markdown | 6 +-- source/_docs/mqtt/service.markdown | 2 +- source/_docs/scripts/service-calls.markdown | 2 +- source/_docs/z-wave/control-panel.markdown | 6 +-- source/_docs/z-wave/device-specific.markdown | 4 +- source/_docs/z-wave/devices.markdown | 2 +- source/_integrations/alexa.intent.markdown | 6 +-- .../_integrations/alexa.smart_home.markdown | 2 +- source/_integrations/almond.markdown | 4 +- source/_integrations/androidtv.markdown | 2 +- source/_integrations/arest.markdown | 6 +-- source/_integrations/axis.markdown | 2 +- .../binary_sensor.template.markdown | 2 +- source/_integrations/broadlink.markdown | 6 +-- source/_integrations/calendar.google.markdown | 2 +- source/_integrations/cast.markdown | 2 +- source/_integrations/climate.knx.markdown | 2 +- source/_integrations/config.markdown | 2 +- .../_integrations/cover.command_line.markdown | 2 +- source/_integrations/ddwrt.markdown | 2 +- source/_integrations/deconz.markdown | 2 +- source/_integrations/default_config.markdown | 34 +++++++------- source/_integrations/denonavr.markdown | 2 +- source/_integrations/device_tracker.markdown | 2 +- source/_integrations/doods.markdown | 2 +- source/_integrations/ecobee.markdown | 2 +- source/_integrations/emulated_roku.markdown | 4 +- source/_integrations/ephember.markdown | 2 +- source/_integrations/fail2ban.markdown | 2 +- source/_integrations/fibaro.markdown | 2 +- source/_integrations/fortios.markdown | 2 +- source/_integrations/freebox.markdown | 6 +-- source/_integrations/frontend.markdown | 2 +- source/_integrations/geniushub.markdown | 2 +- source/_integrations/gitlab_ci.markdown | 2 +- .../_integrations/google_assistant.markdown | 2 +- source/_integrations/google_pubsub.markdown | 2 +- source/_integrations/harmony.markdown | 2 +- source/_integrations/hdmi_cec.markdown | 4 +- source/_integrations/hisense_aehw4a1.markdown | 4 +- source/_integrations/hitron_coda.markdown | 2 +- source/_integrations/homeassistant.markdown | 4 +- source/_integrations/homekit.markdown | 20 ++++---- .../_integrations/homekit_controller.markdown | 8 ++-- source/_integrations/homematic.markdown | 2 +- source/_integrations/icloud.markdown | 4 +- .../_integrations/image_processing.markdown | 2 +- source/_integrations/input_text.markdown | 2 +- source/_integrations/iperf3.markdown | 2 +- source/_integrations/juicenet.markdown | 2 +- source/_integrations/kankun.markdown | 2 +- source/_integrations/kodi.markdown | 2 +- source/_integrations/lifx.markdown | 2 +- source/_integrations/light.mqtt.markdown | 4 +- source/_integrations/limitlessled.markdown | 14 +++--- source/_integrations/linksys_smart.markdown | 6 +-- source/_integrations/logi_circle.markdown | 4 +- source/_integrations/manual.markdown | 2 +- source/_integrations/matrix.markdown | 2 +- source/_integrations/netio.markdown | 2 +- source/_integrations/onvif.markdown | 2 +- source/_integrations/opencv.markdown | 2 +- source/_integrations/openevse.markdown | 2 +- source/_integrations/pandora.markdown | 2 +- source/_integrations/plum_lightpad.markdown | 4 +- source/_integrations/proxmoxve.markdown | 4 +- source/_integrations/radarr.markdown | 2 +- source/_integrations/raspyrfm.markdown | 2 +- source/_integrations/rest.markdown | 2 +- source/_integrations/rflink.markdown | 2 +- source/_integrations/rfxtrx.markdown | 2 +- source/_integrations/ring.markdown | 2 +- source/_integrations/saj.markdown | 6 +-- source/_integrations/samsungtv.markdown | 2 +- source/_integrations/sensibo.markdown | 2 +- source/_integrations/smartthings.markdown | 2 +- source/_integrations/smhi.markdown | 2 +- source/_integrations/snmp.markdown | 2 +- source/_integrations/solax.markdown | 2 +- source/_integrations/soma.markdown | 2 +- source/_integrations/sonarr.markdown | 2 +- source/_integrations/sonos.markdown | 2 +- source/_integrations/spaceapi.markdown | 2 +- source/_integrations/ssdp.markdown | 2 +- .../switch.command_line.markdown | 4 +- .../_integrations/switch.mysensors.markdown | 2 +- source/_integrations/tensorflow.markdown | 6 +-- source/_integrations/tomato.markdown | 2 +- source/_integrations/tplink.markdown | 2 +- source/_integrations/ubus.markdown | 2 +- source/_integrations/uk_transport.markdown | 2 +- source/_integrations/unifi.markdown | 4 +- source/_integrations/vacuum.mqtt.markdown | 6 +-- .../_integrations/vacuum.xiaomi_miio.markdown | 4 +- source/_integrations/velux.markdown | 2 +- .../_integrations/waze_travel_time.markdown | 2 +- source/_integrations/webostv.markdown | 2 +- source/_integrations/withings.markdown | 2 +- source/_integrations/worxlandroid.markdown | 2 +- source/_integrations/zeroconf.markdown | 2 +- source/_lovelace/markdown.markdown | 2 +- source/getting-started/configuration.markdown | 6 +-- source/hassio/enable_i2c.markdown | 2 +- source/hassio/installation.markdown | 2 +- source/lovelace/changelog.markdown | 46 +++++++++---------- source/lovelace/index.markdown | 2 +- source/lovelace/views.markdown | 6 +-- source/lovelace/yaml-mode.markdown | 6 +-- 128 files changed, 257 insertions(+), 232 deletions(-) diff --git a/.textlintrc.json b/.textlintrc.json index ac4efb6c32a..8d83be6ca3b 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -9,6 +9,7 @@ "skip": ["Blockquote"], "terms": [ " API ", + "2FA", "ABB Solar PV", "ABB", "Abode", @@ -88,7 +89,10 @@ "GitHub", "Google Assistant", "Google Home", + "Google Wifi", "Google", + "GraphiQL", + "GraphQL", "Home Assistant Companion", "Home Assistant Core", "Home Assistant Operating System", @@ -115,12 +119,16 @@ "LED", "Let's Encrypt", "Life360", + "LinkedIn", "Linky", "Linux", "Lovelace", + "MacBook", "macOS", + "Markdown", "Microsoft", "MikroTik", + "MIME", "MJPEG", "MQTT", "NAS", @@ -129,6 +137,7 @@ "NodeMCU", "Norway", "OpenWrt", + "PayPal", "PDU", "Philips", "PlayStation", @@ -210,19 +219,35 @@ "Ziggo", "ZoneMinder", [" HA ", "Home Assistant"], + ["\\(s\\)he", "they"], + ["2 ?steps? authentication", "two-step authentication"], ["Alarm ?dot ?com", "Alarm.com"], ["an URL", "a URL"], ["API['’]?s", "APIs"], + ["backwards compatible", "backward compatible"], + ["client ?side", "client-side"], + ["colour", "color"], ["DarkSky", "Dark Sky"], + ["end ?to ?end", "end-to-end"], ["FRITZ!? ?Box", "FRITZ!Box"], ["hass", "Home Assistant"], + ["he or she", "they"], + ["he/she", "they"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], ["ISY ?994", "ISY994"], ["Mac ?OS", "macOS"], ["OS ?X", "macOS"], + ["repo\\b", "repository"], + ["config\\b", "configuration"], ["Sky Bell", "SkyBell"], ["Sleep IQ", "SleepIQ"], ["Twill?o", "Twilio"], + ["analyse", "analyze"], + ["recognise", "recognize"], + ["travelled", "traveled"], + ["licence", "license"], + ["behaviour", "behavior"], + ["two ?steps? authentication", "two-step authentication"], ["URL['’]?s", "URLs"], ["ZWave", "Z-Wave"] ] diff --git a/source/_cookbook/fail2ban.markdown b/source/_cookbook/fail2ban.markdown index 7b09d9b4ee1..5813f33913e 100644 --- a/source/_cookbook/fail2ban.markdown +++ b/source/_cookbook/fail2ban.markdown @@ -160,5 +160,5 @@ Fail2ban should now be configured and running, if an IP address is banned you wi If you want to read more about `fail2ban`, some links are below: - - [fail2ban Split config](http://www.fail2ban.org/wiki/index.php/FEATURE_Split_config) + - [fail2ban Split configuration](http://www.fail2ban.org/wiki/index.php/FEATURE_Split_config) - [How To Protect SSH with Fail2Ban on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-protect-ssh-with-fail2ban-on-ubuntu-14-04) diff --git a/source/_cookbook/ifttt.manything.markdown b/source/_cookbook/ifttt.manything.markdown index 45a8161b666..c2aa460254f 100644 --- a/source/_cookbook/ifttt.manything.markdown +++ b/source/_cookbook/ifttt.manything.markdown @@ -7,7 +7,7 @@ redirect_from: /integrations/ifttt.manything/ --- -[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a WiFi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. +[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a Wi-Fi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. To get manything support, HA will use IFTTT's [Webhooks Service](https://ifttt.com/maker_webhooks) and the [ManyThing Service](https://ifttt.com/manything). Use the [IFTTT Setup instructions](/integrations/ifttt/) to activate the IFTTT Platform. diff --git a/source/_cookbook/owntracks_two_mqtt_broker.markdown b/source/_cookbook/owntracks_two_mqtt_broker.markdown index 6bb66837a81..d7ee62f43bb 100644 --- a/source/_cookbook/owntracks_two_mqtt_broker.markdown +++ b/source/_cookbook/owntracks_two_mqtt_broker.markdown @@ -40,7 +40,7 @@ $ docker run -ti -p 1884:1883 \ --name mosquitto-ext -d toke/mosquitto ``` -Here are the config files: +Here are the configuration files: `/volume1/data/mosquitto-int/config/mosquitto.conf` diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown index 9d33438b574..a026cd0ed1d 100644 --- a/source/_docs/authentication/multi-factor-auth.markdown +++ b/source/_docs/authentication/multi-factor-auth.markdown @@ -33,7 +33,7 @@ homeassistant: - type: totp ``` -If no `auth_mfa_modules` config section is defined in `configuration.yaml` a TOTP module named "Authenticator app" will be autoloaded. +If no `auth_mfa_modules` configuration section is defined in `configuration.yaml` a TOTP module named "Authenticator app" will be autoloaded. You will need an authenticator app on your phone. We recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/). Both are available for iOS or Android. diff --git a/source/_docs/automation/troubleshooting.markdown b/source/_docs/automation/troubleshooting.markdown index 5085acd0a12..12354c708df 100644 --- a/source/_docs/automation/troubleshooting.markdown +++ b/source/_docs/automation/troubleshooting.markdown @@ -28,7 +28,7 @@ Please note that if you click on **Trigger** of an automation in the frontend, * All this makes that Trigger feature pretty limited and nearly useless for debugging purposes so you need to find another way. Make sure you check and adapt to your circumstances appropriate examples from Automation Trigger, Conditions and Actions. -It is also useful to go to **Configuration** -> **Server Control** and click on **Check Config** button in Configuration validation section to make sure there are no syntax errors before restarting Home Assistant. In order for **Check Config** to be visible, you must enable **Advanced Mode** on your user profile. +It is also useful to go to **Configuration** -> **Server Control** and click on **Check Configuration** button in Configuration validation section to make sure there are no syntax errors before restarting Home Assistant. In order for **Check configuration** to be visible, you must enable **Advanced Mode** on your user profile. If your automation uses templates in any part, you can do the following to make sure it works as expected: diff --git a/source/_docs/autostart/upstart.markdown b/source/_docs/autostart/upstart.markdown index 716c62fa628..065f525e25a 100644 --- a/source/_docs/autostart/upstart.markdown +++ b/source/_docs/autostart/upstart.markdown @@ -128,4 +128,4 @@ sudo service hass-daemon stop When running Home Assistant with this script, the configuration directory will be located at `/var/opt/homeassistant`. This directory will contain a verbose log rather than simply an error log. -When running daemons, it is good practice to have the daemon run under its own user name rather than the default user's name. Instructions for setting this up are outside the scope of this document. +When running daemons, it is good practice to have the daemon run under its own username rather than the default user's name. Instructions for setting this up are outside the scope of this document. diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index b7fffed55f6..d3b26d31339 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -6,7 +6,7 @@ redirect_from: /topics/packages/ Packages in Home Assistant provide a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the integration key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration). -Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a package name (no spaces, all lower case) followed by a dictionary with the package config. For example, package `pack_1` would be created as: +Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a package name (no spaces, all lower case) followed by a dictionary with the package configuration. For example, package `pack_1` would be created as: ```yaml homeassistant: @@ -60,7 +60,7 @@ There are some rules for packages that will be merged: 1. Platform based integrations (`light`, `switch`, etc) can always be merged. 2. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file. - For example if we have the following in the main config. You are not allowed to re-use "my_input" again for `input_boolean` in a package: + For example if we have the following in the main configuration. You are not allowed to re-use "my_input" again for `input_boolean` in a package: ```yaml input_boolean: diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 2d7774f51ab..8ec666a8cab 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -21,7 +21,7 @@ If you want secure remote access, the easiest option is to use [Home Assistant c As well as the above we advise that you consider the following to improve security: -- For systems that use SSH set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services. +- For systems that use SSH set `PermitRootLogin no` in your sshd configuration (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services. - Lock down the host following good practice guidance, for example: * [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html) (this also applies to Raspbian) * [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf) diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index e6874fdc286..ec01ded7592 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -154,8 +154,8 @@ If you have issues checkout `home-assistant.log` in the configuration directory If you have many configuration files, the `check_config` script allows you to see how Home Assistant interprets them: - Listing all loaded files: `hass --script check_config --files` -- Viewing a component's config: `hass --script check_config --info light` -- Or all components' config: `hass --script check_config --info all` +- Viewing a component's configuration: `hass --script check_config --info light` +- Or all components' configuration: `hass --script check_config --info all` You can get help from the command line using: `hass --script check_config --help` diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index e3e1362018b..c15caf07ef9 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -186,7 +186,7 @@ Note: [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) is the number of ### To/From JSON -The `to_json` filter serializes an object to a JSON string. In some cases, it may be necessary to format a JSON string for use with a webhook, as a parameter for command line utilities or any number of other applications. This can be complicated in a template, especially when dealing with escaping special characters. Using the `to_json` filter, this is handled automatically. +The `to_json` filter serializes an object to a JSON string. In some cases, it may be necessary to format a JSON string for use with a webhook, as a parameter for command-line utilities or any number of other applications. This can be complicated in a template, especially when dealing with escaping special characters. Using the `to_json` filter, this is handled automatically. The `from_json` filter operates similarly, but in the other direction, de-serializing a JSON string back into an object. diff --git a/source/_docs/ecosystem/appdaemon.markdown b/source/_docs/ecosystem/appdaemon.markdown index 44722632095..fbaffb82e9f 100644 --- a/source/_docs/ecosystem/appdaemon.markdown +++ b/source/_docs/ecosystem/appdaemon.markdown @@ -12,7 +12,7 @@ AppDaemon is not meant to replace Home Assistant Automations and Scripts, rather - New paradigm - Some problems require a procedural and/or iterative approach, and `AppDaemon` Apps are a much more natural fit for this. Recent enhancements to Home Assistant scripts and templates have made huge strides, but for the most complex scenarios, Apps can do things that automations can't. - Ease of use - AppDaemon's API is full of helper functions that make programming as easy and natural as possible. The functions and their operation are as "Pythonic" as possible; experienced Python programmers should feel right at home. -- Reuse - write a piece of code once and instantiate it as an App as many times as you need with different parameters; e.g., a motion light program that you can use in five different places around your home. The code stays the same, you just dynamically add new instances of it in the config file. +- Reuse - write a piece of code once and instantiate it as an App as many times as you need with different parameters; e.g., a motion light program that you can use in five different places around your home. The code stays the same, you just dynamically add new instances of it in the configuration file. - Dynamic - AppDaemon has been designed from the start to enable the user to make changes without requiring a restart of Home Assistant, thanks to its loose coupling. However, it is better than that - the user can make changes to code and AppDaemon will automatically reload the code, figure out which Apps were using it, and restart them to use the new code without the need to restart `AppDaemon` itself. It is also possible to change parameters for an individual or multiple Apps and have them picked up dynamically. For a final trick, removing or adding Apps is also picked up dynamically. Testing cycles become a lot more efficient as a result. - Complex logic - Python's If/Else constructs are clearer and easier to code for arbitrarily complex nested logic. - Durable variables and state - Variables can be kept between events to keep track of things like the number of times a motion sensor has been activated, or how long it has been since a door opened. diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown index 6a44dfd1d9c..cf135c6046d 100644 --- a/source/_docs/ecosystem/appdaemon/api.markdown +++ b/source/_docs/ecosystem/appdaemon/api.markdown @@ -18,7 +18,7 @@ class MotionLights(appapi.AppDaemon): """Motion lights implementation.""" ``` -When configured as an app in the config file (more on that later) the lifecycle of the App begins. It will be instantiated as an object by AppDaemon, and immediately, it will have a call made to its `initialize()` function - this function must appear as part of every app: +When configured as an app in the configuration file (more on that later) the lifecycle of the App begins. It will be instantiated as an object by AppDaemon, and immediately, it will have a call made to its `initialize()` function - this function must appear as part of every app: ```python def initialize(self): @@ -1936,7 +1936,7 @@ get_app(self, name) ##### name -Name of the app required. This is the name specified in header section of the config file, not the module or class. +Name of the app required. This is the name specified in header section of the configuration file, not the module or class. #### Returns @@ -2035,19 +2035,19 @@ self.error("Some Critical string", level="CRITICAL") Sharing information between different Apps is very simple if required. Each app gets access to a global dictionary stored in a class attribute called `self.global_vars`. Any App can add or read any key as required. This operation is not however threadsafe so some car is needed. -In addition, Apps have access to the entire configuration if required, meaning they can access AppDaemon configuration items as well as parameters from other Apps. To use this, there is a class attribute called `self.config`. It contains a `ConfigParser` object, which is similar in operation to a `Dictionary`. To access any apps parameters, simply reference the ConfigParser object using the Apps name (form the config file) as the first key, and the parameter required as the second, for instance: +In addition, Apps have access to the entire configuration if required, meaning they can access AppDaemon configuration items as well as parameters from other Apps. To use this, there is a class attribute called `self.config`. It contains a `ConfigParser` object, which is similar in operation to a `Dictionary`. To access any apps parameters, simply reference the ConfigParser object using the Apps name (form the configuration file) as the first key, and the parameter required as the second, for instance: ```python other_apps_arg = self.config["some_app"]["some_parameter"] ``` -To get AppDaemon's config parameters, use the key "AppDaemon", e.g.: +To get AppDaemon's configuration parameters, use the key "AppDaemon", e.g.: ```python app_timezone = self.config["AppDaemon"]["time_zone"] ``` -And finally, it is also possible to use the AppDaemon as a global area for sharing parameters across Apps. Simply add the required parameters to the AppDaemon section of your config: +And finally, it is also possible to use the AppDaemon as a global area for sharing parameters across Apps. Simply add the required parameters to the AppDaemon section of your configuration: ```ini [AppDaemon] diff --git a/source/_docs/ecosystem/appdaemon/running.markdown b/source/_docs/ecosystem/appdaemon/running.markdown index 031eb19b8ce..615ad1d356d 100644 --- a/source/_docs/ecosystem/appdaemon/running.markdown +++ b/source/_docs/ecosystem/appdaemon/running.markdown @@ -8,7 +8,7 @@ As configured, `AppDaemon` comes with a single HelloWorld App that will send a g ## Docker -Assuming you have set the config up as described above for Docker, you can run it with the command: +Assuming you have set the configuration up as described above for Docker, you can run it with the command: ```bash $ docker run -d -v /conf:/conf --name appdaemon acockburn/appdaemon:latest diff --git a/source/_docs/ecosystem/appdaemon/tutorial.markdown b/source/_docs/ecosystem/appdaemon/tutorial.markdown index fdf445b4c1d..b546206e660 100644 --- a/source/_docs/ecosystem/appdaemon/tutorial.markdown +++ b/source/_docs/ecosystem/appdaemon/tutorial.markdown @@ -23,7 +23,7 @@ So why `AppDaemon`? AppDaemon is not meant to replace Home Assistant Automations - New paradigm - some problems require a procedural and/or iterative approach, and `AppDaemon` Apps are a much more natural fit for this. Recent enhancements to Home Assistant scripts and templates have made huge strides, but for the most complex scenarios, Apps can do things that Automations can't - Ease of use - AppDaemon's API is full of helper functions that make programming as easy and natural as possible. The functions and their operation are as "Pythonic" as possible, experienced Python programmers should feel right at home. -- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g., a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the config file +- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g., a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the configuration file - Dynamic - AppDaemon has been designed from the start to enable the user to make changes without requiring a restart of Home Assistant, thanks to its loose coupling. However, it is better than that - the user can make changes to code and AppDaemon will automatically reload the code, figure out which Apps were using it and restart them to use the new code with out the need to restart `AppDaemon` itself. It is also possible to change parameters for an individual or multiple apps and have them picked up dynamically, and for a final trick, removing or adding apps is also picked up dynamically. Testing cycles become a lot more efficient as a result. - Complex logic - Python's If/Else constructs are clearer and easier to code for arbitrarily complex nested logic - Durable variables and state - variables can be kept between events to keep track of things like the number of times a motion sensor has been activated, or how long it has been since a door opened diff --git a/source/_docs/ecosystem/haproxy.markdown b/source/_docs/ecosystem/haproxy.markdown index 3010e9f42f4..e601ef5e9ec 100644 --- a/source/_docs/ecosystem/haproxy.markdown +++ b/source/_docs/ecosystem/haproxy.markdown @@ -86,7 +86,7 @@ Forward ports 443 and (optionally) 80 to your server on your router. Do not forward port 8123, HAProxy takes care of securing the connection with HTTPS on 443. If 8123 is forwarded then it will not be secured. -Replace 443 with whatever port you chose to bind to in the config if different. +Replace 443 with whatever port you chose to bind to in the configuration if different. ### Configure Home Assistant HTTP Component diff --git a/source/_docs/ecosystem/nginx.markdown b/source/_docs/ecosystem/nginx.markdown index 4b2a370bfeb..9383b9ad58d 100644 --- a/source/_docs/ecosystem/nginx.markdown +++ b/source/_docs/ecosystem/nginx.markdown @@ -97,7 +97,7 @@ http: trusted_proxies: ``` -### NGINX Config +### NGINX configuration ```nginx map $http_upgrade $connection_upgrade { diff --git a/source/_docs/ecosystem/tor.markdown b/source/_docs/ecosystem/tor.markdown index 613d57f5ce7..37ac2694acd 100644 --- a/source/_docs/ecosystem/tor.markdown +++ b/source/_docs/ecosystem/tor.markdown @@ -80,7 +80,7 @@ For Tor Browser on Windows, Mac or Linux, you can find the torrc file here: ` **Menu** -> **Settings** to the "Torrc Custom Config" entry. Restart Orbot, and then use the [Orfox browser app](https://guardianproject.info/apps/orfox/), and browse to the "dot onion" site name to access your Home Assistant instance. You can also use Orbot's VPN mode, to enable Tor access from any application on your device, such as Tasker or Owntracks. +For [Orbot: Tor on Android](https://guardianproject.info/apps/orbot), add it in **Orbot** -> **Menu** -> **Settings** to the "Torrc Custom Configuration" entry. Restart Orbot, and then use the [Orfox browser app](https://guardianproject.info/apps/orfox/), and browse to the "dot onion" site name to access your Home Assistant instance. You can also use Orbot's VPN mode, to enable Tor access from any application on your device, such as Tasker or Owntracks. On iOS, we have not fully tested this yet, but you should be able to add custom torrc entries on [Onion Browser](https://mike.tig.as/onionbrowser/), Red Onion or TOBY browsers, all available in the iTunes App Store. diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index 452067963b8..02139e0cebe 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -42,7 +42,7 @@ Alternatively, `docker-compose` works with any recent release of `docker-ce` on Docker containers are completely isolated from its Windows host system. So when you delete a container, all the changes you made to that container are also removed. If you want to have configuration files or other assets remain persistent, try mounting Windows folders on containers. -Before proceeding, make sure you have shared out a drive for Docker to mount to. This will allow the saving of config files to persist on the local machine rather than in the Docker container (which may be destroyed when upgraded). +Before proceeding, make sure you have shared out a drive for Docker to mount to. This will allow the saving of configuration files to persist on the local machine rather than in the Docker container (which may be destroyed when upgraded). @@ -117,7 +117,7 @@ Remark: to update your Home Assistant on your Docker within Synology NAS, you ju - Wait until the system-message/-notification comes up, that the download is finished (there is no progress bar) - Move to "Container"-section - Stop your container if it's running -- Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your config-directory +- Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your configuration-directory - Start the container again - it will then boot up with the new Home Assistant image Remark: to restart your Home Assistant within Synology NAS, you just have to do the following: @@ -165,7 +165,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista - Run Docker command: `docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e variable=TZ -e value=Europe/London --device /dev/ttyACM0 homeassistant/home-assistant:stable` - `-v` is your config path + `-v` is your configuration path `-e` is set timezone - Edit `configuration.yaml` @@ -183,7 +183,7 @@ That will tell Home Assistant where to look for our Z-Wave radio. - Run Docker command: `docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e variable=TZ -e value=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus homeassistant/home-assistant:stable` - First `-v` is your config path + First `-v` is your configuration path `-e` is set timezone - Edit the `configuration.yaml` file diff --git a/source/_docs/installation/freenas.markdown b/source/_docs/installation/freenas.markdown index 4ce9bbf28d4..86b41b505ae 100644 --- a/source/_docs/installation/freenas.markdown +++ b/source/_docs/installation/freenas.markdown @@ -292,7 +292,7 @@ This should output the following /dev/cuau0 /dev/cuaU0 ``` -Add the Z-Wave config to your `configuration.yaml` and restart Home Assistant +Add the Z-Wave configuration to your `configuration.yaml` and restart Home Assistant ```bash vi /home/homeassistant/.homeassistant/configuration.yaml diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index e16e2698e61..59cd1a28b20 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -62,7 +62,7 @@ Use PIP to install the Home Assistant package 0.64.3 # ./python3 -m pip install homeassistant==0.64.3 ``` -Create a Home Assistant config directory & switch to it +Create a Home Assistant configuration directory & switch to it ```bash # mkdir /volume1/homeassistant @@ -187,7 +187,7 @@ Create links to python folders to make things easier in the future: # ln -s /volume1/@appstore/py3k/usr/local/lib/python3.5/site-packages/homeassistant homeassistant ``` -Set the owner and permissions on your config folder +Set the owner and permissions on your configuration folder ```bash # chown -R homeassistant:users /volume1/homeassistant @@ -213,7 +213,7 @@ Update your firewall (if it is turned on the Synology device): - Click on OK again -Copy your `configuration.yaml` file into the config folder +Copy your `configuration.yaml` file into the configuration folder That's it... you're all set to go Here are some useful commands: diff --git a/source/_docs/mqtt/service.markdown b/source/_docs/mqtt/service.markdown index ce24e1011ab..f848093a169 100644 --- a/source/_docs/mqtt/service.markdown +++ b/source/_docs/mqtt/service.markdown @@ -50,7 +50,7 @@ retain: true ### Service `mqtt.dump` -Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your config folder. This is useful when debugging a problem. +Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your configuration folder. This is useful when debugging a problem. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index f9560ca274c..626f5b94ad4 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -6,7 +6,7 @@ redirect_from: /getting-started/scripts-service-calls/ Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script or via the Amazon Echo. -The configuration options to call a config are the same between all integrations and are described on this page. +The configuration options to call a configuration are the same between all integrations and are described on this page. Examples on this page will be given as part of an automation integration configuration but different approaches can be used for other integrations too. diff --git a/source/_docs/z-wave/control-panel.markdown b/source/_docs/z-wave/control-panel.markdown index 591da3767e3..0822378bed0 100644 --- a/source/_docs/z-wave/control-panel.markdown +++ b/source/_docs/z-wave/control-panel.markdown @@ -26,7 +26,7 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro * **Stop Network** stops the Z-Wave network * **Soft Reset** tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command, and may cause the Z-Wave network to hang. * **Test Network** tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead". -* **Save Config** Saves the current cache of the network to zwcfg_[home_id].xml +* **Save Configuration** Saves the current cache of the network to zwcfg_[home_id].xml ## Z-Wave Node Management @@ -108,7 +108,7 @@ Some Z-Wave devices may associate themselves with the broadcast node (node 255). That would remove the broadcast group from association group 1 of the device with node_id 3. -### Node config options +### Node configuration options You can set the *wakeup* interval (in seconds) of the device, this is shown for all devices that can be battery powered, even if they are currently mains powered. The wakeup interval only applies when those devices are battery powered. @@ -116,7 +116,7 @@ You can set the *wakeup* interval (in seconds) of the device, this is shown for The wakeup interval has no impact on the device's ability to report sensor changes. This is purely for how often the Z-Wave chip will check in with the controller. That activity consumes a lot of battery power compared to reporting sensor changes and if you reduce it you'll be reducing the battery life of your device. -Underneath that you can select any supported configuration parameter to see the current setting. You can then change this and select **Set Config Parameter** to updated it. Battery powered devices will be updated the next time they wake. +Underneath that you can select any supported configuration parameter to see the current setting. You can then change this and select **Set Configuration Parameter** to updated it. Battery powered devices will be updated the next time they wake. ### Node protection diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index f6483788cb2..69b2ac6d322 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -17,7 +17,7 @@ You can set the settings of the Z-Wave device through the Z-Wave control panel. These devices require a network key to be set for the Z-Wave network before they are paired, using the **Add Node Secure** option. -Home Assistant stores logs from Z-Wave in `OZW_log.txt` in the Home Assistant config directory, when you pair a secure device you should see communication from the node with lines starting with `info: NONCES` in `OZW_log.txt` when the device is paired successfully with a secure connection. +Home Assistant stores logs from Z-Wave in `OZW_log.txt` in the Home Assistant configuration directory, when you pair a secure device you should see communication from the node with lines starting with `info: NONCES` in `OZW_log.txt` when the device is paired successfully with a secure connection. ### Specific Devices @@ -457,7 +457,7 @@ Press circle and plus simultaneously to wake up the device. -Once you've added the NanoMote to your Z-Wave network, you'll need to update your zwcfg_\*.xml file with the below xml data. Stop Home Assistant and open your zwcfg_\*.xml file (located in your config folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below xml data. Save the file and restart Home Assistant. +Once you've added the NanoMote to your Z-Wave network, you'll need to update your zwcfg_\*.xml file with the below xml data. Stop Home Assistant and open your zwcfg_\*.xml file (located in your configuration folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below xml data. Save the file and restart Home Assistant. ```xml diff --git a/source/_docs/z-wave/devices.markdown b/source/_docs/z-wave/devices.markdown index 0aa392486aa..b8c79c760c3 100644 --- a/source/_docs/z-wave/devices.markdown +++ b/source/_docs/z-wave/devices.markdown @@ -20,7 +20,7 @@ The *entity* is an individual integration of the node. It may be a sensor that y ## Z-Wave, Plus, Security 2 -There have been 2 extensions to the Z-Wave protocol. Using these requires that your controller supports these extensions, but devices are backwards compatible. +There have been 2 extensions to the Z-Wave protocol. Using these requires that your controller supports these extensions, but devices are backward compatible. ### Z-Wave Plus diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown index b434486c9b2..b70928da73a 100644 --- a/source/_integrations/alexa.intent.markdown +++ b/source/_integrations/alexa.intent.markdown @@ -68,7 +68,7 @@ Next you need to create a Lambda function. - Click `Create function`, select `Author from scratch`, then input a `Function name`. - Select *Python 3.6* or *Python 3.7* as `Runtime`. - Select *Use an existing role* as `Execution role`, then select the role you just created from the `Existing role` list. -- Click `Create function`, then you can config detail of Lambda function. +- Click `Create function`, then you can configuration detail of Lambda function. - Under `Configuration` tab, expand `Designer`, then click `Alexa Skills Kit` in the left part of the panel to add a Alexa Skills Kit trigger to your Lambda function. - Scroll down little bit, you need to input the `Skill ID` from the skill you created in previous step. (You may need to switch back to the Alexa Developer Console to copy the `Skill ID`.) - Click your Lambda Function icon in the middle of the diagram and scroll down, you will see a `Function code` window. @@ -211,7 +211,7 @@ Add a sample utterance: ActivateSceneIntent activate {Scene} ``` -Then add the intent to your intent_script section in your HA config file: +Then add the intent to your `intent_script` section in your HA configuration file: ```yaml intent_script: @@ -259,7 +259,7 @@ Add a sample utterance: RunScriptIntent run {Script} ``` -Then add the intent to your intent_script section in your HA config file: +Then add the intent to your intent_script section in your HA configuration file: ```yaml intent_script: diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 0280afa3017..93da91cb92b 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -109,7 +109,7 @@ Next you need create a Lambda function. - Click `Create function`, select `Author from scratch`, then input a `Function name`. - Select *Python 3.6* or *Python 3.7* as `Runtime`. - Make sure select *Use an existing role* as `Execution role`, then select the role you just created from `Existing role` list. -- Click `Create function`, then you can config detail of Lambda function. +- Click `Create function`, then you can configuration detail of Lambda function. - Under `Configuration` tab, expand `Designer`, then click `Alexa Smart Home` in the left part of the panel to add a Alexa Smart Home trigger to your Lambda function. - Scroll down little bit, you need input the `Skill ID` from the skill you created in previous step. (tips: you may need switch back to Alexa Developer Console to copy the `Skill ID`. - Click your Lambda function icon in the middle of the diagram, scroll down you will see a `Function code` window. diff --git a/source/_integrations/almond.markdown b/source/_integrations/almond.markdown index 8f400f6c978..ef85b5e4722 100644 --- a/source/_integrations/almond.markdown +++ b/source/_integrations/almond.markdown @@ -26,7 +26,7 @@ Almond consists of three parts: ### Hass.io installation -To install Almond Server on Hass.io, go to Hass.io App Store, search for Almond and click on Install. Once started, it will initiate a config flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel. +To install Almond Server on Hass.io, go to Hass.io App Store, search for Almond and click on Install. Once started, it will initiate a configuration flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel. ### Manual installation @@ -43,7 +43,7 @@ almond: host: http://127.0.0.1:3000 ``` -The Almond integration does not update config entries yet. If you make a change to configuration.yaml, you will need to remove the config entry and then restart Home Assistant. +The Almond integration does not update configuration entries yet. If you make a change to configuration.yaml, you will need to remove the configuration entry and then restart Home Assistant. ### Almond Web diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index 5aa94b35eb7..82fa9416f57 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -194,7 +194,7 @@ If the setup for your Android TV or Fire TV device fails, then there is probably 4. You need to approve the ADB connection; see the note in the [ADB Setup](#adb-setup) section above. -5. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well. +5. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to Wi-Fi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well. 6. If your device drops off WiFi, breaking the ADB connection and causing the entity to become unavailable in Home Assistant, you could install a wake lock utility (such as [Wakelock](https://github.com/d4rken/wakelock-revamp)) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices. diff --git a/source/_integrations/arest.markdown b/source/_integrations/arest.markdown index 1d1aab15510..3d41220ce18 100644 --- a/source/_integrations/arest.markdown +++ b/source/_integrations/arest.markdown @@ -21,7 +21,7 @@ There is currently support for the following device types within Home Assistant: ## Binary Sensor -The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. +The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -72,7 +72,7 @@ This sensor is not suitable for fast state changes because there is a high possi ## Sensor -The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. +The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file: @@ -175,7 +175,7 @@ The root will give you a JSON response that contains all variables and their cur ## Switch -The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. +The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wi-Fi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework. To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_integrations/axis.markdown b/source/_integrations/axis.markdown index 6e1c2954c03..6b4befd53cd 100644 --- a/source/_integrations/axis.markdown +++ b/source/_integrations/axis.markdown @@ -27,7 +27,7 @@ For configuration go to the `Integrations pane` on your Home Assistant instance. ## Troubleshooting discovery -If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`. +If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Configuration**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`. ## Binary Sensor diff --git a/source/_integrations/binary_sensor.template.markdown b/source/_integrations/binary_sensor.template.markdown index 99e551adeb4..18d6aa35d5f 100644 --- a/source/_integrations/binary_sensor.template.markdown +++ b/source/_integrations/binary_sensor.template.markdown @@ -214,7 +214,7 @@ binary_sensor: This example is determining if anyone is home based on the combination of device tracking and motion sensors. It's extremely useful if you have kids/baby sitter/ grand parents who might still be in your house that aren't represented by a -trackable device in Home Assistant. This is providing a composite of WiFi based +trackable device in Home Assistant. This is providing a composite of Wi-Fi based device tracking and Z-Wave multisensor presence sensors. {% raw %} diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown index 8b7a2d45622..aef068f9f9e 100644 --- a/source/_integrations/broadlink.markdown +++ b/source/_integrations/broadlink.markdown @@ -370,7 +370,7 @@ Information about how to install on Windows can be found [here](/integrations/br Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:**, write in "Service Data" JSON with 1 field "host":"your_broadlink_IP" and hit **CALL SERVICE**. Press the button on your remote with in 20 seconds. The packet will be printed as a persistent notification in the States page of the web interface. -Example config for `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl` and `rm_mini_shate` devices: +Example configuration for `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl` and `rm_mini_shate` devices: ```yaml switch: @@ -413,7 +413,7 @@ switch: command_off: 'JgAaABweOR4bHhwdHB4dHRw6HhsdHR0dOTocAA0FAAAAAAAAAAAAAAAAAAA=' ``` -Example config for `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2` and `spminiplus` devices: +Example configuration for `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2` and `spminiplus` devices: ```yaml switch: @@ -430,7 +430,7 @@ switch: friendly_name: 'Humidifier' ``` -Example config for `mp1` device: +Example configuration for `mp1` device: ```yaml switch: diff --git a/source/_integrations/calendar.google.markdown b/source/_integrations/calendar.google.markdown index 04fcb7b92ef..4613dc8bfa6 100644 --- a/source/_integrations/calendar.google.markdown +++ b/source/_integrations/calendar.google.markdown @@ -12,7 +12,7 @@ The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this integration it will generate a new -configuration file `google_calendars.yaml` in your config directory that will contain information about +configuration file `google_calendars.yaml` in your configuration directory that will contain information about all of the calendars you can see. It also exposes a service to add an event to one of your Google Calendars. diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index 2bd49bfafb5..7888edbb168 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -10,7 +10,7 @@ ha_iot_class: Local Polling ha_config_flow: true --- -You can enable the Cast integration by going to the Integrations page inside the config panel. +You can enable the Cast integration by going to the Integrations page inside the configuration panel. ## Home Assistant Cast diff --git a/source/_integrations/climate.knx.markdown b/source/_integrations/climate.knx.markdown index ef083237d8a..9274d7acbc6 100644 --- a/source/_integrations/climate.knx.markdown +++ b/source/_integrations/climate.knx.markdown @@ -50,7 +50,7 @@ climate: If your device doesn't support setpoint_shift calculations (i.e. if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address` -to the config in this case.: +to the configuration in this case.: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/config.markdown b/source/_integrations/config.markdown index 89537ad0ee5..c20362b7eef 100644 --- a/source/_integrations/config.markdown +++ b/source/_integrations/config.markdown @@ -1,5 +1,5 @@ --- -title: Config +title: Configuration description: Instructions on how to setup the configuration panel for Home Assistant. logo: home-assistant.png ha_category: diff --git a/source/_integrations/cover.command_line.markdown b/source/_integrations/cover.command_line.markdown index b0053579b54..646fbb5bd82 100644 --- a/source/_integrations/cover.command_line.markdown +++ b/source/_integrations/cover.command_line.markdown @@ -54,7 +54,7 @@ covers: required: false type: string value_template: - description: if specified, `command_state` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `command_state` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`. + description: if specified, `command_state` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `command_state` returns a string "open", using `value_template` as in the example configuration above will allow you to translate that into the valid state `100`. required: false default: "'{% raw %}{{ value }}{% endraw%}'" type: template diff --git a/source/_integrations/ddwrt.markdown b/source/_integrations/ddwrt.markdown index bb28ea003a8..48a991747ef 100644 --- a/source/_integrations/ddwrt.markdown +++ b/source/_integrations/ddwrt.markdown @@ -44,7 +44,7 @@ verify_ssl: type: boolean default: true wireless_only: - description: Whether to only list devices that are connected directly to the router via WiFi or include those connected via Ethernet or other networked access points as well. + description: Whether to only list devices that are connected directly to the router via Wi-Fi or include those connected via Ethernet or other networked access points as well. required: false type: boolean default: true diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index 5a3b9a937ad..fdead68dbb1 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -45,7 +45,7 @@ See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/ Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. -If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Settings** → **Gateway** → **Advanced** → **Authenticate app** in the Phoscon App and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry. +If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Settings** → **Gateway** → **Advanced** → **Authenticate app** in the Phoscon App and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a configuration entry. You can manually add deCONZ by going to the integrations page. diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index eceacafabdb..96ccf20c966 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -1,6 +1,6 @@ --- -title: Default Config -description: The default config integration will initate a default configuration for Home Assistant. +title: Default Configuration +description: The default configuration integration will initiate a default configuration for Home Assistant. logo: home-assistant.png ha_category: - Other @@ -9,21 +9,21 @@ ha_release: 0.88 This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are: -- [automation](/integrations/automation/) -- [cloud](/integrations/cloud/) -- [config](/integrations/config/) -- [frontend](/integrations/frontend/) -- [history](/integrations/history/) -- [logbook](/integrations/logbook/) -- [map](/integrations/map/) -- [mobile_app](/integrations/mobile_app/) -- [person](/integrations/person/) -- [script](/integrations/script/) -- [ssdp](/integrations/ssdp/) -- [sun](/integrations/sun/) -- [system_health](/integrations/system_health/) -- [updater](/integrations/updater/) -- [zeroconf](/integrations/zeroconf/) +- [Automation](/integrations/automation/) +- [Home Assistant Cloud](/integrations/cloud/) +- [Configuration](/integrations/config/) +- [Frontend](/integrations/frontend/) +- [History](/integrations/history/) +- [Logbook](/integrations/logbook/) +- [Map](/integrations/map/) +- [Mobile App Support](/integrations/mobile_app/) +- [Person](/integrations/person/) +- [Scripts](/integrations/script/) +- [Simple Service Discovery Protocol (SSDP)](/integrations/ssdp/) +- [Sun](/integrations/sun/) +- [System Health](/integrations/system_health/) +- [Updater](/integrations/updater/) +- [Zero-configuration networking (zeroconf)](/integrations/zeroconf/) ## Configuration diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown index 80e53c600f1..130e2e7b536 100644 --- a/source/_integrations/denonavr.markdown +++ b/source/_integrations/denonavr.markdown @@ -97,7 +97,7 @@ A few notes: #### Service `denonavr.get_command` -Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g. "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at https://ca.denon.com/ca/product/hometheater/receivers/avrx4400h?docname=AVR-X6400H_X4400H_X3400H_X2400H_X1400H_S930H_S730H_PROTOCOL_V01.xlsx and a full list of IR codes at http://www.denon-hifi.nl/uk/product/hometheater/avreceivers/avr3313?docname=AVR3313_IR_CODE_V01.pdf +Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g. "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at and a full list of IR codes at | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------- | diff --git a/source/_integrations/device_tracker.markdown b/source/_integrations/device_tracker.markdown index 3ddb857bd20..6c9a9bbb57c 100644 --- a/source/_integrations/device_tracker.markdown +++ b/source/_integrations/device_tracker.markdown @@ -66,7 +66,7 @@ As of 0.94 `known_devices.yaml` is being phased out and no longer used by all tr -Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked. +Once `device_tracker` is enabled, a file will be created in your configuration dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked. Here's an example configuration for a single device: diff --git a/source/_integrations/doods.markdown b/source/_integrations/doods.markdown index 517c1d38d4f..e0ba3775c23 100644 --- a/source/_integrations/doods.markdown +++ b/source/_integrations/doods.markdown @@ -178,7 +178,7 @@ image_processing: ## Optimizing resources -[Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. +[Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. ```yaml # Example advanced configuration.yaml entry diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index cd14a04d2e0..4e063fe6bb0 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -48,7 +48,7 @@ To configure the ecobee integration in Home Assistant, you can either use the ** 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. +4. After authorizing the App on ecobee.com, return to Home Assistant and hit **Submit**. If the authorization was successful, a configuration entry will be created and your thermostats and sensors will be available in Home Assistant. ### Setup via `configuration.yaml` diff --git a/source/_integrations/emulated_roku.markdown b/source/_integrations/emulated_roku.markdown index ea80363b9f7..3ed02e9dc5c 100644 --- a/source/_integrations/emulated_roku.markdown +++ b/source/_integrations/emulated_roku.markdown @@ -10,7 +10,7 @@ ha_config_flow: true --- This integration integrates an emulated Roku API into Home Assistant, -so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player. +so remotes such as Harmony and Android apps can connect to it through Wi-Fi as if it were a Roku player. Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations. Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries. @@ -135,6 +135,6 @@ Known limitations: * Harmony uses UPnP discovery (UPnP is not needed after pairing), which might not work in Docker. You can: * Change Docker to host networking temporarily, then revert after pairing. * Run the `advertise.py` helper script from the emulated_roku library directly somewhere else and point it to the emulated Roku API. -* Harmony cannot launch apps as it uses IR instead of the WiFi API and will not display the custom dummy app list. +* Harmony cannot launch apps as it uses IR instead of the Wi-Fi API and will not display the custom dummy app list. * Home control buttons cannot be assigned to emulated Roku on the Harmony Hub Companion remote as they are limited to Hue (and possibly other APIs) within Harmony. * Harmony will not set the name of the added emulated Roku device to the specified `name`. diff --git a/source/_integrations/ephember.markdown b/source/_integrations/ephember.markdown index ee53dd5a6ba..3b2e7329bc1 100644 --- a/source/_integrations/ephember.markdown +++ b/source/_integrations/ephember.markdown @@ -10,7 +10,7 @@ ha_codeowners: - '@ttroy50' --- -The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a WiFi gateway to control your EPH system and an account on the EMBER app. +The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app. To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index f6397327f0b..62c24f48e4f 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -130,7 +130,7 @@ proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; ``` -This snippet should be added within your Home Assistant server config, so you have something like the following: +This snippet should be added within your Home Assistant server configuration, so you have something like the following: ```bash server { diff --git a/source/_integrations/fibaro.markdown b/source/_integrations/fibaro.markdown index 230fa166660..8355fbe63a5 100644 --- a/source/_integrations/fibaro.markdown +++ b/source/_integrations/fibaro.markdown @@ -72,7 +72,7 @@ plugins: type: boolean default: false device_config: - description: Lists device specific parameter or behaviour overrides. + description: Lists device specific parameter or behavior overrides. required: false type: list default: None diff --git a/source/_integrations/fortios.markdown b/source/_integrations/fortios.markdown index 2cf29b52dcd..1245ef9047c 100644 --- a/source/_integrations/fortios.markdown +++ b/source/_integrations/fortios.markdown @@ -15,7 +15,7 @@ This integration enables Home Assistant to do device tracking of devices with a The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). The integration has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0. -All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and WiFi devices, including devices detected by LLDP. +All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and Wi-Fi devices, including devices detected by LLDP. The integration is based on the Home Assistant `device_tracker` platform. diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown index 4e8b588cbb3..bc7b137a7de 100644 --- a/source/_integrations/freebox.markdown +++ b/source/_integrations/freebox.markdown @@ -19,7 +19,7 @@ There is currently support for the following device types within Home Assistant: * [Sensor](#sensor) with traffic metrics * [Device tracker](#presence-detection) for connected devices -* [Switch](#switch) to control WiFi +* [Switch](#switch) to control Wi-Fi ## Configuration @@ -64,7 +64,7 @@ The first time Home Assistant will connect to your Freebox, you will need to authorize it by pressing the right arrow on the facade of the Freebox when prompted to do so. -To make the WiFi switch and the reboot service working you will have to add "Modification des réglages de la Freebox +To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox " permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". ### Supported routers @@ -104,4 +104,4 @@ This service will reboot your Freebox router. It does not take any parameter. Be ## Switch -This platform offers you a switch to toggle the Wifi on or off. This will toggle all WiFi interfaces of the router (all SSID and all bands). +This platform offers you a switch to toggle the Wi-Fi on or off. This will toggle all Wi-Fi interfaces of the router (all SSID and all bands). diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index 28cf66bb6a4..8cd22f36c63 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -19,7 +19,7 @@ frontend: {% configuration %} javascript_version: - description: "DEPRECATED, it is now done using feature detection in the browser. Version of the JavaScript to serve to clients. Options: `es5` - transpiled so old browsers understand it. `latest` - not transpiled, so will work on recent browsers only. `auto` - select a version according to the browser user-agent. The value in the config can be overiden by putting `es5` or `latest` in the URL. For example `http://localhost:8123/states?es5` " + description: "DEPRECATED, it is now done using feature detection in the browser. Version of the JavaScript to serve to clients. Options: `es5` - transpiled so old browsers understand it. `latest` - not transpiled, so will work on recent browsers only. `auto` - select a version according to the browser user-agent. The value in the configuration can be overiden by putting `es5` or `latest` in the URL. For example `http://localhost:8123/states?es5` " required: false type: string default: auto diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown index 66bbf01f2ce..b9da60c0041 100644 --- a/source/_integrations/geniushub.markdown +++ b/source/_integrations/geniushub.markdown @@ -57,7 +57,7 @@ Switch entities will report back their state; other properties are available via - `On` for **Override** \ **On**, and - `Off` otherwise (NB: the zone could still be 'on', e.g. with **Timer** mode) -Note: if you turn a Switch entity `Off` via Home Assistant's web UI, it will revert to **Timer** mode - this may not be the behaviour you are expecting. +Note: if you turn a Switch entity `Off` via Home Assistant's web UI, it will revert to **Timer** mode - this may not be the behavior you are expecting. Individual smart plugs are not yet exposed as switches - you can create one zone per smart plug as a work-around. diff --git a/source/_integrations/gitlab_ci.markdown b/source/_integrations/gitlab_ci.markdown index 1a4b045ba9d..7a9ee6ffd86 100644 --- a/source/_integrations/gitlab_ci.markdown +++ b/source/_integrations/gitlab_ci.markdown @@ -12,7 +12,7 @@ The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jo ## Setup -You will need a GitLab repository ID. On the **Details** page for your GitLab repo, just below the project name is **Project ID:**. +You will need a GitLab repository ID. On the **Details** page for your GitLab repository, just below the project name is **Project ID:**. Alternatively, you can use `GitLab_Username/GitLab_RepositoryName`, e.g., `MyCoolUsername/MyCoolRepository`. diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index f2965b3ca34..d198836a78f 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -66,7 +66,7 @@ If you've added Home Assistant to your phone's home screen, you have to first re 2. Copy and share the link with the new user. 3. When the new user opens the link with their own Google account, it will enable your draft test app under their account. 3. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account. -2. If you want to support actively reporting of state to Google's server (config option `report_state`) and support `google_assistant.request_sync`, you need to generate a service account. +2. If you want to support actively reporting of state to Google's server (configuration option `report_state`) and support `google_assistant.request_sync`, you need to generate a service account. 1. In the GCP Console, go to the [Create Service account key](https://console.cloud.google.com/apis/credentials/serviceaccountkey) page. 2. From the Service account list, select New service account. 3. In the Service account name field, enter a name. diff --git a/source/_integrations/google_pubsub.markdown b/source/_integrations/google_pubsub.markdown index 9545095c0b9..02556f0e999 100644 --- a/source/_integrations/google_pubsub.markdown +++ b/source/_integrations/google_pubsub.markdown @@ -17,7 +17,7 @@ You need to create a Service Account key in the [Google Cloud API Console](https - Choose a new "New Service Account", give it a name and leave the key type as JSON - Select the role: Pub/Sub Publisher -This will download the Service Account JSON key to your machine. Do NOT share this with anyone. Place this file in your Home Assistant config folder. +This will download the Service Account JSON key to your machine. Do NOT share this with anyone. Place this file in your Home Assistant configuration folder. Next, create a Google Pub/Sub topic in the [Google Cloud API Console](https://console.cloud.google.com/cloudpubsub/topicList). The topic name will become something like `projects/project-198373/topics/topic-name`. Note the last part only (the name you chose): `topic-name`. diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown index 96882ebe77b..ad542976fd4 100644 --- a/source/_integrations/harmony.markdown +++ b/source/_integrations/harmony.markdown @@ -31,7 +31,7 @@ remote: host: 10.168.1.13 ``` -You can override some default configuration values on a discovered hub (e.g., the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the config to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. +You can override some default configuration values on a discovered hub (e.g., the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the configuration to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. ```yaml # Example configuration.yaml entry with discovery diff --git a/source/_integrations/hdmi_cec.markdown b/source/_integrations/hdmi_cec.markdown index ac3b15825c1..1bc7667a369 100644 --- a/source/_integrations/hdmi_cec.markdown +++ b/source/_integrations/hdmi_cec.markdown @@ -122,7 +122,7 @@ hdmi_cec: Choose just one schema. Mixing both approaches is not possible. -Another option you can use in config is `platform` which specifying of default platform of HDMI devices. "switch" and "media_player" are supported. Switch is default. +Another option you can use in configuration is `platform` which specifying of default platform of HDMI devices. "switch" and "media_player" are supported. Switch is default. ```yaml hdmi_cec: @@ -149,7 +149,7 @@ hdmi_cec: ### Select Device -Call the `hdmi_cec.select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: +Call the `hdmi_cec.select_device` service with the name of the device from configuration or entity_id or physical address"to select it, for example: ```json {"device": "Chromecast"} diff --git a/source/_integrations/hisense_aehw4a1.markdown b/source/_integrations/hisense_aehw4a1.markdown index e99a0f8b9b0..9fa484ca2d8 100644 --- a/source/_integrations/hisense_aehw4a1.markdown +++ b/source/_integrations/hisense_aehw4a1.markdown @@ -11,9 +11,9 @@ ha_codeowners: - '@bannhead' --- -The Hisense AEH-W4A1 is a WiFi module used to give WiFi connectivity to some Hisense ACs and rebranded models (Smart Cool, Beko and others). +The Hisense AEH-W4A1 is a Wi-Fi module used to give Wi-Fi connectivity to some Hisense ACs and rebranded models (Smart Cool, Beko and others). -Later AC models use other WiFi modules (like AEH-W4B1 and AEH-W4E1) that are not compatible or otherwise tested with this integration. +Later AC models use other Wi-Fi modules (like AEH-W4B1 and AEH-W4E1) that are not compatible or otherwise tested with this integration. It is highly recommended not to use one of the official smartphone applications and this integration at the same time, to avoid problems related to command collision. diff --git a/source/_integrations/hitron_coda.markdown b/source/_integrations/hitron_coda.markdown index 33743215a88..6a095817ffa 100644 --- a/source/_integrations/hitron_coda.markdown +++ b/source/_integrations/hitron_coda.markdown @@ -32,7 +32,7 @@ username: required: true type: string password: - description: The password for the specified username. Usually your WiFi password. + description: The password for the specified username. Usually your Wi-Fi password. required: true type: string type: diff --git a/source/_integrations/homeassistant.markdown b/source/_integrations/homeassistant.markdown index 9c728c8c7f6..f094458fbe3 100644 --- a/source/_integrations/homeassistant.markdown +++ b/source/_integrations/homeassistant.markdown @@ -16,11 +16,11 @@ The `homeassistant` integration provides services for controlling Home Assistant ### Service `homeassistant.check_config` -Reads the config files and checks them for correctness, but **does not** load them into Home Assistant. Creates a persistent notification and log entry if errors are found. +Reads the configuration files and checks them for correctness, but **does not** load them into Home Assistant. Creates a persistent notification and log entry if errors are found. ### Service `homeassistant.reload_core_config` -Loads the main config file (`configuration.yaml`) and all linked files. Once loaded the new configuration is applied. +Loads the main configuration file (`configuration.yaml`) and all linked files. Once loaded the new configuration is applied. ### Service `homeassistant.restart` diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown index 75b73a2cad7..371c9ff7342 100644 --- a/source/_integrations/homekit.markdown +++ b/source/_integrations/homekit.markdown @@ -191,7 +191,7 @@ The HomeKit guidelines only allow a maximum of 100 unique accessories (`aid`) pe ### Persistence Storage -Unfortunately `HomeKit` doesn't support any persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems, it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not set up, their config will be deleted. (State unknown or similar will not cause any issues.) +Unfortunately `HomeKit` doesn't support any persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems, it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not set up, their configuration will be deleted. (State unknown or similar will not cause any issues.) A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable `auto start` and `turn off` the `Start HomeKit` automation (if you have one). @@ -313,7 +313,7 @@ Filters are applied as follows: The `safe_mode` option should only be used (and only works) if you encounter issues during the pairing. ([Pairing hangs - zeroconf error](#pairing-hangs---zeroconf-error)). -To use `safe_mode`, add the option to your `homekit` config: +To use `safe_mode`, add the option to your `homekit` configuration: ```yaml homekit: @@ -324,7 +324,7 @@ Restart your Home Assistant instance. If you don't see a `pincode`, follow the [
-To avoid any errors, after you have successfully paired your Home Assistant Bridge, remove the `safe_mode` option from your config and restart Home Assistant. +To avoid any errors, after you have successfully paired your Home Assistant Bridge, remove the `safe_mode` option from your configuration and restart Home Assistant.
@@ -332,7 +332,7 @@ To avoid any errors, after you have successfully paired your Home Assistant Brid The `advertise_ip` option can be used to run this integration even inside an ephemeral Docker container with network isolation enabled, e.g., not using the host network. -To use `advertise_ip`, add the option to your `homekit` config: +To use `advertise_ip`, add the option to your `homekit` configuration: ```yaml homekit: @@ -411,7 +411,7 @@ You might have paired the `Home Assistant Bridge` already. If not, delete the `. This is often setup and network related. Make sure to check the other issues below as well, but things that might work include: - Check your router configuration -- Try with WIFI **and** LAN +- Try with Wi-Fi **and** LAN - Change the default [port](#port) Remember that the iOS device needs to be in the same local network as the Home Assistant device for pairing. @@ -428,15 +428,15 @@ Configure the network mode as `networkbridge`. Otherwise the Home Assistant Brid #### Pairing hangs - zeroconf error -Pairing eventually fails, you might see and an error message `NonUniqueNameException`. Add the `safe_mode` option to your config, see [safe_mode](#safe-mode). +Pairing eventually fails, you might see and an error message `NonUniqueNameException`. Add the `safe_mode` option to your configuration, see [safe_mode](#safe-mode). -#### Pairing hangs - only works with debug config +#### Pairing hangs - only works with debug configuration -Pairing works fine when the filter is set to only include `demo.demo`, but fails with normal config. See [specific entity doesn't work](#specific-entity-doesnt-work) +Pairing works fine when the filter is set to only include `demo.demo`, but fails with normal configuration. See [specific entity doesn't work](#specific-entity-doesnt-work) #### Pairing hangs - no error -1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it. +1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repository, so we can resolve it. 2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook up to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable. #### Duplicate AID found when attempting to add accessory @@ -479,7 +479,7 @@ To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homeki #### The linked battery sensor isn't recognized -Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added. See [resetting accessories](#resetting-accessories). +Try removing the entity from HomeKit and then adding it again. If you are adding this configuration option to an existing entity in HomeKit, any changes you make to this entity's configuration options won't appear until the accessory is removed from HomeKit and then re-added. See [resetting accessories](#resetting-accessories). #### My media player is not showing up as a television accessory diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown index e35ab89203f..fb37e982d77 100644 --- a/source/_integrations/homekit_controller.markdown +++ b/source/_integrations/homekit_controller.markdown @@ -44,7 +44,7 @@ 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. Home Assistant can then find it and pair with it. +- If the device is Wi-Fi 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 Wi-Fi 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 Wi-Fi. 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. @@ -73,13 +73,13 @@ This is normal - HomeKit controller is currently a local polling based integrati ### 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 Wi-Fi based and has no user interface for joining it to your Wi-Fi 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 Wi-Fi 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'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 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 device briefly to get them onto your WiFi, but other than that you do not need any Apple hardware on your network. +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 Wi-Fi 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. 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. @@ -94,7 +94,7 @@ 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 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, 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. +- 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 Wi-Fi 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 buildup of back pressure in your instance. diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index b82b75f1290..52b2438c1df 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -503,7 +503,7 @@ param: required: true type: string interface: - description: Set the name of the interface from the config. + description: Set the name of the interface from the configuration. required: false type: string value: diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown index eb45715ad9e..3bb2c8ccc11 100644 --- a/source/_integrations/icloud.markdown +++ b/source/_integrations/icloud.markdown @@ -78,9 +78,9 @@ You may receive an email and a notification from Apple saying that someone has l For the notification, press "Allow", then "OK". -If 2 Step Authentication is enabled for your iCloud account, some time after Home Assistant startup the integration will ask which device you want to use as the Trusted Device via a notification in the Home Assistant UI. The integration will send an SMS prompt to that device with the auth code to enter in Home Assistant. The duration of this authentication is determined by Apple, but is currently 2 months, so you will only need to verify your account every two months. +If two-step authentication is enabled for your iCloud account, some time after Home Assistant startup the integration will ask which device you want to use as the Trusted Device via a notification in the Home Assistant UI. The integration will send an SMS prompt to that device with the auth code to enter in Home Assistant. The duration of this authentication is determined by Apple, but is currently 2 months, so you will only need to verify your account every two months. -2 Factor Authentication is the improved version of 2 Step Authentication and is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. +2 Factor Authentication is the improved version of two-step authentication and is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. To prevent excessive battery drainage, a dynamic interval is used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device. diff --git a/source/_integrations/image_processing.markdown b/source/_integrations/image_processing.markdown index eaf41a4b103..ab00a547f39 100644 --- a/source/_integrations/image_processing.markdown +++ b/source/_integrations/image_processing.markdown @@ -56,7 +56,7 @@ The following event attributes will be present (platform-dependent): `entity_id` ## scan_interval and Optimising Resources -Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. +Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. ```yaml # Example configuration.yaml diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index 12245543659..96161c987d1 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -59,7 +59,7 @@ input_text: required: false type: icon pattern: - description: Regex pattern for client side validation. + description: Regex pattern for client-side validation. required: false type: string default: empty diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown index 99d7acd40b9..a32d2da62b2 100644 --- a/source/_integrations/iperf3.markdown +++ b/source/_integrations/iperf3.markdown @@ -13,7 +13,7 @@ ha_codeowners: The `iperf3` sensor integration allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server. -Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. +Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a Iperf3 test to run. ## Setup diff --git a/source/_integrations/juicenet.markdown b/source/_integrations/juicenet.markdown index 9ae1709b0c7..9c23e753381 100644 --- a/source/_integrations/juicenet.markdown +++ b/source/_integrations/juicenet.markdown @@ -13,7 +13,7 @@ ha_codeowners: - '@jesserockz' --- -The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule. +The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a Wi-Fi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule. ## Configuration diff --git a/source/_integrations/kankun.markdown b/source/_integrations/kankun.markdown index b844f607047..13f6d888e97 100644 --- a/source/_integrations/kankun.markdown +++ b/source/_integrations/kankun.markdown @@ -7,7 +7,7 @@ ha_release: 0.36 ha_iot_class: Local Polling --- -The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are +The `kankun` switch platform allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi) script to provide an HTTP API. Details of the necessary modifications can be found [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown index c0dab3ab5f2..94a0ac6066c 100644 --- a/source/_integrations/kodi.markdown +++ b/source/_integrations/kodi.markdown @@ -124,7 +124,7 @@ With the `turn_on_action` and `turn_off_action` parameters you can run any combi #### Turn on Kodi with Wake on LAN -With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to config the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. +With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. ```yaml media_player: diff --git a/source/_integrations/lifx.markdown b/source/_integrations/lifx.markdown index ae434aba53c..c31de1f2b4f 100644 --- a/source/_integrations/lifx.markdown +++ b/source/_integrations/lifx.markdown @@ -13,7 +13,7 @@ The `lifx` integration allows you to integrate your [LIFX](https://www.lifx.com) _Please note, the `lifx` integration does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ -You can configure the LIFX integration by going to the integrations page inside the config panel. +You can configure the LIFX integration by going to the integrations page inside the configuration panel. ## Set state diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 19053fb0baa..85f0260e417 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -640,7 +640,7 @@ light: - A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing. -- There is also another implementation forked from the above repo, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found [here](https://github.com/JammyDodger231/nodemcu-mqtt-rgb-led). +- There is also another implementation forked from the above repository, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found [here](https://github.com/JammyDodger231/nodemcu-mqtt-rgb-led). - [McLighting](https://github.com/toblum/McLighting) is another ESP8266 firmware for WS2812 addressable LEDs. @@ -648,7 +648,7 @@ light: - [ESPHome](https://esphome.io) implements the JSON schema for MQTT based installs and supports [MQTT discovery](/docs/mqtt/discovery/). -- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. +- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours, brightness, color temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. - [h801-mqtt-json](https://github.com/starkillerOG/h801-mqtt-json) is a custom firmware for the H801 LED dimmer, a 5 channel (RGBWWCW) WiFi LED strip controller for 12V LED strips. The firmware is meant to control the 5 channels of the H801 to simultaneously control an RGB and a Warm-white/Cold-white LED strip such as a 5050 RGB LED strip and a 5025 Dual White strip. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours (RGB strip), brightness, color temperature (CW/WW strip) and transitions. diff --git a/source/_integrations/limitlessled.markdown b/source/_integrations/limitlessled.markdown index 59597a5494f..fe19d1cd0c1 100644 --- a/source/_integrations/limitlessled.markdown +++ b/source/_integrations/limitlessled.markdown @@ -84,7 +84,7 @@ bridges: required: true type: string type: - description: Type of group. Choose either `rgbww`, `rgbw`, `white`, `bridge-led` or `dimmer`. Use `bridge-led` to control the built-in LED of newer WiFi bridges. + description: Type of group. Choose either `rgbww`, `rgbw`, `white`, `bridge-led` or `dimmer`. Use `bridge-led` to control the built-in LED of newer Wi-Fi bridges. required: false default: rgbw type: string @@ -123,14 +123,14 @@ Refer to the [light]({{site_root}}/integrations/light/) documentation for genera - *Brightness*: There are 101 brightness steps. - **RGBW** - *Color*: There are 256 color possibilities along the LimitlessLED color spectrum. Color properties like saturation and lightness cannot be used - only Hue can. The only exception is white (which may be warm or cold depending on the type of RGBW bulb). If you select a color with saturation or lightness, Home Assistant will calculate the nearest valid LimitlessLED color. - - *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 25. + - *Brightness*: Wi-Fi bridge v6 supports 101 brightness steps; older versions only 25. - **White** - - When using a legacy WiFi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property. - - *Temperature*: Wifi bridge v6 supports 101 temperature steps; older versions only 10. - - *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 10. + - When using a legacy Wi-Fi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property. + - *Temperature*: Wi-Fi bridge v6 supports 101 temperature steps; older versions only 10. + - *Brightness*: Wi-Fi bridge v6 supports 101 brightness steps; older versions only 10. - **Dimmer** (Only supported on v6 bridges) - - This type is for a single color LED dimmer like the 1CH MiLight dimmer module or similar. This type is only supported by the version 6 Wifi bridges. - - *Brightness*: Wifi bridge v6 supports 101 brightness steps. + - This type is for a single color LED dimmer like the 1CH MiLight dimmer module or similar. This type is only supported by the version 6 Wi-Fi bridges. + - *Brightness*: Wi-Fi bridge v6 supports 101 brightness steps. - **Transitions** - If a transition time is set, the group will transition between the current settings and the target settings for the duration specified. Transitions from or to white are not possible - the color will change immediately. diff --git a/source/_integrations/linksys_smart.markdown b/source/_integrations/linksys_smart.markdown index 9cd5ebb485c..b7c9b6ae913 100644 --- a/source/_integrations/linksys_smart.markdown +++ b/source/_integrations/linksys_smart.markdown @@ -1,13 +1,13 @@ --- title: Linksys Smart Wi-Fi -description: Instructions on how to integrate Linksys Smart Wifi Router into Home Assistant. +description: Instructions on how to integrate Linksys Smart Wi-Fi Router into Home Assistant. ha_category: - Presence Detection logo: linksys.png ha_release: 0.48 --- -The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router. +The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wi-Fi based router. Tested routers: @@ -20,7 +20,7 @@ For this platform to work correctly, it is necessary to disable the "Access via ## Configuration -To use a Linksys Smart Wifi Router in your Home Assistant installation, add the following to your `configuration.yaml` file: +To use a Linksys Smart Wi-Fi Router in your Home Assistant installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/logi_circle.markdown b/source/_integrations/logi_circle.markdown index 50343dc88a9..d7612456f05 100644 --- a/source/_integrations/logi_circle.markdown +++ b/source/_integrations/logi_circle.markdown @@ -115,9 +115,9 @@ sensor: recording: description: The camera's recording mode. If false, the camera will not capture activities. signal_strength_category: - description: Return the WiFi signal level from the camera. + description: Return the Wi-Fi signal level from the camera. signal_strength_percentage: - description: Return the WiFi signal percentage from the camera. + description: Return the Wi-Fi signal percentage from the camera. streaming: description: The soft on/off status of the camera. {% endconfiguration %} diff --git a/source/_integrations/manual.markdown b/source/_integrations/manual.markdown index 0029971f04f..cea79d6c9f9 100644 --- a/source/_integrations/manual.markdown +++ b/source/_integrations/manual.markdown @@ -124,7 +124,7 @@ be used for example to sound the siren for a shorter time during the night. ## Examples -In the config example below: +In the configuration example below: - the disarmed state never triggers the alarm; - the armed_home state will leave no time to leave the building or disarm the alarm; diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown index d676ea53061..7d66028403b 100644 --- a/source/_integrations/matrix.markdown +++ b/source/_integrations/matrix.markdown @@ -73,7 +73,7 @@ commands: required: true type: string rooms: - description: "A list of rooms that the bot should listen for this command in. If this is not given, the *rooms* list from the main config is used. Please note that every room in this list must also be in the main *room* config." + description: "A list of rooms that the bot should listen for this command in. If this is not given, the *rooms* list from the main configuration is used. Please note that every room in this list must also be in the main *room* configuration." required: false type: [string] default: empty diff --git a/source/_integrations/netio.markdown b/source/_integrations/netio.markdown index 713c58a427b..f2001c6c57d 100644 --- a/source/_integrations/netio.markdown +++ b/source/_integrations/netio.markdown @@ -8,7 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.24 --- -The `netio` switch platform allows you to control your [Netio](https://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or WiFi that reports consumptions (Netio4all). +The `netio` switch platform allows you to control your [Netio](https://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or Wi-Fi that reports consumptions (Netio4all). To use Netio devices in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index da4d8b0bead..119ca5a7fd3 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -57,7 +57,7 @@ extra_arguments: default: -q:v 2 {% endconfiguration %} -Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config `profile` variable. +Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in configuration `profile` variable. ### Service `camera.onvif_ptz` diff --git a/source/_integrations/opencv.markdown b/source/_integrations/opencv.markdown index 97107e7eae6..2115d3009dd 100644 --- a/source/_integrations/opencv.markdown +++ b/source/_integrations/opencv.markdown @@ -30,7 +30,7 @@ image_processing: - **source** array (*Required*): List of image sources. - **entity_id** (*Required*): A camera entity id to get picture from. - **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity. -- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repo. +- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repository. **classifier** may also be defined as a dictionary of names to classifier configurations: diff --git a/source/_integrations/openevse.markdown b/source/_integrations/openevse.markdown index db05ed5297c..9b7d532e17f 100644 --- a/source/_integrations/openevse.markdown +++ b/source/_integrations/openevse.markdown @@ -8,7 +8,7 @@ ha_release: 0.38 ha_iot_class: Local Polling --- -This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. +This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection. ## Configuration diff --git a/source/_integrations/pandora.markdown b/source/_integrations/pandora.markdown index c16d794000d..28871c2f6f4 100644 --- a/source/_integrations/pandora.markdown +++ b/source/_integrations/pandora.markdown @@ -26,7 +26,7 @@ And now install the backported FFmpeg-related libraries (note that if you're usi sudo apt-get -t jessie-backports install libav-tools libavcodec-extra libavcodec-dev libavfilter-dev libavformat-dev ``` -Now clone the Pianobar repo and build pianobar: +Now clone the Pianobar repository and build pianobar: ```bash git clone https://github.com/PromyLOPh/pianobar.git diff --git a/source/_integrations/plum_lightpad.markdown b/source/_integrations/plum_lightpad.markdown index 9cade50ec26..73f1accb295 100644 --- a/source/_integrations/plum_lightpad.markdown +++ b/source/_integrations/plum_lightpad.markdown @@ -8,12 +8,12 @@ logo: plum.png ha_release: 0.85 --- -Configurable/Dimmable WiFi Lightswitch +Configurable/Dimmable Wi-Fi Lightswitch - Cloud registered, Local API communication (both RESTful and TCP pushed events) - Motion Sensor - Energy Meter - RGB Glow Ring -- Wifi & Bluetooth connectivity +- Wi-Fi & Bluetooth connectivity - Phone Apps for iOS & Android ## Configuration diff --git a/source/_integrations/proxmoxve.markdown b/source/_integrations/proxmoxve.markdown index c74c8e3ae9d..51c62580890 100644 --- a/source/_integrations/proxmoxve.markdown +++ b/source/_integrations/proxmoxve.markdown @@ -20,7 +20,7 @@ After configuring this component, the binary sensors automatically appear. You should have at least one VM or container entry configured, else this integration won't do anything. -To use the `proxmoxve` component, add the following config to your `configuration.yaml` file: +To use the `proxmoxve` component, add the following configuration to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -120,7 +120,7 @@ Before creating the user, we need to create a permissions role for the user. ### Create Home Assistant User -Creating a dedicated user for Home Assistant, limited to only the role just created is the most secure method. These instructions use the `pve` realm for the user. This allows a connection, but ensures that the user is not authenticated for SSH connections. If you use the `pve` realm, just be sure to add `realm: pve` to your config. +Creating a dedicated user for Home Assistant, limited to only the role just created is the most secure method. These instructions use the `pve` realm for the user. This allows a connection, but ensures that the user is not authenticated for SSH connections. If you use the `pve` realm, just be sure to add `realm: pve` to your configuration. * Click `Datacenter` * Open `Permissions` and click `Users` diff --git a/source/_integrations/radarr.markdown b/source/_integrations/radarr.markdown index c94d7aa7677..91368831d8f 100644 --- a/source/_integrations/radarr.markdown +++ b/source/_integrations/radarr.markdown @@ -95,7 +95,7 @@ sensor: ### Enable SSL -SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the config here (unless it is changed to 7878). +SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the configuration here (unless it is changed to 7878). ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/raspyrfm.markdown b/source/_integrations/raspyrfm.markdown index f70808f7eaf..9d22260d7ca 100644 --- a/source/_integrations/raspyrfm.markdown +++ b/source/_integrations/raspyrfm.markdown @@ -79,7 +79,7 @@ Have a look at the underlying library [raspyrfm-client](https://github.com/marku ## Channel configuration -Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model. +Depending on the control unit the channel configuration can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model. ## Switch state diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index febcb4a06e0..69fbf37cc36 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -300,7 +300,7 @@ sensor: ``` {% endraw %} -This config shows how to extract multiple values from a dictionary with `json_attributes` and `template`. It helps you to avoid flooding the REST service and only ask once the results and separate them in multiple templates referring to it. (No need for a specific state on the REST sensor and it's default state will be the full JSON value which will be longer than the 255 max length. It's why we'll used a static value) +This configuration shows how to extract multiple values from a dictionary with `json_attributes` and `template`. It helps you to avoid flooding the REST service and only ask once the results and separate them in multiple templates referring to it. (No need for a specific state on the REST sensor and it's default state will be the full JSON value which will be longer than the 255 max length. It's why we'll used a static value) {% raw %} ```json diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown index bd41f285a19..31cda0c343f 100644 --- a/source/_integrations/rflink.markdown +++ b/source/_integrations/rflink.markdown @@ -154,7 +154,7 @@ If you find a device is recognized differently, with different protocols or the ### Debug Logging -For debugging purposes or context when investigating issues you can enable debug logging for RFLink with the following config snippet: +For debugging purposes or context when investigating issues you can enable debug logging for RFLink with the following configuration snippet: ```yaml logger: diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown index 451b990f442..459db92a14c 100644 --- a/source/_integrations/rfxtrx.markdown +++ b/source/_integrations/rfxtrx.markdown @@ -59,7 +59,7 @@ Not all protocols as advertised are enabled on the initial setup of your transce ### ser2net -You can host your device on another computer by setting up ser2net and example configuration for ser2net looks like this and then using host/port in your Home Assistant config. +You can host your device on another computer by setting up ser2net and example configuration for ser2net looks like this and then using host/port in your Home Assistant configuration. ```text 50000:raw:0:/dev/ttyUSB0:38400 8DATABITS NONE 1STOPBIT diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index 9dc7f4919b3..e907909898d 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -31,7 +31,7 @@ This component does NOT allow for live viewing of your Ring camera within Home A ## Configuration -Go to the integrations page in your config and click on new integration -> Ring. +Go to the integrations page in your configuration and click on new integration -> Ring. ## YAML configuration diff --git a/source/_integrations/saj.markdown b/source/_integrations/saj.markdown index ed26f24005b..6c8a033d019 100644 --- a/source/_integrations/saj.markdown +++ b/source/_integrations/saj.markdown @@ -14,8 +14,8 @@ The `saj` sensor will poll a [SAJ](https://www.saj-electric.com/) solar inverter This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser. -There is a difference between inverters that are connected via an ethernet module and those connected via a WiFi module. -The WiFi module requires a username and password for authentication where the ethernet module does not. +There is a difference between inverters that are connected via an ethernet module and those connected via a Wi-Fi module. +The Wi-Fi module requires a username and password for authentication where the ethernet module does not. ## Configuration @@ -68,7 +68,7 @@ Sensors available in the library: | temperature | °C | Temperature of the inverter. | | state | N/A | Live state of the inverter. | -## Full configuration example for WiFi inverters +## Full configuration example for Wi-Fi inverters ```yaml sensor: diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown index fc19ce42b18..3cdc0a6c2c6 100644 --- a/source/_integrations/samsungtv.markdown +++ b/source/_integrations/samsungtv.markdown @@ -15,7 +15,7 @@ The `samsungtv` platform allows you to control a [Samsung Smart TV](https://www. ### Setup -Go to the integrations page in your config and click on new integration -> Samsung TV. +Go to the integrations page in your configuration and click on new integration -> Samsung TV. If you have enabled [ssdp](/integrations/ssdp) discovery and your TV is on, it's likely that you just have to confirm the detected device. When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. diff --git a/source/_integrations/sensibo.markdown b/source/_integrations/sensibo.markdown index 70dce13f6e1..8a3bbb08741 100644 --- a/source/_integrations/sensibo.markdown +++ b/source/_integrations/sensibo.markdown @@ -38,7 +38,7 @@ then in the Sensibo app log you will be able to distinguish between actions done in the app and actions done by Home Assistant. -## Full config example +## Full configuration example ```yaml climate: diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown index c4573564b3b..72fdd161a86 100644 --- a/source/_integrations/smartthings.markdown +++ b/source/_integrations/smartthings.markdown @@ -112,7 +112,7 @@ The integration will trigger an event when a device with the [button](https://sm | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. | | `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). | -| `location_id` | The unique id of the location the device is part of. This can be found in the config entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). | +| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). | | `value` | Describes the action taken on the button. See the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability reference for a list of possible values (not all are supported by every device). | | `name` | The name given to the device in SmartThings. | diff --git a/source/_integrations/smhi.markdown b/source/_integrations/smhi.markdown index 2e53261bed0..fe0804a6628 100644 --- a/source/_integrations/smhi.markdown +++ b/source/_integrations/smhi.markdown @@ -20,7 +20,7 @@ There is currently support for the following device types within Home Assistant: The SMHI weather service is free under the Creative Commons Attribution 4.0, international license. Weather data will be pulled once every 30 minutes. -To add SMHI weather forecast to your installation, go to the Integrations page inside the config panel and add a location by providing the longitude and latitude of your location. +To add SMHI weather forecast to your installation, go to the Integrations page inside the configuration panel and add a location by providing the longitude and latitude of your location. If the location is configured in Home Assistant, it will be selected as the default location. After that, you can add additional locations. diff --git a/source/_integrations/snmp.markdown b/source/_integrations/snmp.markdown index 6b6192bd950..be68efffd4a 100644 --- a/source/_integrations/snmp.markdown +++ b/source/_integrations/snmp.markdown @@ -11,7 +11,7 @@ ha_iot_class: Local Polling ha_release: 0.57 --- -A lot of WiFi access points and WiFi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of instances and metrics, like network interfaces, disks and WiFi registrations. +A lot of Wi-Fi access points and Wi-Fi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of instances and metrics, like network interfaces, disks and Wi-Fi registrations. There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/solax.markdown b/source/_integrations/solax.markdown index f862586c943..b5db11ff36b 100644 --- a/source/_integrations/solax.markdown +++ b/source/_integrations/solax.markdown @@ -59,7 +59,7 @@ sensors: ### Note -Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like NGINX and use a raspberry pi (or similar) with two network connections (one being wifi that connects to the inverters SSID). +Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like NGINX and use a raspberry pi (or similar) with two network connections (one being Wi-Fi that connects to the inverters SSID). Example NGINX configuration diff --git a/source/_integrations/soma.markdown b/source/_integrations/soma.markdown index 4e8353a9288..74b060d1f89 100644 --- a/source/_integrations/soma.markdown +++ b/source/_integrations/soma.markdown @@ -13,7 +13,7 @@ ha_codeowners: The Soma integration will allow users to integrate their Soma Smarthome devices into Home Assistant using the Soma Connect hub. -You can build a Soma Connect yourself if you have a spare Raspberry Pi. You just need to follow the [ official instructions](https://somasmarthome.zendesk.com/hc/en-us/articles/360035521234-Install-SOMA-Connect-software-on-SOMA-Connect-Raspberry-Pi). After you have the SD card plug in the Pi and use an ethernet cable or [set up WiFI](https://somasmarthome.zendesk.com/hc/en-us/articles/360026210333-Configuring-Wi-Fi-access). Then find the IP address by checking your routers DHCP table (we will work on this step). +You can build a Soma Connect yourself if you have a spare Raspberry Pi. You just need to follow the [ official instructions](https://somasmarthome.zendesk.com/hc/en-us/articles/360035521234-Install-SOMA-Connect-software-on-SOMA-Connect-Raspberry-Pi). After you have the SD card plug in the Pi and use an ethernet cable or [set up Wi-Fi](https://somasmarthome.zendesk.com/hc/en-us/articles/360026210333-Configuring-Wi-Fi-access). Then find the IP address by checking your routers DHCP table (we will work on this step). The Connect will automatically find all your Smartshade devices in range and expose them through this integration and through Home Kit. This integration will only enumerate new shades when it is first set up. If you add shades after that you just need to restart Home Assistant or reconfigure this integration. Soma Connect will automatically discover new shades as they appear and expose them. diff --git a/source/_integrations/sonarr.markdown b/source/_integrations/sonarr.markdown index a58e92a540c..2d0b63ad3b8 100644 --- a/source/_integrations/sonarr.markdown +++ b/source/_integrations/sonarr.markdown @@ -99,7 +99,7 @@ sensor: ### Enable SSL -SSL may run on a different port than the default (8989). The SSL port can be bound to any port in Sonarr, so it should be set in the config here (unless it is changed to 8989). See the [Sonarr site](https://github.com/Sonarr/Sonarr/wiki/SSL) for details on SSL in Sonarr. +SSL may run on a different port than the default (8989). The SSL port can be bound to any port in Sonarr, so it should be set in the configuration here (unless it is changed to 8989). See the [Sonarr site](https://github.com/Sonarr/Sonarr/wiki/SSL) for details on SSL in Sonarr. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown index 4af4c8e23b2..3332613ac07 100644 --- a/source/_integrations/sonos.markdown +++ b/source/_integrations/sonos.markdown @@ -12,7 +12,7 @@ ha_config_flow: true The `sonos` integration allows you to control your [Sonos](https://www.sonos.com) wireless speakers from Home Assistant. It also works with IKEA Symfonisk speakers. -You can configure the Sonos integration by going to the integrations page inside the config panel. +You can configure the Sonos integration by going to the integrations page inside the configuration panel. ## Services diff --git a/source/_integrations/spaceapi.markdown b/source/_integrations/spaceapi.markdown index 279c8b741ca..58945e46fa8 100644 --- a/source/_integrations/spaceapi.markdown +++ b/source/_integrations/spaceapi.markdown @@ -270,7 +270,7 @@ In order to set a sensor specific location do the following steps: 3. Pick "Other" from the attribute override pulldown 4. Set the attribute name to location and the attribute value to your desired location -If no location is set, the location defined in the HA config is used. +If no location is set, the location defined in the HA configuration is used. ## Examples diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown index 5930efc5633..67c5f6b53b2 100644 --- a/source/_integrations/ssdp.markdown +++ b/source/_integrations/ssdp.markdown @@ -7,7 +7,7 @@ ha_release: 0.94 logo: home-assistant.png --- -The `ssdp` "Simple Service Discovery Protocol" integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the config panel. +The `ssdp` "Simple Service Discovery Protocol" integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. Integrations can opt-in to be found by adding [an SSDP section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#ssdp) to their `manifest.json`. diff --git a/source/_integrations/switch.command_line.markdown b/source/_integrations/switch.command_line.markdown index b7b9c2524e5..ad9a637b6a4 100644 --- a/source/_integrations/switch.command_line.markdown +++ b/source/_integrations/switch.command_line.markdown @@ -64,11 +64,11 @@ When set, the `friendly_name` had been previously used for API calls and backend configuration instead of the `object_id` ("identifier"), but [this behavior is changing](https://github.com/home-assistant/home-assistant/pull/4343) to make the `friendly_name` for display purposes only. This allows users to set -an `identifier` that emphasizes uniqueness and predictability for API and config +an `identifier` that emphasizes uniqueness and predictability for API and configuration purposes but have a prettier `friendly_name` still show up in the UI. As an additional benefit, if a user wanted to change the `friendly_name` / display name (e.g., from "Kitchen Lightswitch" to "Kitchen Switch" or -"Living Room Light", or remove the `friendly_name` altogether), he or she could +"Living Room Light", or remove the `friendly_name` altogether), they could do so without needing to change existing automations or API calls. See aREST device below for an example. diff --git a/source/_integrations/switch.mysensors.markdown b/source/_integrations/switch.mysensors.markdown index f4439feff47..362adb0a4c9 100644 --- a/source/_integrations/switch.mysensors.markdown +++ b/source/_integrations/switch.mysensors.markdown @@ -50,7 +50,7 @@ For more information, visit the [serial API](https://www.mysensors.org/download) ## Services -The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [config](/integrations/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below. +The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [configuration](/integrations/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below. | Service | Description | | ---------------------- | -------------------------------------------------------------------------------------------- | diff --git a/source/_integrations/tensorflow.markdown b/source/_integrations/tensorflow.markdown index 9c3db171f6c..551e1fccb0d 100644 --- a/source/_integrations/tensorflow.markdown +++ b/source/_integrations/tensorflow.markdown @@ -25,7 +25,7 @@ This integration requires files to be downloaded, compiled on your computer, and - Clone [tensorflow/models](https://github.com/tensorflow/models/tree/master/research/object_detection) - Compile protobuf models located in `research/object_detection/protos` with `protoc` -- Create the following directory structure inside your config directory: +- Create the following directory structure inside your configuration directory: ```bash |- {config_dir} @@ -98,7 +98,7 @@ model: description: Full path to tensorflow models directory. required: false type: string - default: /tensorflow inside config + default: /tensorflow inside configuration area: description: Custom detection area. Only objects fully in this box will be reported. Top of image is 0, bottom is 1. Same left to right. required: false @@ -157,7 +157,7 @@ image_processing: ## Optimising resources -[Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. +[Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. ```yaml # Example advanced configuration.yaml entry diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown index 3fed258814c..2e3b4c2a92f 100644 --- a/source/_integrations/tomato.markdown +++ b/source/_integrations/tomato.markdown @@ -7,7 +7,7 @@ ha_category: ha_release: pre 0.7 --- -The `tomato` platform requires an extra config variable called `http_id`. The +The `tomato` platform requires an extra configuration variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index f2df3a41a69..b2f10f3157a 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -20,7 +20,7 @@ There is currently support for the following device types within Home Assistant: - **Light** - **Switch** -In order to activate the support, you will have to enable the integration inside the config panel. +In order to activate the support, you will have to enable the integration inside the configuration panel. The supported devices in your network are automatically discovered, but if you want to control devices residing in other networks you will need to configure them manually as shown below. ## Supported Devices diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 90827edf92a..d132b58b54c 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -119,7 +119,7 @@ $ tail -f home-assistant.log | grep device_tracker 17-04-28 10:43:31 INFO (MainThread) [homeassistant.core] Bus:Handling 17-04-28 10:43:31 INFO (MainThread) [homeassistant.core] Bus:Handling ``` -5. If you see lines like the following repeated at intervals that correspond to the check interval from the config (12 seconds by default), then Home Assistant is correctly polling the router, and you'll need to look at what the router is sending back. +5. If you see lines like the following repeated at intervals that correspond to the check interval from the configuration (12 seconds by default), then Home Assistant is correctly polling the router, and you'll need to look at what the router is sending back. ```txt 17-04-28 10:50:34 INFO (Thread-7) [homeassistant.components.device_tracker.ubus] Checking ARP ``` diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index 128fa890995..294a06a8713 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -146,6 +146,6 @@ And the template sensor for viewing the next bus attributes. ## Managing API requests -If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the config options, and use the service `homeassistant.update_entity` to request the update of an entity, rather than waiting for the next scheduled update. +If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an entity, rather than waiting for the next scheduled update. Powered by [transportAPI](https://www.transportapi.com/) diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown index 77f18ead3c7..b226bb6f3d2 100644 --- a/source/_integrations/unifi.markdown +++ b/source/_integrations/unifi.markdown @@ -44,12 +44,12 @@ unifi: {% configuration %} host: - description: Same address as relevant config entry, needed to identify config entry. + description: Same address as relevant configuration entry, needed to identify configuration entry. type: string required: true default: None site: - description: Same site as relevant config entry, needed to identify config entry. + description: Same site as relevant configuration entry, needed to identify configuration entry. type: string required: true default: None diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index cab23ed7960..e7d8048fbfe 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -12,7 +12,7 @@ There are two possible message schemas - `legacy` and `state`. New installations should use the `state` schema as `legacy` is deprecated and might be removed someday in the future. The `state` schema is preferred because the vacuum will then be represented as a `StateVacuumDevice` which is the preferred parent vacuum entity. -This documentation has 3 sections. Config for `legacy` vacuum with examples, config for `state` vacuum with examples and shared section with examples which are the same for both schemas. +This documentation has 3 sections. Configuration for `legacy` vacuum with examples, configuration for `state` vacuum with examples and shared section with examples which are the same for both schemas. ## Configuration @@ -525,5 +525,5 @@ This integration is supported by the cloud-free Xiaomi Vacuum Webinterface [Vale ### Retrofitting non-wifi vacuums -- Retrofitting your old Roomba with an ESP8266. [This repo](https://github.com/johnboiles/esp-roomba-mqtt) provides MQTT client firmware. -- If you own a non-wifi Neato, you can refer to [this repo](https://github.com/jeroenterheerdt/neato-serial) that uses a Raspberry Pi to retrofit an old Neato. +- Retrofitting your old Roomba with an ESP8266. [This repository](https://github.com/johnboiles/esp-roomba-mqtt) provides MQTT client firmware. +- If you own a non-wifi Neato, you can refer to [this repository](https://github.com/jeroenterheerdt/neato-serial) that uses a Raspberry Pi to retrofit an old Neato. diff --git a/source/_integrations/vacuum.xiaomi_miio.markdown b/source/_integrations/vacuum.xiaomi_miio.markdown index 0101164bc04..bae683ab8a3 100644 --- a/source/_integrations/vacuum.xiaomi_miio.markdown +++ b/source/_integrations/vacuum.xiaomi_miio.markdown @@ -236,7 +236,7 @@ If using an Android device to retrieve the Access Token only `v5.4.49` of Mi Hom

The iPhone app still stores the token in the SQLite db as of `v4.23.4` (Nov 17, 2019).

-After resetting the WiFi settings of the Xiaomi robot vacuum, a new Access Token will be generated and therefore these instructions need to be followed again. +After resetting the Wi-Fi settings of the Xiaomi robot vacuum, a new Access Token will be generated and therefore these instructions need to be followed again.

These instructions are written for the Mi Home app - not for the new RoboRock app.

@@ -303,7 +303,7 @@ This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuu ### Miio command line tool -Use of Miio should be done before the Vacuum is connected to Mi Home. If you already connected to the app you will need to delete it and then join the ad-hoc Wifi network the Vacuum creates. If the vacuum is already paired it's likely this method will only return `???` as your token. +Use of Miio should be done before the Vacuum is connected to Mi Home. If you already connected to the app you will need to delete it and then join the ad-hoc Wi-Fi network the Vacuum creates. If the vacuum is already paired it's likely this method will only return `???` as your token. You can install the command line tool using the following command: diff --git a/source/_integrations/velux.markdown b/source/_integrations/velux.markdown index 2a6946067ab..f39209275db 100644 --- a/source/_integrations/velux.markdown +++ b/source/_integrations/velux.markdown @@ -37,7 +37,7 @@ host: required: true type: string password: - description: The password of the KLF 200 interface. Note that this is the same as the WiFi password (in the upper box on the back), *not* the password for the web login. + description: The password of the KLF 200 interface. Note that this is the same as the Wi-Fi password (in the upper box on the back), *not* the password for the web login. required: true type: string {% endconfiguration %} diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown index 224740691a6..4cc8fdf330f 100644 --- a/source/_integrations/waze_travel_time.markdown +++ b/source/_integrations/waze_travel_time.markdown @@ -81,7 +81,7 @@ avoid_subscription_roads: default: false {% endconfiguration %} -When using the `avoid_toll_roads`, `avoid_subscription_roads` and `avoid_ferries` options be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behaviour is that Waze will route you over roads having subscription options, so best is to set both `avoid_toll_roads` and `avoid_subscription_roads` or `avoid_ferries` if needed and experiment to ensure the desired outcome. +When using the `avoid_toll_roads`, `avoid_subscription_roads` and `avoid_ferries` options be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options, so best is to set both `avoid_toll_roads` and `avoid_subscription_roads` or `avoid_ferries` if needed and experiment to ensure the desired outcome. ## Example using dynamic destination diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown index 94b43e66b0e..a23ee0e2844 100644 --- a/source/_integrations/webostv.markdown +++ b/source/_integrations/webostv.markdown @@ -157,7 +157,7 @@ data: ## Next/Previous buttons -The behaviour of the next and previous buttons is different depending on the active source: +The behavior of the next and previous buttons is different depending on the active source: - if the source is 'LiveTV' (television): next/previous buttons act as channel up/down - otherwise: next/previous buttons act as next/previous track diff --git a/source/_integrations/withings.markdown b/source/_integrations/withings.markdown index 2dae5335907..2f35973026b 100644 --- a/source/_integrations/withings.markdown +++ b/source/_integrations/withings.markdown @@ -46,7 +46,7 @@ Withings supports multiple profiles per account. Each profile has a person's nam ### Step 3 - Authorize Home Assistant - Confirm your YAML configuration is valid by using the `Check Config` tool (see note). - - Note: In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile. The "Check Config" tool can be found by clicking "Configuration" from the sidebar (cog icon) and then clicking "Server Control". + - Note: In order for "Check Configuration" to be visible, you must enable "Advanced Mode" on your user profile. The "Check Configuration" tool can be found by clicking "Configuration" from the sidebar (cog icon) and then clicking "Server Control". - Restart Home Assistant. - Go to the integrations page. - Add a Withings integration. This will open a new tab/window on the withings site. diff --git a/source/_integrations/worxlandroid.markdown b/source/_integrations/worxlandroid.markdown index 341f2136edc..4448e8195fc 100644 --- a/source/_integrations/worxlandroid.markdown +++ b/source/_integrations/worxlandroid.markdown @@ -30,7 +30,7 @@ pin: required: true type: integer allow_unreachable: - description: This will allow the mower to be outside of wifi range without raising an error. + description: This will allow the mower to be outside of Wi-Fi range without raising an error. required: false type: boolean default: true diff --git a/source/_integrations/zeroconf.markdown b/source/_integrations/zeroconf.markdown index b1dbe87ba0f..6406826de28 100644 --- a/source/_integrations/zeroconf.markdown +++ b/source/_integrations/zeroconf.markdown @@ -11,7 +11,7 @@ ha_codeowners: - '@Kane610' --- -The `zeroconf` integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the config panel. It will also make Home Assistant discoverable for other services in the network. Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi. +The `zeroconf` integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. It will also make Home Assistant discoverable for other services in the network. Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi. Integrations can opt-in to be found by adding either [a Zeroconf section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#zeroconf) or [a HomeKit section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#homekit) to their `manifest.json`. diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index fd34e2dd64d..4df04eaa741 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -31,7 +31,7 @@ card_size: required: false type: integer default: none - description: The algorithm for placing cards aesthetically in Lovelace may have problems with the markdown card if it contains templates. You can use this value to help it estimate the height of the card in units of 50 pixels (approximately 3 lines of text in default size). (e.g., `4`) + description: The algorithm for placing cards aesthetically in Lovelace may have problems with the Markdown card if it contains templates. You can use this value to help it estimate the height of the card in units of 50 pixels (approximately 3 lines of text in default size). (e.g., `4`) entity_id: required: false type: [string, list] diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index 13c2a7f6cf7..6237d916c90 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -44,7 +44,7 @@ Now let's make a change using the configurator: we are going to change the name, - 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 "Server Controls" and click on the "CHECK CONFIG" button. When it's valid, it will show the text "Configuration valid!". In order for the "CHECK CONFIG" button to be visible, you must enable "Advanced Mode" on your user profile. + - 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 configuration check. Do this by clicking on Configuration in the sidebar, click on "Server Controls" and click on the "CHECK configuration" button. When it's valid, it will show the text "Configuration valid!". In order for the "CHECK configuration" button to be visible, you must enable "Advanced Mode" on your user profile. - Now Restart Home Assistant using the "RESTART" button in the Server management section on the same page.

@@ -58,10 +58,10 @@ Screenshot of the "General" page in the configuration panel. -### Editing config via Samba/Windows Networking +### Editing configuration via Samba/Windows Networking Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can also be installed from the Hass.io add-on store. This will make your configuration accessible via the network tab on your computer. Go to the add-on store and look for Samba in the core section. After you have installed the add-on, click on START. Hass.io should now be available in the networking tab on your computer. -We suggest that to edit `configuration.yaml`, you use the free text editor [Visual Studio Code](https://code.visualstudio.com/) in combination with the [Home Assistant Config Helper extension](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant). +We suggest that to edit `configuration.yaml`, you use the free text editor [Visual Studio Code](https://code.visualstudio.com/) in combination with the [Home Assistant Configuration Helper extension](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant). diff --git a/source/hassio/enable_i2c.markdown b/source/hassio/enable_i2c.markdown index 88508d0d0c5..98986b6d378 100644 --- a/source/hassio/enable_i2c.markdown +++ b/source/hassio/enable_i2c.markdown @@ -35,7 +35,7 @@ Format a USB stick with FAT32/EXT4/NTFS and name the drive `CONFIG` (uppercase). dtparam=i2c_arm=on ``` -### Step 3 - Load the new USB config +### Step 3 - Load the new USB configuration - Insert the USB drive into your Raspberry PI. - Now go to your Home Assistant web interface, in the sidebar click **Hass.io** > **System**. diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 11c71737f4b..4bb0a6dfd62 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -37,7 +37,7 @@ The following will take you through the steps required to install Home Assistant - Flash the downloaded image to an SD card using [balenaEtcher][balenaEtcher]. If using a Pi, we recommend at least a 32 GB SD card to avoid running out of space. On Virtual machine platforms, provide at least 32 GB of disk space for the VM. - 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: +3. Optional - set up the Wi-Fi or static IP. There are two possible places for that: - 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 Home Assistant SD card's first, bootable partition (labeled `hassio-boot`, might not be auto mounted in Linux) create the `CONFIG/network/my-network` file. diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index 4aab56c333f..00f127ce16f 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -21,7 +21,7 @@ description: "Changelog of the Lovelace UI." * ♿ Add tabindex to Lovelace elements (#4160) @iantrich * 🐛 Fix action directive double tab iOS issues (#4639) @bramkragten * 🐛 [gauge card]: Fix severity toggle (#4600) @iantrich -* 🐛 [markdown card]: Fix visual editor for when all `content` removed (#4583) @iantrich +* 🐛 [Markdown card]: Fix visual editor for when all `content` removed (#4583) @iantrich * 🐛 [alarm panel card]: Fix preview updates (#4592) @bramkragten * 🐛 [thermostat card]: Fix display of current/set temperature when at 0 (#4498) @iantrich * 🐛 [picture glance card]: Fix `camera_view` option in editor (#4495) @iantrich @@ -31,7 +31,7 @@ description: "Changelog of the Lovelace UI." * 🚸 Prompt user to confirm logout (#4501) @iantrich ## Changes in 0.104.0 -- ❤️ Add ability to remove Lovelace config [#4430](https://github.com/home-assistant/home-assistant-polymer/pull/4430) @bramkragten +- ❤️ Add ability to remove Lovelace configuration [#4430](https://github.com/home-assistant/home-assistant-polymer/pull/4430) @bramkragten - ❤️ Add support to add all device entities to Lovelace [#4356](https://github.com/home-assistant/home-assistant-polymer/pull/4356) @bramkragten - 📣 Upgrade MDI icons to 4.7.95 [#4341](https://github.com/home-assistant/home-assistant-polymer/pull/4341) @bonanitech @@ -45,7 +45,7 @@ description: "Changelog of the Lovelace UI." - ❤️ [views]: Add actions to `state-label` badge [#4028](https://github.com/home-assistant/home-assistant-polymer/pull/4028) @iantrich - ❤️ [shopping list card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich - ❤️ [plant status card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich -- ❤️ [markdown card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich +- ❤️ [Markdown card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich - ❤️ [alarm panel card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich - ❤️ [picture card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich - ❤️ [picture elements card]: New `theme` option [#4057](https://github.com/home-assistant/home-assistant-polymer/pull/4057) @iantrich @@ -69,13 +69,13 @@ description: "Changelog of the Lovelace UI." - 🔧 [entities card]: Fix media row secondary info [#3957](https://github.com/home-assistant/home-assistant-polymer/pull/3957) @iantrich - 🔧 [light card]: Fix name wrapping [#3972](https://github.com/home-assistant/home-assistant-polymer/pull/3972) @shbatm - 🔧 [map card]: Fix zone icon visibility [#4085](https://github.com/home-assistant/home-assistant-polymer/pull/4085) @springstan -- 📣 [markdown card]: Add default text to card editor [#3960](https://github.com/home-assistant/home-assistant-polymer/pull/3960) @akargl +- 📣 [Markdown card]: Add default text to card editor [#3960](https://github.com/home-assistant/home-assistant-polymer/pull/3960) @akargl ## Changes in 0.100.0 -- ❤️ [picture glance card]: New config `tap_action` and `hold_action` for `entities` [#3807](https://github.com/home-assistant/home-assistant-polymer/pull/3807) @iantrich -- ❤️ [entities card]: New config `image` for `entities` [#3832](https://github.com/home-assistant/home-assistant-polymer/pull/3832) @iantrich +- ❤️ [picture glance card]: New configuration `tap_action` and `hold_action` for `entities` [#3807](https://github.com/home-assistant/home-assistant-polymer/pull/3807) @iantrich +- ❤️ [entities card]: New configuration `image` for `entities` [#3832](https://github.com/home-assistant/home-assistant-polymer/pull/3832) @iantrich - ❤️ [entity filter card]: Support for operators in `state_filter` and individual `state_filter` option for `entitites` [#3692](https://github.com/home-assistant/home-assistant-polymer/pull/3692) @iantrich -- ❤️ [light card]: New config `icon` [#3771](https://github.com/home-assistant/home-assistant-polymer/pull/3771) @iantrich +- ❤️ [light card]: New configuration `icon` [#3771](https://github.com/home-assistant/home-assistant-polymer/pull/3771) @iantrich - ❤️ [picture entity card]: UI Editor [#3708](https://github.com/home-assistant/home-assistant-polymer/pull/3708) @iantrich - ❤️ [picture glance card]: UI Editor [#3709](https://github.com/home-assistant/home-assistant-polymer/pull/3709) @iantrich - ❤️ [history graph card]: UI Editor [#3782](https://github.com/home-assistant/home-assistant-polymer/pull/3782) @iantrich @@ -90,26 +90,26 @@ description: "Changelog of the Lovelace UI." - 🔧 [views]: Guard for null badges [#3841](https://github.com/home-assistant/home-assistant-polymer/pull/3841) @bramkragten ## Changes in 0.99.0 -- ❤️ [glance card]: New config `show_last_changed` for `entities` -- ❤️ [glance card]: New config `image` for `entities` -- ❤️ [views]: New config `image` for `badges` -- ❤️ [views]: New config `icon` for `badges` -- ❤️ [views]: New config `name` for `badges` +- ❤️ [glance card]: New configuration `show_last_changed` for `entities` +- ❤️ [glance card]: New configuration `image` for `entities` +- ❤️ [views]: New configuration `image` for `badges` +- ❤️ [views]: New configuration `icon` for `badges` +- ❤️ [views]: New configuration `name` for `badges` - 📣 Unused entities: Rewritten into a table view - 📣 Unused entities: Add entities to Lovelace cards - 📣 Lovelace background settings moved to theme `--lovelace-background` - 📣 Haptic feedback support added - 📣 Vibrate support added - 📣 MDI icons updated to [4.3.95](https://cdn.materialdesignicons.com/4.3.95/) -- ⚠️ Only allow admins to edit UI config +- ⚠️ Only allow admins to edit UI configuration - 🔧 [alarm panel card]: Handle keyboard input - 🔧 [alarm panel card]: Show `friendly_name` if set - 🔧 [entities card]: Properly show "unavailable" timestamps - 🔧 [entity filter card]: Throttle updates for performance - 🔧 [light card]: Replace jQuery sliders - 🔧 [light card]: Move brightness below icon -- 🔧 [map card]: Update preview when config changes -- 🔧 [markdown card]: Don't allow SVG by default +- 🔧 [map card]: Update preview when configuration changes +- 🔧 [Markdown card]: Don't allow SVG by default - 🔧 Filter null badges - 🔧 Render an overlay on light cards when the light is unavailable - 🔧 Break long strings in notifications @@ -149,7 +149,7 @@ description: "Changelog of the Lovelace UI." - 🔧 The [weblink row] opens links in new tabs ## Changes in 0.85.0 -- ❤️ [map card]: New config `geo_location_sources` +- ❤️ [map card]: New configuration `geo_location_sources` - ❤️ UI Editor for [picture card] - ❤️ UI Editor for [weather forecast card] - ❤️ UI Editor for [plant status card] @@ -159,7 +159,7 @@ description: "Changelog of the Lovelace UI." - ❤️ UI Editor for [shopping list card] - ❤️ UI Editor for [light card] - ❤️ UI Editor for [gauge card] -- ❤️ UI Editor for [markdown card] +- ❤️ UI Editor for [Markdown card] - ❤️ UI Editor for [alarm panel card] - ❤️ UI Editor for [thermostat card] - ❤️ UI Editor for [entity button card] @@ -181,8 +181,8 @@ description: "Changelog of the Lovelace UI." - ⚠️ [views]: Renamed `id` to `path` - ⚠️ `sensor_data`: `entity` is no longer passed as `entity_id` to service call and must be explicitly set - ⚠️ [sensor card]: Removed configs `height`, `line_color` and `line_width` -- ⚠️ [gauge card]: Renamed config `title` to `name` -- ⚠️ [alarm panel card]: Renamed config `title` to `name` +- ⚠️ [gauge card]: Renamed configuration `title` to `name` +- ⚠️ [alarm panel card]: Renamed configuration `title` to `name` - ⚠️ [glance card]: `tap_action` and `hold_action` configurations changed. See docs. - ⚠️ [entity button card]: `tap_action` and `hold_action` configurations changed. See docs. - ⚠️ [picture card]: `tap_action` and `hold_action` configurations changed. See docs. @@ -191,12 +191,12 @@ description: "Changelog of the Lovelace UI." - ⚠️ [picture glance card]: `tap_action` and `hold_action` configurations changed. See docs. ### All Changes -- ❤️ [weather forecast card]: New config `name` -- ❤️ [thermostat card]: New config `name` -- ❤️ [plant status card]: New config `name` +- ❤️ [weather forecast card]: New configuration `name` +- ❤️ [thermostat card]: New configuration `name` +- ❤️ [plant status card]: New configuration `name` - ❤️ [picture elements card]: Added `state_image` and `camera_image` - 📣 [entities card]: Alert entity rows are now displayed as toggles -- 📣 Ability to generate a Lovelace config if not present using available entities +- 📣 Ability to generate a Lovelace configuration if not present using available entities - 📣 UI Editor now in Beta with support for adding/removing views/cards - 🔧 [map card]: Fix `aspect_ratio` - 🔧 Fix Tap/Hold actions on Windows 10 machines with touchscreens diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown index 9232258fe56..c5fe345447b 100644 --- a/source/lovelace/index.markdown +++ b/source/lovelace/index.markdown @@ -9,7 +9,7 @@ Lovelace is the name of the Home Assistant user interface. It is a fast, customi - 24 different cards to place and configure as you like. - UI Editor. A configuration UI to manage your Lovelace UI including live preview when editing cards. -- Fast. Using a static config allows us to build up the UI once. +- Fast. Using a static configuration allows us to build up the UI once. - Customizable. - Cards have numerous options to configure how your data is presented. - Themes; even at a per card basis. diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index e14373ad299..87c13f4ff7f 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -59,7 +59,7 @@ views: #### Example -View config: +View configuration: ```yaml - title: Living room @@ -78,7 +78,7 @@ You can link to one view from a card in another view when using cards that suppo #### Example -View config: +View configuration: ```yaml - title: Living room @@ -86,7 +86,7 @@ View config: path: living_room ``` -Picture card config: +Picture card configuration: ```yaml - type: picture diff --git a/source/lovelace/yaml-mode.markdown b/source/lovelace/yaml-mode.markdown index 4bc2000b104..6b772bf1e40 100644 --- a/source/lovelace/yaml-mode.markdown +++ b/source/lovelace/yaml-mode.markdown @@ -10,18 +10,18 @@ lovelace: mode: yaml ``` -Restart Home Assistant for the mode to be changed. Create a new file `/ui-lovelace.yaml` and add your Lovelace configuration. A good way to start this file is to copy and paste the "Raw config" from the UI so your manual configuration starts the same as your existing UI. +Restart Home Assistant for the mode to be changed. Create a new file `/ui-lovelace.yaml` and add your Lovelace configuration. A good way to start this file is to copy and paste the "Raw configuration" from the UI so your manual configuration starts the same as your existing UI. - Go into the `Overview` tab. - Click the three dots menu (top-right) and click on `Configure UI`. - Click the three dots menu again and click on `Raw config editor`. -- There you see the config for your current Lovelace UI. Copy that into the `/ui-lovelace.yaml` file. +- There you see the configuration for your current Lovelace UI. Copy that into the `/ui-lovelace.yaml` file. Once you take control of your UI via YAML, the Home Assistant interface for modifying it won't be available anymore and new entities will not automatically be added to your UI. When you make changes to `ui-lovelace.yaml`, you don't have to restart Home Assistant or refresh the page. Just hit the refresh button in the menu at the top of the UI. -To revert back to using the UI to edit your Lovelace interface, remove the `lovelace` section from your `configuration.yaml` and copy the contents of your `ui-lovelace.yaml` into the raw config section of Home Assistant and restart. +To revert back to using the UI to edit your Lovelace interface, remove the `lovelace` section from your `configuration.yaml` and copy the contents of your `ui-lovelace.yaml` into the raw configuration section of Home Assistant and restart. As a super minimal example, here's the bare minimum you will need for this to work: