diff --git a/.textlintrc.json b/.textlintrc.json index bfb11fd9c04..fde8f160be3 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -8,11 +8,13 @@ "defaultTerms": false, "skip": ["Blockquote"], "terms": [ + " API ", "Abode", "Acer", "Actiontec", "AdGuard Home", "AdGuard", + "ADS", "Aeotec", "AfterShip", "Airly", @@ -35,8 +37,10 @@ "AWS", "Axis", "Beckhoff", + "Cisco IOS", "Dark Sky", "deCONZ", + "DNS", "ecobee", "Elgato Key Light", "Elgato", @@ -58,19 +62,71 @@ "Home Assistant", "HomeKit", "Honeywell", + "HTTP", + "HTTPS", "iCloud", "IFTTT", "IKEA", + "IntesisHome", + "iOS", + "IoT", + "IP", + "JSON", + "KEF", + "Life360", "Lovelace", "macOS", "Microsoft", + "MikroTik", + "MJPEG", + "MQTT", + "NodeMCU", + "Philips", + "Plex Media Server", + "Plex", + "PTZ", + "REST API", + "RFXtrx", + "RouterOS", + "Samung", + "Sentry", + "Signal Messenger", + "SmartThings", + "Sonos", + "Spotify", + "SSL", + "Stookalert", + "Sure Petcare", + "Tahoma", + "TCP/IP", + "TMB", + "TwinCAT", + "Twitter", + "UART", + "UI", + "URL", + "Velbus", + "Vera", + "Vizio", + "Wink", + "WLED", + "Xiaomi", + "YAML", + "Yeelight", + "YouTube", + "Z-Wave", + "ZHA", "Zigbee", [" HA ", "Home Assistant"], ["Alarm ?dot ?com", "Alarm.com"], + ["an URL", "a URL"], + ["API['’]?s", "APIs"], ["hass", "Home Assistant"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], ["Mac ?OS", "macOS"], - ["OS ?X", "macOS"] + ["OS ?X", "macOS"], + ["URL['’]?s", "URLs"], + ["ZWave", "Z-Wave"] ] } } diff --git a/source/_cookbook/automation_first_light.markdown b/source/_cookbook/automation_first_light.markdown index d16a4310e59..f752ad5f9bf 100644 --- a/source/_cookbook/automation_first_light.markdown +++ b/source/_cookbook/automation_first_light.markdown @@ -4,7 +4,7 @@ description: "Automation examples that trigger lights in the morning." ha_category: Automation Examples --- -#### Create an input_boolean in your configuration.yaml +#### Create an input_boolean ```yaml input_boolean: @@ -13,7 +13,7 @@ input_boolean: icon: mdi:kettle ``` -#### The Main Automation +#### The Main Automation ```yaml ## These first two control t input_boolean that allows the "first morning action" to occur diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index ce51136927b..2dfc89d14c4 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -15,9 +15,9 @@ If you are starting Home Assistant for the first time, or you have logged out, y When you start Home Assistant for the first time the _owner_ user account is created. This account has some special privileges and can: - - Create and manage other user accounts. - - Configure integrations and other settings (coming soon). - - Configure Hass.io (coming soon). +- Create and manage other user accounts. +- Configure integrations and other settings (coming soon). +- Configure Hass.io (coming soon).
For the moment, other user accounts will have the same access as the owner account. In the future, non-owner accounts will be able to have restrictions applied. @@ -86,11 +86,11 @@ While you should hopefully be storing your passwords in a password manager, if y When you start Home Assistant next, you'll be required to set up authentication again. -### Error: invalid client id or redirect url +### Error: invalid client id or redirect URL Screenshot of Error: invalid client id or redirect url -You have to use a domain name, not IP address, to remote access Home Assistant otherwise you will get **Error: invalid client id or redirect url** error on the login form. However, you can use the IP address to access Home Assistant in your home network. +You have to use a domain name, not IP address, to remote access Home Assistant otherwise you will get `Error: invalid client id or redirect url` error on the login form. However, you can use the IP address to access Home Assistant in your home network. This is because we only allow an IP address as a client ID when your IP address is an internal network address (e.g., `192.168.0.1`) or loopback address (e.g., `127.0.0.1`). diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index 9a8d98e56b4..d5ff1b98553 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -31,7 +31,7 @@ automation 2: notify.{{ trigger.topic.split('/')[-1] }} data_template: message: '{{ trigger.payload }}' - + automation 3: trigger: # Multiple entities for which you want to perform the same action. @@ -84,7 +84,7 @@ Knowing how to access the [state object](/docs/configuration/state_object/) of a The following tables show the available trigger data per platform. -### event +### Event | Template variable | Data | | ---- | ---- | @@ -92,7 +92,7 @@ The following tables show the available trigger data per platform. | `trigger.event` | Event object that matched. | `trigger.event.data` | Optional data -### mqtt +### MQTT | Template variable | Data | | ---- | ---- | @@ -102,7 +102,7 @@ The following tables show the available trigger data per platform. | `trigger.payload_json` | Dictonary of the JSON parsed payload. | `trigger.qos` | QOS of payload. -### numeric_state +### Numeric State | Template variable | Data | | ---- | ---- | @@ -114,7 +114,7 @@ The following tables show the available trigger data per platform. | `trigger.to_state` | The new [state object] that triggered trigger. | `trigger.for` | Timedelta object how long state has met above/below criteria, if any. -### state +### State | Template variable | Data | | ---- | ---- | @@ -124,7 +124,7 @@ The following tables show the available trigger data per platform. | `trigger.to_state` | The new [state object] that triggered trigger. | `trigger.for` | Timedelta object how long state has been to state, if any. -### sun +### Sun | Template variable | Data | | ---- | ---- | @@ -132,7 +132,7 @@ The following tables show the available trigger data per platform. | `trigger.event` | The event that just happened: `sunset` or `sunrise`. | `trigger.offset` | Timedelta object with offset to the event, if any. -### template +### Template | Template variable | Data | | ---- | ---- | @@ -142,21 +142,21 @@ The following tables show the available trigger data per platform. | `trigger.to_state` | New [state object] of entity that caused template to change. | `trigger.for` | Timedelta object how long state has been to state, if any. -### time +### Time | Template variable | Data | | ---- | ---- | | `trigger.platform` | Hardcoded: `time` | `trigger.now` | DateTime object that triggered the time trigger. -### time pattern +### Time Pattern | Template variable | Data | | ---- | ---- | | `trigger.platform` | Hardcoded: `time_pattern` | `trigger.now` | DateTime object that triggered the time_pattern trigger. -### webhook +### Webhook | Template variable | Data | | ---- | ---- | @@ -165,7 +165,7 @@ The following tables show the available trigger data per platform. | `trigger.json` | The JSON data of the request (if it had a JSON content type). | `trigger.data` | The form data of the request (if it had a form data content type). -### zone +### Zone | Template variable | Data | | ---- | ---- | diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index c9d108f9282..f09b10eeadb 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -4,9 +4,9 @@ description: "Storing secrets outside of your configuration.yaml." redirect_from: /topics/secrets/ --- -The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple yaml files if you [split up your configuration](/docs/configuration/splitting_configuration/). +The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/). -### Using secrets.yaml +### Using `secrets.yaml` The workflow for moving private information to `secrets.yaml` is very similar to the [splitting of the configuration](/docs/configuration/splitting_configuration/). Create a `secrets.yaml` file in your Home Assistant [configuration directory](/docs/configuration/). diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index a7763020f9f..e6874fdc286 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -4,7 +4,7 @@ description: "Splitting the configuration.yaml into several files." redirect_from: /topics/splitting_configuration/ --- -So you've been using Home Assistant for a while now and your configuration.yaml file brings people to tears or you simply want to start off with the distributed approach, here's how to "split the configuration.yaml" into more manageable (read: humanly readable) pieces. +So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears or you simply want to start off with the distributed approach, here's how to split the `configuration.yaml` into more manageable (read: humanly readable) pieces. First off, several community members have sanitized (read: without API keys/passwords etc) versions of their configurations available for viewing, you can see a list of them [here](/cookbook/#example-configurationyaml). diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index a3e61e72108..db724c64dc3 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -24,7 +24,7 @@ One of the most common problems with Home Assistant is an invalid `configuration - On Hass.io you can use the [`hassio` command](/hassio/commandline/#home-assistant): `hassio homeassistant check`. - On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container. - The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. -- You can verify your configuration's yaml structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). +- You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). `configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/getting-started/devices/#style-2-list-each-device-separately) to the name or nest them using [this style](/getting-started/devices/#style-1-collect-every-entity-under-the-parent): diff --git a/source/_docs/ecosystem/haproxy.markdown b/source/_docs/ecosystem/haproxy.markdown index 85c99300b07..3010e9f42f4 100644 --- a/source/_docs/ecosystem/haproxy.markdown +++ b/source/_docs/ecosystem/haproxy.markdown @@ -90,7 +90,7 @@ Replace 443 with whatever port you chose to bind to in the config if different. ### Configure Home Assistant HTTP Component -In your `configuration.yaml` file, edit the [http component](/integrations/http/). +In your `configuration.yaml` file, edit the [HTTP component](/integrations/http/). ```text http: diff --git a/source/_docs/frontend/mobile.markdown b/source/_docs/frontend/mobile.markdown index f399ccc7482..b2b6201d606 100644 --- a/source/_docs/frontend/mobile.markdown +++ b/source/_docs/frontend/mobile.markdown @@ -6,9 +6,9 @@ redirect_from: /getting-started/mobile/ Home Assistant has [a companion app for both Android and iOS](/docs/ecosystem/ios/). -As an alternative to the iOS and Android companion apps, you can add the Home Assistant "web app" to your homescreen as if it was native (Home Assistant leverages the W3C [manifest.json](https://w3c.github.io/manifest/) support). +As an alternative to the iOS and Android companion apps, you can add the Home Assistant "web app" to your homescreen as if it was native (Home Assistant leverages the W3C [`manifest.json`](https://w3c.github.io/manifest/) support). -### Android +## Android 1. Open Chrome 2. Navigate to your Home Assistant instance @@ -17,10 +17,10 @@ As an alternative to the iOS and Android companion apps, you can add the Home As 5. A dialog will popup; tap on Add

- +

-### iOS +## iOS 1. Open Safari 2. Navigate to your Home Assistant instance diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index 87bc02b3734..30e91c4db16 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -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 config folder That's it... you're all set to go Here are some useful commands: diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 80aef4f9de5..00da82ff005 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -148,7 +148,7 @@ Home Assistant contains an embedded MQTT broker called [HBMQTT](https://pypi.pyt | Port | 1883 | | Protocol | 3.1.1 | | User | `homeassistant` | -| Password | _password set under mqtt settings_ | +| Password | _password set under MQTT settings_ | | Websocket port | 8080 | ```yaml diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 5e2e0ed8096..72c1e0c6506 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -20,6 +20,7 @@ Screenshot of Home Assistant's Developer Tools. | Info | Details about Home Assistant | ## What can I do with Developer Tools? + The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, update states, raising events, and publish messages in mqtt…etc.). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the section in detail. ## Services @@ -88,7 +89,7 @@ For more information about jinja2, visit [jinja2 documentation](http://jinja.poc ## MQTT -This section is only visible if the MQTT integration is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/integrations/mqtt/) component. +This section is only visible if the MQTT integration is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [MQTT](/integrations/mqtt/) integration. Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button. diff --git a/source/_docs/z-wave/adding.markdown b/source/_docs/z-wave/adding.markdown index 126a495fcdd..57c4d5ade65 100644 --- a/source/_docs/z-wave/adding.markdown +++ b/source/_docs/z-wave/adding.markdown @@ -26,7 +26,7 @@ When you add a device, it may initially appear without a specific entity ID (e.g Security Z-Wave devices require a network key. Some devices only expose their full capabilities when included this way. You should always read the manual for your device to find out the recommended inclusion method. Note, secure devices that had been connected to another hub/network in the past may have a "theft protection" feature which requires to first exclude the device successfully from the previous hub using the previous hub/Software setup before it can be enrolled in a new hub/network. -A valid network key will be a 16 byte value, defined in the zwave section of your configuration, such as the following example: +A valid network key will be a 16 byte value, defined in the Z-Wave section of your configuration, such as the following example: ```yaml zwave: diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index babad7c72be..f6483788cb2 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -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 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. ```xml diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index 5d326be2936..0fcf7f4049a 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -87,7 +87,7 @@ For this system to operate correctly, the following IFTTT applets have to be set * **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. * **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. * **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night. -* **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`. -* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`. -* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`. -* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`. +* **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`. +* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`. +* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`. +* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`. diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown index 83a3e980ed1..595e6347f23 100644 --- a/source/_integrations/amcrest.markdown +++ b/source/_integrations/amcrest.markdown @@ -87,8 +87,8 @@ ffmpeg_arguments: default: -pred 1 authentication: description: > - Defines which authentication method to use only when **stream_source** - is **mjpeg**. Currently, *aiohttp* only support *basic*. + Defines which authentication method to use only when `stream_source` + is `mjpeg`. Currently, `aiohttp` only support `basic`. required: false type: string default: basic @@ -135,9 +135,9 @@ control_light: stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in -your camera's configuration manager. If you defined the *stream_source* to -**mjpeg**, make sure your camera supports *Basic* HTTP authentication. -Newer Amcrest firmware may not work, then **rtsp** is recommended instead. +your camera's configuration manager. If you defined the `stream_source` to +`mjpeg`, make sure your camera supports `Basic` HTTP authentication. +Newer Amcrest firmware may not work, then `rtsp` is recommended instead. **Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at [FFmpeg](/integrations/ffmpeg/) diff --git a/source/_integrations/automatic.markdown b/source/_integrations/automatic.markdown index 16754fe63bd..9cb9cfc2576 100644 --- a/source/_integrations/automatic.markdown +++ b/source/_integrations/automatic.markdown @@ -16,7 +16,7 @@ The `automatic` device tracker platform offers presence detection by retrieving To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. -Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. +Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your `configuration.yaml`. ## Configuration diff --git a/source/_integrations/binary_sensor.rfxtrx.markdown b/source/_integrations/binary_sensor.rfxtrx.markdown index 670c8fef901..ac7b52e4867 100644 --- a/source/_integrations/binary_sensor.rfxtrx.markdown +++ b/source/_integrations/binary_sensor.rfxtrx.markdown @@ -9,17 +9,17 @@ ha_release: 0.48 The `rfxtrx` platform support binary sensors that communicate in the frequency range of 433.92 MHz. -The rfxtrx binary sensor integration provides support for them. +The RFXtrx binary sensor integration provides support for them. Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol but most of them are recognized -under the *Lighting4* protocol. The rfxtrx binary sensor integration provides -some special options for them, while other rfxtrx protocols should work too. +under the *Lighting4* protocol. The RFXtrx binary sensor integration provides +some special options for them, while other RFXtrx protocols should work too. ## Setting up your devices -Once you have set up your [rfxtrx hub](/integrations/rfxtrx/), the easiest way +Once you have set up your [RFXtrx hub](/integrations/rfxtrx/), the easiest way to find your binary sensors is to add this to your `configuration.yaml`: ```yaml @@ -90,7 +90,7 @@ automatic_add:
-This integration and the [rfxtrx switch](/integrations/switch.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. +This integration and the [RFXtrx switch](/integrations/switch.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
@@ -186,7 +186,7 @@ devices: command_off: 0x7 ``` -The *automatic_add* option makes the rfxtrx binary sensor integration calculate +The *automatic_add* option makes the RFXtrx binary sensor integration calculate and display the configuration options for you in the Home Assistant logs: ```text @@ -203,7 +203,7 @@ want to configure your new devices and leave it off otherwise. ### Known working devices -The following devices are known to work with the rfxtrx binary sensor component. +The following devices are known to work with the RFXtrx binary sensor component. There are too many other to list. - Motion detectors: diff --git a/source/_integrations/bluesound.markdown b/source/_integrations/bluesound.markdown index d4bcf552c6e..744f4535e86 100644 --- a/source/_integrations/bluesound.markdown +++ b/source/_integrations/bluesound.markdown @@ -10,8 +10,7 @@ ha_iot_class: Local Polling The `bluesound` platform allows you to control your [Bluesound](https://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant. -If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add a Bluesound device to your installation, add the following to your configuration.yaml file: - +If you want to automatically discover new devices, just make sure you have discovery: in your `configuration.yaml` file. To manually add a Bluesound device to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown index 0ec2d74fc39..8b7a2d45622 100644 --- a/source/_integrations/broadlink.markdown +++ b/source/_integrations/broadlink.markdown @@ -565,7 +565,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro [+] Dumping codes to TV.txt ``` -6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). +6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your `configuration.yaml` file (or wherever you have your switches). ### Using Windows to obtain codes with Broadlink Manager diff --git a/source/_integrations/cert_expiry.markdown b/source/_integrations/cert_expiry.markdown index 5402235e89b..bd9145cd66d 100644 --- a/source/_integrations/cert_expiry.markdown +++ b/source/_integrations/cert_expiry.markdown @@ -19,7 +19,7 @@ The `cert_expiry` sensor fetches information from a configured URL and displays There are 2 options in configuring the `cert_expiry` sensor: - Via the Home Assistant user interface where it will let you enter a name, host and port for the certificate to check. -- Via the Home Assistant configuration.yaml file. +- Via the Home Assistant `configuration.yaml` file. ```yaml diff --git a/source/_integrations/cisco_ios.markdown b/source/_integrations/cisco_ios.markdown index d1827e4041e..ef704dbafde 100644 --- a/source/_integrations/cisco_ios.markdown +++ b/source/_integrations/cisco_ios.markdown @@ -9,7 +9,7 @@ ha_codeowners: - '@fbradyirl' --- -This is a presence detection scanner for [Cisco](https://www.cisco.com/) IOS devices. +This is a presence detection scanner for [Cisco IOS](https://www.cisco.com/) devices.
This device tracker needs SSH to be enabled on the router. diff --git a/source/_integrations/cloudflare.markdown b/source/_integrations/cloudflare.markdown index 3fc65ff1f81..fb40d370c4e 100644 --- a/source/_integrations/cloudflare.markdown +++ b/source/_integrations/cloudflare.markdown @@ -90,7 +90,7 @@ cloudflare: - EXAMPLE.COM ``` -#### The minimum DNS record settings are (if you have set up https already): +#### The minimum DNS record settings (if you have set up HTTPS already) To redirect from your domain to the IP address of your Home Assistant server set this DNS record: diff --git a/source/_integrations/config.markdown b/source/_integrations/config.markdown index 23e626dd151..89537ad0ee5 100644 --- a/source/_integrations/config.markdown +++ b/source/_integrations/config.markdown @@ -53,11 +53,11 @@ This section enables you to organize entities to physical areas of your home. ### Automation -This section enables you to create and modify automations from within Home Assistant, without needing to write out the yaml code. +This section enables you to create and modify automations from within Home Assistant, without needing to write out the YAML code. ### Script -Similar to the automation editor, this section enables you to create and modify scripts from within Home Assistant, without needing to write out the yaml code. +Similar to the automation editor, this section enables you to create and modify scripts from within Home Assistant, without needing to write out the YAML code. ### Z-Wave diff --git a/source/_integrations/cover.rfxtrx.markdown b/source/_integrations/cover.rfxtrx.markdown index a377dfe6e86..1a276eb8f61 100644 --- a/source/_integrations/cover.rfxtrx.markdown +++ b/source/_integrations/cover.rfxtrx.markdown @@ -9,7 +9,7 @@ ha_release: 0.27 The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz. -First you have to set up your [rfxtrx hub](/integrations/rfxtrx/). +First you have to set up your [RFXtrx hub](/integrations/rfxtrx/). ### Configuration diff --git a/source/_integrations/darksky.markdown b/source/_integrations/darksky.markdown index 91920189425..d4fe5874f7c 100644 --- a/source/_integrations/darksky.markdown +++ b/source/_integrations/darksky.markdown @@ -68,12 +68,12 @@ language: latitude: description: Latitude coordinate to monitor weather of (required if **longitude** is specified). required: false - default: coordinates defined in your `configuration.yaml` + default: coordinates from the Home Assistant configuration type: float longitude: description: Longitude coordinate to monitor weather of (required if **latitude** is specified). required: false - default: coordinates defined in your `configuration.yaml` + default: coordinates from the Home Assistant configuration type: float monitored_conditions: description: Conditions to display in the frontend. diff --git a/source/_integrations/device_tracker.markdown b/source/_integrations/device_tracker.markdown index 171b8751aac..3ddb857bd20 100644 --- a/source/_integrations/device_tracker.markdown +++ b/source/_integrations/device_tracker.markdown @@ -88,7 +88,7 @@ In the example above, `devicename` refers to the detected name of the device. F |----------------|-------------------------------|---------------------------------------------------------------------------------------------------------| | `name` | Host name or "Unnamed Device" | The friendly name of the device. | | `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. | -| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. | +| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your `configuration.yaml` file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. | | `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). | | `gravatar` | None | An email address for the device's owner. If provided, it will override `picture`. | | `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update. | diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown index 9e06b06a98c..14f154214c2 100644 --- a/source/_integrations/dialogflow.markdown +++ b/source/_integrations/dialogflow.markdown @@ -39,7 +39,7 @@ To get the webhook URL, go to the integrations page in the configuration screen - Select name, language (if you are planning to use Google Actions check their [supported languages](https://support.google.com/assistant/answer/7108196?hl=en)) and time zone - Click "Save" - Now go to "Fulfillment" (in the left menu) -- Enable Webhook and set your Dialogflow webhook url as the endpoint, e.g., `https://myhome.duckdns.org/api/webhook/800b4cb4d27d078a8871656a90854a292651b20635685f8ea23ddb7a09e8b417` +- Enable Webhook and set your Dialogflow webhook URL as the endpoint, e.g., `https://myhome.duckdns.org/api/webhook/800b4cb4d27d078a8871656a90854a292651b20635685f8ea23ddb7a09e8b417` - Click "Save" - Create a new intent - Below "User says" write one phrase that you, the user, will tell Dialogflow, e.g., `What is the temperature at home?` @@ -52,7 +52,7 @@ To get the webhook URL, go to the integrations page in the configuration screen
- The V1 api will be deprecated on October 23, 2019. If you are still using the V1 API, it is recommended to change your settings in Dialogflow to use the V2 API. No changes to your intents yaml configuration need to take place after upgrading to the V2 API. Change to the V2 API by clicking on the cog button [here](https://console.dialogflow.com/) and then select the V2 API. + The V1 API will be deprecated on October 23, 2019. If you are still using the V1 API, it is recommended to change your settings in Dialogflow to use the V2 API. No changes to your intents YAML configuration need to take place after upgrading to the V2 API. Change to the V2 API by clicking on the cog button [here](https://console.dialogflow.com/) and then select the V2 API.
diff --git a/source/_integrations/discovery.markdown b/source/_integrations/discovery.markdown index 749ff452e8d..feed89e53af 100644 --- a/source/_integrations/discovery.markdown +++ b/source/_integrations/discovery.markdown @@ -25,7 +25,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi * [Netgear routers](/integrations/netgear) * [Panasonic Viera](/integrations/panasonic_viera) * [Philips Hue](/integrations/hue) - * [Plex media server](/integrations/plex#media-player) + * [Plex Media Server](/integrations/plex#media-player) * [Roku media player](/integrations/roku#media-player) * [SABnzbd downloader](/integrations/sabnzbd) * [Samsung SyncThru Printer](/integrations/syncthru) @@ -86,7 +86,7 @@ Valid values for ignore are: * `openhome`: Linn / Openhome * `panasonic_viera`: Panasonic Viera * `philips_hue`: Philips Hue - * `plex_mediaserver`: Plex media server + * `plex_mediaserver`: Plex Media Server * `roku`: Roku media player * `sabnzbd`: SABnzbd downloader * `samsung_printer`: Samsung SyncThru Printer diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index 1332d20f2b9..cd14a04d2e0 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -50,7 +50,7 @@ To configure the ecobee integration in Home Assistant, you can either use the ** 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. -### Setup via configuration.yaml +### Setup via `configuration.yaml` If you prefer to initially set up this integration in [`configuration.yaml`](/docs/configuration/), you may do so by adding your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** menu): diff --git a/source/_integrations/emoncms.markdown b/source/_integrations/emoncms.markdown index b6d3474f477..a5e538b4b70 100644 --- a/source/_integrations/emoncms.markdown +++ b/source/_integrations/emoncms.markdown @@ -23,15 +23,15 @@ sensor: ## Configuration variables -- **api_key** (*Required*): The read API key for your Emoncms user. -- **url** (*Required*): The base URL of Emoncms, use "https://emoncms.org" for the cloud based version. -- **id** (*Required*): Positive integer identifier for the sensor. Must be unique if you specify multiple Emoncms sensors. -- **include_only_feed_id** (*Optional*): Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs specified here will be displayed. Can not be specified if `exclude_feed_id` is specified. -- **exclude_feed_id** (*Optional*): Positive integer list of Emoncms feed IDs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if `include_only_feed_id` is specified. -- **sensor_names** (*Optional*): Dictionary of names for the sensors created that are created based on feed ID. The dictionary consists of `feedid: name` pairs. Sensors for feeds with their feed ID mentioned here will get the chosen name instead of the default name -- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to alter the feed value. -- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. -- **unit_of_measurement** (*Optional*): Defines the unit of measurement of for all the sensors. default is "W". +- `api_key` (*Required*): The read API key for your Emoncms user. +- `url` (*Required*): The base URL of Emoncms, use for the cloud based version. +- `id` (*Required*): Positive integer identifier for the sensor. Must be unique if you specify multiple Emoncms sensors. +- `include_only_feed_id` (*Optional*): Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs specified here will be displayed. Can not be specified if `exclude_feed_id` is specified. +- `exclude_feed_id` (*Optional*): Positive integer list of Emoncms feed IDs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if `include_only_feed_id` is specified. +- `sensor_names` (*Optional*): Dictionary of names for the sensors created that are created based on feed ID. The dictionary consists of `feedid: name` pairs. Sensors for feeds with their feed ID mentioned here will get the chosen name instead of the default name +- `value_template` (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to alter the feed value. +- `scan_interval` (*Optional*): Defines the update interval of the sensor in seconds. +- `unit_of_measurement` (*Optional*): Defines the unit of measurement of for all the sensors. default is "W". ## Default naming scheme diff --git a/source/_integrations/emoncms_history.markdown b/source/_integrations/emoncms_history.markdown index bd7f23b6104..2bb3c0a2b63 100644 --- a/source/_integrations/emoncms_history.markdown +++ b/source/_integrations/emoncms_history.markdown @@ -24,11 +24,11 @@ emoncms_history: {% configuration %} api_key: - description: Your Emoncms write api key + description: Your Emoncms write API key required: true type: string url: - description: The root URL of your Emoncms installation. (Use https://emoncms.org for the cloud based version) + description: The root URL of your Emoncms installation. (Use `https://emoncms.org` for the cloud based version) required: true type: string inputnode: diff --git a/source/_integrations/entur_public_transport.markdown b/source/_integrations/entur_public_transport.markdown index 32ee43e2615..b5be18d9409 100644 --- a/source/_integrations/entur_public_transport.markdown +++ b/source/_integrations/entur_public_transport.markdown @@ -107,18 +107,18 @@ sensor: [Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. -Now the web browser should contain an URL with the id in it. Such as this: +Now the web browser should contain a URL with the id in it. Such as this: `https://en-tur.no/nearby-stop-place-detail?id=NSR:StopPlace:32376` -The stop id is the content after `id=` parameter in the url. Copy paste this into the configuration. +The stop id is the content after `id=` parameter in the URL. Copy paste this into the configuration. ## FAQ - Troubleshooting **Q:** I have multiple stop ids and have added whitelisting of a line. Now some of the stop places are showing `unknown`. **A:** A whitelisting of lines takes affect on all of the stops. So you have to whitelist all lines you are interested in on all stop places. - + --- **Q:** I have added whitelisting of lines, and everything has worked as fine before, but now it has stopped updating all of a sudden. diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index 00722a620de..2e07f187ffc 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -60,7 +60,7 @@ These steps assume you already have the Home Assistant docker running behind NGI For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [let's encrypt docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io. -#### Set http logger +#### Set HTTP logger In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. diff --git a/source/_integrations/feedreader.markdown b/source/_integrations/feedreader.markdown index d96dee2b265..720518012b8 100644 --- a/source/_integrations/feedreader.markdown +++ b/source/_integrations/feedreader.markdown @@ -22,7 +22,7 @@ feedreader: {% configuration %} urls: - description: List of URLS for your feeds. + description: List of URLs for your feeds. required: true type: list scan_interval: diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown index 41dd04d2e7d..d2cac644af9 100644 --- a/source/_integrations/foursquare.markdown +++ b/source/_integrations/foursquare.markdown @@ -42,7 +42,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". -After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. +After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your `configuration.yaml` as the `access_token`. ### Real-Time API diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown index 2762beae405..4e8b588cbb3 100644 --- a/source/_integrations/freebox.markdown +++ b/source/_integrations/freebox.markdown @@ -35,18 +35,18 @@ freebox: {% configuration %} host: - description: The url of the Freebox. + description: The URL of the Freebox. required: true type: string port: - description: The https port the Freebox is listening on. + description: The HTTPS port the Freebox is listening on. required: true type: string {% endconfiguration %} You can find out your Freebox host and port by opening the address in your browser. The -returned json should contain an api_domain (`host`) and a https_port (`port`). -Please consult the [api documentation](https://dev.freebox.fr/sdk/os/) for more information. +returned JSON should contain an `api_domain` (`host`) and a `https_port` (`port`). +Please consult the [API documentation](https://dev.freebox.fr/sdk/os/) for more information.
diff --git a/source/_integrations/gearbest.markdown b/source/_integrations/gearbest.markdown index 4ce076ed841..40fdafb0274 100644 --- a/source/_integrations/gearbest.markdown +++ b/source/_integrations/gearbest.markdown @@ -25,7 +25,7 @@ sensor: {% configuration %} currency: - description: "The currency in which the products should be tracked. Currently supported: USD, EUR, GBP, AUD, CAD, CHF, HKD, CNY, NZD, JPY, RUB, BRL, CLP, NOK, DKK, SEK, KRW, ILS, COP, MXN, PEN, THB, IDR, UAH, PLN, INR, BGN, HUF, RON, TRY, CZK, HRK, MAD, AED, SAR, ZAR, SGD, MYR, TWD, RSD, NGN - if the currency could not be found in the conversion rate list, USD will be used as default. Either an ID or an URL must be present." + description: "The currency in which the products should be tracked. Currently supported: USD, EUR, GBP, AUD, CAD, CHF, HKD, CNY, NZD, JPY, RUB, BRL, CLP, NOK, DKK, SEK, KRW, ILS, COP, MXN, PEN, THB, IDR, UAH, PLN, INR, BGN, HUF, RON, TRY, CZK, HRK, MAD, AED, SAR, ZAR, SGD, MYR, TWD, RSD, NGN - if the currency could not be found in the conversion rate list, USD will be used as default. Either an ID or a URL must be present." required: true type: string items: diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown index 0b2bdd5ac16..66bbf01f2ce 100644 --- a/source/_integrations/geniushub.markdown +++ b/source/_integrations/geniushub.markdown @@ -161,7 +161,7 @@ value_template: "{{ state_attr('climate.genius_zone_12', 'status').occupied }}" ## Configuration -To set up this integration, add one of the following to your **configuration.yaml** file. +To set up this integration, add one of the following to your `configuration.yaml` file. If required, you can switch between one Option and the other and, as the `unique_id` remains consistent, state history will be preserved. This assumes that the correct MAC address is provided for Option 2, below. If a wrong MAC address was provided for Option 1, then the MAC address can be overridden for Option 1 to maintain these links within the entity registry. diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown index f1e80396022..33872616eb7 100644 --- a/source/_integrations/habitica.markdown +++ b/source/_integrations/habitica.markdown @@ -65,7 +65,7 @@ The API is exposed to Home Assistant as a service called `habitica.api_call`. To |----------------------|--------|--------|----------------| | `name` | yes | string | Habitica's username as per `configuration.yaml` entry. | | `path` | yes | [string] | Items from API URL in form of an array with method attached at the end. See the example below. | -| `args` | no | map | Any additional json or url parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). | +| `args` | no | map | Any additional JSON or URL parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). | A successful call to this service will fire an event `habitica_api_call_success`. @@ -73,13 +73,13 @@ A successful call to this service will fire an event `habitica_api_call_success` |----------------------|--------|----------------| | `name` | string | Copied from service data attribute. | | `path` | [string] | Copied from service data attribute. | -| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to api call. For more info see [docs](https://habitica.com/apidoc/). | +| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see [docs](https://habitica.com/apidoc/). | #### Let's consider some examples on how to call the service. For example, let's say that there is a configured `habitica` platform for user `xxxNotAValidNickxxx` with their respective `api_user` and `api_key`. Let's create a new task (a todo) for this user via Home Assistant. There is an [API call](https://habitica.com/apidoc/#api-Task-CreateUserTasks) for this purpose. -To create a new task one should hit `https://habitica.com/api/v3/tasks/user` endpoint with `POST` request with a json object with task properties. +To create a new task one should hit `https://habitica.com/api/v3/tasks/user` endpoint with `POST` request with a JSON object with task properties. So let's call the API on `habitica.api_call`. * The `name` key becomes `xxxNotAValidNickxxx`. diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown index dc9f6f0c8eb..96882ebe77b 100644 --- a/source/_integrations/harmony.markdown +++ b/source/_integrations/harmony.markdown @@ -90,7 +90,7 @@ Turn off all devices that were switched on from the start of the current activit ### Service `remote.turn_on` -Start an activity. Will start the default `activity` from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). +Start an activity. Will start the default `activity` from `configuration.yaml` if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown index 0f99bbbc15d..b57169a25fb 100644 --- a/source/_integrations/heos.markdown +++ b/source/_integrations/heos.markdown @@ -118,7 +118,7 @@ You can play a HEOS Quick Select by nubmer or name with the `media_player.play_m | `media_content_type` | Set to the value `quick_select` | `media_content_id` | The quick select number (i.e. `1`) or name (i.e. `Quick Select 1`) -#### Play Url +#### Play URL You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown index 64bdc61950d..d8b4eb3571c 100644 --- a/source/_integrations/hikvision.markdown +++ b/source/_integrations/hikvision.markdown @@ -98,7 +98,7 @@ port: type: integer default: 80 ssl: - description: "`true` if you want to connect with https. Be sure to set the port also." + description: "`true` if you want to connect with HTTPS. Be sure to set the port also." required: false type: boolean default: false diff --git a/source/_integrations/honeywell.markdown b/source/_integrations/honeywell.markdown index 01f2b0b418d..854b7902ccb 100644 --- a/source/_integrations/honeywell.markdown +++ b/source/_integrations/honeywell.markdown @@ -18,7 +18,7 @@ If your system is compatible with this integration, then you will be able access ## Configuration -To set up this integration, add the following to the `climate:` section of your **configuration.yaml** file: +To set up this integration, add the following to the `climate:` section of your `configuration.yaml` file: ```yaml climate: diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown index 2d9af3443b5..16606dfef50 100644 --- a/source/_integrations/hyperion.markdown +++ b/source/_integrations/hyperion.markdown @@ -76,7 +76,7 @@ automation: effect: "Full color mood blobs" ``` -To have the lights playing an effect when pausing, idle or turn off a media player like plex you can use this example: +To have the lights playing an effect when pausing, idle or turn off a media player like Plex you can use this example: ```yaml - alias: Set hyperion effect after playback diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index 5e0e7c4c7b1..5f9dc845be3 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -100,7 +100,7 @@ Service Data | `{"event": "EventName", "value1": "Hello World"}` When your screen looks like this, click the 'call service' button.

-By default the trigger is sent to all the api keys from `configuration.yaml`. If you +By default, the trigger is sent to all the API keys from `configuration.yaml`. If you want to send the trigger to a specific key use the `target` field: Field | Value diff --git a/source/_integrations/image_processing.markdown b/source/_integrations/image_processing.markdown index cfeb350ac39..eaf41a4b103 100644 --- a/source/_integrations/image_processing.markdown +++ b/source/_integrations/image_processing.markdown @@ -8,7 +8,7 @@ Image processing enables Home Assistant to process images from [cameras](/integr
-If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/integrations/http/). +If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [HTTP component](/integrations/http/).
diff --git a/source/_integrations/incomfort.markdown b/source/_integrations/incomfort.markdown index 2ea0bef5eb9..9ff53bda70a 100644 --- a/source/_integrations/incomfort.markdown +++ b/source/_integrations/incomfort.markdown @@ -54,7 +54,7 @@ Other properties are available via each device's attributes. ## Configuration -To set up this integration, add one of the following to your **configuration.yaml** file: +To set up this integration, add one of the following to your `configuration.yaml` file: The hub does not have to be in the same network as HA, but must be reachable via port 80/HTTP. diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown index 1f099b7ba05..171f6588401 100644 --- a/source/_integrations/influxdb.markdown +++ b/source/_integrations/influxdb.markdown @@ -60,12 +60,12 @@ database: default: home_assistant ssl: type: boolean - description: Use https instead of http to connect. + description: Use HTTPS instead of HTTP to connect. required: false default: false verify_ssl: type: boolean - description: Verify SSL certificate for https request. + description: Verify SSL certificate for HTTPS request. required: false default: true max_retries: @@ -212,12 +212,12 @@ password: required: false type: string ssl: - description: Use https instead of http to connect. + description: Use HTTPS instead of HTTP to connect. required: false default: false type: boolean verify_ssl: - description: Verify SSL certificate for https request. + description: Verify SSL certificate for HTTP request. required: false default: false type: boolean diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown index 19daab71d12..dc959416670 100644 --- a/source/_integrations/iperf3.markdown +++ b/source/_integrations/iperf3.markdown @@ -111,7 +111,7 @@ You can use the service `sensor.iperf3_update` to trigger a manual speed test fo Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode. | Service data attribute | Description | -| `host` | String that point at a configured `host` from configuration.yaml. Otherwise, tests will be run against all configured hosts. +| `host` | String that point at a configured `host` from `configuration.yaml`. Otherwise, tests will be run against all configured hosts. Example Service data: diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown index f16d6782287..0f923ff761c 100644 --- a/source/_integrations/joaoapps_join.markdown +++ b/source/_integrations/joaoapps_join.markdown @@ -14,8 +14,8 @@ divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component allows us to access the other special features that Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this is based on. -In the `configuration.yaml` file you need to provide the api key and device id -or name of the target device. You can find your device id and api key +In the `configuration.yaml` file you need to provide the API key and device id +or name of the target device. You can find your device id and API key [here](https://joinjoaomgcd.appspot.com/). To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown index 46358cfac5d..c0dab3ab5f2 100644 --- a/source/_integrations/kodi.markdown +++ b/source/_integrations/kodi.markdown @@ -385,7 +385,7 @@ data: type: map keys: icon: - description: "Kodi comes with 3 default icons: `info`, `warning` and `error`, an URL to an image is also valid." + description: "Kodi comes with 3 default icons: `info`, `warning` and `error`, a URL to an image is also valid." required: false default: "`info`" type: string diff --git a/source/_integrations/lannouncer.markdown b/source/_integrations/lannouncer.markdown index ebae5eca4a5..973387d10a5 100644 --- a/source/_integrations/lannouncer.markdown +++ b/source/_integrations/lannouncer.markdown @@ -48,7 +48,7 @@ More information can be found [here](https://www.keybounce.com/lannouncer/config Lannouncer supports two types of messages. -Spoken messages is the default method (`speak`). You just invoke the `notify` service with the following json and the device will speak out the specified message. +Spoken messages is the default method (`speak`). You just invoke the `notify` service with the following JSON and the device will speak out the specified message. ```json { diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index f31bf090cf1..de2f8d805b3 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -44,7 +44,7 @@ There is currently support for the following device types within Home Assistant: To use your LCN system in your installation, add the following lines to your `configuration.yaml` file. You have to specify at least one IP/port with login credentials for a PCHK host. -Consider to store your credentials in a [secrets.yaml](/docs/configuration/secrets). +Consider to store your credentials in a [`secrets.yaml`](/docs/configuration/secrets). ```yaml lcn: diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index cdcd0c6db22..04fd833be6f 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -335,7 +335,7 @@ light: ## Default schema - Implementations -- A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off). +- A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a NodeMCU board (ESP8266) to control its built-in LED (on/off). - Another [example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) to control a RGB LED (on/off, brightness, and colors). - [Integration guide](https://github.com/xoseperez/espurna/wiki/HomeAssistant) for the ESPUrna firmware (ESP8285/ESP8266). diff --git a/source/_integrations/light.rfxtrx.markdown b/source/_integrations/light.rfxtrx.markdown index 031e27cd945..0fb5be5b2c9 100644 --- a/source/_integrations/light.rfxtrx.markdown +++ b/source/_integrations/light.rfxtrx.markdown @@ -10,7 +10,7 @@ ha_iot_class: Assumed State The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. -First you have to set up your [rfxtrx hub](/integrations/rfxtrx/). +First you have to set up your [RFXtrx hub](/integrations/rfxtrx/). The easiest way to find your lights is to add this to your `configuration.yaml`: diff --git a/source/_integrations/light.xiaomi_aqara.markdown b/source/_integrations/light.xiaomi_aqara.markdown index c8940c38a69..cbf96cf2f6e 100644 --- a/source/_integrations/light.xiaomi_aqara.markdown +++ b/source/_integrations/light.xiaomi_aqara.markdown @@ -9,7 +9,7 @@ ha_iot_class: Local Push --- -The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The integration will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. +The `xiaomi aqara` light platform allows you to control the internal light of the Xiaomi gateway. The integration will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. The requirement is that you have setup [Xiaomi aqara](/integrations/xiaomi_aqara/). diff --git a/source/_integrations/light.xiaomi_miio.markdown b/source/_integrations/light.xiaomi_miio.markdown index 1494eba80f8..27484aa390a 100644 --- a/source/_integrations/light.xiaomi_miio.markdown +++ b/source/_integrations/light.xiaomi_miio.markdown @@ -98,7 +98,7 @@ Supported models: `philips.light.moonlight` Please follow the instructions on [Retrieving the Access Token](/integrations/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. -To add a Xiaomi Philips Light to your installation, add the following to your configuration.yaml file: +To add a Xiaomi Philips Light to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entries diff --git a/source/_integrations/mailgun.markdown b/source/_integrations/mailgun.markdown index 67a5a4fde1b..2c6a03fed88 100644 --- a/source/_integrations/mailgun.markdown +++ b/source/_integrations/mailgun.markdown @@ -12,7 +12,7 @@ To be able to receive webhooks from Mailgun, your Home Assistant instance needs To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun. -You will get a URL of the following format: `https:///api/webhook/9940e99a26fae4dcf6fe0a478124b6b58b578ea4c55c9a584beb1c9f5057bb91`. To receive webhooks from Mailgun, you need to provide that url as a callback URL in the Webhooks tab of the Mailgun Control Panel. +You will get a URL of the following format: `https:///api/webhook/9940e99a26fae4dcf6fe0a478124b6b58b578ea4c55c9a584beb1c9f5057bb91`. To receive webhooks from Mailgun, you need to provide that URL as a callback URL in the Webhooks tab of the Mailgun Control Panel. There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/mikrotik.markdown b/source/_integrations/mikrotik.markdown index e4e51b154d5..67bf3acf40e 100644 --- a/source/_integrations/mikrotik.markdown +++ b/source/_integrations/mikrotik.markdown @@ -34,7 +34,7 @@ Go to **IP** -> **Services** -> **API** and enable it. Make sure that port 8728 or the port you choose is accessible from your network. -Home Assistant offers Mikrotik integration through **Configuration** -> **Integrations** -> **Mikrotik**. +Home Assistant offers MikroTik integration through **Configuration** -> **Integrations** -> **MikroTik**. It also allows importing from the `configuration.yaml` file: ```yaml @@ -48,7 +48,7 @@ mikrotik: {% configuration %} name: - description: The name of your Mikrotik device. + description: The name of your MikroTik device. required: true default: Mikrotik type: string diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown index ed9a5d835c0..0f3fbc9c3b5 100644 --- a/source/_integrations/minio.markdown +++ b/source/_integrations/minio.markdown @@ -45,7 +45,7 @@ secret_key: required: true type: string secure: - description: Whether to use http or https connection + description: Whether to use HTTP or HTTPS connection required: true type: boolean default: false diff --git a/source/_integrations/mjpeg.markdown b/source/_integrations/mjpeg.markdown index 5ddd5dd9455..4beabb56a8e 100644 --- a/source/_integrations/mjpeg.markdown +++ b/source/_integrations/mjpeg.markdown @@ -50,7 +50,7 @@ authentication: type: string default: basic verify_ssl: - description: Validate the ssl certificate for this camera. + description: Validate the SSL certificate for this camera. required: false type: boolean default: true diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown index 1623255ec73..10dede4388a 100644 --- a/source/_integrations/neato.markdown +++ b/source/_integrations/neato.markdown @@ -26,7 +26,7 @@ Menu: *Configuration* -> *Integrations* Search for or select **Neato** from the list and configure the integration. You will need to enter your username and password and whether you are using a Neato or Vorwerk device. After that, all the entities will automatically show up in Home Assistant. -## Setup the integration via configuration.yaml +## Setup the integration via `configuration.yaml` Add the following to your configuration.yaml: diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 31e61f11cb2..f98fab48afc 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -48,7 +48,7 @@ client_secret: type: string {% endconfiguration %} -After the client_id and client_secret is added to your configuration.yaml you must enable Netatmo through the integrations page. +**After the client_id and client_secret is added to your `configuration.yaml` you must enable Netatmo through the integrations page.** ### Get API and Secret Key diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown index ae746df86d8..e81a0c47d9a 100644 --- a/source/_integrations/netdata.markdown +++ b/source/_integrations/netdata.markdown @@ -62,7 +62,7 @@ Alternatively you can browse to the built in Netdata API in your browser `http:/ }, ``` -Once the `data_group` "system.load" and the `element` "load15" have been identified from the JSON it can be configured in your configuration.yaml like the example below. +Once the `data_group` "system.load" and the `element` "load15" have been identified from the JSON it can be configured in your `configuration.yaml` like the example below. ## Configuration diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown index 3fc9ccd81b3..a4cdb5fe67e 100644 --- a/source/_integrations/nfandroidtv.markdown +++ b/source/_integrations/nfandroidtv.markdown @@ -97,8 +97,8 @@ The following attributes can be placed inside `data` to send images. | `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided. | `path` | yes | Local path of an image file. Is placed inside `file`. | `url` | yes | URL of an image file. Is placed inside `file`. -| `username` | yes | Username if the url requires authentication. Is placed inside `file`. -| `password` | yes | Password if the url requires authentication. Is placed inside `file`. +| `username` | yes | Username if the URL requires authentication. Is placed inside `file`. +| `password` | yes | Password if the URL requires authentication. Is placed inside `file`. | `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used. Is placed inside `file`. Example for posting file from URL: diff --git a/source/_integrations/openhome.markdown b/source/_integrations/openhome.markdown index 109534e3826..aa1c3b80b61 100644 --- a/source/_integrations/openhome.markdown +++ b/source/_integrations/openhome.markdown @@ -10,7 +10,7 @@ ha_iot_class: Local Polling The `openhome` platform allows you to connect an [Openhome Compliant Renderer](http://openhome.org/) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item. Openhome devices should be discovered by using the [the discovery component](/integrations/discovery/), their device names are taken from the name of the room configured on the device. -### Example configuration.yaml entry +### Example `configuration.yaml` entry ```yaml discovery: diff --git a/source/_integrations/opnsense.markdown b/source/_integrations/opnsense.markdown index 31f7af2432c..9921045639a 100644 --- a/source/_integrations/opnsense.markdown +++ b/source/_integrations/opnsense.markdown @@ -32,7 +32,7 @@ to the OPNsense [documentation](https://docs.opnsense.org/development/how-tos/ap {% configuration %} url: - description: The URL for the OPNsense api endpoint of your router. + description: The URL for the OPNsense API endpoint of your router. type: string required: true api_key: @@ -44,7 +44,7 @@ api_secret: type: string required: true verify_ssl: - description: Set to true to enable the validation of the OPNsense API's SSL. + description: Set to true to enable the validation of the OPNsense API SSL. type: boolean required: false default: false diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown index e076f80b823..4a8280a8eff 100644 --- a/source/_integrations/owntracks.markdown +++ b/source/_integrations/owntracks.markdown @@ -124,7 +124,7 @@ Owntracks v2.0.0 removes support for iBeacons on Android. When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. -iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](https://owntracks.org/booklet/guide/beacons/). +iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by iOS and some Android devices. Owntracks explain more [here](https://owntracks.org/booklet/guide/beacons/). When you enter an iBeacon region, Owntracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`. diff --git a/source/_integrations/plugwise.markdown b/source/_integrations/plugwise.markdown index 6ac354c9555..af7da0bec7d 100644 --- a/source/_integrations/plugwise.markdown +++ b/source/_integrations/plugwise.markdown @@ -21,7 +21,7 @@ The password can be found on the bottom of your Smile, it should consist of 6 ch ## Configuration -You have to add the following to your configuration.yaml file: +You have to add the following to your `configuration.yaml` file: ```yaml # Minimal configuration.yaml entry diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown index 8e2fc2a5b39..3450aec70a1 100644 --- a/source/_integrations/ps4.markdown +++ b/source/_integrations/ps4.markdown @@ -165,7 +165,7 @@ When the integration retrieves data from the PlayStation Store, it stores it in | ----- | ----- | ----------- | | `locked` | boolean | Must be `true` or `false` | `media_content_type` | string | Must be `game` or `app` -| `media_image_url` | string | Any valid url for an image +| `media_image_url` | string | Any valid URL for an image | `media_title` | string | The title of the game or app The data in the example shows 2 entries. diff --git a/source/_integrations/pushbullet.markdown b/source/_integrations/pushbullet.markdown index d96e84864db..8169511baef 100644 --- a/source/_integrations/pushbullet.markdown +++ b/source/_integrations/pushbullet.markdown @@ -143,7 +143,7 @@ action: url: google.com ``` -- **url** (*Required*): Page URL to send with Pushbullet. +- `url` (*Required*): Page URL to send with Pushbullet. ### File support @@ -157,7 +157,7 @@ action: file: /path/to/my/file ``` -- **file** (*Required*): File to send with Pushbullet. +- `file` (*Required*): File to send with Pushbullet. ### File URL support @@ -171,7 +171,7 @@ action: file_url: https://cdn.pixabay.com/photo/2014/06/03/19/38/test-361512_960_720.jpg ``` -- **file_url** (*Required*): File to send with Pushbullet. +- `file_url` (*Required*): File to send with Pushbullet. ### Single target @@ -184,7 +184,7 @@ action: target: device/DEVICE_NAME ``` -- **target**: Pushbullet device to receive the notification. +- `target`: Pushbullet device to receive the notification.
diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown index 0289f8e6c75..94ab6d883ab 100644 --- a/source/_integrations/rejseplanen.markdown +++ b/source/_integrations/rejseplanen.markdown @@ -14,13 +14,13 @@ The `rejseplanen` sensor will provide you with travel details for Danish public The `stop_id` can be obtained through the following steps: -If you know the exact name of the stop you can search the stop_id with the following url [http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME](http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME) and put in the name of the stop instead of "STOP_NAME" in the end of the url. +If you know the exact name of the stop you can search the stop_id with the following URL [http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME](http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME) and put in the name of the stop instead of "STOP_NAME" in the end of the URL. If you don't know the name of the stop follow this guide: - Go to [https://www.openstreetmap.org](https://www.openstreetmap.org) - Make a search and fill in the location you want to find for. -- The url will look like this [https://www.openstreetmap.org/#map=18/56.15756/10.20674](https://www.openstreetmap.org/#map=18/56.15756/10.20674) -- Now insert the coordinates for the location in the url, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&) +- The URL will look like this [https://www.openstreetmap.org/#map=18/56.15756/10.20674](https://www.openstreetmap.org/#map=18/56.15756/10.20674) +- Now insert the coordinates for the location in the URL, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&) - You will now see the 30 stops closest to your location. You will see an output like this: diff --git a/source/_integrations/rocketchat.markdown b/source/_integrations/rocketchat.markdown index 328f2313c41..cf87d79359d 100644 --- a/source/_integrations/rocketchat.markdown +++ b/source/_integrations/rocketchat.markdown @@ -24,13 +24,13 @@ notify: room: YOUR_ROOM_NAME ``` -- **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **url** (*Required*): The URL of your Rocket.Chat instance. -- **username** (*Required*): The Rocket.Chat username. -- **password** (*Required*): The Rocker.Chat password. -- **room** (*Required*): The chat room name to send messages to. +- `name` (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- `url` (*Required*): The URL of your Rocket.Chat instance. +- `username` (*Required*): The Rocket.Chat username. +- `password` (*Required*): The Rocker.Chat password. +- `room` (*Required*): The chat room name to send messages to. -### script.yaml example +### Script example ```yaml rocketchat_notification: diff --git a/source/_integrations/rova.markdown b/source/_integrations/rova.markdown index 40de5218116..0414d86e5a3 100644 --- a/source/_integrations/rova.markdown +++ b/source/_integrations/rova.markdown @@ -12,7 +12,7 @@ ha_iot_class: Cloud Polling ## Configuration -To use the ROVA sensor in your installation, add the following to your configuration.yaml file: +To use the ROVA sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sensor.command_line.markdown b/source/_integrations/sensor.command_line.markdown index 62edb923463..fb5b2c78f72 100644 --- a/source/_integrations/sensor.command_line.markdown +++ b/source/_integrations/sensor.command_line.markdown @@ -108,7 +108,7 @@ sensor: command: "grep -c 'Login attempt' /home/hass/.homeassistant/home-assistant.log" ``` -Make sure to configure the [logger component](/integrations/logger) to monitor the [http component](/integrations/http/) at least the `warning` level. +Make sure to configure the [Logger integration](/integrations/logger) to monitor the [HTTP integration](/integrations/http/) at least the `warning` level. ```yaml # Example working logger settings that works diff --git a/source/_integrations/sensor.metoffice.markdown b/source/_integrations/sensor.metoffice.markdown index cbdd3dff02d..83d1f53fcf2 100644 --- a/source/_integrations/sensor.metoffice.markdown +++ b/source/_integrations/sensor.metoffice.markdown @@ -13,7 +13,7 @@ The `metoffice` sensor platform uses the Met Office's [DataPoint API](https://ww - Each sensor will be given the `device_id` of "Met Office [condition]" if `name:` is not set. - The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half hour. -To add the Met Office weather to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file: +To add the Met Office weather to your installation you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sensor.rfxtrx.markdown b/source/_integrations/sensor.rfxtrx.markdown index 40bad148235..fc4a797d977 100644 --- a/source/_integrations/sensor.rfxtrx.markdown +++ b/source/_integrations/sensor.rfxtrx.markdown @@ -10,7 +10,7 @@ ha_release: 0.7 The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz. -First you have to set up your [rfxtrx hub](/integrations/rfxtrx/). +First you have to set up your [RFXtrx hub](/integrations/rfxtrx/). The easiest way to find your sensors is to add this to your `configuration.yaml`: ```yaml diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown index c70fb19c262..4e4e998f853 100644 --- a/source/_integrations/slack.markdown +++ b/source/_integrations/slack.markdown @@ -77,8 +77,8 @@ The following attributes can be placed inside `data` for extended functionality. | `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided. | `path ` | yes | Local path of file, photo etc to post to slack. Is placed inside `file`. | `url` | yes | URL of file, photo etc to post to slack. Is placed inside `file`. -| `username` | yes | Username if the url requires authentication. Is placed inside `file`. -| `password` | yes | Password if the url requires authentication. Is placed inside `file`. +| `username` | yes | Username if the URL requires authentication. Is placed inside `file`. +| `password` | yes | Password if the URL requires authentication. Is placed inside `file`. | `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`. | `attachments` | yes | Array of [Slack attachments](https://api.slack.com/docs/message-attachments). See [the attachment documentation](https://api.slack.com/docs/message-attachments) for how to format. *NOTE*: if using `attachments`, they are shown **in addition** to `message` diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown index 49eb4c6b457..c4573564b3b 100644 --- a/source/_integrations/smartthings.markdown +++ b/source/_integrations/smartthings.markdown @@ -49,7 +49,7 @@ If you are using Home Assistant Cloud (Nabu Casa) the integration will create a 1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions). 2. Home Assistant setup for [remote access](/docs/configuration/remote/) via a domain name secured with SSL. *Self-signed SSL certificates are not supported by the SmartThings Cloud API.* -3. [`base_url` of the http integration](/integrations/http#base_url) set the URL that Home Assistant is available on the internet. SmartThings requires the `base_url` and Home Assistant to use the standard HTTPS port (443). +3. [`base_url` of the HTTP integration](/integrations/http#base_url) set the URL that Home Assistant is available on the internet. SmartThings requires the `base_url` and Home Assistant to use the standard HTTPS port (443). ## Setup instructions diff --git a/source/_integrations/snmp.markdown b/source/_integrations/snmp.markdown index 6ae8d3eb7b8..6b6192bd950 100644 --- a/source/_integrations/snmp.markdown +++ b/source/_integrations/snmp.markdown @@ -34,8 +34,8 @@ The following OID examples pull the current MAC Address table from a router. Thi | Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` | | BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` | | DD-WRT | unknown version/model | `1.3.6.1.2.1.4.22.1.2` | -| Mikrotik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` | -| Mikrotik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` | +| MikroTik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` | +| MikroTik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` | | OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` | | OPNSense | 19.1 | `1.3.6.1.2.1.4.22.1.2` | | pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` | diff --git a/source/_integrations/solaredge_local.markdown b/source/_integrations/solaredge_local.markdown index 560ff4e51a1..40aacdfa225 100644 --- a/source/_integrations/solaredge_local.markdown +++ b/source/_integrations/solaredge_local.markdown @@ -27,7 +27,7 @@ If your inverter does not support the local API, you can use the [cloud based ve ## Configuration -To use the SolarEdge sensors in your installation, add the following to your configuration.yaml file: +To use the SolarEdge sensors in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/solax.markdown b/source/_integrations/solax.markdown index 47d16b6c06a..14ced979e70 100644 --- a/source/_integrations/solax.markdown +++ b/source/_integrations/solax.markdown @@ -15,7 +15,7 @@ The `solax` integration connects Home Assistant to Solax solar power inverters. ## Configuration -To use the Solax sensors in your installation, add the following to your configuration.yaml file: +To use the Solax sensors in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown index d83c0da0274..7ccf01c1bb9 100644 --- a/source/_integrations/somfy.markdown +++ b/source/_integrations/somfy.markdown @@ -11,7 +11,7 @@ ha_codeowners: - '@tetienne' --- -The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [tahoma](/integrations/tahoma/) component. +The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [Tahoma](/integrations/tahoma/) integration. ## Installation @@ -62,7 +62,7 @@ client_secret: ### Potential duplicate with the Tahoma integration -If you use the [tahoma](/integrations/tahoma) component, you will have to exclude the covers added by this one. Otherwise, they will be added twice. +If you use the [Tahoma](/integrations/tahoma) integration, you will have to exclude the covers added by this one. Otherwise, they will be added twice. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/spotcrime.markdown b/source/_integrations/spotcrime.markdown index 8889ffb50c1..6512f2efdf6 100644 --- a/source/_integrations/spotcrime.markdown +++ b/source/_integrations/spotcrime.markdown @@ -9,7 +9,7 @@ ha_iot_class: Cloud Polling SpotCrime is no longer handing out API keys to integrate their services.
-The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](https://www.spotcrime.info). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. +The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](https://www.spotcrime.info). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via `configuration.yaml`. ## Configuration diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown index f677803e337..5930efc5633 100644 --- a/source/_integrations/ssdp.markdown +++ b/source/_integrations/ssdp.markdown @@ -9,7 +9,7 @@ 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. -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. +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`. ## Configuration diff --git a/source/_integrations/stookalert.markdown b/source/_integrations/stookalert.markdown index f08da8299b2..abdba5f4de7 100644 --- a/source/_integrations/stookalert.markdown +++ b/source/_integrations/stookalert.markdown @@ -11,8 +11,7 @@ ha_codeowners: - '@fwestenberg' --- -The `stookalert` sensor platform queries the [RIVM stookalert](https://www.rivm.nl/stookalert) API for unfavorable weather conditions or poor air quality. With a Stookalert, the RIVM calls on people not to burn wood. This can prevent health problems in people in the area. - +The `stookalert` sensor platform queries the [RIVM Stookalert](https://www.rivm.nl/stookalert) API for unfavorable weather conditions or poor air quality. With a Stookalert, the RIVM calls on people not to burn wood. This can prevent health problems in people in the area. ## Configuration diff --git a/source/_integrations/supla.markdown b/source/_integrations/supla.markdown index eb2597bbf34..1ca79a2ce0b 100644 --- a/source/_integrations/supla.markdown +++ b/source/_integrations/supla.markdown @@ -40,7 +40,7 @@ server: access_token: description: An access token for REST API configuration. Can be acquired from - http[s]://your.server.org/integrations/tokens (please add at least Channel's Read and Action Execution permissions). + `http[s]://your.server.org/integrations/tokens` (please add at least Channel's Read and Action Execution permissions). required: true type: string {% endconfiguration %} diff --git a/source/_integrations/switch.rfxtrx.markdown b/source/_integrations/switch.rfxtrx.markdown index e1f1ecaa38c..f61d08f1373 100644 --- a/source/_integrations/switch.rfxtrx.markdown +++ b/source/_integrations/switch.rfxtrx.markdown @@ -11,7 +11,7 @@ The `rfxtrx` platform support switches that communicate in the frequency range o ## Configuration -First you have to set up your [rfxtrx hub](/integrations/rfxtrx/). +First you have to set up your [RFXtrx hub](/integrations/rfxtrx/). The easiest way to find your switches is to add this to your `configuration.yaml`: ```yaml @@ -68,7 +68,7 @@ signal_repetitions:
-This integration and the [rfxtrx binary sensor](/integrations/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`. +This integration and the [RFXtrx binary sensor](/integrations/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
@@ -88,7 +88,7 @@ If you need to generate codes for switches you can use a template (useful for ex {% raw %}0b11000{{ range(100,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70{% endraw %} ``` -- Use this code to add a new switch in your configuration.yaml +- Use this code to add a new switch in your `configuration.yaml` - Launch your Home Assistant and go to the website. - Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket) - Toggle your new switch in the Home Assistant interface diff --git a/source/_integrations/tautulli.markdown b/source/_integrations/tautulli.markdown index 2859c84d12b..0d54a07aff4 100644 --- a/source/_integrations/tautulli.markdown +++ b/source/_integrations/tautulli.markdown @@ -56,7 +56,7 @@ port: default: 8181 type: integer path: - description: The Base Url path of your Tautulli server. + description: The Base URL path of your Tautulli server. required: false type: string ssl: diff --git a/source/_integrations/telegram_broadcast.markdown b/source/_integrations/telegram_broadcast.markdown index c138ca1c1ca..17464649bd5 100644 --- a/source/_integrations/telegram_broadcast.markdown +++ b/source/_integrations/telegram_broadcast.markdown @@ -38,7 +38,7 @@ parse_mode: type: string default: "`markdown`" proxy_url: - description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`). + description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`). required: false type: string proxy_params: diff --git a/source/_integrations/telegram_polling.markdown b/source/_integrations/telegram_polling.markdown index 2292561224d..38dbfd928b1 100644 --- a/source/_integrations/telegram_polling.markdown +++ b/source/_integrations/telegram_polling.markdown @@ -40,7 +40,7 @@ parse_mode: type: string default: "`markdown`" proxy_url: - description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`). + description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`). required: false type: string proxy_params: diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown index 81429f62891..091dfacec4d 100644 --- a/source/_integrations/telegram_webhooks.markdown +++ b/source/_integrations/telegram_webhooks.markdown @@ -46,7 +46,7 @@ parse_mode: default: markdown type: string proxy_url: - description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`). + description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`). required: false type: string proxy_params: diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown index f8748bca5ab..3fed258814c 100644 --- a/source/_integrations/tomato.markdown +++ b/source/_integrations/tomato.markdown @@ -44,7 +44,7 @@ ssl: type: boolean default: false verify_ssl: - description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `false` or `true` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`." + description: "If SSL verification for HTTPS resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `false` or `true` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`." required: false type: [string, boolean] default: true diff --git a/source/_integrations/transmission.markdown b/source/_integrations/transmission.markdown index ccbb2b50e27..bc81ae4f094 100644 --- a/source/_integrations/transmission.markdown +++ b/source/_integrations/transmission.markdown @@ -119,7 +119,7 @@ Example of configuration of an automation with completed torrents: ### Service `add_torrent` -Adds a new torrent to download. It can either be a URL (http, https or ftp), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#whitelist_external_dirs)). +Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#whitelist_external_dirs)). | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown index a9d9a7812fc..2337e0b94c9 100644 --- a/source/_integrations/tts.markdown +++ b/source/_integrations/tts.markdown @@ -20,7 +20,7 @@ tts:
-Depending on your setup, you might need to set a base URL (`base_url`) inside the [http component](/integrations/http/) or in the parameters of this component. +Depending on your setup, you might need to set a base URL (`base_url`) inside the [HTTP component](/integrations/http/) or in the parameters of this component.
@@ -43,7 +43,7 @@ time_memory: type: integer default: 300 base_url: - description: A base URL to use *instead* of the one set in the [http component](/integrations/http/). It is used as-is by the `tts` component. In particular, you need to include the protocol scheme `http://` or `https://` and the correct port number. They will not be automatically added for you. + description: A base URL to use *instead* of the one set in the [HTTP component](/integrations/http/). It is used as-is by the `tts` component. In particular, you need to include the protocol scheme `http://` or `https://` and the correct port number. They will not be automatically added for you. required: false type: string default: value of ``http.base_url`` @@ -75,7 +75,7 @@ In the above example, `base_url` is custom to this particular TTS platform confi ## When do you need to set `base_url` here? -The general answer is "whenever the global `base_url` set in [http component](/integrations/http/) is not adequate to allow the `say` service to run". The `say` service operates by generating a media file that contains the speech corresponding to the text passed to the service. Then the `say` service sends a message to the media device with a URL pointing to the file. The device fetches the media file at the URL and plays the media. Some combinations of a media device, network configuration and Home Assistant configuration can make it so that the device cannot fetch the media file. +The general answer is "whenever the global `base_url` set in [HTTP component](/integrations/http/) is not adequate to allow the `say` service to run". The `say` service operates by generating a media file that contains the speech corresponding to the text passed to the service. Then the `say` service sends a message to the media device with a URL pointing to the file. The device fetches the media file at the URL and plays the media. Some combinations of a media device, network configuration and Home Assistant configuration can make it so that the device cannot fetch the media file. The following sections describe some of the problems encountered with media devices. @@ -83,7 +83,7 @@ The following sections describe some of the problems encountered with media devi This problem occurs when your Home Assistant instance is configured to be accessed through SSL, and you are using a self-signed certificate. -The `tts` service will send an `https://` URL to the media device, which will check the certificate, and reject it. So it won't play your file. If you could make the device accept your certificate, it would play the file. However, many media devices do not allow changing settings to accept self-signed certificates. Ultimately, your option may be to serve files to the device as `http://` rather than `https://`. To do this, you *could* change the `base_url` setting in [http component](/integrations/http/), but that would turn off SSL for all services that use `base_url`. Instead, setting a `base_url` for the `tts` service allows turning off SSL only for this component. +The `tts` service will send an `https://` URL to the media device, which will check the certificate, and reject it. So it won't play your file. If you could make the device accept your certificate, it would play the file. However, many media devices do not allow changing settings to accept self-signed certificates. Ultimately, your option may be to serve files to the device as `http://` rather than `https://`. To do this, you *could* change the `base_url` setting in [HTTP component](/integrations/http/), but that would turn off SSL for all services that use `base_url`. Instead, setting a `base_url` for the `tts` service allows turning off SSL only for this component. ### Google cast devices @@ -145,7 +145,7 @@ The integration has two caches. Both caches can be controlled with the `cache` o ### POST `/api/tts_get_url` -Returns an URL to the generated TTS file. Platform and message are required. +Returns a URL to the generated TTS file. Platform and message are required. ```json { diff --git a/source/_integrations/unifiled.markdown b/source/_integrations/unifiled.markdown index 8aa27c5033c..7333f086456 100644 --- a/source/_integrations/unifiled.markdown +++ b/source/_integrations/unifiled.markdown @@ -29,7 +29,7 @@ light: {% configuration %} host: - description: Ip address or hostname used to connect to the Unifi LED controller. + description: IP address or hostname used to connect to the Unifi LED controller. type: string required: true default: None diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index 8125ff62f41..cab23ed7960 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -320,7 +320,7 @@ payload_pause: type: string default: pause state_topic: - description: The MQTT topic subscribed to receive state messages from the vacuum. State topic is extracting json if no `value_template` is defined. + description: The MQTT topic subscribed to receive state messages from the vacuum. State topic is extracting JSON if no `value_template` is defined. required: false type: string value_template: @@ -417,7 +417,7 @@ Vacuum send_command allows three parameters: - params - optional If params are not provided it sends command as payload to MQTT send_command topic. -If params are provided service sends json as payload with such structure: +If params are provided service sends JSON as payload with such structure: ```json { @@ -492,7 +492,7 @@ Vacuum send_command allows three parameters: - params - optional If params are not provided it sends command as payload to MQTT send_command topic. -If params are provided service sends json as payload with such structure: +If params are provided service sends JSON as payload with such structure: ```json { diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown index dafd75accf0..acd515fb6b2 100644 --- a/source/_integrations/velbus.markdown +++ b/source/_integrations/velbus.markdown @@ -32,7 +32,7 @@ The pushbutton LEDs of input modules are disabled by default. These can be enabl ## Configuration -There are 2 options in configuring the velbus integration: +There are 2 options in configuring the Velbus integration: - Via the Home Assistant user interface where it will let you enter the port string to connect to the Velbus bus. - Via the Home Assistant `configuration.yaml` file. @@ -48,7 +48,7 @@ velbus: The port string used in the user interface or the configuration file can have 2 formats: - For a serial device: /dev/ttyUSB00 -- For a tcp/ip device: 127.0.0.1:3678 +- For a TCP/IP device: 127.0.0.1:3678 {% configuration %} port: diff --git a/source/_integrations/vera.markdown b/source/_integrations/vera.markdown index d46ccbfc236..c5038161d69 100644 --- a/source/_integrations/vera.markdown +++ b/source/_integrations/vera.markdown @@ -32,7 +32,7 @@ and will be automatically added when HA connects to your Vera controller. ## Configuration -To use Vera devices in your installation, add the following to your configuration.yaml file using the IP and port number of your Vera controller: +To use Vera devices in your installation, add the following to your `configuration.yaml` file using the IP and port number of your Vera controller: ```yaml vera: @@ -77,7 +77,7 @@ If you want to use a Z-Wave device from the Vera controller in Home Assistant au The `vera` platform allows you to get data from your [Vera](https://getvera.com/) sensors from within Home Assistant. -Please note that some vera sensors (such as _motion_ and _flood_ sensors) are _armable_ which means that vera will send alerts (email messages to txts) when they are _armed_ and change state. +Please note that some Vera sensors (such as _motion_ and _flood_ sensors) are _armable_ which means that Vera will send alerts (email messages to txts) when they are _armed_ and change state. Home Assistant will display the state of these sensors regardless of the _armed_ state. diff --git a/source/_integrations/wink.markdown b/source/_integrations/wink.markdown index a8b7480432a..47b16b98913 100644 --- a/source/_integrations/wink.markdown +++ b/source/_integrations/wink.markdown @@ -435,7 +435,7 @@ The above devices are confirmed to work, but others may work as well. Wink Cover garage door functionality varies on the product. Home Assistant can open, close, and view state of GoControl/Linear openers. For Chamberlain MyQ-enabled openers, Home Assistant is limited to show current state (open or closed) only using this Wink cover. This restriction was imposed by Chamberlain for third party control. Wink suggests that MyQ customers should contact Chamberlain directly to inquire about expanding permissions. -The [MyQ Cover](/integrations/myq) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via customize.yaml. +The [MyQ Cover](/integrations/myq) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via `customize.yaml`. The requirement is that you have setup [Wink](/integrations/wink/) from above. diff --git a/source/_integrations/zeroconf.markdown b/source/_integrations/zeroconf.markdown index 506da99be4d..b1dbe87ba0f 100644 --- a/source/_integrations/zeroconf.markdown +++ b/source/_integrations/zeroconf.markdown @@ -13,7 +13,7 @@ ha_codeowners: 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. -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. +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`. ## Configuration diff --git a/source/_integrations/zhong_hong.markdown b/source/_integrations/zhong_hong.markdown index dd934388bc9..49dfe6047c6 100644 --- a/source/_integrations/zhong_hong.markdown +++ b/source/_integrations/zhong_hong.markdown @@ -10,7 +10,7 @@ ha_iot_class: Local Push The `zhong_hong` climate platform lets you control [Zhonghong HVAC Gateway Controller](http://zhonghongtech.cn/v1/index.shtml) thermostats through Home Assistant. -To set it up, add the following information to your configuration.yaml file: +To set it up, add the following information to your `configuration.yaml` file: ```yaml climate: diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index 1c745a7292a..e14373ad299 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -109,7 +109,7 @@ If you define an icon the title will be used as a tool-tip. ## Visible -You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The url path is still accessible) +You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The URL path is still accessible) #### Example diff --git a/source/lovelace/yaml-mode.markdown b/source/lovelace/yaml-mode.markdown index ef586d091e7..4bc2000b104 100644 --- a/source/lovelace/yaml-mode.markdown +++ b/source/lovelace/yaml-mode.markdown @@ -3,7 +3,7 @@ title: "Lovelace YAML mode" description: "Advanced users can switch on YAML mode for editing the Lovelace UI." --- -It is possible to customize your Home Assistant interface by writing in YAML instead of via the UI. To do so, you configure the Lovelace integration to be in yaml mode by adding the following to your `configuration.yaml`: +It is possible to customize your Home Assistant interface by writing in YAML instead of via the UI. To do so, you configure the Lovelace integration to be in YAML mode by adding the following to your `configuration.yaml`: ```yaml lovelace: