diff --git a/.textlintrc.json b/.textlintrc.json index d044e1bdf00..a0b0f3a6127 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -77,11 +77,14 @@ "CalDAV", "CardDAV", "Cisco IOS", + "CLI", "Daikin", "Danfoss", "Dark Sky", "Debian", "deCONZ", + "Dialogflow", + "DIY", "DNS", "Docker Hub", "Docker", @@ -112,6 +115,7 @@ "GraphiQL", "GraphQL", "Growatt", + "HDMI", "Heatmiser", "Home Assistant Companion", "Home Assistant Core", @@ -143,6 +147,7 @@ "Kafka", "KEF", "KNX", + "Kodi", "LaCrosse", "LED", "Let's Encrypt", @@ -150,6 +155,10 @@ "LinkedIn", "Linky", "Linux", + "LMS", + "Logitech Harmony", + "Logitech Media Server", + "Logitech", "Lovelace", "LTE", "MacBook", @@ -169,6 +178,8 @@ "Norway", "NuHeat", "NZBGet", + "ODRIOD-N2", + "ODROID", "OpenTherm", "OpenWrt", "PayPal", @@ -206,6 +217,7 @@ "Sony", "Spotify", "SQL", + "Squeezebox", "SSID", "SSL", "StarLine", @@ -238,6 +250,7 @@ "unRAID", "UPS", "URL", + "USB", "Velbus", "Velux", "Venstar", @@ -273,6 +286,8 @@ [" HA ", "Home Assistant"], ["\\(s\\)he", "they"], ["2 ?steps? authentication", "two-step authentication"], + ["addon", "add-on"], + ["addons", "add-ons"], ["Alarm ?dot ?com", "Alarm.com"], ["an URL", "a URL"], ["analyse", "analyze"], @@ -287,13 +302,15 @@ ["end ?to ?end", "end-to-end"], ["FRITZ!? ?Box", "FRITZ!Box"], ["grey", "gray"], - ["Hass\\.?io", "Home Assistant"], ["hass", "Home Assistant"], + ["Hass\\.?io", "Home Assistant"], ["HassOS", "Home Assistant Operating System"], ["he or she", "they"], ["he/she", "they"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], + ["IFF?TTT?T?", "IFTTT"], ["ISY ?994", "ISY994"], + ["JSONRPC", "JSON-RPC"], ["licence", "license"], ["licences", "licenses"], ["Mac ?OS", "macOS"], diff --git a/source/_docs/installation/armbian.markdown b/source/_docs/installation/armbian.markdown index cb6c1e983d7..2f6862973c4 100644 --- a/source/_docs/installation/armbian.markdown +++ b/source/_docs/installation/armbian.markdown @@ -3,7 +3,7 @@ title: "Installation on a Armbian system" description: "Instructions to install Home Assistant on an Armbian-powered systems." --- -[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and Odroid. +[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and ODROID. Setup Python and `pip`: diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 051e01bf04d..233492f1198 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -30,7 +30,7 @@ While you should hopefully be storing your passwords in a password manager, if y ## Recovering Data for Home Assistant (including Supervised) -Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. +Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. There are a few routes: - Connect a USB keyboard and HDMI monitor directly to the Raspberry Pi. @@ -43,10 +43,10 @@ If you’re using a Raspberry Pi, you're likely going to have to pull the power Once you're connected, you'll see a running dmesg log. Hit the enter key to interrupt the log. Sign in as "root". There is no password. -You will then be at the Home Assistant CLI, where you can run the custom commands. These are the same as you would run using the SSH addon but without using `ha` in front of it. For example: +You will then be at the Home Assistant CLI, where you can run the custom commands. These are the same as you would run using the SSH add-on but without using `ha` in front of it. For example: - `core logs` for Home Assistant Core log -- `supervisor logs` for supervisor logs +- `supervisor logs` for supervisor logs - `host reboot` to reboot the host - `dns logs` for checking DNS - etc (typing `help` will show more) @@ -60,5 +60,5 @@ These are easily accessed using another Linux machine with EXT support. For Windows or macOS you will need third party software. Below are some options. -- Windows: https://www.diskinternals.com/linux-reader/ (read-only access to the SD) -- Mac: https://osxfuse.github.io/ +- Windows: (read-only access to the SD) +- Mac: diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index a0c7f5fc4e1..9f5079e66cf 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -10,7 +10,7 @@ The MQTT integration needs you to run an MQTT broker for Home Assistant to conne This is the most private option, is running your own MQTT broker. -The recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto). +The recommended setup method is to use the [Mosquitto MQTT broker add-on](/addons/mosquitto). ## Configuration diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index 3f34dcf5859..8bf346be58e 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -180,7 +180,7 @@ Prior to Home Assistant 0.101, this approach did not work well for newer devices The second option is to use an ADB server to connect to your Android TV and Fire TV devices. -For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value. +For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) add-on. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value. ## ADB Troubleshooting diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown index ea6f7418487..67f0b9c5bd3 100644 --- a/source/_integrations/dialogflow.markdown +++ b/source/_integrations/dialogflow.markdown @@ -10,7 +10,7 @@ ha_config_flow: true The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. -To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). +To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms. diff --git a/source/_integrations/discovery.markdown b/source/_integrations/discovery.markdown index ba492edc60c..4202627d79e 100644 --- a/source/_integrations/discovery.markdown +++ b/source/_integrations/discovery.markdown @@ -21,7 +21,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi * [Frontier Silicon internet radios](/integrations/frontier_silicon) * [Linn / Openhome](/integrations/openhome) * [Logitech Harmony Hub](/integrations/harmony) - * [Logitech media server (Squeezebox)](/integrations/squeezebox) + * [Logitech Media Server (Squeezebox)](/integrations/squeezebox) * [NETGEAR routers](/integrations/netgear) * [Panasonic Viera](/integrations/panasonic_viera) * [Philips Hue](/integrations/hue) @@ -80,7 +80,7 @@ Valid values for ignore are: * `frontier_silicon`: Frontier Silicon internet radios * `harmony`: Logitech Harmony Hub * `igd`: Internet Gateway Device - * `logitech_mediaserver`: Logitech media server (Squeezebox) + * `logitech_mediaserver`: Logitech Media Server (Squeezebox) * `netgear_router`: NETGEAR routers * `octoprint`: Octoprint * `openhome`: Linn / Openhome diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown index 94a0ac6066c..03e41d3f45f 100644 --- a/source/_integrations/kodi.markdown +++ b/source/_integrations/kodi.markdown @@ -99,17 +99,17 @@ Add music to the default playlist (i.e. playlistid=0). #### Service `kodi.call_method` -Call a [Kodi JSONRPC API](https://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. +Call a [Kodi JSON-RPC API](https://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of the Kodi entities where to run the API method. | -| `method` | yes | Name of the Kodi JSONRPC API method to be called. | +| `method` | yes | Name of the Kodi JSON-RPC API method to be called. | | any other parameter | no | Optional parameters for the Kodi API call. | ### Event triggering -When calling the `kodi.call_method` service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: +When calling the `kodi.call_method` service, if the Kodi JSON-RPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: ```yaml entity_id: "" @@ -237,7 +237,7 @@ media_player:
-This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your kodi player. Use this with caution. +This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your Kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your Kodi player. Use this with caution.
@@ -340,7 +340,7 @@ port: default: 8080 type: integer proxy_ssl: - description: Connect to kodi with HTTPS. Useful if Kodi is behind an SSL proxy. + description: Connect to Kodi with HTTPS. Useful if Kodi is behind an SSL proxy. required: false default: "`false`" type: boolean diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown index 7641cd3515e..11ed3559705 100644 --- a/source/_integrations/onkyo.markdown +++ b/source/_integrations/onkyo.markdown @@ -55,32 +55,32 @@ sources: List of source names: -- video1 -- video2 -- video3 -- video4 -- video5 -- video6 -- video7 -- dvd -- bd-dvd -- tape1 -- tv-tape -- tape2 -- phono -- cd -- tv-cd -- fm -- am -- tuner -- dlna -- internet-radio -- usb -- network -- universal-port -- multi-ch -- xm -- sirius +- `video1` +- `video2` +- `video3` +- `video4` +- `video5` +- `video6` +- `video7` +- `dvd` +- `bd-dvd` +- `tape1` +- `tv-tape` +- `tape2` +- `phono` +- `cd` +- `tv-cd` +- `fm` +- `am` +- `tuner` +- `dlna` +- `internet-radio` +- `usb` +- `network` +- `universal-port` +- `multi-ch` +- `xm` +- `sirius` If your source is not listed above, and you want to figure out how to format that source name so you can map its entry, you can use the `onkyo-eiscp` Python module to discover the exact naming needed. First, change your receiver's source to the one that you need to define, and then run: diff --git a/source/_integrations/squeezebox.markdown b/source/_integrations/squeezebox.markdown index cf50b3435fc..c47723a0615 100644 --- a/source/_integrations/squeezebox.markdown +++ b/source/_integrations/squeezebox.markdown @@ -60,7 +60,7 @@ transporter_toslink: ### Service `call_method` -Call a custom Squeezebox JSONRPC API. +Call a custom Squeezebox JSON-RPC API. See documentation for this interface on `http://HOST:PORT/html/docs/cli-api.html?player=` where HOST and PORT are the host name and port for your Logitech Media Server. @@ -72,10 +72,10 @@ See documentation for this interface on `http://HOST:PORT/html/docs/cli-api.html This service can be used to integrate any Squeezebox action to an automation. -It can also be used to target a Squeezebox from IFTT (or DialogFlow, Alexa...). +It can also be used to target a Squeezebox from IFTTT (or Dialogflow, Alexa...). -For example, to play an album from your collection, create an IFTT applet like this: +For example, to play an album from your collection, create an IFTTT applet like this: - Trigger: Google assistant, with sentence: `I want to listen to album $` - Action: JSON post query with such JSON body: `{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch={{TextField}}"] }` -This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTT cannot escape the text field. +This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTTT cannot escape the text field. diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown index 74fd4128e1d..6a0a7ba1635 100644 --- a/source/_integrations/universal.markdown +++ b/source/_integrations/universal.markdown @@ -135,7 +135,7 @@ media_player: #### Kodi CEC-TV control -In this example, a [Kodi Media Player](/integrations/kodi) runs in a CEC capable device (OSMC/OpenElec running in a Raspberry Pi 24/7, for example), and, with the JSON-CEC Kodi addon installed, it can turn on and off the attached TV. +In this example, a [Kodi Media Player](/integrations/kodi) runs in a CEC capable device (OSMC/OpenElec running in a Raspberry Pi 24/7, for example), and, with the JSON-CEC Kodi add-on installed, it can turn on and off the attached TV. We store the state of the attached TV in a hidden [input boolean](/integrations/input_boolean/), so we can differentiate the TV being on or off, while Kodi is always 'idle', and use the universal media player to render its state with a template. We can hide the Kodi Media Player too, and only show the universal one, which now can differentiate between the 'idle' and the 'off' state (being the second when it is idle and the TV is off).