@@ -25,7 +28,8 @@ FFmpeg doesn't have a motion detection filter, but can use a scene filter to det
## Configuration
-To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file:
+To add FFmpeg with motion detection 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/ffmpeg_noise.markdown b/source/_integrations/ffmpeg_noise.markdown
index 92d7ea2808a..dcc2d43bdd6 100644
--- a/source/_integrations/ffmpeg_noise.markdown
+++ b/source/_integrations/ffmpeg_noise.markdown
@@ -9,9 +9,12 @@ ha_domain: ffmpeg_noise
ha_platforms:
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](https://www.ffmpeg.org/) for various sensors in Home Assistant.
+The `ffmpeg` {% term integration %} allows you to use any video or audio feed with [FFmpeg](https://www.ffmpeg.org/) for various sensors in Home Assistant.
@@ -21,7 +24,8 @@ If the `ffmpeg` process is broken, the sensor will be unavailable. To control th
## Configuration
-To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:
+To add FFmpeg with noise detection 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/fido.markdown b/source/_integrations/fido.markdown
index e3f47fb8499..c34ac37454d 100644
--- a/source/_integrations/fido.markdown
+++ b/source/_integrations/fido.markdown
@@ -9,13 +9,17 @@ ha_domain: fido
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant.
## 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
diff --git a/source/_integrations/file.markdown b/source/_integrations/file.markdown
index 88fb0caf33c..458d208aae5 100644
--- a/source/_integrations/file.markdown
+++ b/source/_integrations/file.markdown
@@ -14,6 +14,9 @@ ha_platforms:
- notify
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
There is currently support for the following device types within Home Assistant:
@@ -23,9 +26,10 @@ There is currently support for the following device types within Home Assistant:
## Notifications
-The `file` platform allows you to store notifications from Home Assistant as a file.
+The `file` {% term integration %} allows you to store notifications from Home Assistant as a file.
-To enable file notifications in your installation, add the following to your `configuration.yaml` file:
+To enable file notifications 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/filter.markdown b/source/_integrations/filter.markdown
index 70e9650adef..e965ae3b2bf 100644
--- a/source/_integrations/filter.markdown
+++ b/source/_integrations/filter.markdown
@@ -13,9 +13,12 @@ ha_domain: filter
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `filter` platform enables sensors that process the states of other entities.
+The `filter` {% term integration %} enables sensors that process the states of other entities.
`filter` applies a signal processing algorithm to a sensor, previous and current states, and generates a `new state` given the chosen algorithm. The next image depicts an original sensor and the filter sensor of that same sensor using the [History Graph](/dashboards/history-graph/) integration.
@@ -25,7 +28,8 @@ The `filter` platform enables sensors that process the states of other entities.
## Configuration
-To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file:
+To enable Filter Sensors 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/fints.markdown b/source/_integrations/fints.markdown
index 8d2713f6fc2..defd7b76f6b 100644
--- a/source/_integrations/fints.markdown
+++ b/source/_integrations/fints.markdown
@@ -9,9 +9,12 @@ ha_domain: fints
ha_platforms:
- sensor
ha_integration_type: service
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
+With the FinTS {% term integration %}, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
## Configuration
@@ -19,6 +22,9 @@ To find out the configuration for your bank, check their website or call their h
For each account you have with the bank, a separate sensor is created. If you have several accounts with a bank, you can select which ones you want to have, and you can also give the accounts a name.
+To enable FinTS, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
sensor:
diff --git a/source/_integrations/fixer.markdown b/source/_integrations/fixer.markdown
index 8d499198c33..f22e524fd2a 100644
--- a/source/_integrations/fixer.markdown
+++ b/source/_integrations/fixer.markdown
@@ -9,9 +9,12 @@ ha_domain: fixer
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `fixer` sensor will show you the current exchange rate from [Fixer.io](https://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
+The `fixer` {% term integration %} will show you the current exchange rate from [Fixer.io](https://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
To get an overview about the available [currencies](https://fixer.io/symbols).
@@ -21,7 +24,8 @@ You need to create an [API key](https://apilayer.com/marketplace/fixer-api#prici
## Configuration
-To enable this sensor, add the following lines to your `configuration.yaml` file:
+To enable this {% term integration %}, 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/fleetgo.markdown b/source/_integrations/fleetgo.markdown
index 3929cdc2012..f0b4927444b 100644
--- a/source/_integrations/fleetgo.markdown
+++ b/source/_integrations/fleetgo.markdown
@@ -9,17 +9,21 @@ ha_domain: fleetgo
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `fleetgo` device tracker platform allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
+The `fleetgo` device tracker {% term integration %} allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
## Setup
-To use this integration, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
+To use this {% term integration %}, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration
-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/flexit.markdown b/source/_integrations/flexit.markdown
index 59746c7b512..174d6cf1c71 100644
--- a/source/_integrations/flexit.markdown
+++ b/source/_integrations/flexit.markdown
@@ -9,13 +9,17 @@ ha_domain: flexit
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrates [Flexit](https://www.flexit.no/en/) Air Conditioning unit into Home Assistant.
Requires an CI66 Modbus Adapter [CI66](https://www.flexit.no/en/products/air_handling_units_700-5000_m-h/accessories_ahu/modbusadapter_ci66/modbus_adapter_ci66_k2-c2-uni/)
-To enable this platform, add the following lines to your `configuration.yaml` file:
+To enable 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
diff --git a/source/_integrations/flic.markdown b/source/_integrations/flic.markdown
index a7fe1f436d2..c82ea30a571 100644
--- a/source/_integrations/flic.markdown
+++ b/source/_integrations/flic.markdown
@@ -9,11 +9,14 @@ ha_domain: flic
ha_platforms:
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `flic` platform allows you to receive click events from [flic](https://flic.io) smart buttons.
+The `flic` {% term integration %} allows you to receive click events from [flic](https://flic.io) smart buttons.
-The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
+The {% term integration %} does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
## Service setup
@@ -23,7 +26,8 @@ For instructions on how to install the service manually, visit the GitHub reposi
## Configuration
-To use your flic buttons in your installation, add the following to your `configuration.yaml` file:
+To use your flic buttons 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/flock.markdown b/source/_integrations/flock.markdown
index cb3ce746853..5ec0c2ec6f9 100644
--- a/source/_integrations/flock.markdown
+++ b/source/_integrations/flock.markdown
@@ -9,9 +9,12 @@ ha_domain: flock
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
+The `flock` integration uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
## Setup
@@ -29,7 +32,8 @@ You will need the last part of the URL which is the `access_token` for your room
## Configuration
-To add Flock notifications to your installation, add the following to your `configuration.yaml` file:
+To add Flock notifications 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/flume.markdown b/source/_integrations/flume.markdown
index 56216c0b645..62892c7813a 100644
--- a/source/_integrations/flume.markdown
+++ b/source/_integrations/flume.markdown
@@ -17,9 +17,12 @@ ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Flume integration will show you the current [Flume](https://flumewater.com/) status for the given Device ID.
+The Flume {% term integration %} will show you the current [Flume](https://flumewater.com/) status for the given Device ID.
Flume monitors the real-time status of your home water meter. Allowing the end-user to detect small leaks, gain real-time information on household water consumption, set water goals and budgets, and receive push notifications when suspicious water activities occur.
diff --git a/source/_integrations/flux.markdown b/source/_integrations/flux.markdown
index b1cdb3527ab..85a7e405881 100644
--- a/source/_integrations/flux.markdown
+++ b/source/_integrations/flux.markdown
@@ -10,11 +10,14 @@ ha_iot_class: Calculated
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. The `flux` switch restores its last state after startup.
+The `flux` switch {% term integration %} will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. The `flux` switch restores its last state after startup.
-The integration will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration.
+The {% term integration %} will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration.
During the day (in between `start_time` and `sunset_time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights periodically.
@@ -24,7 +27,8 @@ The color temperature is specified in kelvin, and accepted values are between 10
If you want to update at variable intervals, you can leave the switch turned off and use automation rules that call the service `switch.
_update` whenever you want the lights updated, where `` equals the `name:` property in the switch configuration.
-To use the Flux switch in your installation, add the following to your `configuration.yaml` file:
+To use the Flux switch 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/fortios.markdown b/source/_integrations/fortios.markdown
index 1e4d66b4b47..acfd719c029 100644
--- a/source/_integrations/fortios.markdown
+++ b/source/_integrations/fortios.markdown
@@ -11,20 +11,25 @@ ha_platforms:
ha_codeowners:
- '@kimfrellsen'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The FortiOS presence detection enables Home Assistant to track devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com).
-The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). It has been verified on FortiGate appliances and FortiGate VM running FortiOS v. 6.4.x (up to 6.4.8), 7.0.x (up to 7.0.4) and 7.2.0.
+The {% term integration %} relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). It has been verified on FortiGate appliances and FortiGate VM running FortiOS v. 6.4.x (up to 6.4.8), 7.0.x (up to 7.0.4) and 7.2.0.
The minimum version supported is FortiOS 6.4.3.
All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and Wi-Fi devices, including devices detected by LLDP.
-The integration is based on the Home Assistant `device_tracker` platform.
+The {% term integration %} is based on the Home Assistant `device_tracker` platform.
-### Example configuration:
+### Example configuration
-This example uses the FortiOS integration as a device tracker, with an API token and does not verify the SSL certificate.
+This example uses the FortiOS {% term integration %} as a device tracker, with an API token and does not verify the SSL certificate.
+Add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml
diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown
index d088f2ec9f2..e5567e14225 100644
--- a/source/_integrations/foursquare.markdown
+++ b/source/_integrations/foursquare.markdown
@@ -7,9 +7,15 @@ ha_release: 0.26
ha_iot_class: Cloud Push
ha_domain: foursquare
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `foursquare` integration accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm.
+The `foursquare` {% term integration %} accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm.
+
+To enable Foursquare, 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/free_mobile.markdown b/source/_integrations/free_mobile.markdown
index c203c03c1f7..0a5f30e9fba 100644
--- a/source/_integrations/free_mobile.markdown
+++ b/source/_integrations/free_mobile.markdown
@@ -9,9 +9,12 @@ ha_domain: free_mobile
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `free_mobile` platform uses the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone.
+The `free_mobile` {% term integration %} uses the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone.
## Prerequisites
@@ -29,7 +32,8 @@ If you disable and re-enable the SMS API option, please be sure to update your t
## Configuration
-To use this notification platform in your installation, add the following to your `configuration.yaml` file:
+To use this notification 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/freedns.markdown b/source/_integrations/freedns.markdown
index c75063ddd6a..5522c1af716 100644
--- a/source/_integrations/freedns.markdown
+++ b/source/_integrations/freedns.markdown
@@ -9,7 +9,7 @@ ha_domain: freedns
ha_integration_type: integration
---
-With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date.
+With the `freedns` {% term integration %} you can keep your [FreeDNS](https://freedns.afraid.org) record up to date.
## Setup (Default API V1)
@@ -24,7 +24,8 @@ You need to determine your update URL or your access token.
## Configuration (API V1)
-To use the integration in your installation, add the following to your `configuration.yaml` file:
+To use the {% term integration %} 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/frontier_silicon.markdown b/source/_integrations/frontier_silicon.markdown
index 709c0810454..57ddc4efab9 100644
--- a/source/_integrations/frontier_silicon.markdown
+++ b/source/_integrations/frontier_silicon.markdown
@@ -15,7 +15,7 @@ ha_ssdp: true
ha_config_flow: true
---
-This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the OKTIV or UNDOK apps.
+This {% term integration %} provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the OKTIV or UNDOK apps.
## Supported models
@@ -31,13 +31,13 @@ Supported devices include, but are not limited to:
- TechniSat: [DIGITRADIO 10 IR], and some other models
- Some models from: Auna, Revo, Pinell, Como Audio
-This integration was developed and tested with a [Roberts Stream 94i].
+This {% term integration %} was developed and tested with a [Roberts Stream 94i].
If your device is supported by the OKTIV or UNDOK apps, then it is also supported by this integration.
## Prerequisites
-The integration supports automatic discovery of your Internet Radio. If you need to set up the device manually, please provide the device IP-address. Some models use a separate port (2244) for API access, this can be verified by visiting `http://[host]:[port]/device`.
+The {% term integration %} supports automatic discovery of your Internet Radio. If you need to set up the device manually, please provide the device IP-address. Some models use a separate port (2244) for API access, this can be verified by visiting `http://[host]:[port]/device`.
The default PIN for Frontier Silicon-based devices is 1234. You can set the PIN code of your device (depending on manufacturer) under:
*MENU button > Main Menu > System setting > Network > NetRemote PIN setup*
@@ -76,7 +76,7 @@ Overview of the info dialog:
-Some older devices may require setting up a session to process requests. This is automatically detected by the underlying library. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated.
+Some older devices may require setting up a session to process requests. This is automatically detected by the underlying library. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated.
This renders the usage of [UNDOK] almost impossible for these older devices, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session. In that case, you have to disable the integration if you want to use UNDOK.
diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown
index b1807f5a6d5..2ccf6263bec 100644
--- a/source/_integrations/futurenow.markdown
+++ b/source/_integrations/futurenow.markdown
@@ -9,15 +9,20 @@ ha_domain: futurenow
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `futurenow` light platform allows you to use [P5](https://www.p5.hu/) FutureNow relay/dimmer units as lights. Currently supported units:
+The `futurenow` light {% term integration %} allows you to use [P5](https://www.p5.hu/) FutureNow relay/dimmer units as lights. Currently supported units:
+
- [FutureNow FNIP-6x2AD](https://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only)
- [FutureNow FNIP-8x10A](https://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only)
### Configuration Sample
-To use your FutureNow units, add the following to your `configuration.yaml` file:
+To use your FutureNow units, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry