diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown index 3031fee40ae..8b2fe35ce7d 100644 --- a/source/_integrations/caldav.markdown +++ b/source/_integrations/caldav.markdown @@ -21,6 +21,9 @@ related: title: To-do list card - docs: /integrations/calendar title: Calendar +related: + - docs: /docs/configuration/ + title: Configuration file --- The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant @@ -47,7 +50,8 @@ This integration was tested against the following systems, but any other complyi ## Manual configuration -You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your `configuration.yaml` file. This method does not support to-do lists. +You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your {% term "`configuration.yaml`" %} file. This method does not support to-do lists. +{% include integrations/restart_ha_after_config_inclusion.md %} {% details Manual configuration examples %} diff --git a/source/_integrations/channels.markdown b/source/_integrations/channels.markdown index a8fe9cf0a3c..53c0f9a82a1 100644 --- a/source/_integrations/channels.markdown +++ b/source/_integrations/channels.markdown @@ -9,6 +9,9 @@ ha_domain: channels ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The Channels platform allows you to control [Channels](https://getchannels.com/) from Home Assistant. Play, pause, seek, or skip commercials on an instance of Channels that is running on your network. @@ -17,7 +20,8 @@ Your favorite channels will appear as sources in the Source List in Home Assista ## Configuration -To add Channels to your installation, add the following to your `configuration.yaml` file: +To add Channels to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -48,23 +52,23 @@ name: Seek forward by the number of seconds currently set in settings on the instance of Channels. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String that points at `entity_id` of Channels app. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------- | +| `entity_id` | no | String that points at `entity_id` of Channels app. | ### Service `seek_backward` Seek backward by the number of seconds currently set in settings on the instance of Channels. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String that points at `entity_id` of Channels app. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------- | +| `entity_id` | no | String that points at `entity_id` of Channels app. | ### Service `seek_by` Seek forward or backward by a provided number of seconds. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String that points at `entity_id` of Channels app. -| `seconds` | no | Number of seconds to seek in the timeline by. Negative seconds seeks backwards. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------------------- | +| `entity_id` | no | String that points at `entity_id` of Channels app. | +| `seconds` | no | Number of seconds to seek in the timeline by. Negative seconds seeks backwards. | diff --git a/source/_integrations/cisco_ios.markdown b/source/_integrations/cisco_ios.markdown index 9aab1516d08..1634ff4cfd9 100644 --- a/source/_integrations/cisco_ios.markdown +++ b/source/_integrations/cisco_ios.markdown @@ -11,6 +11,9 @@ ha_domain: cisco_ios ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This is a presence detection scanner for [Cisco IOS](https://www.cisco.com/) devices. @@ -49,7 +52,8 @@ If you have a very large number of devices on your VLan (+1000), then you may wa -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/cisco_mobility_express.markdown b/source/_integrations/cisco_mobility_express.markdown index 7cf7859e5db..54a9381afc9 100644 --- a/source/_integrations/cisco_mobility_express.markdown +++ b/source/_integrations/cisco_mobility_express.markdown @@ -11,11 +11,15 @@ ha_domain: cisco_mobility_express ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This is a presence detection scanner for [Cisco](https://www.cisco.com) Mobility Express wireless controllers. -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/cisco_webex_teams.markdown b/source/_integrations/cisco_webex_teams.markdown index a76593f9eaf..30844b7adcf 100644 --- a/source/_integrations/cisco_webex_teams.markdown +++ b/source/_integrations/cisco_webex_teams.markdown @@ -11,6 +11,9 @@ ha_domain: cisco_webex_teams ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark). @@ -32,7 +35,8 @@ You must add the bot email (in the format `mybot@webex.bot`) as a participant to -To enable this platform in your installation, add the following to your `configuration.yaml` file: +To enable this platform in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/citybikes.markdown b/source/_integrations/citybikes.markdown index f786a5864a6..ecf6e153b2c 100644 --- a/source/_integrations/citybikes.markdown +++ b/source/_integrations/citybikes.markdown @@ -9,13 +9,17 @@ ha_domain: citybikes ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. ## Configuration -To enable it, add the following lines to your `configuration.yaml`: +To enable it, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry (using radius) diff --git a/source/_integrations/clementine.markdown b/source/_integrations/clementine.markdown index b20820f032c..9c227813c07 100644 --- a/source/_integrations/clementine.markdown +++ b/source/_integrations/clementine.markdown @@ -9,11 +9,15 @@ ha_domain: clementine ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org). -To add a Clementine Player to your Home Assistant installation, add the following to your `configuration.yaml` file: +To add a Clementine Player to your Home Assistant installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/clickatell.markdown b/source/_integrations/clickatell.markdown index 9533dda849a..a83555f6afa 100644 --- a/source/_integrations/clickatell.markdown +++ b/source/_integrations/clickatell.markdown @@ -9,6 +9,9 @@ ha_domain: clickatell ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `clickatell` platform uses [Clickatell](https://www.clickatell.com) to deliver SMS notifications from Home Assistant. @@ -26,7 +29,8 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se ## Configuration -To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file: +To add Clickatell to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/clicksend.markdown b/source/_integrations/clicksend.markdown index 229b8c7312a..eef5a803078 100644 --- a/source/_integrations/clicksend.markdown +++ b/source/_integrations/clicksend.markdown @@ -9,6 +9,9 @@ ha_iot_class: Cloud Push ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. @@ -19,7 +22,8 @@ Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and cr ## Configuration -To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: +To add ClickSend to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/cmus.markdown b/source/_integrations/cmus.markdown index 0069c91d0e1..93388762eb3 100644 --- a/source/_integrations/cmus.markdown +++ b/source/_integrations/cmus.markdown @@ -13,7 +13,10 @@ ha_integration_type: integration The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant. -To add cmus to your installation, add the following to your `configuration.yaml` file if running locally it will look like: +To add cmus to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + +Running it locally will look like: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/comed_hourly_pricing.markdown b/source/_integrations/comed_hourly_pricing.markdown index e9a20edf8cf..8f0e0351a1a 100644 --- a/source/_integrations/comed_hourly_pricing.markdown +++ b/source/_integrations/comed_hourly_pricing.markdown @@ -15,7 +15,8 @@ The ComEd Hourly Pricing program is an optional program available to ComEd elect There are two price feeds available: the 5-minute price and current hour average price. -To use this sensor in your installation, add the following to your `configuration.yaml` file: +To use this sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index db47f832d30..5ded7287b20 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -19,6 +19,9 @@ ha_platforms: ha_integration_type: integration ha_codeowners: - '@gjohansson-ST' +related: + - docs: /docs/configuration/ + title: Configuration file --- The **Command line** {% term integration %} offers functionality that issues specific commands to get data or to control a device. diff --git a/source/_integrations/compensation.markdown b/source/_integrations/compensation.markdown index f71e9c18fa1..94bf44ee218 100644 --- a/source/_integrations/compensation.markdown +++ b/source/_integrations/compensation.markdown @@ -18,7 +18,8 @@ The **Compensation** {% term integration %} consumes the {% term state %} from o ## Configuration -To enable the compensation sensor, add the following lines to your `configuration.yaml`: +To enable the compensation sensor, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/concord232.markdown b/source/_integrations/concord232.markdown index 1aef7c46065..6d19f47f983 100644 --- a/source/_integrations/concord232.markdown +++ b/source/_integrations/concord232.markdown @@ -24,7 +24,8 @@ There is currently support for the following device types within Home Assistant: ## Alarm control panel -To enable the alarm control panel platform, add the following lines to your `configuration.yaml`: +To enable the alarm control panel platform, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/cppm_tracker.markdown b/source/_integrations/cppm_tracker.markdown index adbe1135f52..615842ce393 100644 --- a/source/_integrations/cppm_tracker.markdown +++ b/source/_integrations/cppm_tracker.markdown @@ -23,7 +23,8 @@ You must first create an API client [here](https://www.arubanetworks.com/techdoc -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/cups.markdown b/source/_integrations/cups.markdown index 15767eac74f..224a87d6c82 100644 --- a/source/_integrations/cups.markdown +++ b/source/_integrations/cups.markdown @@ -11,6 +11,9 @@ ha_domain: cups ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `cups` sensor platform uses the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the information using a CUPS server or by communicating directly with the printer with the Internet Printing Protocol. @@ -27,7 +30,8 @@ To set up the sensor the "Queue Name" of the printer is needed. The fastest way ## Configuration -To enable the CUPS sensor, add the following lines to your `configuration.yaml`: +To enable the CUPS sensor, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/currencylayer.markdown b/source/_integrations/currencylayer.markdown index c27e5bf39ca..bcdd1efd378 100644 --- a/source/_integrations/currencylayer.markdown +++ b/source/_integrations/currencylayer.markdown @@ -9,6 +9,9 @@ ha_domain: currencylayer ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 250 requests per month and updates daily. @@ -19,7 +22,8 @@ Obtain your API key from [here](https://currencylayer.com/product). ## Configuration -To enable this sensor, add the following lines to your `configuration.yaml` file: +To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry