diff --git a/source/_integrations/baidu.markdown b/source/_integrations/baidu.markdown index 829677aa09d..e938ec2f958 100644 --- a/source/_integrations/baidu.markdown +++ b/source/_integrations/baidu.markdown @@ -9,13 +9,17 @@ ha_domain: baidu ha_platforms: - tts ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices. ## Configuration -To get started, add the following lines to your `configuration.yaml`: +To get started, 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/bayesian.markdown b/source/_integrations/bayesian.markdown index 187aca26a54..66efb3fb525 100644 --- a/source/_integrations/bayesian.markdown +++ b/source/_integrations/bayesian.markdown @@ -13,6 +13,9 @@ ha_platforms: ha_integration_type: integration ha_codeowners: - '@HarvsG' +related: + - docs: /docs/configuration/ + title: Configuration file --- The `bayesian` binary sensor platform observes the state from multiple sensors. It uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event is occurring given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on`; otherwise, it is `off`. @@ -38,7 +41,8 @@ In the configuration use the probability of the observation (the sensor state in ## Configuration -To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: +To enable the Bayesian 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/bbox.markdown b/source/_integrations/bbox.markdown index d060b9fcc8c..8d82bde2674 100644 --- a/source/_integrations/bbox.markdown +++ b/source/_integrations/bbox.markdown @@ -12,6 +12,9 @@ ha_platforms: - device_tracker - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `bbox` platform uses the [Bbox Modem Router](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures. @@ -35,7 +38,8 @@ Bbox is a generic name for different hardware routers. The platform has been tes ### Configuration -To use an Bbox router in your installation, add the following to your `configuration.yaml` file: +To use an Bbox router 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/beewi_smartclim.markdown b/source/_integrations/beewi_smartclim.markdown index 4a90979176b..06543cbda56 100644 --- a/source/_integrations/beewi_smartclim.markdown +++ b/source/_integrations/beewi_smartclim.markdown @@ -11,6 +11,9 @@ ha_domain: beewi_smartclim ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `beewi_smartclim` sensor platform allows one to monitor room or external temperature and humidity. The BeeWi SmartClim BLE is a Bluetooth Low Energy sensor device that monitors temperature from a room or a garden from your smartphone by using an APP. Use this integration to track these metrics from any location thanks to Home Assistant, as well as to create some automation scripts based on your room's temperature. @@ -48,7 +51,8 @@ Discovery started Check for `BeeWi SmartClim` or similar entries, those are your sensor. -To use your Mi Temperature and Humidity sensor in your installation, add the following to your `configuration.yaml` file: +To use your Mi Temperature and Humidity 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/bitcoin.markdown b/source/_integrations/bitcoin.markdown index 0726e020e31..3536899ceb5 100644 --- a/source/_integrations/bitcoin.markdown +++ b/source/_integrations/bitcoin.markdown @@ -9,11 +9,15 @@ ha_domain: bitcoin ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `bitcoin` sensor platform displays various details about the [Bitcoin](https://bitcoin.org) network. -To add the Bitcoin sensor to your installation, add a selection of the available display options to your `configuration.yaml` file: +To add the Bitcoin sensor to your installation, add a selection of the available display options to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/bizkaibus.markdown b/source/_integrations/bizkaibus.markdown index 3bec914050e..e119e330ca4 100644 --- a/source/_integrations/bizkaibus.markdown +++ b/source/_integrations/bizkaibus.markdown @@ -12,6 +12,9 @@ ha_domain: bizkaibus ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `bizkaibus` sensor will give you the time until the next bus in the selected stop. @@ -20,7 +23,8 @@ The next website can help to determine the id of your bus stop. You can check if For a correct use of the sensor the selected route must stop in the selected stop. -Then add the data to your `configuration.yaml` file as shown in the example: +Then add the data to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/blackbird.markdown b/source/_integrations/blackbird.markdown index aaef4de7f68..34d800efc72 100644 --- a/source/_integrations/blackbird.markdown +++ b/source/_integrations/blackbird.markdown @@ -9,11 +9,15 @@ ha_domain: blackbird ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) (8x8) using a serial or IP connection, this integration does not support the 4x4 matrix switch. -To add a Blackbird 8x8 device to your installation, add the following to your `configuration.yaml` file: +To add a Blackbird 8x8 device 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 @@ -59,7 +63,7 @@ sources: Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | String that points at an `entity_id` of a zone. -| `source` | no | String of source name to activate. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| `entity_id` | yes | String that points at an `entity_id` of a zone. | +| `source` | no | String of source name to activate. | diff --git a/source/_integrations/blinksticklight.markdown b/source/_integrations/blinksticklight.markdown index f1086ec1277..106a3921654 100644 --- a/source/_integrations/blinksticklight.markdown +++ b/source/_integrations/blinksticklight.markdown @@ -9,6 +9,9 @@ ha_domain: blinksticklight ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. @@ -23,7 +26,8 @@ sudo blinkstick --add-udev-rule ## Configuration -To add a Blinkstick to your installation, add the following to your `configuration.yaml` file: +To add a Blinkstick 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 diff --git a/source/_integrations/blockchain.markdown b/source/_integrations/blockchain.markdown index f51bf3c150a..8e9a1cbf444 100644 --- a/source/_integrations/blockchain.markdown +++ b/source/_integrations/blockchain.markdown @@ -9,11 +9,15 @@ ha_domain: blockchain ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `Blockchain` sensor platform displays Bitcoin wallet balances from [blockchain.com](https://blockchain.com). -To add the Blockchain sensor to your installation, specify a list of bitcoin addresses to watch in the `configuration.yaml` file. The sensor state will be the sum of the balances of all addresses listed. +To add the Blockchain sensor to your installation, specify a list of bitcoin addresses to watch in the {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %}. The sensor state will be the sum of the balances of all addresses listed. Currently, the original Bitcoin address format is supported. For example, the newer Segwit and Taproot format are not supported. diff --git a/source/_integrations/bloomsky.markdown b/source/_integrations/bloomsky.markdown index a56e6e01b6b..c881df51f85 100644 --- a/source/_integrations/bloomsky.markdown +++ b/source/_integrations/bloomsky.markdown @@ -15,6 +15,9 @@ ha_platforms: - camera - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The **BloomSky** {% term integration %} allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. @@ -31,7 +34,8 @@ Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.co ## Configuration -To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: +To integrate your BloomSky hub with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/bluesound.markdown b/source/_integrations/bluesound.markdown index 7f96c63b25e..15a44ef2302 100644 --- a/source/_integrations/bluesound.markdown +++ b/source/_integrations/bluesound.markdown @@ -11,11 +11,15 @@ ha_platforms: ha_codeowners: - '@thrawnarn' ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `bluesound` platform allows you to control your [Bluesound](https://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant. -To manually add a Bluesound device to your installation, add the following to your `configuration.yaml` file: +To manually add a Bluesound device to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml @@ -63,32 +67,32 @@ media_player: Group players together under a single master speaker. That will make a new group or join an existing group. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `master` | no | A single `entity_id` that will become/hold the master speaker. -| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------------- | +| `master` | no | A single `entity_id` that will become/hold the master speaker. | +| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. | ### Service `bluesound.unjoin` Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------------------------------------- | +| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. | ### Service `bluesound.set_sleep_timer` Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0. If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0). -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of `entity_id`s that will have their timers set. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------- | +| `entity_id` | no | String or list of `entity_id`s that will have their timers set. | ### Service `bluesound.clear_sleep_timer` Clear the sleep timer on a speaker, if one is set. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------- | +| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. | diff --git a/source/_integrations/bluetooth.markdown b/source/_integrations/bluetooth.markdown index 7638b828528..56c5a0cdd4b 100644 --- a/source/_integrations/bluetooth.markdown +++ b/source/_integrations/bluetooth.markdown @@ -27,7 +27,8 @@ Suppose a Bluetooth proxy is not a good fit for your use case. Consider using th ## Configuration -While this integration is part of [`default_config:`](/integrations/default_config/) to enable automatic discovery of the Bluetooth Adapter, it will only be enabled by setting up the configuration flow, or manually adding it to your `configuration.yaml`. +While this integration is part of [`default_config:`](/integrations/default_config/) to enable automatic discovery of the Bluetooth Adapter, it will only be enabled by setting up the configuration flow, or manually adding it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/bluetooth_le_tracker.markdown b/source/_integrations/bluetooth_le_tracker.markdown index bdd5fef0122..83cbd4e2994 100644 --- a/source/_integrations/bluetooth_le_tracker.markdown +++ b/source/_integrations/bluetooth_le_tracker.markdown @@ -9,6 +9,9 @@ ha_domain: bluetooth_le_tracker ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other. @@ -21,7 +24,8 @@ This {% term integration %} requires the [Bluetooth](/integrations/bluetooth) in ## Configuration -To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file: +To use the Bluetooth 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/bluetooth_tracker.markdown b/source/_integrations/bluetooth_tracker.markdown index 8be816b65f0..3f18b8d86cf 100644 --- a/source/_integrations/bluetooth_tracker.markdown +++ b/source/_integrations/bluetooth_tracker.markdown @@ -23,7 +23,8 @@ sudo apt install bluetooth libbluetooth-dev {% enddetails %} -To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file: +To use the Bluetooth 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/broadlink.markdown b/source/_integrations/broadlink.markdown index 9b42213f718..85c0a56afea 100644 --- a/source/_integrations/broadlink.markdown +++ b/source/_integrations/broadlink.markdown @@ -24,6 +24,9 @@ ha_platforms: - switch ha_dhcp: true ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The **Broadlink** {% term integration %} allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported: diff --git a/source/_integrations/browser.markdown b/source/_integrations/browser.markdown index 5f9da4012d2..0e19a364a2d 100644 --- a/source/_integrations/browser.markdown +++ b/source/_integrations/browser.markdown @@ -8,13 +8,17 @@ ha_iot_class: Local Push ha_quality_scale: internal ha_domain: browser ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The **Browser** {% term integration %} provides a service to open URLs in the default browser on the host machine. ## Configuration -To load this integration, add the following lines to your `configuration.yaml`: +To load this integration, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -27,9 +31,9 @@ Once loaded, the `browser` platform will expose {% term services %} that can be Available services: `browser/browse_url`. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `url` | no | The URL to open. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------- | +| `url` | no | The URL to open. | ### Usage diff --git a/source/_integrations/bt_home_hub_5.markdown b/source/_integrations/bt_home_hub_5.markdown index 9d4182854dd..1f8d6cc8c3a 100644 --- a/source/_integrations/bt_home_hub_5.markdown +++ b/source/_integrations/bt_home_hub_5.markdown @@ -9,11 +9,15 @@ ha_iot_class: Local Polling ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router. -To use a BT Home Hub 5 router in your installation, add the following to your `configuration.yaml` file: +To use a BT Home Hub 5 router 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/bt_smarthub.markdown b/source/_integrations/bt_smarthub.markdown index 7374ab438fd..e68cf408993 100644 --- a/source/_integrations/bt_smarthub.markdown +++ b/source/_integrations/bt_smarthub.markdown @@ -11,6 +11,9 @@ ha_domain: bt_smarthub ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router. @@ -18,7 +21,8 @@ This router is sometimes referred to as the BT Home Hub 6. ## Configuration -To use a BT Smart Hub router in your installation, add the following to your `configuration.yaml` file: +To use a BT Smart Hub router 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