-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
diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown
index c0eb9c43ff4..b1c5d1115b6 100644
--- a/source/_integrations/garadget.markdown
+++ b/source/_integrations/garadget.markdown
@@ -9,13 +9,17 @@ ha_domain: garadget
ha_platforms:
- cover
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `garadget` cover platform lets you control [Garadget](https://www.garadget.com/) garage door futurizers through Home Assistant.
+The `garadget` cover {% term integration %} lets you control [Garadget](https://www.garadget.com/) garage door futurizers through Home Assistant.
## Configuration
-To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file:
+To enable Garadget Covers 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/gc100.markdown b/source/_integrations/gc100.markdown
index 82d9ef4aece..147631cb25c 100644
--- a/source/_integrations/gc100.markdown
+++ b/source/_integrations/gc100.markdown
@@ -12,6 +12,9 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The Global Caché GC-100 can be integrated into Home Assistant. GC-100 is a TCP-controllable
@@ -27,7 +30,8 @@ Currently, only relays and ports configured to be digital inputs are supported i
## Configuration
-To enable this device, add the following lines to your `configuration.yaml`:
+To enable this device, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -73,7 +77,8 @@ ports:
This allows you to control and monitor the relay state on your GC100.
-To enable this switch, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
+To enable this switch, you first have to set up [gc100](#configuration), and 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/generic_hygrostat.markdown b/source/_integrations/generic_hygrostat.markdown
index 3eab325e82e..19b029548d5 100644
--- a/source/_integrations/generic_hygrostat.markdown
+++ b/source/_integrations/generic_hygrostat.markdown
@@ -12,9 +12,15 @@ ha_iot_class: Local Polling
ha_platforms:
- humidifier
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `generic_hygrostat` humidifier integration is a virtual hygrostat implemented in Home Assistant. It uses a sensor and a switch connected to a humidifier or dehumidifier under the hood. When in humidifier mode, if the measured humidity is less than the target humidity, the humidifier will be turned on and turned off when the required humidity is reached. When in dehumidifier mode, if the measured humidity is greater than the target humidity, the dehumidifier will be turned on and turned off when required humidity is reached. One Generic Hygrostat entity can only control one switch. If you need to activate two switches, one for a humidifier and one for a dehumidifier, you will need two Generic Hygrostat entities.
+The `generic_hygrostat` humidifier {% term integration %} is a virtual hygrostat implemented in Home Assistant. It uses a sensor and a switch connected to a humidifier or dehumidifier under the hood. When in humidifier mode, if the measured humidity is less than the target humidity, the humidifier will be turned on and turned off when the required humidity is reached. When in dehumidifier mode, if the measured humidity is greater than the target humidity, the dehumidifier will be turned on and turned off when required humidity is reached. One Generic Hygrostat entity can only control one switch. If you need to activate two switches, one for a humidifier and one for a dehumidifier, you will need two Generic Hygrostat entities.
+
+To enable the {% term integration %}, you need to add 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/generic_thermostat.markdown b/source/_integrations/generic_thermostat.markdown
index 2ad00f82897..bcb9faa7924 100644
--- a/source/_integrations/generic_thermostat.markdown
+++ b/source/_integrations/generic_thermostat.markdown
@@ -9,9 +9,15 @@ ha_domain: generic_thermostat
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities.
+The `generic_thermostat` climate {% term integration %} is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities.
+
+To enable the {% term integration %}, you need to add 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/geo_rss_events.markdown b/source/_integrations/geo_rss_events.markdown
index 314fb06d955..568a53dc25c 100644
--- a/source/_integrations/geo_rss_events.markdown
+++ b/source/_integrations/geo_rss_events.markdown
@@ -11,11 +11,14 @@ ha_domain: geo_rss_events
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `geo_rss_events` sensor retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category.
+The `geo_rss_events` {% term integration %} retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category.
-This sensor is particularly useful if events occur unexpectedly in the vicinity of the home while the GeoRSS feed also contains many events representing distant unrelated entries. Typical examples are bush fires alerts or earthquakes.
+This {% term integration %} is particularly useful if events occur unexpectedly in the vicinity of the home while the GeoRSS feed also contains many events representing distant unrelated entries. Typical examples are bush fires alerts or earthquakes.
@@ -29,7 +32,9 @@ The data is updated every 5 minutes.
## Configuration
-To enable the GeoRSS events sensor, add the following lines to your `configuration.yaml`. This is an example configuration showing bush fire incidents from the NSW Rural Fire Service.
+To enable the GeoRSS events sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
+This is an example configuration showing bush fire incidents from the NSW Rural Fire Service.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/geofency.markdown b/source/_integrations/geofency.markdown
index f8216feb53f..c9eb67cfa56 100644
--- a/source/_integrations/geofency.markdown
+++ b/source/_integrations/geofency.markdown
@@ -10,9 +10,12 @@ ha_domain: geofency
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This integration sets up integration with [Geofency](https://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
+This {% term integration %} sets up integration with [Geofency](https://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
## Configuration
@@ -20,7 +23,8 @@ To configure Geofency, you must set it up via the integrations panel in the conf
Geofency will automatically generate the device tracker name used for geofences, and you will find it in the integrations section after the first request. For beacons, the device name will be `beacon_`, e.g., `device_tracker.beacon_car`.
-When using mobile beacons (optional) an entry in `configuration.yaml` is still needed as this can't be added via the integrations panel.
+When using mobile beacons (optional) an entry in {% term "`configuration.yaml`" %} file is still needed as this can't be added via the integrations panel.
+{% include integrations/restart_ha_after_config_inclusion.md %}
{% configuration %}
mobile_beacons:
diff --git a/source/_integrations/gitlab_ci.markdown b/source/_integrations/gitlab_ci.markdown
index 725559091d1..6aa38468993 100644
--- a/source/_integrations/gitlab_ci.markdown
+++ b/source/_integrations/gitlab_ci.markdown
@@ -9,9 +9,12 @@ ha_domain: gitlab_ci
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
+The `gitlab_ci` sensor {% term integration %} integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
## Setup
@@ -23,7 +26,8 @@ A GitLab token with at least the API permission scope is needed, which can be cr
## Configuration
-To enable this platform, please add the following to your `configuration.yaml` file:
+To enable this {% term integration %}, please 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/gitter.markdown b/source/_integrations/gitter.markdown
index 6222dc77709..daddc2ffe97 100644
--- a/source/_integrations/gitter.markdown
+++ b/source/_integrations/gitter.markdown
@@ -9,15 +9,19 @@ ha_domain: gitter
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
+This `gitter` {% term integration %} allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
## Configuration
Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".
-To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
+To use a Gitter {% 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/google_domains.markdown b/source/_integrations/google_domains.markdown
index 8225ca63c47..0aaa8b7cb83 100644
--- a/source/_integrations/google_domains.markdown
+++ b/source/_integrations/google_domains.markdown
@@ -7,13 +7,17 @@ ha_release: 0.57
ha_domain: google_domains
ha_iot_class: Cloud Polling
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-With the Google Domains integration you can keep your Google Domains **dynamic** DNS record up to date. To setup a dynamic domain name using Goole Domains, refer to the [_Use Dynamic DNS_ section in the Google support documentation](https://support.google.com/domains/answer/6147083).
+With the Google Domains {% term integration %} you can keep your Google Domains **dynamic** DNS record up to date. To setup a dynamic domain name using Goole Domains, refer to the [_Use Dynamic DNS_ section in the Google support documentation](https://support.google.com/domains/answer/6147083).
## Configuration
-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/google_maps.markdown b/source/_integrations/google_maps.markdown
index 5de714d2fcd..48695ee03df 100644
--- a/source/_integrations/google_maps.markdown
+++ b/source/_integrations/google_maps.markdown
@@ -9,9 +9,12 @@ ha_domain: google_maps
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
+The `google_maps` {% term integration %} allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
## Setup
@@ -44,7 +47,8 @@ If using more than one account, your own device may show twice, however, the par
## Configuration
-To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate Google Maps Location Sharing in 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/google_pubsub.markdown b/source/_integrations/google_pubsub.markdown
index bfa0c55f7c3..529defa3909 100644
--- a/source/_integrations/google_pubsub.markdown
+++ b/source/_integrations/google_pubsub.markdown
@@ -7,9 +7,12 @@ ha_release: 0.88
ha_iot_class: Cloud Push
ha_domain: google_pubsub
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month).
+The `google_pubsub` {% term integration %} allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month).
## First time setup
@@ -26,7 +29,8 @@ This will download the Service Account JSON key to your machine. Do NOT share th
## Configuration
-Add the following lines to your `configuration.yaml` file:
+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/google_wifi.markdown b/source/_integrations/google_wifi.markdown
index 0f1027e273d..05c9dedbfff 100644
--- a/source/_integrations/google_wifi.markdown
+++ b/source/_integrations/google_wifi.markdown
@@ -9,13 +9,17 @@ ha_domain: google_wifi
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `google_wifi` sensor platform is displaying the exposed status of a Google Wifi (or OnHub) router.
+The `google_wifi` sensor {% term integration %} is displaying the exposed status of a Google Wifi (or OnHub) router.
-The sensor is able to report network status, up-time, current IP address and firmware versions.
+The {% term integration %} is able to report network status, up-time, current IP address and firmware versions.
-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/graphite.markdown b/source/_integrations/graphite.markdown
index bfe32219780..68df583d119 100644
--- a/source/_integrations/graphite.markdown
+++ b/source/_integrations/graphite.markdown
@@ -7,11 +7,15 @@ ha_release: 0.13
ha_domain: graphite
ha_iot_class: Local Push
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphiteapp.org/) instance.
+The `graphite` {% term integration %} records all events and state changes and feeds the data to a [graphite](http://graphiteapp.org/) instance.
-To enable this integration, add the following lines to your `configuration.yaml`:
+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/greeneye_monitor.markdown b/source/_integrations/greeneye_monitor.markdown
index 948c672abba..68af3aba56c 100644
--- a/source/_integrations/greeneye_monitor.markdown
+++ b/source/_integrations/greeneye_monitor.markdown
@@ -13,11 +13,15 @@ ha_domain: greeneye_monitor
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The [GreenEye Monitor (GEM)](https://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations.
+The [GreenEye Monitor (GEM)](https://www.brultech.com/greeneye/) {% term integration %} for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations.
-Configure your GEM(s) to produce binary-format packets (for example, "Bin32 NET" for a 32-channel GEM with some channels configured for net metering) and send them to an unused port on your Home Assistant machine. (These settings are in the "Packet Send" and "Network" pages of the GEM UI.) Then specify that port and information about your monitor(s) and the data channels you wish to monitor in your `configuration.yaml`:
+Configure your GEM(s) to produce binary-format packets (for example, "Bin32 NET" for a 32-channel GEM with some channels configured for net metering) and send them to an unused port on your Home Assistant machine. (These settings are in the "Packet Send" and "Network" pages of the GEM UI.) Then specify that port and information about your monitor(s) and the data channels you wish to monitor in your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/gstreamer.markdown b/source/_integrations/gstreamer.markdown
index 6f15cabbb1b..572eecf178e 100644
--- a/source/_integrations/gstreamer.markdown
+++ b/source/_integrations/gstreamer.markdown
@@ -9,11 +9,15 @@ ha_domain: gstreamer
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `gstreamer` platform allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.
+The `gstreamer` {% term integration %} allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.
-To add a `gstreamer` media player to your installation, add the following to your `configuration.yaml` file:
+To add a `gstreamer` media player 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/gtfs.markdown b/source/_integrations/gtfs.markdown
index 019c7672cfd..6d8f520957c 100644
--- a/source/_integrations/gtfs.markdown
+++ b/source/_integrations/gtfs.markdown
@@ -9,9 +9,12 @@ ha_domain: gtfs
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `gtfs` sensor will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS.
+The `gtfs` {% term integration %} will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS.
You need to find a valid GTFS data set, which you can usually find just by searching the internet. Most public transit authorities have GTFS available somewhere, as Google requires public transit authorities to provide the data if they wish to appear on Google Maps. You may also be able to find data at [TransitFeeds](https://transitfeeds.com/feeds).
@@ -35,6 +38,9 @@ Your mileage may vary depending on the transit agency used. Most agencies respec
**Please note**: This is a _static_ data source. Currently, there is no GTFS Realtime support in this sensor due to issues surrounding parsing the protocol buffer format in Python 3. Once those issues have been fixed Realtime support will be added. Once added, the sensor will check for any delays and advisories and report them in the sensor as needed.
+To enable the GTFS {% term integration %}, you need to add it 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/harman_kardon_avr.markdown b/source/_integrations/harman_kardon_avr.markdown
index f4c3077e287..eb899447eb6 100644
--- a/source/_integrations/harman_kardon_avr.markdown
+++ b/source/_integrations/harman_kardon_avr.markdown
@@ -9,6 +9,9 @@ ha_domain: harman_kardon_avr
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `harman_kardon_avr` platform allows you to control Harman Kardon Network Receivers from Home Assistant.
@@ -18,7 +21,8 @@ Supported devices:
- Harman Kardon AVR-151S
- Other Harman Kardon AVR receivers (untested)
-To add a Harman Kardon Network Receiver to your installation, add the following to your `configuration.yaml` file:
+To add a Harman Kardon Network Receiver 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/haveibeenpwned.markdown b/source/_integrations/haveibeenpwned.markdown
index ea796232e8c..48cb979330f 100644
--- a/source/_integrations/haveibeenpwned.markdown
+++ b/source/_integrations/haveibeenpwned.markdown
@@ -9,9 +9,12 @@ ha_domain: haveibeenpwned
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).
+The `haveibeenpwned` sensor {% term integration %} creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).
## Configuration
@@ -19,7 +22,8 @@ In order to use this integration you need to purchase an API key. Visit the [API
## Configuration
-To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing the number of breaches on that email account.
+To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file. It will list every specified email address as a sensor showing the number of breaches on that email account.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry using cloud based emoncms
diff --git a/source/_integrations/hddtemp.markdown b/source/_integrations/hddtemp.markdown
index 4f6bc851ef0..73e057c3a62 100644
--- a/source/_integrations/hddtemp.markdown
+++ b/source/_integrations/hddtemp.markdown
@@ -9,9 +9,12 @@ ha_domain: hddtemp
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `hddtemp` sensor platform is using the data provided by [HDDTemp](https://savannah.nongnu.org/projects/hddtemp).
+The `hddtemp` sensor {% term integration %} is using the data provided by [HDDTemp](https://savannah.nongnu.org/projects/hddtemp).
## Setup
@@ -30,7 +33,8 @@ hddtemp -dF
## Configuration
-To setup a HDDTemp to your installation, add the following to your `configuration.yaml` file:
+To setup a HDDTemp 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/hikvisioncam.markdown b/source/_integrations/hikvisioncam.markdown
index 85d6d0f2d14..dad7e7a9618 100644
--- a/source/_integrations/hikvisioncam.markdown
+++ b/source/_integrations/hikvisioncam.markdown
@@ -11,15 +11,19 @@ ha_domain: hikvisioncam
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `hikvisioncam` switch platform allows you to control your motion detection setting on your [Hikvision](https://www.hikvision.com/) camera.
+This `hikvisioncam` switch {% term integration %} allows you to control your motion detection setting on your [Hikvision](https://www.hikvision.com/) camera.
Currently works using default https port only.
-To use your Hikvision cam in your installation, add the following to your `configuration.yaml` file:
+To use your Hikvision cam 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/history_stats.markdown b/source/_integrations/history_stats.markdown
index 5cabd7d3e59..cbcac3f108f 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -11,11 +11,14 @@ ha_domain: history_stats
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **History stats** {% term integration %} provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
-It can track how long the integration has been in a specific state, in a custom time period.
+It can track how long the {% term integration %} has been in a specific state, in a custom time period.
Examples of what you can track:
@@ -25,7 +28,8 @@ Examples of what you can track:
## Configuration
-To enable the history statistics sensor, add the following lines to your `configuration.yaml`:
+To enable the history statistics sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
{% raw %}
diff --git a/source/_integrations/hitron_coda.markdown b/source/_integrations/hitron_coda.markdown
index e205d8dc511..168befeb826 100644
--- a/source/_integrations/hitron_coda.markdown
+++ b/source/_integrations/hitron_coda.markdown
@@ -14,7 +14,8 @@ ha_integration_type: integration
This integration offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3)
or [Shaw Hitron CGNM](https://community.shaw.ca/docs/DOC-4066) Router.
-To use a Hitron router in your installation, add the following to your `configuration.yaml` file:
+To use a Hitron 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/homematic.markdown b/source/_integrations/homematic.markdown
index 10d27e1bb93..cbdcf2ddac8 100644
--- a/source/_integrations/homematic.markdown
+++ b/source/_integrations/homematic.markdown
@@ -26,9 +26,12 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The [Homematic](https://www.eq-3.com/products/homematic.html) integration provides bi-directional communication with your CCU/Homegear. It uses an XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
+The [Homematic](https://www.eq-3.com/products/homematic.html) {% term integration %} provides bi-directional communication with your CCU/Homegear. It uses an XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
If you are using Homegear with paired [Intertechno](https://intertechno.at/) devices, uni-directional communication is possible as well.
There is currently support for the following device types within Home Assistant:
@@ -57,7 +60,8 @@ You can manually rename the created entities by using Home Assistant's [Customiz
## Configuration
-To set up the integration, add the following information to your `configuration.yaml` file:
+To set up the integration, add the following information to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
homematic:
diff --git a/source/_integrations/horizon.markdown b/source/_integrations/horizon.markdown
index ca43d588fdd..d6dbb0e74b4 100644
--- a/source/_integrations/horizon.markdown
+++ b/source/_integrations/horizon.markdown
@@ -9,11 +9,15 @@ ha_domain: horizon
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `horizon` integration allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant.
+The `horizon` {% term integration %} allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant.
-To add a Horizon HD Recorder to your installation, add the following to your `configuration.yaml` file:
+To add a Horizon HD Recorder 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
@@ -37,7 +41,6 @@ media_player:
type: string
{% endconfiguration %}
-
#### Preparation of the Horizon HD Recorder
The Home Networking ("Heimnetzwerk") service needs to be enabled at the settings menu of the Horizon receiver. Once you have set up the Media Library ("Medienbibliothek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start.
diff --git a/source/_integrations/hp_ilo.markdown b/source/_integrations/hp_ilo.markdown
index d25414cb672..47948af801b 100644
--- a/source/_integrations/hp_ilo.markdown
+++ b/source/_integrations/hp_ilo.markdown
@@ -9,9 +9,12 @@ ha_domain: hp_ilo
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors.
+The `hp_ilo` {% term integration %} allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors.
If the ILO or specified jsonpath query returns only a single value (e.g., a temperature or state), it will be put in the state field. If a data structure is returned, it will be placed in the `ilo_data` attribute.
@@ -23,7 +26,8 @@ Some more details about what can be retrieved from these sensors is available in
## Configuration
-To use this integration in your installation, add the following to your `configuration.yaml` file:
+To use this 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/html5.markdown b/source/_integrations/html5.markdown
index 201fcbedc1f..65c93305410 100644
--- a/source/_integrations/html5.markdown
+++ b/source/_integrations/html5.markdown
@@ -9,9 +9,12 @@ ha_domain: html5
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `html5` notification platform enables you to receive push notifications to Chrome or Firefox, no matter where you are in the world. `html5` also supports Chrome and Firefox on Android, which enables native-app-like integrations without actually needing a native app.
+The `html5` notification {% term integration %} enables you to receive push notifications to Chrome or Firefox, no matter where you are in the world. `html5` also supports Chrome and Firefox on Android, which enables native-app-like integrations without actually needing a native app.
@@ -21,7 +24,8 @@ HTML5 push notifications **do not** work on iOS versions below 16.4.
## Configuration
-To enable this platform, add the following lines to your `configuration.yaml` file:
+To enable this 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/husqvarna_automower.markdown b/source/_integrations/husqvarna_automower.markdown
index 8e51bd69b23..03b01a9cd83 100644
--- a/source/_integrations/husqvarna_automower.markdown
+++ b/source/_integrations/husqvarna_automower.markdown
@@ -113,7 +113,14 @@ The integration will create a lawn mower entity to control the mower. This entit
### Number (if available)
-The integration will create a number entity for changing the cutting height of the mower. This entity is disabled by default. You have to enable it manually because it can't be detected with the API if the mower has the capability to change the cutting height remotely. Before enabling this function, consult the handbook of the mower. It's possible that you can use this entity only as sensor but cannot actively change the cutting height.
+#### Cutting height
+
+The integration will create a number entity for changing the cutting height of the mower. This entity is disabled by default. You have to enable it manually. It can't be detected with the API if the mower has the capability to change the cutting height remotely. Before enabling this function, refer to the mower documentation. Depending on the mower, it is possible that you can use this entity only passively as a sensor and not actively to change the cutting height.
+Possible values are 1 (grass stays short) to 9 (grass stays high).
+
+#### Cutting height for work areas
+
+The integration will create a number entity for changing the cutting height for each work area of the mower if your mower supports work areas. Possible values for the cutting heights are 0% (grass stays short) to 100% (grass stays high) of the default cutting height. Note: It's not yet possible to change the default cutting height with Home Assistant.
### Select (if available)
diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown
index 1485c4ce9d6..0f9cb2a74b4 100644
--- a/source/_integrations/hydrawise.markdown
+++ b/source/_integrations/hydrawise.markdown
@@ -28,15 +28,6 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
-## Prerequisites
-
-To set up the Hydrawise integration, you must first obtain an API Key.
-
-1. Login at [https://app.hydrawise.com](https://app.hydrawise.com).
-2. Go to **Account Details** under the **My Account** menu (in the upper-right-hand corner).
-3. Under the **Account Settings** section, copy the **API Key**.
- 1. If no API Key is present, select the **Generate API Key** button.
-
{% include integrations/config_flow.md %}
## Binary sensor
diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown
index 16fd1779eb7..8333c07841f 100644
--- a/source/_integrations/iammeter.markdown
+++ b/source/_integrations/iammeter.markdown
@@ -12,6 +12,9 @@ ha_codeowners:
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[IAMMETER](https://www.iammeter.com/) provides both a bi-directional single-phase energy meter([WEM3080](https://www.iammeter.com/products/single-phase-meter)) and a bi-directional three-phase energy monitor ([WEM3080T](https://www.iammeter.com/products/three-phase-meter)). Both of them can be integrated into Home Assistant.
@@ -20,11 +23,10 @@ The WEM3050T provides nearly all of the features the WEM3080T provides, with the
The WEM3050T can be integrated into Home Assistant by [all of the methods](https://community.home-assistant.io/t/four-ways-to-integrate-the-electricity-usage-monitor-iammeter-into-the-home-assistant/485520/) that WEM3080T supports.
Because there is no cloud service by default, the WEM3050T is much cheaper than the WEM3080T.
-
-
## Configuration
-To use this sensor in your installation, add the following to your `configuration.yaml` file:
+To use this {% 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/iglo.markdown b/source/_integrations/iglo.markdown
index 1712a8510e4..3dafc39cfe1 100644
--- a/source/_integrations/iglo.markdown
+++ b/source/_integrations/iglo.markdown
@@ -9,11 +9,15 @@ ha_domain: iglo
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `iglo` platform allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant.
+The `iglo` {% term integration %} allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant.
-To use your iGlo light in your installation, add the following to your `configuration.yaml` file:
+To use your iGlo light 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/ign_sismologia.markdown b/source/_integrations/ign_sismologia.markdown
index 1953005f5c5..75bffc91fe5 100644
--- a/source/_integrations/ign_sismologia.markdown
+++ b/source/_integrations/ign_sismologia.markdown
@@ -11,9 +11,12 @@ ha_domain: ign_sismologia
ha_platforms:
- geo_location
ha_integration_type: service
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ign_sismologia` platform lets you integrate a GeoRSS feed provided by the
+The `ign_sismologia` {% term integration %} lets you integrate a GeoRSS feed provided by the
Spanish [Instituto Geográfico Nacional](https://www.ign.es/) with information
about seismic events like earthquakes on the Iberian Peninsula and Canary
Islands. It retrieves incidents from a feed and shows information of those
@@ -33,7 +36,8 @@ The data is updated every 5 minutes.
## Configuration
-To integrate the IGN Sismología feed, add the following lines to your `configuration.yaml`.
+To integrate the IGN Sismología feed, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -70,17 +74,17 @@ longitude:
The following state attributes are available for each entity in addition to
the standard ones:
-| Attribute | Description |
-|--------------------|-------------|
-| latitude | Latitude of the earthquake. |
-| longitude | Longitude of the earthquake. |
-| source | `ign_sismologia` to be used in conjunction with `geo_location` automation trigger. |
-| external_id | The external ID used in the feed to identify the earthquake in the feed. |
-| title | Original title from the feed. |
-| region | Textual description of named geographic region near to the event. |
-| magnitude | Reported magnitude of the earthquake. |
-| publication_date | Date and time when this event occurred. |
-| image_url | URL to a map supplied in the feed marking the location of the event. This could for example be used in notifications. |
+| Attribute | Description |
+| ---------------- | --------------------------------------------------------------------------------------------------------------------- |
+| latitude | Latitude of the earthquake. |
+| longitude | Longitude of the earthquake. |
+| source | `ign_sismologia` to be used in conjunction with `geo_location` automation trigger. |
+| external_id | The external ID used in the feed to identify the earthquake in the feed. |
+| title | Original title from the feed. |
+| region | Textual description of named geographic region near to the event. |
+| magnitude | Reported magnitude of the earthquake. |
+| publication_date | Date and time when this event occurred. |
+| image_url | URL to a map supplied in the feed marking the location of the event. This could for example be used in notifications. |
## Full Configuration
diff --git a/source/_integrations/ihc.markdown b/source/_integrations/ihc.markdown
index c4f0a6eb05d..c7401a19912 100644
--- a/source/_integrations/ihc.markdown
+++ b/source/_integrations/ihc.markdown
@@ -16,9 +16,12 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-IHC Controller integration for Home Assistant allows you to connect the LK IHC controller to Home Assistant. The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway.
+IHC Controller {% term integration %} for Home Assistant allows you to connect the LK IHC controller to Home Assistant. The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway.
There is currently support for the following device types within Home Assistant:
@@ -27,7 +30,8 @@ There is currently support for the following device types within Home Assistant:
- [Light](#light)
- [Switch](#switch)
-An `ihc` section must be present in the `configuration.yaml` file and contain the following options:
+An `ihc` section must be present in the {% term "`configuration.yaml`" %} file and contain the following options:
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry for two IHC controllers
diff --git a/source/_integrations/incomfort.markdown b/source/_integrations/incomfort.markdown
index 8eb1cff3fb8..f6183a1b9ad 100644
--- a/source/_integrations/incomfort.markdown
+++ b/source/_integrations/incomfort.markdown
@@ -17,9 +17,12 @@ ha_platforms:
- sensor
- water_heater
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `incomfort` integration links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it.
+The `incomfort` {% term integration %} links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it.
It uses the [incomfort](https://pypi.org/project/incomfort-client/) client library.
@@ -37,7 +40,8 @@ Any room thermostats (there can be 0, 1 or 2) are represented as **Climate** dev
## 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 {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
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 8a09c9fab1d..13420acfe7d 100644
--- a/source/_integrations/influxdb.markdown
+++ b/source/_integrations/influxdb.markdown
@@ -12,11 +12,14 @@ ha_domain: influxdb
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available.
+The `influxdb` {% term integration %} makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available.
-Additionally, you can now make use of an InfluxDB 2.0 installation with this integration. See the [official installation instructions](https://v2.docs.influxdata.com/v2.0/) for how to set up an InfluxDB 2.0 database. Or you can sign up for their [cloud service](https://cloud2.influxdata.com/signup) and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.
+Additionally, you can now make use of an InfluxDB 2.0 installation with this {% term integration %}. See the [official installation instructions](https://v2.docs.influxdata.com/v2.0/) for how to set up an InfluxDB 2.0 database. Or you can sign up for their [cloud service](https://cloud2.influxdata.com/signup) and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.
There is currently support for the following device types within Home Assistant:
@@ -30,7 +33,8 @@ The `influxdb` database integration runs parallel to the Home Assistant database
## Configuration
-The default InfluxDB configuration doesn't enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven't made any configuration changes, add the following to your `configuration.yaml` file:
+The default InfluxDB configuration doesn't enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven't made any configuration changes, 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/iperf3.markdown b/source/_integrations/iperf3.markdown
index 026f3e972c4..d19fc04de13 100644
--- a/source/_integrations/iperf3.markdown
+++ b/source/_integrations/iperf3.markdown
@@ -12,11 +12,14 @@ ha_domain: iperf3
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `iperf3` sensor integration allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server.
+The `iperf3` sensor {% term integration %} allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server.
-Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a Iperf3 test to run.
+Enabling this {% term integration %} will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a Iperf3 test to run.
## Setup
@@ -24,7 +27,8 @@ This integration requires the `iperf3` command to be installed on your OS. Pleas
## Configuration
-To add the `iperf3` sensor to your installation, add the following to your `configuration.yaml` file:
+To add the `iperf3` sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
Once per hour, on the hour (default):
diff --git a/source/_integrations/irish_rail_transport.markdown b/source/_integrations/irish_rail_transport.markdown
index 316a8003a75..b407f7dcf7b 100644
--- a/source/_integrations/irish_rail_transport.markdown
+++ b/source/_integrations/irish_rail_transport.markdown
@@ -11,13 +11,17 @@ ha_domain: irish_rail_transport
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information.
A station name is the full station name as specified on the Irish Rail search site, for example, `Tara Street` or `Dublin Connolly`.
-To activate the sensor add the data to your `configuration.yaml` file as shown in the example:
+To activate the sensor add the data to your {% term "`configuration.yaml`" %} file as shown in the example:
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/itach.markdown b/source/_integrations/itach.markdown
index 8d2f5648877..7d4b72f797e 100644
--- a/source/_integrations/itach.markdown
+++ b/source/_integrations/itach.markdown
@@ -9,13 +9,17 @@ ha_domain: itach
ha_platforms:
- remote
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `itach` remote platform allows you to control IR devices with a Global Caché iTach Device and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.
+The `itach` remote {% term integration %} allows you to control IR devices with a Global Caché iTach Device and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.
In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the [gc100 integration](/integrations/gc100) and associated platforms.
-To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and add the following to your `configuration.yaml` file:
+To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and 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/itunes.markdown b/source/_integrations/itunes.markdown
index c3713cbf822..ecd960f3641 100644
--- a/source/_integrations/itunes.markdown
+++ b/source/_integrations/itunes.markdown
@@ -9,15 +9,19 @@ ha_domain: itunes
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `itunes` media player platform allows you to control [iTunes](https://apple.com/itunes/) from Home Assistant. It uses a 3rd party server that you run on your Mac called [itunes-api](https://github.com/maddox/itunes-api). Play, pause or skip songs remotely on iTunes running on your Mac.
+The `itunes` media player {% term integration %} allows you to control [iTunes](https://apple.com/itunes/) from Home Assistant. It uses a 3rd party server that you run on your Mac called [itunes-api](https://github.com/maddox/itunes-api). Play, pause or skip songs remotely on iTunes running on your Mac.
In addition to controlling iTunes, your available AirPlay endpoints will be added as media players as well. You can then individually address them and turn them on, turn them off or adjust their volume.
## Configuration
-To add iTunes to your installation, add the following to your `configuration.yaml` file:
+To add iTunes 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/izone.markdown b/source/_integrations/izone.markdown
index 02209993c04..afdd454ad12 100644
--- a/source/_integrations/izone.markdown
+++ b/source/_integrations/izone.markdown
@@ -13,9 +13,12 @@ ha_homekit: true
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `iZone` integration allows access of control of a local [iZone](https://izone.com.au/) ducted reverse-cycle climate control devices. These are largely available in Australia.
+The `iZone` {% term integration %} allows access of control of a local [iZone](https://izone.com.au/) ducted reverse-cycle climate control devices. These are largely available in Australia.
## Supported hardware
@@ -23,12 +26,12 @@ Any current iZone unit with ducted reverse cycle air-conditioning, and the CB wi
{% include integrations/config_flow.md %}
-
## Manual configuration
Alternatively, the iZone integration can be configured manually via the
-`configuration.yaml` file if there is more than one iZone system on the local
-network and one or more must be excluded use manual configuration:
+{% term "`configuration.yaml`" %} file if there is more than one iZone system on the local
+network and one or more must be excluded use manual configuration.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Full manual example configuration.yaml entry
@@ -126,16 +129,16 @@ This will help you to find network connection issues etc.
Set the minimum airflow for a particular zone.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | izone Zone entity. For example `climate.bed_2`
-| `airflow` | no | Airflow percent in 5% increments
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | yes | izone Zone entity. For example `climate.bed_2` |
+| `airflow` | no | Airflow percent in 5% increments |
### Service `izone.airflow_max`
Set the maximum airflow for a particular zone.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | izone Zone entity. For example `climate.bed_2`
-| `airflow` | no | Airflow percent in 5% increments
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | yes | izone Zone entity. For example `climate.bed_2` |
+| `airflow` | no | Airflow percent in 5% increments |
diff --git a/source/_integrations/jewish_calendar.markdown b/source/_integrations/jewish_calendar.markdown
index 61008551f2c..12806e6036d 100644
--- a/source/_integrations/jewish_calendar.markdown
+++ b/source/_integrations/jewish_calendar.markdown
@@ -12,13 +12,17 @@ ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Jewish Calendar (`jewish_calendar`) integration displays a variety of information related to the Jewish Calendar as a variety of sensors.
+The Jewish Calendar (`jewish_calendar`) {% term integration %} displays a variety of information related to the Jewish Calendar as a variety of sensors.
## Configuration
-To enable this integration in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown
index 035aa874b8e..9d869075372 100644
--- a/source/_integrations/joaoapps_join.markdown
+++ b/source/_integrations/joaoapps_join.markdown
@@ -10,9 +10,12 @@ ha_domain: joaoapps_join
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `joaoapps_join` integration exposes services from
+The `joaoapps_join` {% term integration %} exposes services from
[Join](https://joaoapps.com/join). In Home Assistant, the Joaoapps Join features are
divided up in two locations, the Join integration, and the Joaoapps Join notify platform.
The notify platform allows us to send messages to Joaoapps Join devices, the integration
@@ -22,7 +25,8 @@ 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:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -104,11 +108,11 @@ data:
The services exposed in the `joaoapps_join` integration can be used with the
service data described below:
-| Service | Data |
-|------------------------------ |------------------------------------------------------------------ |
-| joaoapps_join/ring | |
-| joaoapps_join/send_sms | `{"number":"5553334444", "message":"Hello!"}` |
-| joaoapps_join/send_tasker | `{"command":"test"}` |
-| joaoapps_join/send_url | `{"url":"http://google.com"}` |
-| joaoapps_join/send_wallpaper | `{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}` |
-| joaoapps_join/send_file | `{"url":"http://download.thinkbroadband.com/5MB.zip"}` |
+| Service | Data |
+| ---------------------------- | ------------------------------------------------------------------ |
+| joaoapps_join/ring | |
+| joaoapps_join/send_sms | `{"number":"5553334444", "message":"Hello!"}` |
+| joaoapps_join/send_tasker | `{"command":"test"}` |
+| joaoapps_join/send_url | `{"url":"http://google.com"}` |
+| joaoapps_join/send_wallpaper | `{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}` |
+| joaoapps_join/send_file | `{"url":"http://download.thinkbroadband.com/5MB.zip"}` |
diff --git a/source/_integrations/kaiterra.markdown b/source/_integrations/kaiterra.markdown
index 7e866d0cd7e..dd344225b7e 100644
--- a/source/_integrations/kaiterra.markdown
+++ b/source/_integrations/kaiterra.markdown
@@ -12,15 +12,19 @@ ha_platforms:
- air_quality
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://dev.kaiterra.com/).
+The `kaiterra` {% term integration %} allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://dev.kaiterra.com/).
-To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`.
+To use the {% term integration %}, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`.
## Configuration
-To enable `kaiterra` in your installation, add the following to your `configuration.yaml` file:
+To enable `kaiterra` 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/kankun.markdown b/source/_integrations/kankun.markdown
index 1c63842022a..b022428eea8 100644
--- a/source/_integrations/kankun.markdown
+++ b/source/_integrations/kankun.markdown
@@ -9,9 +9,12 @@ ha_domain: kankun
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `kankun` switch platform allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are
+The `kankun` switch {% term integration %} allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are
modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi)
script to provide an HTTP API.
Details of the necessary modifications were provided on the now dead HomeAutomationForGeeks site,
@@ -21,7 +24,8 @@ but fortunately we can still access the information via
## 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
diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown
index 02128a9cb18..427e5c62d97 100644
--- a/source/_integrations/keba.markdown
+++ b/source/_integrations/keba.markdown
@@ -17,11 +17,14 @@ ha_platforms:
- notify
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `keba` integrates your Keba charging station/BMW Wallbox into your Home Assistant instance using the UDP Smart Home Interface ([manual](https://www.ifix-solar.shop/wp-content/uploads/shop/Dokumente/KEBA/KeContact_P20_P30_UDP_ProgrGuide_en.pdf)). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app. In order to use the integration, enable the UDP Smart Home Interface by adjusting the DIP switches within the charging station according to the [installation manual](https://www.keba.com/file/downloads/e-mobility/KeContact_KCP20_30_ih_en.pdf).
-This integration provides the following platforms:
+This {% term integration %} provides the following platforms:
- Binary sensors: Online state, plug state, charging state and failsafe mode state.
- Lock: Authorization (like with the RFID card).
@@ -31,7 +34,8 @@ This integration provides the following platforms:
## Configuration
-To enable this integration in your installation, add at least the following to your `configuration.yaml` file:
+To enable this integration in your installation, add at least 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/kef.markdown b/source/_integrations/kef.markdown
index 27644471ecf..af7155490cf 100644
--- a/source/_integrations/kef.markdown
+++ b/source/_integrations/kef.markdown
@@ -11,19 +11,23 @@ ha_domain: kef
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `kef` platform allows you to control the KEF LS50 Wireless and [KEF LSX](https://international.kef.com/products/lsx) speakers from Home Assistant.
+The `kef` {% term integration %} allows you to control the KEF LS50 Wireless and [KEF LSX](https://international.kef.com/products/lsx) speakers from Home Assistant.
Supported devices:
- KEF LS50 Wireless
- KEF LSX
-To add KEF Speakers to your installation, add the following to your `configuration.yaml` file:
-
## Configuration
+To add KEF Speakers 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
media_player:
@@ -101,76 +105,76 @@ To update the settings manually, use `kef.update_dsp`.
Update all DSP settings.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
### Service `kef.set_mode`
Set the mode of the speaker. When optional attributes are left out, the setting will be unchanged.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
-| desk_mode | Yes | "Desk mode" (`true` or `false`) |
-| wall_mode | Yes | "Wall mode" (`true` or `false`) |
-| phase_correction | Yes | "Phase correction" (`true` or `false`) |
-| high_pass | Yes | "High-pass mode" (`true` or `false`) |
-| sub_polarity | Yes | "Sub polarity" (`-` or `+`) |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
+| desk_mode | Yes | "Desk mode" (`true` or `false`) |
+| wall_mode | Yes | "Wall mode" (`true` or `false`) |
+| phase_correction | Yes | "Phase correction" (`true` or `false`) |
+| high_pass | Yes | "High-pass mode" (`true` or `false`) |
+| sub_polarity | Yes | "Sub polarity" (`-` or `+`) |
| bass_extension | Yes | "Bass extension" selector (`Less`, `Standard`, or `Extra`) |
### Service `kef.set_desk_db`
Set the "Desk mode" slider of the speaker in dB.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) |
### Service `kef.set_wall_db`
Set the "Wall mode" slider of the speaker in dB.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) |
### Service `kef.set_treble_db`
Set desk the "Treble trim" slider of the speaker in dB.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-2 to 2 with steps of 0.5) |
### Service `kef.set_high_hz`
Set the "High-pass mode" slider of the speaker in Hz.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| hz_value | No | Value of the slider (50 to 120 with steps of 5) |
### Service `kef.set_low_hz`
Set the "Sub out low-pass frequency" slider of the speaker in Hz.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| hz_value | No | Value of the slider (40 to 250 with steps of 5) |
### Service `kef.set_sub_db`
Set the "Sub gain" slider of the speaker in dB.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| entity_id | No | The entity_id of the KEF speaker. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-10 to 10 with steps of 1) |
## Notes
diff --git a/source/_integrations/keyboard_remote.markdown b/source/_integrations/keyboard_remote.markdown
index 3b14b4da2cb..867b384c0a2 100644
--- a/source/_integrations/keyboard_remote.markdown
+++ b/source/_integrations/keyboard_remote.markdown
@@ -10,14 +10,20 @@ ha_codeowners:
- '@lanrat'
ha_domain: keyboard_remote
ha_integration_type: hub
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Receive signals from a keyboard and use it as a remote control.
-This integration allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules.
+This {% term integration %} allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules.
The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it.
+To enable the Keyboard Remote {% term integration %}, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
keyboard_remote:
diff --git a/source/_integrations/kitchen_sink.markdown b/source/_integrations/kitchen_sink.markdown
index 388b2ea832f..6e15886a40b 100644
--- a/source/_integrations/kitchen_sink.markdown
+++ b/source/_integrations/kitchen_sink.markdown
@@ -19,13 +19,17 @@ ha_platforms:
- switch
- weather
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Kitchen Sink integration contains demonstrations of various odds and ends.
+The Kitchen Sink {% term integration %} contains demonstrations of various odds and ends.
This sets up a demo environment of features which are obscure or which represent incorrect behavior, and are thus not wanted in the `demo` integration.
-To enable the `kitchen_sink` integration in Home Assistant, add the following section to your `configuration.yaml` file:
+To enable the `kitchen_sink` {% term integration %} in 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/kiwi.markdown b/source/_integrations/kiwi.markdown
index 5ddeedafd21..1b05a02268d 100644
--- a/source/_integrations/kiwi.markdown
+++ b/source/_integrations/kiwi.markdown
@@ -9,13 +9,19 @@ ha_domain: kiwi
ha_platforms:
- lock
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices.
+The `KIWI` {% term integration %} allows you to open your KIWI Smart Locks and Smart Entry Devices.
All you need to get started is a KIWI account. Register at [the KIWI website](https://kiwi.ki/login/).
## Configuration
+To enable the KIWI {% term integration %}, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
lock:
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index 0b74b7f25c5..47d5e4f9dc8 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -82,7 +82,8 @@ As a Home Assistant KNX user, you can start a FREE KNX online training and get a
## Basic configuration
-In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main `configuration.yaml` file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/).
+In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main {% term "`configuration.yaml`" %} file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/).
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
knx:
diff --git a/source/_integrations/kwb.markdown b/source/_integrations/kwb.markdown
index 1fbbff97817..2f086ee072a 100644
--- a/source/_integrations/kwb.markdown
+++ b/source/_integrations/kwb.markdown
@@ -9,14 +9,20 @@ ha_domain: kwb
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant.
+The `kwb` {% term integration %} integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant.
Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals).
Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see
).
+To enable the KWB Easyfire {% term integration %}, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
Direct connection via serial port:
```yaml
diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown
index aaccacfad33..acfe2ba575c 100644
--- a/source/_integrations/lacrosse.markdown
+++ b/source/_integrations/lacrosse.markdown
@@ -9,9 +9,12 @@ ha_domain: lacrosse
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
+The `lacrosse` sensor {% term integration %} is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
## Tested devices
@@ -41,7 +44,8 @@ For TX 29 DTH-IT sensors you can also read the ID from the display and calculate
## Configuration
-To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file:
+To use your `lacrosse` compatible 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/lannouncer.markdown b/source/_integrations/lannouncer.markdown
index 25cacdba67d..377f499d6bf 100644
--- a/source/_integrations/lannouncer.markdown
+++ b/source/_integrations/lannouncer.markdown
@@ -9,11 +9,15 @@ ha_domain: lannouncer
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `lannouncer` notification platform allows you to play spoken messages (TTS) or sounds on an Android device running [Lannouncer](https://play.google.com/store/apps/details?id=com.keybounce.lannouncer&hl=en_US). This can be useful when you have a wall mounted Android tablet, or an Android device that is permanently powered and turned on and want to use that to play notifications.
+The `lannouncer` notification {% term integration %} allows you to play spoken messages (TTS) or sounds on an Android device running [Lannouncer](https://play.google.com/store/apps/details?id=com.keybounce.lannouncer&hl=en_US). This can be useful when you have a wall mounted Android tablet, or an Android device that is permanently powered and turned on and want to use that to play notifications.
-To enable Lannouncer notifications in your installation, add the following to your `configuration.yaml` file:
+To enable Lannouncer 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/lifx_cloud.markdown b/source/_integrations/lifx_cloud.markdown
index 7dfd11e404e..1546cbd36fb 100644
--- a/source/_integrations/lifx_cloud.markdown
+++ b/source/_integrations/lifx_cloud.markdown
@@ -9,9 +9,15 @@ ha_domain: lifx_cloud
ha_platforms:
- scene
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `lifx_cloud` scene platform allows you to activate the scenes that LIFX smartphone apps store in the LIFX cloud.
+The `lifx_cloud` scene {% term integration %} allows you to activate the scenes that LIFX smartphone apps store in the LIFX cloud.
+
+To enable the LIFX Cloud {% term integration %}, add 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/lightwave.markdown b/source/_integrations/lightwave.markdown
index 0ad0cc1fd01..56ba9dddc10 100644
--- a/source/_integrations/lightwave.markdown
+++ b/source/_integrations/lightwave.markdown
@@ -14,12 +14,16 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `lightwave` integration links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights, switches and TRVs.
+The `lightwave` {% term integration %} links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights, switches and TRVs.
This integration uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/).
-To add your Lightwave devices into your Home Assistant installation, add the following to your `configuration.yaml` file:
+To add your Lightwave devices into 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/limitlessled.markdown b/source/_integrations/limitlessled.markdown
index d42505259e9..306fef689e6 100644
--- a/source/_integrations/limitlessled.markdown
+++ b/source/_integrations/limitlessled.markdown
@@ -9,6 +9,9 @@ ha_domain: limitlessled
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
`limitlessled` can control your LimitlessLED lights from within Home Assistant. The lights are also known as EasyBulb, AppLight, AppLamp, MiLight, LEDme, dekolight, or iLight.
@@ -23,7 +26,8 @@ An archive of the extensive API can be found [here](https://github.com/Fantasmos
Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([Android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)).
-To add `limitlessled` to your installation, add the following to your `configuration.yaml` file:
+To add `limitlessled` 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/linksys_smart.markdown b/source/_integrations/linksys_smart.markdown
index 465069da04f..6a0495a2ed0 100644
--- a/source/_integrations/linksys_smart.markdown
+++ b/source/_integrations/linksys_smart.markdown
@@ -9,9 +9,12 @@ ha_domain: linksys_smart
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wi-Fi based router.
+The `linksys_smart` {% term integration %} offers presence detection by looking at connected devices to a Linksys Smart Wi-Fi based router.
Tested routers:
@@ -22,11 +25,12 @@ Tested routers:
## Setup
-For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password.
+For this {% term integration %} to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password.
## Configuration
-To use a Linksys Smart Wi-Fi Router in your Home Assistant installation, add the following to your `configuration.yaml` file:
+To use a Linksys Smart Wi-Fi Router in 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/linode.markdown b/source/_integrations/linode.markdown
index 0ff266fe5bc..5e18b151220 100644
--- a/source/_integrations/linode.markdown
+++ b/source/_integrations/linode.markdown
@@ -12,9 +12,12 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `linode` integration allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant.
+The `linode` {% term integration %} allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant.
There is currently support for the following device types within Home Assistant:
@@ -33,7 +36,8 @@ Obtain your oAuth2 Access Token from Linode account.
## Configuration
-To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate Linode 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/linux_battery.markdown b/source/_integrations/linux_battery.markdown
index a14d1133f54..bf86f5a5311 100644
--- a/source/_integrations/linux_battery.markdown
+++ b/source/_integrations/linux_battery.markdown
@@ -11,11 +11,15 @@ ha_domain: linux_battery
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `linux_battery` sensor platform is using the information stored in `/sys/class/power_supply/` on your local Linux system to display details about the current state of your battery.
+The `linux_battery` sensor {% term integration %} is using the information stored in `/sys/class/power_supply/` on your local Linux system to display details about the current state of your battery.
-To setup a battery sensor to your installation, add the following to your `configuration.yaml` file:
+To setup a battery sensor 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/llamalab_automate.markdown b/source/_integrations/llamalab_automate.markdown
index 70495c6e137..024ebdbe9b4 100644
--- a/source/_integrations/llamalab_automate.markdown
+++ b/source/_integrations/llamalab_automate.markdown
@@ -9,9 +9,12 @@ ha_domain: llamalab_automate
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `llamalab_automate` platform uses Googles Cloud Messaging Services to push messages from Home Assistant to your Android device running the LlamaLab [Automate](https://llamalab.com/automate/) app. This can serve as an alternative to Tasker + AutoRemote.
+The `llamalab_automate` {% term integration %} uses Googles Cloud Messaging Services to push messages from Home Assistant to your Android device running the LlamaLab [Automate](https://llamalab.com/automate/) app. This can serve as an alternative to Tasker + AutoRemote.
## Prerequisites
@@ -19,7 +22,8 @@ Go to [https://llamalab.com/automate/cloud/](https://llamalab.com/automate/cloud
## Configuration
-To use this notification platform in your installation, add the following to your `configuration.yaml` file:
+To use this notification {% 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/local_file.markdown b/source/_integrations/local_file.markdown
index ca49a1ded32..999e3bede7b 100644
--- a/source/_integrations/local_file.markdown
+++ b/source/_integrations/local_file.markdown
@@ -9,6 +9,9 @@ ha_domain: local_file
ha_platforms:
- camera
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation.
@@ -17,7 +20,8 @@ The `local_file` camera can for example be used with various camera platforms th
## Configuration
-To enable this camera in your installation, add the following to your `configuration.yaml` file:
+To enable this camera 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/logentries.markdown b/source/_integrations/logentries.markdown
index f3a4548ba0c..4eefbcb72a0 100644
--- a/source/_integrations/logentries.markdown
+++ b/source/_integrations/logentries.markdown
@@ -7,13 +7,17 @@ ha_iot_class: Cloud Push
ha_release: 0.13
ha_domain: logentries
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `logentries` integration makes it possible to log all state changes to [Logentries](https://logentries.com) using Logentries Webhook endpoint.
+The `logentries` {% term integration %} makes it possible to log all state changes to [Logentries](https://logentries.com) using Logentries Webhook endpoint.
Open the **Add a Log** page and choose **Manual**. Enter a name for your log in **Log Name**, add a group in **Select Log Set**, set **Token TCP - logs are identified by a token.** and press **Create Log Token**. The generated token is required for the Home Assistant configuration.
-To use the `logentries` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `logentries` {% 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/london_air.markdown b/source/_integrations/london_air.markdown
index 8e34851c4a0..a002623bccf 100644
--- a/source/_integrations/london_air.markdown
+++ b/source/_integrations/london_air.markdown
@@ -9,13 +9,17 @@ ha_domain: london_air
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `london_air` integration [queries](https://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available.
+The `london_air` {% term integration %} [queries](https://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available.
Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](https://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO](https://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](https://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](https://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](https://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](https://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.
-To add sensors to Home Assistant for all possible areas/boroughs add the following to your `configuration.yaml` file:
+To add sensors to Home Assistant for all possible areas/boroughs add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry for a single sensor
diff --git a/source/_integrations/london_underground.markdown b/source/_integrations/london_underground.markdown
index ffc47e7bb56..7b288994046 100644
--- a/source/_integrations/london_underground.markdown
+++ b/source/_integrations/london_underground.markdown
@@ -11,9 +11,15 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@jpbede'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `london_underground` sensor will display the status of London underground lines, as well as the Overground and DLR.
+The `london_underground` {% term integration %} will display the status of London underground lines, as well as the Overground and DLR.
+
+To enable this {% term integration %}, add 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/luci.markdown b/source/_integrations/luci.markdown
index 2de65aa84f1..822a3fb5e3e 100644
--- a/source/_integrations/luci.markdown
+++ b/source/_integrations/luci.markdown
@@ -21,7 +21,8 @@ Before this scanner can be used you have to install the luci RPC package on Open
# opkg install luci-mod-rpc
```
-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/lw12wifi.markdown b/source/_integrations/lw12wifi.markdown
index 60709c89c79..7630c262e42 100644
--- a/source/_integrations/lw12wifi.markdown
+++ b/source/_integrations/lw12wifi.markdown
@@ -9,13 +9,17 @@ ha_domain: lw12wifi
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `lw12wifi` light platform supports Lagute LW-12 Wifi LED controller.
+The `lw12wifi` light {% term integration %} supports Lagute LW-12 Wifi LED controller.
## Configuration
-To enable these lights, add the following lines to your `configuration.yaml` file:
+To enable these lights, 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/manual.markdown b/source/_integrations/manual.markdown
index 391339a8d81..eae9dbc2fec 100644
--- a/source/_integrations/manual.markdown
+++ b/source/_integrations/manual.markdown
@@ -10,13 +10,17 @@ ha_iot_class: Calculated
ha_platforms:
- alarm_control_panel
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `manual` alarm control panel platform enables you to create an alarm system in Home Assistant.
+The `manual` alarm control panel {% term integration %} enables you to create an alarm system in Home Assistant.
## Configuration
-To enable this, 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/manual_mqtt.markdown b/source/_integrations/manual_mqtt.markdown
index daebb429e3a..f64d45304bc 100644
--- a/source/_integrations/manual_mqtt.markdown
+++ b/source/_integrations/manual_mqtt.markdown
@@ -9,13 +9,16 @@ ha_iot_class: Local Push
ha_platforms:
- alarm_control_panel
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mqtt` platform extends the [manual alarm](/integrations/manual) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant.
+The `mqtt` {% term integration %} extends the [manual alarm](/integrations/manual) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant.
It's essentially the opposite of the [MQTT Alarm Panel](/integrations/alarm_control_panel.mqtt/) which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device.
-The integration will accept the following commands from your Alarm Panel via the `command_topic`:
+The {% term integration %} will accept the following commands from your Alarm Panel via the `command_topic`:
- `DISARM`
- `ARM_HOME`
@@ -37,7 +40,8 @@ When the state of the manual alarm changes, Home Assistant will publish one of t
## Configuration
-To use your panel in your installation, add the following to your `configuration.yaml` file:
+To use your panel 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/marytts.markdown b/source/_integrations/marytts.markdown
index 920741c9571..609f2bd2a88 100644
--- a/source/_integrations/marytts.markdown
+++ b/source/_integrations/marytts.markdown
@@ -9,13 +9,17 @@ ha_domain: marytts
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) text-to-speech engine to read a text with natural sounding voices.
+The `marytts` text-to-speech {% term integration %} uses [MaryTTS](http://mary.dfki.de/) text-to-speech engine to read a text with natural sounding voices.
## Configuration
-To enable text-to-speech with MaryTTS, add the following lines to your `configuration.yaml`:
+To enable text-to-speech with MaryTTS, 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/mastodon.markdown b/source/_integrations/mastodon.markdown
index b3c2937daf7..d0a79ef1966 100644
--- a/source/_integrations/mastodon.markdown
+++ b/source/_integrations/mastodon.markdown
@@ -11,6 +11,9 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver notifications from Home Assistant.
@@ -22,7 +25,8 @@ If you want to grant only required accesses, uncheck all checkboxes then check o
### Configuration
-To add Mastodon to your installation, add the following to your `configuration.yaml` file:
+To add Mastodon 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/matrix.markdown b/source/_integrations/matrix.markdown
index 48cfb641a39..278fe2491fe 100644
--- a/source/_integrations/matrix.markdown
+++ b/source/_integrations/matrix.markdown
@@ -12,9 +12,12 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@PaarthShah'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This integration allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered.
+This {% term integration %} allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered.
There is currently support for the following device types within Home Assistant:
@@ -22,6 +25,9 @@ There is currently support for the following device types within Home Assistant:
## Configuration
+To enable the Matrix {% term integration %}, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
matrix:
diff --git a/source/_integrations/maxcube.markdown b/source/_integrations/maxcube.markdown
index 7628a1d6753..75f4b7b4daf 100644
--- a/source/_integrations/maxcube.markdown
+++ b/source/_integrations/maxcube.markdown
@@ -11,6 +11,9 @@ ha_platforms:
- binary_sensor
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[eQ-3 MAX!](https://www.eq-3.com/products/homematic/detail/max-cube-lan-gateway.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported integrations available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names.
@@ -34,7 +37,8 @@ Supported Devices:
### One gateway
-A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required:
+A `maxcube` section must be present in the {% term "`configuration.yaml`" %} file and contain the following options as required:
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/media_extractor.markdown b/source/_integrations/media_extractor.markdown
index 877144db959..b6a2c9d253b 100644
--- a/source/_integrations/media_extractor.markdown
+++ b/source/_integrations/media_extractor.markdown
@@ -10,15 +10,19 @@ ha_domain: media_extractor
ha_integration_type: integration
ha_codeowners:
- '@joostlek'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.
+The `media_extractor` {% term integration %} gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.
Media extractor doesn't transcode streams, it just tries to find a stream that matches the requested query.
-To use the media extractor service in your installation, add the following to your `configuration.yaml` file:
+To use the media extractor service 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
@@ -81,10 +85,10 @@ This will download the file from the given URL.
There is also a service that will directly return the URL in the response of the service.
-| Service data attribute | Optional | Description |
-|-----------------------| -------- |-----------------------------------------------------------------------------------------------------------|
-| `url` | no | The URL of the media to extract. |
-| `format_query` | yes | The query that will be used to select the right media. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------ |
+| `url` | no | The URL of the media to extract. |
+| `format_query` | yes | The query that will be used to select the right media. |
### Cookies
diff --git a/source/_integrations/mediaroom.markdown b/source/_integrations/mediaroom.markdown
index eb619086176..7f8350be106 100644
--- a/source/_integrations/mediaroom.markdown
+++ b/source/_integrations/mediaroom.markdown
@@ -11,11 +11,15 @@ ha_domain: mediaroom
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mediaroom` integration allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant.
+The `mediaroom` {% term integration %} allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant.
-To add a Mediaroom STB to your installation, add the following to your `configuration.yaml` file:
+To add a Mediaroom STB 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/melissa.markdown b/source/_integrations/melissa.markdown
index 70f8178452d..e700e5fd810 100644
--- a/source/_integrations/melissa.markdown
+++ b/source/_integrations/melissa.markdown
@@ -12,9 +12,12 @@ ha_domain: melissa
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `melissa` integration is the main integration to connect to a [Melissa Climate](https://seemelissa.com/) A/C control.
+The `melissa` {% term integration %} is the main integration to connect to a [Melissa Climate](https://seemelissa.com/) A/C control.
There is currently support for the following device types within Home Assistant:
@@ -24,7 +27,8 @@ The climate platform will be automatically configured if Melissa integration is
## Configuration
-To set the Melissa integration up, add the following information to your `configuration.yaml` file:
+To set the Melissa {% term integration %} up, add the following information to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/meraki.markdown b/source/_integrations/meraki.markdown
index 33c82c4891e..1617eb1aaf2 100644
--- a/source/_integrations/meraki.markdown
+++ b/source/_integrations/meraki.markdown
@@ -9,6 +9,9 @@ ha_domain: meraki
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network.
@@ -26,7 +29,8 @@ Use your Meraki AP as device tracker. Note that Meraki will see all devices, not
## Configuration
-After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file:
+After you configure access to the Meraki CMX API, 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/message_bird.markdown b/source/_integrations/message_bird.markdown
index d20a448105a..ddc9668314d 100644
--- a/source/_integrations/message_bird.markdown
+++ b/source/_integrations/message_bird.markdown
@@ -9,9 +9,12 @@ ha_domain: message_bird
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone.
+The `MessageBird` notification {% term integration %} sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone.
## Setup
@@ -19,7 +22,8 @@ Go to [MessageBird](https://www.messagebird.com/) to retrieve your API key.
## Configuration
-To enable MessageBird notifications in your installation, add the following to your `configuration.yaml` file:
+To enable MessageBird 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/mfi.markdown b/source/_integrations/mfi.markdown
index 88bd59bd175..f1083aa5c8b 100644
--- a/source/_integrations/mfi.markdown
+++ b/source/_integrations/mfi.markdown
@@ -12,6 +12,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
There is currently support for the following device types within Home Assistant:
@@ -21,9 +24,10 @@ There is currently support for the following device types within Home Assistant:
## Sensor
-The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/).
+The `mfi` sensor {% term integration %} to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/).
-To add this platform to your installation, add the following to your `configuration.yaml` file:
+To add this {% term integration %} 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/microsoft.markdown b/source/_integrations/microsoft.markdown
index 886fd07f78b..e8ac566daf2 100644
--- a/source/_integrations/microsoft.markdown
+++ b/source/_integrations/microsoft.markdown
@@ -9,13 +9,17 @@ ha_domain: microsoft
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `microsoft` text-to-speech platform uses the [TTS engine of the Microsoft Speech Service](https://learn.microsoft.com/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices).
+The `microsoft` text-to-speech {% term integration %} uses the [TTS engine of the Microsoft Speech Service](https://learn.microsoft.com/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices).
## Configuration
-To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`:
+To enable text-to-speech with Microsoft, 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/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown
index b2bd4ea5ef2..a41fb8d96e1 100644
--- a/source/_integrations/microsoft_face.markdown
+++ b/source/_integrations/microsoft_face.markdown
@@ -9,7 +9,7 @@ ha_domain: microsoft_face
ha_integration_type: integration
---
-The `microsoft_face` integration platform is the main integration for Microsoft
+The `microsoft_face` integration {% term integration %} is the main integration for Microsoft
Azure Cognitive service
[Face](https://azure.microsoft.com/products/cognitive-services/vision-services).
All data are stored in your own private instance in the Azure cloud.
@@ -26,7 +26,7 @@ Please note that all keys on cognitive services must be recreated every 90 days.
## Configuration
-To enable the Microsoft Face integration,
+To enable the Microsoft Face {% term integration %},
add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_integrations/microsoft_face_detect.markdown b/source/_integrations/microsoft_face_detect.markdown
index 0e2132c1fbe..eccd546a6df 100644
--- a/source/_integrations/microsoft_face_detect.markdown
+++ b/source/_integrations/microsoft_face_detect.markdown
@@ -7,9 +7,12 @@ ha_iot_class: Cloud Push
ha_release: 0.38
ha_domain: microsoft_face_detect
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `microsoft_face_detect` image processing platform allows you to use the
+The `microsoft_face_detect` image processing {% term integration %} allows you to use the
[Microsoft Face Identify](https://azure.microsoft.com/products/cognitive-services/)
API through Home Assistant. This platform enables you to detect face on camera
and fire an event with attributes.
@@ -28,6 +31,9 @@ The free version of the Microsoft Face identify API limits the number of request
### Configuration
+To enable the integration, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
image_processing:
diff --git a/source/_integrations/microsoft_face_identify.markdown b/source/_integrations/microsoft_face_identify.markdown
index 12fe03f3e0d..87cfb45fbe7 100644
--- a/source/_integrations/microsoft_face_identify.markdown
+++ b/source/_integrations/microsoft_face_identify.markdown
@@ -7,9 +7,12 @@ ha_iot_class: Cloud Push
ha_release: 0.37
ha_domain: microsoft_face_identify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `microsoft_face_identify` image processing platform lets you use
+The `microsoft_face_identify` image processing {% term integration %} lets you use
[Microsoft Face identify](https://azure.microsoft.com/products/cognitive-services/)
API through Home Assistant. This platform allow you do identify persons on
camera and fire an event with attributes.
@@ -28,6 +31,9 @@ The free version of the Microsoft Face identify API limits the number of request
### Configuration
+To enable this integration, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
image_processing:
diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown
index a7f7985d4dd..92a250b71b4 100644
--- a/source/_integrations/mochad.markdown
+++ b/source/_integrations/mochad.markdown
@@ -12,9 +12,12 @@ ha_platforms:
- light
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mochad` integration is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately.
+The `mochad` {% term integration %} is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately.
There is currently support for the following device types within Home Assistant:
@@ -23,7 +26,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate your Mochad units 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/modbus.markdown b/source/_integrations/modbus.markdown
index 0fc5fae1bce..329eee69ef3 100644
--- a/source/_integrations/modbus.markdown
+++ b/source/_integrations/modbus.markdown
@@ -18,13 +18,16 @@ ha_platforms:
- switch
ha_quality_scale: platinum
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[modbus](http://www.modbus.org/) is a communication protocol to control PLCs (Programmable Logic Controller) and RTUs (Remote Terminal Unit).
The integration adheres strictly to the [protocol specification](https://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf) using [pymodbus](https://github.com/pymodbus-dev/pymodbus) for the protocol implementation.
-The modbus integration supports all devices adhering to the modbus standard. The communication to the device/devices can be serial (rs-485), TCP, or UDP connections. The modbus integration allows multiple communication channels e.g. a serial port connection combined with one or more TCP connections.
+The modbus {% term integration %} supports all devices adhering to the modbus standard. The communication to the device/devices can be serial (rs-485), TCP, or UDP connections. The modbus integration allows multiple communication channels e.g. a serial port connection combined with one or more TCP connections.
# Configuring modbus communication
@@ -34,6 +37,9 @@ The modbus integration allows you to use multiple connections each with multiple
The modbus integration provides a number of parameters to help communicate with "difficult" devices, these parameters are independent of the type of communication.
+To enable this integration, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
{% configuration %}
delay:
description: "Time to delay sending messages in seconds after connecting.
@@ -1608,7 +1614,7 @@ Description:
| Attribute | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hub | Hub name (defaults to 'modbus_hub' when omitted) |
-| slave | Slave address (0-255) |
+| slave | Slave address (0-255) |
| address | Address of the Register (e.g. 138) |
| value | (write_register) A single value or an array of 16-bit values. Single value will call modbus function code 0x06. Array will call modbus function code 0x10. Values might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]`, this depend on the byte order of your CPU |
| state | (write_coil) A single boolean or an array of booleans. Single boolean will call modbus function code 0x05. Array will call modbus function code 0x0F |
@@ -1660,7 +1666,7 @@ When opening an issue, please add your current configuration (or a scaled down v
- the entity (sensor, etc.) lines
In order for the developers better to identify the problem, please add the
-following lines to configuration.yaml:
+following lines to {% term "`configuration.yaml`" %}:
```yaml
logger:
diff --git a/source/_integrations/mold_indicator.markdown b/source/_integrations/mold_indicator.markdown
index 5d1d1e51ea8..e3ca94b0825 100644
--- a/source/_integrations/mold_indicator.markdown
+++ b/source/_integrations/mold_indicator.markdown
@@ -10,15 +10,19 @@ ha_domain: mold_indicator
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Mold Indicator sensor integration consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.
+The Mold Indicator sensor {% term integration %} consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.
The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum.
## Configuration
-To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file:
+To use the Mold Indicator 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/mpd.markdown b/source/_integrations/mpd.markdown
index ae2caa11e23..be76527d973 100644
--- a/source/_integrations/mpd.markdown
+++ b/source/_integrations/mpd.markdown
@@ -9,13 +9,17 @@ ha_domain: mpd
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mpd` platform allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs.
+The `mpd` {% term integration %} allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs.
Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene.
-To add MPD to your installation, add the following to your `configuration.yaml` file:
+To add MPD 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/mqtt.markdown b/source/_integrations/mqtt.markdown
index 9cf7a2036f8..b1b61e47fb6 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -311,7 +311,7 @@ Best practice for entities with a `unique_id` is to set `` to `unique
#### Discovery payload
-The payload must be a serialized JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the integration's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features.
+The payload must be a serialized JSON dictionary and will be checked like an entry in your {% term "`configuration.yaml`" %} file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the integration's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features.
Subsequent messages on a topic where a valid payload has been received will be handled as a configuration update, and a configuration update with an empty payload will cause a previously discovered device to be deleted.
@@ -1001,7 +1001,7 @@ In the example above, the entity_id will be `sensor.my_super_device` instead of
## Manual configured MQTT items
-For most integrations, it is also possible to manually set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml).
+For most integrations, it is also possible to manually set up MQTT items in {% term "`configuration.yaml`" %}. Read more [about configuration in YAML](/docs/configuration/yaml).
MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt.
diff --git a/source/_integrations/mqtt_eventstream.markdown b/source/_integrations/mqtt_eventstream.markdown
index 15351a9fd6b..f950960043d 100644
--- a/source/_integrations/mqtt_eventstream.markdown
+++ b/source/_integrations/mqtt_eventstream.markdown
@@ -7,13 +7,17 @@ ha_release: 0.11
ha_iot_class: Local Polling
ha_domain: mqtt_eventstream
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT.
+The `mqtt_eventstream` {% term integration %} connects two Home Assistant instances via MQTT.
## Configuration
-To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate MQTT Eventstream into 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/mqtt_json.markdown b/source/_integrations/mqtt_json.markdown
index 76d65a7e442..facd9bc3f1e 100644
--- a/source/_integrations/mqtt_json.markdown
+++ b/source/_integrations/mqtt_json.markdown
@@ -9,13 +9,17 @@ ha_domain: mqtt_json
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device.
+The `mqtt_json` device tracker {% term integration %} allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device.
## 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/mqtt_room.markdown b/source/_integrations/mqtt_room.markdown
index c55e6f23eb0..cc1192d776b 100644
--- a/source/_integrations/mqtt_room.markdown
+++ b/source/_integrations/mqtt_room.markdown
@@ -9,13 +9,17 @@ ha_domain: mqtt_room
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients.
+The `mqtt_room` sensor {% term integration %} allows you to detect the indoor location of devices using MQTT clients.
## 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/mqtt_statestream.markdown b/source/_integrations/mqtt_statestream.markdown
index ab11c4e16f2..deb62c44dd3 100644
--- a/source/_integrations/mqtt_statestream.markdown
+++ b/source/_integrations/mqtt_statestream.markdown
@@ -7,13 +7,17 @@ ha_release: 0.54
ha_iot_class: Local Push
ha_domain: mqtt_statestream
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. [The MQTT integration](/integrations/mqtt/) is a prerequisite for MQTT Statestream to work.
+The `mqtt_statestream` {% term integration %} publishes state changes in Home Assistant to individual MQTT topics. [The MQTT integration](/integrations/mqtt/) is a prerequisite for MQTT Statestream to work.
## Configuration
-To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file:
+To enable MQTT Statestream in 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/mvglive.markdown b/source/_integrations/mvglive.markdown
index 433bb0268da..238518005fb 100644
--- a/source/_integrations/mvglive.markdown
+++ b/source/_integrations/mvglive.markdown
@@ -9,13 +9,17 @@ ha_domain: mvglive
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
+The `mvglive` {% term integration %} will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
## 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/mycroft.markdown b/source/_integrations/mycroft.markdown
index 67044f7a741..d1b230be3d0 100644
--- a/source/_integrations/mycroft.markdown
+++ b/source/_integrations/mycroft.markdown
@@ -10,6 +10,9 @@ ha_domain: mycroft
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.
@@ -20,7 +23,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To use Mycroft in your installation, add the following to your `configuration.yaml` file:
+To use Mycroft 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/mystrom.markdown b/source/_integrations/mystrom.markdown
index 47a18f9533a..6410c2da9df 100644
--- a/source/_integrations/mystrom.markdown
+++ b/source/_integrations/mystrom.markdown
@@ -17,6 +17,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
There is currently support for the following device types within Home Assistant:
@@ -26,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
## Lights and switches
-The myStrom integration allows you to control your [myStrom](https://mystrom.ch/) Wi-Fi Bulbs and Wi-Fi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
+The myStrom {% term integration %} allows you to control your [myStrom](https://mystrom.ch/) Wi-Fi Bulbs and Wi-Fi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
Supported devices are:
@@ -81,7 +84,8 @@ The buttons will give you feedback with its built-in LED:
- white then green: Pattern was submitted successfully
- white then red: There is a problem with the communication
-To use your myStrom WiFi Button in your installation, add the following to your `configuration.yaml` file:
+To use your myStrom WiFi Button 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/mythicbeastsdns.markdown b/source/_integrations/mythicbeastsdns.markdown
index d95379a9090..2e8a8c8991e 100644
--- a/source/_integrations/mythicbeastsdns.markdown
+++ b/source/_integrations/mythicbeastsdns.markdown
@@ -7,13 +7,17 @@ ha_release: 0.85
ha_iot_class: Cloud Push
ha_domain: mythicbeastsdns
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/).
+With the `mythicbeastsdns` {% term integration %} you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/).
## Configuration
-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/nad.markdown b/source/_integrations/nad.markdown
index cb8e68f5935..3e7187cd8a9 100644
--- a/source/_integrations/nad.markdown
+++ b/source/_integrations/nad.markdown
@@ -9,16 +9,20 @@ ha_domain: nad
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `nad` platform allows you to control a [NAD receiver](https://nadelectronics.com/) through RS232, TCP and Telnet from Home Assistant.
+The `nad` {% term integration %} allows you to control a [NAD receiver](https://nadelectronics.com/) through RS232, TCP and Telnet from Home Assistant.
Please note that the RS232 interface is only tested with the NAD T748v2, but it should work with other NAD receivers.
The Telnet interface has been tested with the NAD T787 and the NAD C658.
## Configuration
-To add a NAD receiver to your installation, add the following to your `configuration.yaml` file:
+To add a NAD receiver 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 for RS232 configuration
diff --git a/source/_integrations/namecheapdns.markdown b/source/_integrations/namecheapdns.markdown
index 53029f0ee8f..d129c3cd4b3 100644
--- a/source/_integrations/namecheapdns.markdown
+++ b/source/_integrations/namecheapdns.markdown
@@ -7,9 +7,12 @@ ha_iot_class: Cloud Push
ha_release: 0.56
ha_domain: namecheapdns
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-With the `namecheapdns` integration you can automatically update your dynamic DNS entry hosted by Namecheap's [FreeDNS](https://www.namecheap.com/store/domains/freedns/) service.
+With the `namecheapdns` {% term integration %} you can automatically update your dynamic DNS entry hosted by Namecheap's [FreeDNS](https://www.namecheap.com/store/domains/freedns/) service.
Namecheap only supports updating IPv4 addresses.
@@ -17,7 +20,8 @@ Namecheap only supports updating IPv4 addresses.
## Configuration
-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/nederlandse_spoorwegen.markdown b/source/_integrations/nederlandse_spoorwegen.markdown
index 26aad0d8f26..fa36062d9f0 100644
--- a/source/_integrations/nederlandse_spoorwegen.markdown
+++ b/source/_integrations/nederlandse_spoorwegen.markdown
@@ -11,13 +11,17 @@ ha_domain: nederlandse_spoorwegen
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This sensor will provide you with time table information of the [Nederlandse Spoorwegen](https://www.ns.nl/) train service in the Netherlands.
+This {% term integration %} will provide you with time table information of the [Nederlandse Spoorwegen](https://www.ns.nl/) train service in the Netherlands.
To obtain an API key, create an account on the [NS API-Portaal](https://apiportal.ns.nl/) and obtain an API key for the `Reisinformatie` API which is part of the `Ns-App` product.
-The `nederlandse_spoorwegen` integration can be configured using `configuration.yaml` as shown below:
+The `nederlandse_spoorwegen` {% term integration %} can be configured using your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown
index 2f2845432eb..b02c3283ad1 100644
--- a/source/_integrations/ness_alarm.markdown
+++ b/source/_integrations/ness_alarm.markdown
@@ -13,9 +13,12 @@ ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ness_alarm` integration will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm.
+The `ness_alarm` {% term integration %} will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm.
There is currently support for the following device types within Home Assistant:
@@ -26,7 +29,8 @@ The module communicates via the [Ness D8x/D16x ASCII protocol](https://ia802202.
## Configuration
-A `ness_alarm` section must be present in the `configuration.yaml` file and contain the following options as required:
+A `ness_alarm` section must be present in the {% term "`configuration.yaml`" %} file and contain the following options as required:
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -104,15 +108,15 @@ scan_interval:
Trigger an aux output. This requires PCB version 7.8 or higher.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `output_id` | No | The aux output you wish to change. A number from 1-4.
-| `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `output_id` | No | The aux output you wish to change. A number from 1-4. |
+| `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. |
### Service `panic`
Trigger a panic
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `code` | No | The user code to use to trigger the panic.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------ |
+| `code` | No | The user code to use to trigger the panic. |
diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown
index 02fc40b2d6d..42870d67453 100644
--- a/source/_integrations/netdata.markdown
+++ b/source/_integrations/netdata.markdown
@@ -11,9 +11,12 @@ ha_domain: netdata
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `netdata` sensor platform allows you to display information collected by [Netdata](https://www.netdata.cloud/).
+The `netdata` sensor {% term integration %} allows you to display information collected by [Netdata](https://www.netdata.cloud/).
## Prerequisites
@@ -69,7 +72,8 @@ 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 {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
## Configuration
diff --git a/source/_integrations/netio.markdown b/source/_integrations/netio.markdown
index a49ccf8f83b..ca5d58c164c 100644
--- a/source/_integrations/netio.markdown
+++ b/source/_integrations/netio.markdown
@@ -9,11 +9,15 @@ ha_domain: netio
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `netio` switch platform allows you to control your [Netio](https://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or Wi-Fi that reports consumptions (Netio4all). This integration requires Telnet to be enabled on the Netio device.
+The `netio` switch {% term integration %} allows you to control your [Netio](https://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or Wi-Fi that reports consumptions (Netio4all). This integration requires Telnet to be enabled on the Netio device.
-To use Netio devices in your installation, add the following to your `configuration.yaml` file:
+To use Netio devices 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/neurio_energy.markdown b/source/_integrations/neurio_energy.markdown
index 443e537aecc..311f95668d7 100644
--- a/source/_integrations/neurio_energy.markdown
+++ b/source/_integrations/neurio_energy.markdown
@@ -9,11 +9,15 @@ ha_domain: neurio_energy
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrate your [Neurio](https://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your [Neurio account](https://my.neur.io/#settings/applications/register) and register an application. Note the Homepage URL and Callback URL are optional.
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/niko_home_control.markdown b/source/_integrations/niko_home_control.markdown
index aa16b621e45..7d70318d816 100644
--- a/source/_integrations/niko_home_control.markdown
+++ b/source/_integrations/niko_home_control.markdown
@@ -9,13 +9,17 @@ ha_domain: niko_home_control
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `niko_home_control` platform allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant.
+The `niko_home_control` {% term integration %} allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant.
## Configuration
-To enable this lights, add the following lines to your `configuration.yaml`:
+To enable this lights, 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/nilu.markdown b/source/_integrations/nilu.markdown
index f5724e2e38a..c55ce4d4672 100644
--- a/source/_integrations/nilu.markdown
+++ b/source/_integrations/nilu.markdown
@@ -11,13 +11,17 @@ ha_domain: nilu
ha_platforms:
- air_quality
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `nilu` air quality platform shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](https://www.luftkvalitet.info) and [nilu.no](https://nilu.no/) available in Home Assistant.
+The `nilu` air quality {% term integration %} shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](https://www.luftkvalitet.info) and [nilu.no](https://nilu.no/) available in Home Assistant.
## Configuration
-To enable this platform, 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/nina.markdown b/source/_integrations/nina.markdown
index c2664f49113..988edfd8c70 100644
--- a/source/_integrations/nina.markdown
+++ b/source/_integrations/nina.markdown
@@ -20,7 +20,7 @@ For each county/city it creates warning slots that change to Unsafe when warning
-This integration may only works with an Internet connection that supports IPv4.
+This integration may only work with an Internet connection that supports IPv4.
diff --git a/source/_integrations/nissan_leaf.markdown b/source/_integrations/nissan_leaf.markdown
index b710bc007b8..950010d0b67 100644
--- a/source/_integrations/nissan_leaf.markdown
+++ b/source/_integrations/nissan_leaf.markdown
@@ -14,17 +14,20 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings.
+The `nissan_leaf` {% term integration %} offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings.
-Please be aware that the `nissan_leaf` integration only works with Nissan vehicles from before 2019. Newer vehicles will not work with this integration.
+Please be aware that the `nissan_leaf` {% term integration %} only works with Nissan vehicles from before 2019. Newer vehicles will not work with this integration.
-The integration offers offers:
+The {% term integration %} offers offers:
- sensors for the battery status, range and charging status.
- a switch to start and stop the climate control.
@@ -33,7 +36,8 @@ The integration offers offers:
## Configuration
-To use Nissan Leaf in your installation, add the following to your `configuration.yaml` file:
+To use Nissan Leaf 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/nmbs.markdown b/source/_integrations/nmbs.markdown
index 56cf49efd75..2e7f69a32e1 100644
--- a/source/_integrations/nmbs.markdown
+++ b/source/_integrations/nmbs.markdown
@@ -11,13 +11,17 @@ ha_domain: nmbs
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations.
+The `nmbs` {% term integration %} will create sensors for monitoring travel time and information between 2 stations.
## Configuration
-To enable this sensor, add the following lines to your `configuration.yaml`:
+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/no_ip.markdown b/source/_integrations/no_ip.markdown
index 040c40b5dbb..7a04f498ebf 100644
--- a/source/_integrations/no_ip.markdown
+++ b/source/_integrations/no_ip.markdown
@@ -7,13 +7,17 @@ ha_iot_class: Cloud Polling
ha_release: 0.57
ha_domain: no_ip
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-With the `no_ip` integration you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain.
+With the `no_ip` {% term integration %} you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain.
Note that it does not confirm your hostname (as is required periodically for free domain names); you will still need to do that manually.
-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/noaa_tides.markdown b/source/_integrations/noaa_tides.markdown
index 64ea1349272..2df28c52e01 100644
--- a/source/_integrations/noaa_tides.markdown
+++ b/source/_integrations/noaa_tides.markdown
@@ -13,15 +13,16 @@ ha_platforms:
ha_integration_type: integration
---
-The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States.
+The `noaa_tides` sensor {% term integration %} uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States.
## Setup
-This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164`
+This {% term integration %} requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164`
## Configuration
-To use this sensor, add the following to your `configuration.yaml` file:
+To use this {% term integration %}, 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/norway_air.markdown b/source/_integrations/norway_air.markdown
index 8c3751d7936..7c1ed2c040b 100644
--- a/source/_integrations/norway_air.markdown
+++ b/source/_integrations/norway_air.markdown
@@ -9,11 +9,15 @@ ha_domain: norway_air
ha_platforms:
- air_quality
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `norway_air` integration [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute.
+The `norway_air` {% term integration %} [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute.
-To add air quality sensor to your installation, add the following to your `configuration.yaml` file:
+To add the air quality {% term integration %} 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/notify_events.markdown b/source/_integrations/notify_events.markdown
index b51bf8bce00..60ada8c75cc 100644
--- a/source/_integrations/notify_events.markdown
+++ b/source/_integrations/notify_events.markdown
@@ -12,11 +12,14 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
## Description
-The [Notify.Events service](https://notify.events/) is a platform for the **notify** integration.
+The [Notify.Events service](https://notify.events/) is an {% term integration %} for the **notify** integration.
This platform allows you to quickly configure the distribution of messages between different recipients, no matter how they are used to receiving notifications:
@@ -52,7 +55,8 @@ token:
type: string
{% endconfiguration %}
-Now you can use notify_events integration as a platform for your **notify service**, add the following to your `configuration.yaml` file:
+Now you can use notify_events integration as a platform for your **notify service**, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}:
```yaml
# Example configuration.yaml entry
@@ -98,21 +102,21 @@ Now you can use the `notify.events` service inside your Home Assistant to:
The following attributes can be placed inside `data` for extended functionality.
-| Attribute | Description
-| ---------- | -----------
-| `title` | Message title.
-| `level` | For recipients who have differences in the display of messages at different levels, this level will be applied.
Available values: `verbose`, `info`, `notice`, `warning`, `error`, `success`.
-| `priority` | For recipients which supports priority, the message will be highlighted accordingly.
Available values: `lowest`, `low`, `normal`, `high`, `highest`.
-| `images` | Array of images to attach (see item properties below).
-| `files` | Array of files to attach (see item properties below).
-| `token` | Notify.Events channel token (in case you want to override the channel to get this message to).
+| Attribute | Description |
+| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `title` | Message title. |
+| `level` | For recipients who have differences in the display of messages at different levels, this level will be applied.
Available values: `verbose`, `info`, `notice`, `warning`, `error`, `success`. |
+| `priority` | For recipients which supports priority, the message will be highlighted accordingly.
Available values: `lowest`, `low`, `normal`, `high`, `highest`. |
+| `images` | Array of images to attach (see item properties below). |
+| `files` | Array of files to attach (see item properties below). |
+| `token` | Notify.Events channel token (in case you want to override the channel to get this message to). |
Every item of images and files has the following properties:
-| Property | Required | Description
-| ---------------------------- | -------- | ----
-| `path` or `url` or `content` | True | File source.
-| `name` | False | Result file name
-| `mime_type` | False | File MIME-type
+| Property | Required | Description |
+| ---------------------------- | -------- | ---------------- |
+| `path` or `url` or `content` | True | File source. |
+| `name` | False | Result file name |
+| `mime_type` | False | File MIME-type |
To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/_integrations/nsw_rural_fire_service_feed.markdown b/source/_integrations/nsw_rural_fire_service_feed.markdown
index 19882a14db0..fd77fae7699 100644
--- a/source/_integrations/nsw_rural_fire_service_feed.markdown
+++ b/source/_integrations/nsw_rural_fire_service_feed.markdown
@@ -11,6 +11,9 @@ ha_domain: nsw_rural_fire_service_feed
ha_platforms:
- geo_location
ha_integration_type: service
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location.
@@ -31,7 +34,8 @@ The data is updated every 5 minutes.
## Configuration
-To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your `configuration.yaml`.
+To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -66,21 +70,21 @@ longitude:
The following state attributes are available for each entity in addition to the standard ones:
-| Attribute | Description |
-|--------------------|-------------|
-| latitude | Latitude of the incident. |
-| longitude | Longitude of the incident. |
+| Attribute | Description |
+| ------------------ | ----------------------------------------------------------------------------------------------- |
+| latitude | Latitude of the incident. |
+| longitude | Longitude of the incident. |
| source | `nsw_rural_fire_service_feed` to be used in conjunction with `geo_location` automation trigger. |
-| external_id | The external ID used in the feed to identify the incident in the feed. |
-| category | One of 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'. |
-| location | Location details of where the incident takes place. |
-| publication_date | Date and time when this incident was last updated. |
-| council_area | Council area in which this incident takes place. |
-| status | One of 'Under Control', 'Being Controlled', 'Out of Control'. |
-| type | Incident type, for example 'Bush Fire', 'Grass Fire' or 'Hazard Reduction'. |
-| fire | `True` if this incident is a fire, `False` otherwise. |
-| size | Size in hectare |
-| responsible_agency | Agency responsible for this incident. |
+| external_id | The external ID used in the feed to identify the incident in the feed. |
+| category | One of 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'. |
+| location | Location details of where the incident takes place. |
+| publication_date | Date and time when this incident was last updated. |
+| council_area | Council area in which this incident takes place. |
+| status | One of 'Under Control', 'Being Controlled', 'Out of Control'. |
+| type | Incident type, for example 'Bush Fire', 'Grass Fire' or 'Hazard Reduction'. |
+| fire | `True` if this incident is a fire, `False` otherwise. |
+| size | Size in hectare |
+| responsible_agency | Agency responsible for this incident. |
## Advanced Configuration Example
diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown
index 3c5574a3bef..23a44649cb7 100644
--- a/source/_integrations/nx584.markdown
+++ b/source/_integrations/nx584.markdown
@@ -11,9 +11,12 @@ ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](https://github.com/kk7ds/pynx584) which is required for this to work.
+The `nx584` {% term integration %} provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](https://github.com/kk7ds/pynx584) which is required for this to work.
There is currently support for the following device types within Home Assistant:
@@ -22,7 +25,8 @@ There is currently support for the following device types within Home Assistant:
## Alarm control panel
-To enable this, add the following lines to your `configuration.yaml`:
+To enable this, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -120,16 +124,16 @@ binary_sensor:
This service will bypass a given zone.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | entity_id of the NX584 Alarm.
-| `zone` | no | Zone number you want to bypass.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------- |
+| `entity_id` | yes | entity_id of the NX584 Alarm. |
+| `zone` | no | Zone number you want to bypass. |
### Service `unbypass_zone`
This service will unbypass a given zone.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | entity_id of the NX584 Alarm.
-| `zone` | no | Zone number you want to unbypass.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------- |
+| `entity_id` | yes | entity_id of the NX584 Alarm. |
+| `zone` | no | Zone number you want to unbypass. |
diff --git a/source/_integrations/oasa_telematics.markdown b/source/_integrations/oasa_telematics.markdown
index 0df45cd7a4b..ed14ed07b56 100644
--- a/source/_integrations/oasa_telematics.markdown
+++ b/source/_integrations/oasa_telematics.markdown
@@ -10,13 +10,17 @@ ha_domain: oasa_telematics
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `oasa_telematics` sensor will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/).
+The `oasa_telematics` {% term integration %} will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/).
## Configuration
-Add a sensor to your `configuration.yaml` file as shown in the example:
+Add the {% term integration %} to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/oem.markdown b/source/_integrations/oem.markdown
index 30071180980..7fdb80b31b2 100644
--- a/source/_integrations/oem.markdown
+++ b/source/_integrations/oem.markdown
@@ -9,13 +9,17 @@ ha_domain: oem
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://web.archive.org/web/20220426080315/https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/) (archived page, no longer for sale). The underlying [library](https://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/).
+This {% term integration %} supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://web.archive.org/web/20220426080315/https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/) (archived page, no longer for sale). The underlying [library](https://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/).
This platform controls the setpoint of the thermostat in its "manual" mode.
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/ohmconnect.markdown b/source/_integrations/ohmconnect.markdown
index d0b711845e7..7c19ee1a973 100644
--- a/source/_integrations/ohmconnect.markdown
+++ b/source/_integrations/ohmconnect.markdown
@@ -11,9 +11,12 @@ ha_domain: ohmconnect
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID.
+The `ohmconnect` {% term integration %} will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID.
OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that.
@@ -21,7 +24,8 @@ OhmConnect monitors real-time conditions on the electricity grid. When dirty and
You can find your OhmConnect ID on the [OhmConnect API settings page](https://login.ohmconnect.com/api/v2/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`.
-To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file:
+To enable the OhMConnect {% 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/ombi.markdown b/source/_integrations/ombi.markdown
index d0e3014bb18..b3ad34c741d 100644
--- a/source/_integrations/ombi.markdown
+++ b/source/_integrations/ombi.markdown
@@ -11,13 +11,16 @@ ha_domain: ombi
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The Ombi integration monitors data from your [Ombi](https://ombi.io) instance.
## Setup
-This integration needs to authenticate to your Ombi instance with either a user `password` or an `api_key`.
+This {% term integration %} needs to authenticate to your Ombi instance with either a user `password` or an `api_key`.
To find your `api_key` open the Ombi web interface. Navigate to **Settings** and then to **Ombi**, you should then be able to see your `api_key`.
@@ -25,7 +28,8 @@ If you want to use `password` authentication simply use the same `password` you
## Configuration
-If you want to enable this sensor, add the following lines to your `configuration.yaml`:
+If you want 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
@@ -91,23 +95,23 @@ Available services: `submit_movie_request`, `submit_music_request`, `submit_tv_r
Searches and requests the closest matching movie.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------ |
-| `name` | no | Search parameter. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------- |
+| `name` | no | Search parameter. |
#### Service `submit_music_request`
Searches and requests the closest matching music album.
-| Service data attribute | Optional | Description |
-|------------------------|----------|--------------------------------------------------|
-| `name` | no | Search parameter. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------- |
+| `name` | no | Search parameter. |
#### Service `submit_tv_request`
Searches and requests the closest matching TV show.
-| Service data attribute | Optional | Description |
-|------------------------|----------|-----------------------------------------------------------------------------------------------|
-| `name` | no | Search parameter. |
-| `season` | yes | Which season(s) to request. Must be one of `first`, `latest` or `all`. Defaults to latest. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------ |
+| `name` | no | Search parameter. |
+| `season` | yes | Which season(s) to request. Must be one of `first`, `latest` or `all`. Defaults to latest. |
diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown
index c6613f9fba5..35e2f9e588c 100644
--- a/source/_integrations/onkyo.markdown
+++ b/source/_integrations/onkyo.markdown
@@ -9,15 +9,19 @@ ha_domain: onkyo
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `onkyo` platform allows you to control a [Onkyo](https://www.onkyo.com), [Integra](http://www.integrahometheater.com)
+The `onkyo` {% term integration %} allows you to control a [Onkyo](https://www.onkyo.com), [Integra](http://www.integrahometheater.com)
and some recent [Pioneer](https://www.pioneerelectronics.com) receivers from Home Assistant.
Please be aware that you need to enable "Network Standby" for this integration to work in your Hardware.
## Configuration
-To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file:
+To add an Onkyo or Pioneer receiver 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
@@ -105,10 +109,10 @@ unknown-model: master-volume = 191
Changes HDMI output of your receiver
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | String or list of a single `entity_id` that will change output.
-| `hdmi_output` | no | The desired output code.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------- |
+| `entity_id` | no | String or list of a single `entity_id` that will change output. |
+| `hdmi_output` | no | The desired output code. |
Accepted values are:
'no', 'analog', 'yes', 'out', 'out-sub', 'sub', 'hdbaset', 'both', 'up'
diff --git a/source/_integrations/openalpr_cloud.markdown b/source/_integrations/openalpr_cloud.markdown
index 0ee6bde7b8a..c0ea55d94e0 100644
--- a/source/_integrations/openalpr_cloud.markdown
+++ b/source/_integrations/openalpr_cloud.markdown
@@ -7,9 +7,12 @@ ha_iot_class: Cloud Push
ha_release: 0.36
ha_domain: openalpr_cloud
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
+The [OpenALPR](https://www.openalpr.com/) {% term integration %} for Home Assistant allows you
to process license plates from a camera. This allows you to open a garage door
or trigger any other [automation](/integrations/automation/) based on a license plate.
@@ -18,6 +21,9 @@ take a look at the [integration](/integrations/image_processing/) page.
### Configuration
+To enable the OPENALPR {% term integration %}, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
image_processing:
diff --git a/source/_integrations/openerz.markdown b/source/_integrations/openerz.markdown
index df73a818750..b573774b85d 100644
--- a/source/_integrations/openerz.markdown
+++ b/source/_integrations/openerz.markdown
@@ -11,13 +11,17 @@ ha_codeowners:
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `openerz` sensor platform uses [OpenERZ](http://openerz.metaodi.ch/) API to access data from Entsorgung und Recycling Zürich (ERZ). It reports the next pickup date for the specified zip and waste type.
+This `openerz` sensor {% term integration %} uses [OpenERZ](http://openerz.metaodi.ch/) API to access data from Entsorgung und Recycling Zürich (ERZ). It reports the next pickup date for the specified zip and waste type.
## Configuration
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/openevse.markdown b/source/_integrations/openevse.markdown
index 4d4e89e740d..20283d33203 100644
--- a/source/_integrations/openevse.markdown
+++ b/source/_integrations/openevse.markdown
@@ -9,13 +9,17 @@ ha_domain: openevse
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection.
+This `openevse` sensor {% term integration %} pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection.
## Configuration
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable 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/openhardwaremonitor.markdown b/source/_integrations/openhardwaremonitor.markdown
index 939770b1c45..a47fd7e4cdb 100644
--- a/source/_integrations/openhardwaremonitor.markdown
+++ b/source/_integrations/openhardwaremonitor.markdown
@@ -9,9 +9,12 @@ ha_domain: openhardwaremonitor
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `openhardwaremonitor` platform uses your [Open Hardware Monitor](https://openhardwaremonitor.org/) installation as a source for sensors that will display system information.
+The `openhardwaremonitor` {% term integration %} uses your [Open Hardware Monitor](https://openhardwaremonitor.org/) installation as a source for sensors that will display system information.
## Setup
@@ -37,7 +40,8 @@ sudo firewall-cmd --reload
## Configuration
-To add Open Hardware Monitor to your installation, add the following to your `configuration.yaml` file:
+To add Open Hardware Monitor 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/opensensemap.markdown b/source/_integrations/opensensemap.markdown
index 338f1ef458d..21d1d5dddfa 100644
--- a/source/_integrations/opensensemap.markdown
+++ b/source/_integrations/opensensemap.markdown
@@ -9,9 +9,12 @@ ha_domain: opensensemap
ha_platforms:
- air_quality
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `opensensemap` air quality platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station.
+The `opensensemap` air quality {% term integration %} will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station.
## Setup
@@ -19,7 +22,8 @@ To get the ID of a station you need to select it on the [openSense map](https://
## Manual configuration
-To enable this platform, 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/opple.markdown b/source/_integrations/opple.markdown
index 4de10b970b5..66c82a47b84 100644
--- a/source/_integrations/opple.markdown
+++ b/source/_integrations/opple.markdown
@@ -9,13 +9,17 @@ ha_domain: opple
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `opple` light platform allows you to control the state of your Opple smart light.
+The `opple` light {% term integration %} allows you to control the state of your Opple smart light.
The platform supports all Opple lights with Wi-Fi support or lights that can be controlled by the App.
-To use your Opple light in your installation, add the following to your `configuration.yaml` file:
+To use your Opple light 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/oru.markdown b/source/_integrations/oru.markdown
index 15f4ce9f35f..ed60f03fa58 100644
--- a/source/_integrations/oru.markdown
+++ b/source/_integrations/oru.markdown
@@ -11,14 +11,18 @@ ha_domain: oru
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[Orange and Rockland Utility](https://oru.com) is an energy provider in NY and NJ, USA.
-The `oru` sensor platform fetches your current energy usage from your ORU smart meter.
+The `oru` sensor {% term integration %} fetches your current energy usage from your ORU smart meter.
## Configuration
-To add the `oru` sensor to your installation, add your `meter_number` to your `configuration.yaml` file:
+To add the `oru` {% term integration %} to your installation, add your `meter_number` to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/osramlightify.markdown b/source/_integrations/osramlightify.markdown
index 76c08c4c237..7ab3dfed980 100644
--- a/source/_integrations/osramlightify.markdown
+++ b/source/_integrations/osramlightify.markdown
@@ -9,9 +9,15 @@ ha_domain: osramlightify
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `osramlightify` platform allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant.
+The `osramlightify` {% term integration %} allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant.
+
+To enable the {% term integration %}, add 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/otp.markdown b/source/_integrations/otp.markdown
index dd720f74729..9954dedf775 100644
--- a/source/_integrations/otp.markdown
+++ b/source/_integrations/otp.markdown
@@ -11,13 +11,17 @@ ha_domain: otp
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds.
+The `otp` {% term integration %} generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds.
## Configuration
-To enable the OTP sensor, add the following lines to your `configuration.yaml`:
+To enable the OTP {% 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/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown
index c6bbd9e5357..bdd0be741f8 100644
--- a/source/_integrations/panasonic_viera.markdown
+++ b/source/_integrations/panasonic_viera.markdown
@@ -12,9 +12,12 @@ ha_platforms:
- media_player
- remote
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Panasonic Viera integration allows you to control a Panasonic Viera TV.
+The Panasonic Viera {% term integration %} allows you to control a Panasonic Viera TV.
There is currently support for the following device types within Home Assistant:
@@ -30,6 +33,8 @@ To allow your TV to be turned on or controlled while off, enable `Powered On By
## Manual configuration
If you prefer to use YAML to set up your Panasonic Viera TV, you can still do it. It also allows for some extra settings.
+To enable the integration via YAML, add 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/pandora.markdown b/source/_integrations/pandora.markdown
index 5dced5c6e7e..afff323f618 100644
--- a/source/_integrations/pandora.markdown
+++ b/source/_integrations/pandora.markdown
@@ -9,6 +9,9 @@ ha_domain: pandora
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
If you have a Pandora account, you can control it from Home Assistant with this media player.
@@ -53,7 +56,8 @@ Test it out by running `pianobar` in the command line. You should be able to lis
### Configuration in Home Assistant
-The Pandora player can be loaded by adding the following lines to your `configuration.yaml`:
+The Pandora player can be loaded by adding 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/panel_custom.markdown b/source/_integrations/panel_custom.markdown
index bd3270a9b65..dd83cc95564 100644
--- a/source/_integrations/panel_custom.markdown
+++ b/source/_integrations/panel_custom.markdown
@@ -9,11 +9,15 @@ ha_codeowners:
- '@home-assistant/frontend'
ha_domain: panel_custom
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `panel_custom` integration allows you to write your own panels in JavaScript and add them to Home Assistant. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/frontend/custom-ui/creating-custom-panels/).
+The `panel_custom` {% term integration %} allows you to write your own panels in JavaScript and add them to Home Assistant. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/frontend/custom-ui/creating-custom-panels/).
-To enable customized panels in your installation, add the following to your `configuration.yaml` file:
+To enable customized panels 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/pencom.markdown b/source/_integrations/pencom.markdown
index 96ab2649b06..ba1b0c3fcb5 100644
--- a/source/_integrations/pencom.markdown
+++ b/source/_integrations/pencom.markdown
@@ -9,13 +9,17 @@ ha_domain: pencom
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[Pencom Design](https://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
## Configuration
-The Pencom relays can be daisy-chained to allow for up to 8 boards.
+The Pencom relays can be daisy-chained to allow for up to 8 boards. To enable Pencom in your installation, add 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/picotts.markdown b/source/_integrations/picotts.markdown
index a57e17d2102..998fc48e769 100644
--- a/source/_integrations/picotts.markdown
+++ b/source/_integrations/picotts.markdown
@@ -9,14 +9,18 @@ ha_domain: picotts
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `picotts` text-to-speech platform uses [Pico TTS library](https://github.com/naggety/picotts) to read out text with natural sounding voices.
+The `picotts` text-to-speech {% term integration %} uses [Pico TTS library](https://github.com/naggety/picotts) to read out text with natural sounding voices.
Pico TTS is a powerful open-source engine that runs locally (cloudless) so it can work even without an internet connection.
## Configuration
-To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`:
+To enable text-to-speech with Pico, 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/pilight.markdown b/source/_integrations/pilight.markdown
index 2056e1992a4..8d070eb7dd9 100644
--- a/source/_integrations/pilight.markdown
+++ b/source/_integrations/pilight.markdown
@@ -17,6 +17,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://manual.pilight.org/protocols/) are already available.
@@ -34,7 +37,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate pilight into 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/pioneer.markdown b/source/_integrations/pioneer.markdown
index 6b68b469619..44f9ce2398a 100644
--- a/source/_integrations/pioneer.markdown
+++ b/source/_integrations/pioneer.markdown
@@ -9,11 +9,15 @@ ha_domain: pioneer
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `pioneer` platform allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/integrations/onkyo) platform instead.
+The `pioneer` {% term integration %} allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/integrations/onkyo) platform instead.
-To add a Pioneer receiver to your installation, add the following to your `configuration.yaml` file:
+To add a Pioneer receiver 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/pjlink.markdown b/source/_integrations/pjlink.markdown
index 00948dda491..7f99441de15 100644
--- a/source/_integrations/pjlink.markdown
+++ b/source/_integrations/pjlink.markdown
@@ -9,13 +9,17 @@ ha_domain: pjlink
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](https://pjlink.jbmia.or.jp/english/index.html).
+The `pjlink` {% term integration %} allows you to control from Home Assistant, projectors with support for the [PJLink protocol](https://pjlink.jbmia.or.jp/english/index.html).
## Configuration
-To add a PJLink projector to your installation, add the following to your `configuration.yaml` file:
+To add a PJLink projector 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/plant.markdown b/source/_integrations/plant.markdown
index 67c0d1d88f3..253db87e2e4 100644
--- a/source/_integrations/plant.markdown
+++ b/source/_integrations/plant.markdown
@@ -7,13 +7,17 @@ ha_release: 0.44
ha_quality_scale: internal
ha_domain: plant
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `plant` integration lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits.
+This `plant` {% term integration %} lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits.
## Configuration
-To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file:
+To use your `plant` 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/pocketcasts.markdown b/source/_integrations/pocketcasts.markdown
index a7a28f932d0..769c8336915 100644
--- a/source/_integrations/pocketcasts.markdown
+++ b/source/_integrations/pocketcasts.markdown
@@ -9,13 +9,17 @@ ha_domain: pocketcasts
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `pocketcasts` sensor platform lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work!
+The `pocketcasts` sensor {% term integration %} lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work!
## Configuration
-To enable this sensor, add the following lines to your `configuration.yaml`:
+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/point.markdown b/source/_integrations/point.markdown
index 7b91a0fe8cb..0561832e5d5 100644
--- a/source/_integrations/point.markdown
+++ b/source/_integrations/point.markdown
@@ -18,6 +18,9 @@ ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account and have a Pro subscription](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://homeassistant.local:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
@@ -32,6 +35,9 @@ There is currently support for the following device types within Home Assistant:
### Configuration
+To use the Minut Point {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
point:
diff --git a/source/_integrations/prometheus.markdown b/source/_integrations/prometheus.markdown
index c6ae3263cc0..cff2bb947ba 100644
--- a/source/_integrations/prometheus.markdown
+++ b/source/_integrations/prometheus.markdown
@@ -9,13 +9,17 @@ ha_domain: prometheus
ha_codeowners:
- '@knyar'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read.
+The `prometheus` {% term integration %} exposes metrics in a format which [Prometheus](https://prometheus.io/) can read.
## Configuration
-To use the `prometheus` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `prometheus` {% 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/prowl.markdown b/source/_integrations/prowl.markdown
index a5b68f9a77b..fb3ea5b4281 100644
--- a/source/_integrations/prowl.markdown
+++ b/source/_integrations/prowl.markdown
@@ -9,13 +9,17 @@ ha_domain: prowl
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `prowl` platform uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
+The `prowl` {% term integration %} uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
Go to the [Prowl website](https://www.prowlapp.com/) and create a new API key.
-To add Prowl notifications to your installation, add the following to your `configuration.yaml` file:
+To add Prowl 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
@@ -41,9 +45,9 @@ api_key:
The following attributes can be placed `data` for extended functionality.
-| Service data attribute | Optional | Default | Description |
-| ---------------------- | -------- | ------- | ----------- |
-| `priority` | yes | 0 | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
-| `url` | yes | n/a | URL to be attached, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
+| Service data attribute | Optional | Default | Description |
+| ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- |
+| `priority` | yes | 0 | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
+| `url` | yes | n/a | URL to be attached, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/_integrations/proxmoxve.markdown b/source/_integrations/proxmoxve.markdown
index 98545d12adc..d1297d36f8c 100644
--- a/source/_integrations/proxmoxve.markdown
+++ b/source/_integrations/proxmoxve.markdown
@@ -12,11 +12,14 @@ ha_domain: proxmoxve
ha_platforms:
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[Proxmox VE](https://www.proxmox.com/en/) is an open-source server virtualization environment. This integration allows you to poll various data from your instance.
-After configuring this integration, the binary sensors automatically appear.
+After configuring this {% term integration %}, the binary sensors automatically appear.
## Configuration
@@ -24,7 +27,8 @@ After configuring this integration, the binary sensors automatically appear.
You should have at least one VM or container entry configured, else this integration won't do anything.
This integration is only available on Home Assistant Core installation types. Unfortunately, it cannot be used with Home Assistant OS, Supervised or Container.
@@ -19,7 +22,8 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration
-To enable this camera in your installation, add the following to your `configuration.yaml` file:
+To enable this camera 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/rss_feed_template.markdown b/source/_integrations/rss_feed_template.markdown
index 5e7a04bfa47..36e79e62bba 100644
--- a/source/_integrations/rss_feed_template.markdown
+++ b/source/_integrations/rss_feed_template.markdown
@@ -12,7 +12,7 @@ ha_codeowners:
ha_integration_type: integration
---
-The `rss_feed_template` integration can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform.
+The `rss_feed_template` {% term integration %} can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform.
For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.
diff --git a/source/_integrations/rtorrent.markdown b/source/_integrations/rtorrent.markdown
index 1156ba80315..a7484d2718f 100644
--- a/source/_integrations/rtorrent.markdown
+++ b/source/_integrations/rtorrent.markdown
@@ -9,11 +9,15 @@ ha_domain: rtorrent
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `rtorrent` platform allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
+The `rtorrent` {% term integration %} allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
-To enable this sensor, add the following lines to your `configuration.yaml`:
+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/russound_rio.markdown b/source/_integrations/russound_rio.markdown
index 83380f7c5ad..c422c5176d4 100644
--- a/source/_integrations/russound_rio.markdown
+++ b/source/_integrations/russound_rio.markdown
@@ -9,13 +9,17 @@ ha_domain: russound_rio
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `russound_rio` platform allows you to control Russound devices that make use of the RIO protocol.
+The `russound_rio` {% term integration %} allows you to control Russound devices that make use of the RIO protocol.
The platform automatically discovers all enabled zones and sources. Each zone is added as a media player device with the enabled sources available as inputs. Media information is supported if the selected source reports it.
-To add a device to your installation, add the following to your `configuration.yaml` file:
+To add a 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
diff --git a/source/_integrations/russound_rnet.markdown b/source/_integrations/russound_rnet.markdown
index 3cfb07d47ec..48140ef4b54 100644
--- a/source/_integrations/russound_rnet.markdown
+++ b/source/_integrations/russound_rnet.markdown
@@ -9,15 +9,19 @@ ha_domain: russound_rnet
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol.
+The `russound_rnet` {% term integration %} allows you to control Russound devices that make use of the RNET protocol.
This has initially been tested against a Russound CAV6.6 unit with six zones and six sources. It will also work with a Russound CAA66, but be sure to use a null-modem cable. If you have mutiple controllers connected via the RNET link ports, every increment of 6 zones maps to the corresponding controller ID.
Connecting to the Russound device is only possible by TCP, you can make use of a TCP to Serial gateway such as [tcp_serial_redirect](https://github.com/pyserial/pyserial/blob/master/examples/tcp_serial_redirect.py)
-To add a device to your installation, add the following to your `configuration.yaml` file:
+To add an {% term integration %} 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/saj.markdown b/source/_integrations/saj.markdown
index 81e89fff6dd..d6270dd93f0 100644
--- a/source/_integrations/saj.markdown
+++ b/source/_integrations/saj.markdown
@@ -11,9 +11,12 @@ ha_domain: saj
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `saj` sensor will poll a [SAJ](https://www.saj-electric.com/) solar inverter and present the values as sensors in Home Assistant.
+The `saj` {% term integration %} will poll a [SAJ](https://www.saj-electric.com/) solar inverter and present the values as sensors in Home Assistant.
This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser.
@@ -22,7 +25,8 @@ The Wi-Fi module requires a username and password for authentication where the e
## 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
@@ -59,17 +63,17 @@ password:
Sensors available in the library:
-| name | Unit | Description |
-|--------------------|------|:-----------------------------------------------------------------------------|
-| current_power | W | Current power generated by the inverter. |
-| today_yield | kWh | Power yield for today. |
-| today_time | h | Inverter's running time for today. |
-| today_max_current | W | Maximum current power for today. (only for connection via ethernet module) |
-| total_yield | kWh | Total kWh generated to date. |
-| total_time | h | Total running time of the inverter. |
-| total_co2_reduced | kg | Total CO2 in kg reduced. |
-| temperature | °C | Temperature of the inverter. |
-| state | N/A | Live state of the inverter. |
+| name | Unit | Description |
+| ----------------- | ---- | :------------------------------------------------------------------------- |
+| current_power | W | Current power generated by the inverter. |
+| today_yield | kWh | Power yield for today. |
+| today_time | h | Inverter's running time for today. |
+| today_max_current | W | Maximum current power for today. (only for connection via ethernet module) |
+| total_yield | kWh | Total kWh generated to date. |
+| total_time | h | Total running time of the inverter. |
+| total_co2_reduced | kg | Total CO2 in kg reduced. |
+| temperature | °C | Temperature of the inverter. |
+| state | N/A | Live state of the inverter. |
## Full configuration example for Wi-Fi inverters
diff --git a/source/_integrations/satel_integra.markdown b/source/_integrations/satel_integra.markdown
index 38e8dcc2ad8..d4f1ee7cc22 100644
--- a/source/_integrations/satel_integra.markdown
+++ b/source/_integrations/satel_integra.markdown
@@ -14,9 +14,12 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `satel_integra` integration will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed).
+The `satel_integra` {% term integration %} will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed).
There is currently support for the following device types within Home Assistant:
@@ -38,7 +41,8 @@ For the binary sensor, check the [type/class](/integrations/binary_sensor/) list
## Configuration
-A `satel_integra` section must be present in the `configuration.yaml` file:
+A `satel_integra` section must be present in the {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/schluter.markdown b/source/_integrations/schluter.markdown
index 3d06174a6a0..a966bf1a7e0 100644
--- a/source/_integrations/schluter.markdown
+++ b/source/_integrations/schluter.markdown
@@ -11,9 +11,12 @@ ha_codeowners:
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `schluter` integration allows you to integrate your [Schluter-DITRA-HEAT-E-WiFi](https://www.schluter.com/schluter-us/en_US/ditra-heat-wifi) electric floor heating thermostat in Home Assistant.
+The `schluter` {% term integration %} allows you to integrate your [Schluter-DITRA-HEAT-E-WiFi](https://www.schluter.com/schluter-us/en_US/ditra-heat-wifi) electric floor heating thermostat in Home Assistant.
You will need to create a Schluter DITRA-HEAT account and register your thermostat with it. This can be done via the thermostat touchscreen, where an email will be sent to you to confirm your account.
@@ -23,7 +26,8 @@ You will need to create a Schluter DITRA-HEAT account and register your thermost
You will need your Schluter login information (email and password) to use this module.
-To set it up, add the following to your `configuration.yaml` file:
+To set it up, 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/scrape.markdown b/source/_integrations/scrape.markdown
index 5fec33707d8..4853f4e7a42 100644
--- a/source/_integrations/scrape.markdown
+++ b/source/_integrations/scrape.markdown
@@ -13,9 +13,12 @@ ha_platforms:
- sensor
ha_integration_type: integration
ha_config_flow: true
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `scrape` sensor platform is scraping information from websites. The sensor loads an HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section.
+The `scrape` sensor {% term integration %} is scraping information from websites. The sensor loads an HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section.
If you are not using Home Assistant Container or Home Assistant Operating System, this integration requires `libxml2` to be installed. On Debian based installs, run:
@@ -27,7 +30,8 @@ Both UI and YAML setup is supported while YAML provides additional configuration
{% include integrations/config_flow.md %}
-To enable this sensor, add the following lines to your `configuration.yaml` file:
+To enable this {% term integration %} using YAML, 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/scsgate.markdown b/source/_integrations/scsgate.markdown
index b5553a93d1d..68ba44a7756 100644
--- a/source/_integrations/scsgate.markdown
+++ b/source/_integrations/scsgate.markdown
@@ -14,9 +14,12 @@ ha_platforms:
- light
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The SCSGate integration support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande.
+The SCSGate {% term integration %} support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande.
There is currently support for the following device types within Home Assistant:
@@ -24,7 +27,8 @@ There is currently support for the following device types within Home Assistant:
- [Light](/integrations/scsgate/#light)
- [Switch](/integrations/scsgate/#switch)
-To enable SCSGate in your installation, add the following to your `configuration.yaml` file:
+To enable SCSGate 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/sendgrid.markdown b/source/_integrations/sendgrid.markdown
index 222c75bef0c..d1f0ca729c0 100644
--- a/source/_integrations/sendgrid.markdown
+++ b/source/_integrations/sendgrid.markdown
@@ -9,9 +9,12 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.
+The `sendgrid` notification {% term integration %} sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.
## Setup
@@ -19,7 +22,8 @@ You need an [API key](https://app.sendgrid.com/settings/api_keys) from SendGrid.
## Configuration
-To enable notification emails via SendGrid in your installation, add the following to your `configuration.yaml` file:
+To enable notification emails via SendGrid 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/serial.markdown b/source/_integrations/serial.markdown
index 41d648a4542..88f5478dd5f 100644
--- a/source/_integrations/serial.markdown
+++ b/source/_integrations/serial.markdown
@@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](https://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system.
+The `serial` sensor {% term integration %} is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](https://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system.
To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`.
@@ -23,7 +23,8 @@ sudo minicom -D /dev/ttyACM0
## Configuration
-To setup a serial sensor to your installation, add the following to your `configuration.yaml` file:
+To setup a serial sensor 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/sesame.markdown b/source/_integrations/sesame.markdown
index 09d2d025f72..6f001460dad 100644
--- a/source/_integrations/sesame.markdown
+++ b/source/_integrations/sesame.markdown
@@ -9,9 +9,12 @@ ha_domain: sesame
ha_platforms:
- lock
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.
+The `sesame` {% term integration %} allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.
## Configuration
@@ -19,7 +22,8 @@ Your Sesame needs to be paired with a standalone [Wi-Fi Access Point](https://ca
You will also need to generate an API key from [my.candyhouse.co](https://my.candyhouse.co/#/credentials).
-Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file:
+Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, 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/seven_segments.markdown b/source/_integrations/seven_segments.markdown
index 65f340eb6aa..3d7c4378e06 100644
--- a/source/_integrations/seven_segments.markdown
+++ b/source/_integrations/seven_segments.markdown
@@ -10,9 +10,12 @@ ha_domain: seven_segments
ha_codeowners:
- '@fabaff'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/).
+The `seven_segments` image processing {% term integration %} allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/).
{% details "Notes for Home Assistant Core Installations" %}
@@ -33,7 +36,8 @@ make deb # (Optional) This allows you to make a deb so that you apt is aware of
## Configuration
-To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file:
+To enable the OCR of a seven segment display 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/shodan.markdown b/source/_integrations/shodan.markdown
index 59ac4c42fa8..ddc35f12ef0 100644
--- a/source/_integrations/shodan.markdown
+++ b/source/_integrations/shodan.markdown
@@ -11,15 +11,19 @@ ha_domain: shodan
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `shodan` sensor platform is displaying the total of result of a
+The `shodan` sensor {% term integration %} is displaying the total of result of a
[Shodan](https://www.shodan.io/) query.
Use "Show API Key" in the upper right corner when you are logged in or got to
your "My Account" page to retrieve your API key.
-To enable this sensor, add the following lines to your `configuration.yaml`
+To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
file:
```yaml
diff --git a/source/_integrations/sigfox.markdown b/source/_integrations/sigfox.markdown
index c75f5968ba8..64363c90f4c 100644
--- a/source/_integrations/sigfox.markdown
+++ b/source/_integrations/sigfox.markdown
@@ -9,9 +9,12 @@ ha_domain: sigfox
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-[SigFox](https://www.sigfox.com/) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
+[SigFox](https://www.sigfox.com/) {% term integration %} adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
## Setup
@@ -24,7 +27,8 @@ Note that `your_api_login` and `your_api_password` are your **API access credent
## Configuration
-To use this sensor, add the following to your `configuration.yaml` file:
+To use this {% term integration %}, 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/sighthound.markdown b/source/_integrations/sighthound.markdown
index c3f3152e11d..da19dd85e20 100644
--- a/source/_integrations/sighthound.markdown
+++ b/source/_integrations/sighthound.markdown
@@ -9,19 +9,23 @@ ha_codeowners:
- '@robmarkcole'
ha_domain: sighthound
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Detect people in camera images using [Sighthound Cloud](https://www.sighthound.com/products/cloud). The Sighthound Developer tier (free for non-commercial use) allows 5000 images to be processed per month. If you need more processing per month you will need to sign up for a production account (i.e., a Basic or Pro account).
-This integration adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person.
+This {% term integration %} adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person.
If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection.
-**Note** that by default the integration will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
+**Note** that by default the {% term integration %} will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
## Configuration
-To enable this platform in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/signal_messenger.markdown b/source/_integrations/signal_messenger.markdown
index 2a364595429..2cbb794eda6 100644
--- a/source/_integrations/signal_messenger.markdown
+++ b/source/_integrations/signal_messenger.markdown
@@ -11,9 +11,12 @@ ha_domain: signal_messenger
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `signal_messenger` integration uses the [Signal Messenger REST API](https://github.com/bbernhard/signal-cli-rest-api) to deliver notifications from Home Assistant to your Android or iOS device.
+The `signal_messenger` {% term integration %} uses the [Signal Messenger REST API](https://github.com/bbernhard/signal-cli-rest-api) to deliver notifications from Home Assistant to your Android or iOS device.
## Setup
@@ -28,7 +31,8 @@ Please follow those [instructions](https://github.com/bbernhard/signal-cli-rest-
## Configuration
-To send Signal Messenger notifications with Home Assistant, add the following to your `configuration.yaml` file:
+To send Signal Messenger notifications with Home Assistant, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry for Signal Messenger
diff --git a/source/_integrations/sinch.markdown b/source/_integrations/sinch.markdown
index bb9b384fb94..745e6355135 100644
--- a/source/_integrations/sinch.markdown
+++ b/source/_integrations/sinch.markdown
@@ -11,9 +11,12 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `sinch` platform uses [Sinch](https://www.sinch.com/products/apis/messaging/sms/) to deliver notifications from Home Assistant.
+The `sinch` {% term integration %} uses [Sinch](https://www.sinch.com/products/apis/messaging/sms/) to deliver notifications from Home Assistant.
## Prerequisites
@@ -21,7 +24,8 @@ Go to your [Sinch Dashboard](https://dashboard.sinch.com/sms/api/rest) and click
## Configuration
-To add Sinch to your installation, add the following to your Home Assistant `configuration.yaml` file:
+To add Sinch 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/sky_hub.markdown b/source/_integrations/sky_hub.markdown
index aa172202ba5..b58858f785a 100644
--- a/source/_integrations/sky_hub.markdown
+++ b/source/_integrations/sky_hub.markdown
@@ -11,11 +11,15 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `sky_hub` platform offers presence detection by looking at connected devices to a [Sky Hub router](https://www.sky.com/shop/broadband-talk/sky-hub/) based router.
+The `sky_hub` {% term integration %} offers presence detection by looking at connected devices to a [Sky Hub router](https://www.sky.com/shop/broadband-talk/sky-hub/) based router.
-To use your Sky Hub device in your installation, add the following to your `configuration.yaml` file:
+To use your Sky Hub device 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/skybeacon.markdown b/source/_integrations/skybeacon.markdown
index b73271ac7ff..488d085c56c 100644
--- a/source/_integrations/skybeacon.markdown
+++ b/source/_integrations/skybeacon.markdown
@@ -9,13 +9,17 @@ ha_domain: skybeacon
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `skybeacon` sensor platform supports [CR2477](https://cnsky9.en.alibaba.com/)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module.
+The `skybeacon` sensor {% term integration %} supports [CR2477](https://cnsky9.en.alibaba.com/)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module.
## Configuration
-To use your Skybeacon sensor in your installation, add the following to your `configuration.yaml` file:
+To use your Skybeacon {% 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/slide.markdown b/source/_integrations/slide.markdown
index f854e5e7fec..e9c4d0a0ff2 100644
--- a/source/_integrations/slide.markdown
+++ b/source/_integrations/slide.markdown
@@ -12,12 +12,18 @@ ha_domain: slide
ha_platforms:
- cover
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `slide` implementation allows you to integrate your [slide.store](https://slide.store/) devices in Home Assistant using the [official API](https://documenter.getpostman.com/view/6223391/S1Lu2pSf?version=latest).
+The `slide` {% term integration %} allows you to integrate your [slide.store](https://slide.store/) devices in Home Assistant using the [official API](https://documenter.getpostman.com/view/6223391/S1Lu2pSf?version=latest).
### Configuration
+To use the Slide {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
slide:
diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown
index 6a05c7831d9..c6179f9d08a 100644
--- a/source/_integrations/smappee.markdown
+++ b/source/_integrations/smappee.markdown
@@ -19,24 +19,27 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Smappee integration will allow users to integrate their Smappee monitors, Smappee Comfort Plugs and Smappee Switches into Home Assistant using the [official cloud API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview) or the limited local option.
+The Smappee {% term integration %} will allow users to integrate their Smappee monitors, Smappee Comfort Plugs and Smappee Switches into Home Assistant using the [official cloud API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview) or the limited local option.
## Smappee monitors
The table below summarizes the available options to initiate the Smappee integration in Home Assistant per Smappee monitor type.
-|Monitor type|Local discovery|Cloud API|
-|---|---|---|
-|Smappee Energy|Yes|Yes|
-|Smappee Solar|Yes|Yes|
-|Smappee Plus|Yes|Yes|
-|Smappee Pro|Yes|Yes|
-|Smappee Genius|Yes|Yes|
-|Smappee Connect|No|Yes|
-|Smappee Wi-Fi Connect|No|Yes|
-|Smappee P1/S1 module|No|Yes|
+| Monitor type | Local discovery | Cloud API |
+| --------------------- | --------------- | --------- |
+| Smappee Energy | Yes | Yes |
+| Smappee Solar | Yes | Yes |
+| Smappee Plus | Yes | Yes |
+| Smappee Pro | Yes | Yes |
+| Smappee Genius | Yes | Yes |
+| Smappee Connect | No | Yes |
+| Smappee Wi-Fi Connect | No | Yes |
+| Smappee P1/S1 module | No | Yes |
## Local discovery
@@ -59,7 +62,7 @@ Switch entities are created for each Smappee Switch and Smappee Comfort Plug.
## Cloud API configuration
-To use the Smappee cloud integration you need a personal `client_id` and `client_secret` and add these to your `configuration.yaml` file. For personal use, access to the API is free and credentials can be obtained by contacting [support@smappee.com](mailto:support@smappee.com). For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting [info@smappee.com](mailto:info@smappee.com).
+To use the Smappee cloud integration you need a personal `client_id` and `client_secret` and add these to your {% term "`configuration.yaml`" %} file. For personal use, access to the API is free and credentials can be obtained by contacting [support@smappee.com](mailto:support@smappee.com). For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting [info@smappee.com](mailto:info@smappee.com).
For any information about the use of the API please refer to the [Smappee API space](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview).
```yaml
diff --git a/source/_integrations/solaredge_local.markdown b/source/_integrations/solaredge_local.markdown
index 4dd0ffef1ac..2cb91603254 100644
--- a/source/_integrations/solaredge_local.markdown
+++ b/source/_integrations/solaredge_local.markdown
@@ -13,9 +13,12 @@ ha_domain: solaredge_local
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `solaredge_local` integration uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
+The `solaredge_local` {% term integration %} uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
Only specific models support the local API. The local API is available on inverters that do not have an LCD character screen. You can also check the datasheets if in the section "Additional Features", sub-section "Inverter Commissioning" is present the following line "With the SetApp mobile application using built-in Wi-Fi access point for local connection". These inverters also have a part number that ends with a 4. For example: SEXXK-XXXXXBXX4 or SEXXXXH-XXXXXBXX4
@@ -31,7 +34,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 {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown
index 20fb050e83a..ae676ba3cd8 100644
--- a/source/_integrations/sonos.markdown
+++ b/source/_integrations/sonos.markdown
@@ -71,7 +71,7 @@ The favorites sensor provides the names and `media_content_id` values for each o
When calling the `media_player.play_media` service, the `media_content_type` must be set to "favorite_item_id" and the `media_content_id` must be set to just the key portion of the favorite item.
-Example service call:
+Example service call using the item id:
```yaml
service: media_player.play_media
@@ -82,6 +82,17 @@ data:
media_content_id: "FV:2/31"
```
+Example using the Sonos playlist name:
+
+```yaml
+service: media_player.play_media
+target:
+ entity_id: media_player.sonos_speaker1
+data:
+ media_content_type: playlist
+ media_content_id: stevie_wonder
+```
+
Example templates:
{% raw %}
@@ -119,7 +130,7 @@ Music services which require an account (e.g., Spotify) must first be configured
Playing TTS (text-to-speech) or audio files as alerts (e.g., a doorbell or alarm) is possible by setting the `announce` argument to `true`. Using `announce` will play the provided media URL as an overlay, gently lowering the current music volume and automatically restoring to the original level when finished. An optional `volume` argument can also be provided in the `extra` dictionary to play the alert at a specific volume level. Note that older Sonos hardware or legacy firmware versions ("S1") may not fully support these features. Additionally, see [Network Requirements](#network-requirements) for use in restricted networking environments.
-An optional `enqueue` argument can be added to the service call. If `true`, the media will be appended to the end of the playback queue. If not provided or `false` then the queue will be replaced.
+An optional `enqueue` argument can be added to the service call. If `replace` or not provided then the queue will be replaced and the item will be replaced. If `add` the item will be appended to the queue. If `next` the item will be added into the queue to play next. If `play`, the item will be added into the queue and played immediately.
### Examples:
@@ -186,6 +197,57 @@ data:
plex://{ "library_name": "Music", "artist_name": "M83", "album_name": "Hurry Up, We're Dreaming" }
```
+#### Sonos Music Library
+
+If you have configured a Sonos music library; you can play music from it.
+
+Play all albums by the Beatles.
+
+```yaml
+service: media_player.play_media
+target:
+ entity_id: media_player.sonos
+data:
+ media_content_type: album
+ media_content_id: A:ALBUMARTIST/Beatles
+```
+
+Play a specific album:
+
+```yaml
+service: media_player.play_media
+target:
+ entity_id: media_player.sonos
+data:
+ media_content_type: album
+ media_content_id: A:ALBUM/The Wall
+ enqueue: replace
+```
+
+Or add a specific album by a specific artist to the queue. This is useful in case you have multiple albums with the same name.
+
+```yaml
+service: media_player.play_media
+target:
+ entity_id: media_player.sonos
+data:
+ media_content_type: album
+ media_content_id: A:ALBUMARTIST/Neil Young/Greatest Hits
+ enqueue: add
+```
+
+Play all albums by a composer.
+
+```yaml
+service: media_player.play_media
+target:
+ entity_id: media_player.porch
+data:
+ media_content_type: composer
+ media_content_id: A:COMPOSER/Carlos Santana
+ enqueue: play
+```
+
## Services
The Sonos integration makes various custom services available in addition to the [standard media player services](/integrations/media_player/#services).
@@ -346,4 +408,4 @@ The Sonos speakers will attempt to connect back to Home Assistant to deliver cha
sonos:
media_player:
advertise_addr: 192.0.2.1
-```
+```
\ No newline at end of file
diff --git a/source/_integrations/spaceapi.markdown b/source/_integrations/spaceapi.markdown
index f2bf19510d4..83df0538349 100644
--- a/source/_integrations/spaceapi.markdown
+++ b/source/_integrations/spaceapi.markdown
@@ -9,13 +9,17 @@ ha_codeowners:
- '@fabaff'
ha_domain: spaceapi
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `spaceapi` integration allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
+The `spaceapi` {% term integration %} allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
## Configuration
-To setup the `spaceapi` integration in your installation, add the following to your `configuration.yaml` file:
+To setup the `spaceapi` {% 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/spc.markdown b/source/_integrations/spc.markdown
index 008d13ddb69..b05bbe92fd1 100644
--- a/source/_integrations/spc.markdown
+++ b/source/_integrations/spc.markdown
@@ -12,6 +12,9 @@ ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Home Assistant has support to integrate your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) alarm panel and any connected motion, door, smoke and technical sensors.
@@ -23,7 +26,8 @@ There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
- [Binary sensor](#binary-sensor)
-Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this add the following section to your `configuration.yaml` file:
+Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this 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/splunk.markdown b/source/_integrations/splunk.markdown
index 456c7fdd11d..ba2a75110b9 100644
--- a/source/_integrations/splunk.markdown
+++ b/source/_integrations/splunk.markdown
@@ -9,13 +9,17 @@ ha_domain: splunk
ha_codeowners:
- '@Bre77'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `splunk` integration makes it possible to log all state changes to an external [Splunk](https://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3.
## Configuration
-To use the `splunk` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `splunk` 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/sql.markdown b/source/_integrations/sql.markdown
index 48f001e33e3..8632b650582 100644
--- a/source/_integrations/sql.markdown
+++ b/source/_integrations/sql.markdown
@@ -14,9 +14,12 @@ ha_domain: sql
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `sql` sensor platform enables you to use values from an [SQL](https://en.wikipedia.org/wiki/SQL) database supported by the [sqlalchemy](https://www.sqlalchemy.org) library, to populate a sensor state (and attributes).
+The `sql` sensor {% term integration %} enables you to use values from an [SQL](https://en.wikipedia.org/wiki/SQL) database supported by the [sqlalchemy](https://www.sqlalchemy.org) library, to populate a sensor state (and attributes).
This can be used to present statistics about Home Assistant sensors if used with the `recorder` integration database. It can also be used with an external data source.
**This integration can be configured using both config flow and by YAML.**
@@ -27,7 +30,8 @@ This can be used to present statistics about Home Assistant sensors if used with
To configure this sensor, define the sensor connection variables and a list of queries to your `configuration.yaml` file. A sensor will be created for each query.
-To enable it, add the following lines to your `configuration.yaml` file (example by required fields):
+To enable it, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
{% raw %}
```yaml
diff --git a/source/_integrations/starlingbank.markdown b/source/_integrations/starlingbank.markdown
index 2559e3fe442..e2b479e3467 100644
--- a/source/_integrations/starlingbank.markdown
+++ b/source/_integrations/starlingbank.markdown
@@ -9,9 +9,12 @@ ha_domain: starlingbank
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The Starling Bank sensor platform allows you to monitor your account balance data as sensors in Home Assistant.
+The Starling Bank sensor {% term integration %} allows you to monitor your account balance data as sensors in Home Assistant.
- Turn off the lights when money's tight?
- Play a song when you reach a savings goal?
@@ -37,7 +40,8 @@ Once you've signed up:
## Configuration
-To add Starling account balance sensors to your installation, add the following to your `configuration.yaml` file:
+To add Starling account balance sensors 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
sensor:
diff --git a/source/_integrations/startca.markdown b/source/_integrations/startca.markdown
index 855acad976a..0c911cecaf0 100644
--- a/source/_integrations/startca.markdown
+++ b/source/_integrations/startca.markdown
@@ -9,6 +9,9 @@ ha_domain: startca
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant.
@@ -19,7 +22,8 @@ You can get your API key from: [Start.ca Usage API](https://portal.start.ca/acco
## Configuration
-To use your Start.ca sensor in your installation, add the following to your `configuration.yaml` file:
+To use your Start.ca {% 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/statsd.markdown b/source/_integrations/statsd.markdown
index fa8a133762a..007305b3445 100644
--- a/source/_integrations/statsd.markdown
+++ b/source/_integrations/statsd.markdown
@@ -7,11 +7,15 @@ ha_iot_class: Local Push
ha_release: 0.12
ha_domain: statsd
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `statsd` integration makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance.
+The `statsd` {% term integration %} makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance.
-To use the `statsd` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `statsd` {% 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/stiebel_eltron.markdown b/source/_integrations/stiebel_eltron.markdown
index 566f8f9c85c..c870878c00f 100644
--- a/source/_integrations/stiebel_eltron.markdown
+++ b/source/_integrations/stiebel_eltron.markdown
@@ -11,9 +11,12 @@ ha_domain: stiebel_eltron
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `stiebel_eltron` integration lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com).
+The `stiebel_eltron` {% term integration %} lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com).
It requires the following components:
@@ -48,7 +51,8 @@ The following preset modes are supported. The STIEBEL ELTRON modes are mapped an
## Configuration
-To enable this integration, 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/sun.markdown b/source/_integrations/sun.markdown
index 743179bd17e..05c886ab639 100644
--- a/source/_integrations/sun.markdown
+++ b/source/_integrations/sun.markdown
@@ -13,9 +13,12 @@ ha_config_flow: true
ha_integration_type: integration
ha_platforms:
- sensor
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The sun integration will use the location as
+The sun {% term integration %} will use the location as
{% my general title="configured in your Home Assistant configuration" %} to
track if the sun is above or below the horizon. The sun can be used within
automations as
@@ -27,7 +30,7 @@ automations as
## Configured by default
-This integration is by default configured and installed, and you don't need
+This {% term integration %} is by default configured and installed, and you don't need
to configure it yourself, unless you've disabled or removed the
[`default_config:`](/integrations/default_config/) line from your
YAML configuration.
@@ -40,7 +43,8 @@ If that is the case, you can configure it as described in the next paragraphs.
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the sun integration in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -65,30 +69,30 @@ trigger:
offset: "-01:00:01"
```
-| Key name | Description |
-| --------- | ----------- |
-| `event` | Possible values: `sunset` or `sunrise`
-| `offset` | An optional offset for the sun event trigger, in a positive or negative number of seconds, or specified in `HH:MM:SS` (after sun event trigger) or `-HH:MM:SS` (before sun event trigger).
+| Key name | Description |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `event` | Possible values: `sunset` or `sunrise` |
+| `offset` | An optional offset for the sun event trigger, in a positive or negative number of seconds, or specified in `HH:MM:SS` (after sun event trigger) or `-HH:MM:SS` (before sun event trigger). |
### Maintains entity `sun.sun`
-| Possible state | Description |
-| --------- | ----------- |
-| `above_horizon` | When the sun is above the horizon.
-| `below_horizon` | When the sun is below the horizon.
+| Possible state | Description |
+| --------------- | ---------------------------------- |
+| `above_horizon` | When the sun is above the horizon. |
+| `below_horizon` | When the sun is below the horizon. |
## Sensors
The sensors are also available as attributes on the `sun.sun` entity for backwards compatibility reasons.
-| Sensors | Description |
-| --------- | ----------- |
-| Next rising | Date and time of the next sun rising (in UTC).
-| Next setting | Date and time of the next sun setting (in UTC).
-| Next dawn | Date and time of the next dawn (in UTC).
-| Next dusk | Date and time of the next dusk (in UTC).
-| Next noon | Date and time of the next solar noon (in UTC).
-| Next midnight | Date and time of the next solar midnight (in UTC).
-| Elevation | Solar elevation. This is the angle between the sun and the horizon. Negative values mean the sun is below the horizon.
-| Azimuth | Solar azimuth. The angle is shown clockwise from north.
-| `rising` | True if the Sun is currently rising, after solar midnight and before solar noon.
+| Sensors | Description |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| Next rising | Date and time of the next sun rising (in UTC). |
+| Next setting | Date and time of the next sun setting (in UTC). |
+| Next dawn | Date and time of the next dawn (in UTC). |
+| Next dusk | Date and time of the next dusk (in UTC). |
+| Next noon | Date and time of the next solar noon (in UTC). |
+| Next midnight | Date and time of the next solar midnight (in UTC). |
+| Elevation | Solar elevation. This is the angle between the sun and the horizon. Negative values mean the sun is below the horizon. |
+| Azimuth | Solar azimuth. The angle is shown clockwise from north. |
+| `rising` | True if the Sun is currently rising, after solar midnight and before solar noon. |
diff --git a/source/_integrations/supervisord.markdown b/source/_integrations/supervisord.markdown
index 838eda1ad43..9c13337418f 100644
--- a/source/_integrations/supervisord.markdown
+++ b/source/_integrations/supervisord.markdown
@@ -9,9 +9,12 @@ ha_domain: supervisord
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `supervisord` platform allows you to track the states of [Supervisord](http://supervisord.org/).
+The `supervisord` {% term integration %} allows you to track the states of [Supervisord](http://supervisord.org/).
It required that you enable the HTTP feature in the `/etc/supervisord.conf` configuration file.
@@ -26,7 +29,8 @@ After a restart of `supervisord` you should be able to access the web interface.
-To use this sensor in your installation, add the following to your `configuration.yaml` file:
+To use this {% 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/swiss_hydrological_data.markdown b/source/_integrations/swiss_hydrological_data.markdown
index 71da723df73..efdff463961 100644
--- a/source/_integrations/swiss_hydrological_data.markdown
+++ b/source/_integrations/swiss_hydrological_data.markdown
@@ -11,9 +11,12 @@ ha_domain: swiss_hydrological_data
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland.
+The `swiss_hydrological_data` {% term integration %} will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland.
## Setup
@@ -21,7 +24,8 @@ The [station overview](https://www.hydrodaten.admin.ch/en/stations-and-data.html
## 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/swisscom.markdown b/source/_integrations/swisscom.markdown
index 948eaee8b47..b7147f397a8 100644
--- a/source/_integrations/swisscom.markdown
+++ b/source/_integrations/swisscom.markdown
@@ -9,15 +9,19 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `swisscom` platform offers presence detection by looking at connected devices to an [Internet-Box](https://www.swisscom.ch/en/residential/help/device/internet-router.html) router from [Swisscom](https://www.swisscom.ch) which is an Internet provider in Switzerland.
+The `swisscom` {% term integration %} offers presence detection by looking at connected devices to an [Internet-Box](https://www.swisscom.ch/en/residential/help/device/internet-router.html) router from [Swisscom](https://www.swisscom.ch) which is an Internet provider in Switzerland.
There are three models of Internet-Box (light, standard and plus). The platform has only been tested on the Internet-Box plus but the others should work as well because they have the same web interface.
-To use an Internet-Box router in your installation, add the following to your `configuration.yaml` file:
+To use an Internet-Box 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/synology_chat.markdown b/source/_integrations/synology_chat.markdown
index 0545068b3a0..d11fad1f919 100644
--- a/source/_integrations/synology_chat.markdown
+++ b/source/_integrations/synology_chat.markdown
@@ -9,13 +9,17 @@ ha_domain: synology_chat
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `synology_chat` notification platform allows you to deliver notifications to your [Synology Chat](https://www.synology.com/en-us/dsm/feature/chat) install as a Synology Chat bot.
+The `synology_chat` notification {% term integration %} allows you to deliver notifications to your [Synology Chat](https://www.synology.com/en-us/dsm/feature/chat) install as a Synology Chat bot.
To configure a Synology Chat bot, first you must create a [Synology Chat Integration Incoming Webhook](https://www.synology.com/en-us/knowledgebase/DSM/tutorial/Collaboration/How_to_configure_webhooks_and_slash_commands_in_Chat_Integration#t2.1). After this is complete, you will have a Webhook URL. This is what will be required in the Home Assistant configuration.
-To enable the Synology Chat notification in your installation, add the following to your `configuration.yaml` file:
+To enable the Synology Chat notification 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/synology_srm.markdown b/source/_integrations/synology_srm.markdown
index 9d7456d2f26..86812afc83f 100644
--- a/source/_integrations/synology_srm.markdown
+++ b/source/_integrations/synology_srm.markdown
@@ -11,13 +11,17 @@ ha_domain: synology_srm
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This platform allows you to detect presence by looking at connected devices to a [Synology SRM](https://www.synology.com/srm) router.
+This {% term integration %} allows you to detect presence by looking at connected devices to a [Synology SRM](https://www.synology.com/srm) router.
## 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/syslog.markdown b/source/_integrations/syslog.markdown
index 2a8b5853c3c..024e8761305 100644
--- a/source/_integrations/syslog.markdown
+++ b/source/_integrations/syslog.markdown
@@ -9,11 +9,15 @@ ha_domain: syslog
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `syslog` platform allows you to deliver notifications from Home Assistant to the local syslog.
+The `syslog` {% term integration %} allows you to deliver notifications from Home Assistant to the local syslog.
-To enable syslog notifications in your installation, add the following to your `configuration.yaml` file:
+To enable syslog 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
@@ -47,26 +51,26 @@ priority:
The table contains values to use in your `configuration.yaml` file.
-| facility | option | priority |
-| :-------- |:--------| :---------|
-| kernel | pid | 5 |
-| user | cons | 4 |
-| mail | ndelay | 3 |
-| daemon | nowait | 2 |
-| auth | perror | 1 |
-| LPR | | 0 |
-| news | | -1 |
-| uucp | | -2 |
-| cron | | |
-| syslog | | |
-| local0 | | |
-| local1 | | |
-| local2 | | |
-| local3 | | |
-| local4 | | |
-| local5 | | |
-| local6 | | |
-| local7 | | |
+| facility | option | priority |
+| :------- | :----- | :------- |
+| kernel | pid | 5 |
+| user | cons | 4 |
+| mail | ndelay | 3 |
+| daemon | nowait | 2 |
+| auth | perror | 1 |
+| LPR | | 0 |
+| news | | -1 |
+| uucp | | -2 |
+| cron | | |
+| syslog | | |
+| local0 | | |
+| local1 | | |
+| local2 | | |
+| local3 | | |
+| local4 | | |
+| local5 | | |
+| local6 | | |
+| local7 | | |
For details about facility, option, and priority please consult the [wikipedia article](https://en.wikipedia.org/wiki/Syslog) and [RFC 3164](https://tools.ietf.org/html/rfc3164).
diff --git a/source/_integrations/tank_utility.markdown b/source/_integrations/tank_utility.markdown
index f9f6afca980..47925d4186f 100644
--- a/source/_integrations/tank_utility.markdown
+++ b/source/_integrations/tank_utility.markdown
@@ -9,6 +9,9 @@ ha_domain: tank_utility
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant.
@@ -54,7 +57,8 @@ The device item value is the last segment of the URL path, e.g., the URL
## Configuration
-To enable the integration, add the following lines to your `configuration.yaml` file:
+To enable the {% 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/tapsaff.markdown b/source/_integrations/tapsaff.markdown
index a2eefa8a538..0b7ece0c31b 100644
--- a/source/_integrations/tapsaff.markdown
+++ b/source/_integrations/tapsaff.markdown
@@ -11,13 +11,17 @@ ha_codeowners:
ha_platforms:
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](https://www.taps-aff.co.uk/).
+The `tapsaff` binary sensor {% term integration %} provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](https://www.taps-aff.co.uk/).
## Configuration
-To enable this sensor, add the following lines to your `configuration.yaml`:
+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/tcp.markdown b/source/_integrations/tcp.markdown
index 410221856d6..750b573618d 100644
--- a/source/_integrations/tcp.markdown
+++ b/source/_integrations/tcp.markdown
@@ -11,9 +11,12 @@ ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The TCP integration allows the integration of some services for which a specific Home Assistant integration does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this integration will allow integration with it.
+The TCP {% term integration %} allows the integration of some services for which a specific Home Assistant integration does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this integration will allow integration with it.
There is currently support for the following device types within Home Assistant:
@@ -22,7 +25,8 @@ There is currently support for the following device types within Home Assistant:
## Sensor
-To enable the TCP sensor, add the following lines to your `configuration.yaml`:
+To enable the TCP {% 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/ted5000.markdown b/source/_integrations/ted5000.markdown
index da2d60cac9c..8a2a8a4e0bf 100644
--- a/source/_integrations/ted5000.markdown
+++ b/source/_integrations/ted5000.markdown
@@ -9,11 +9,15 @@ ha_domain: ted5000
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `ted 5000` monitors electricity consumption/production by connecting to the [TED](https://www.theenergydetective.com/) gateway, itself connected to one or several Measuring Transmitting Units (MTU). The platform creates up to two sensors per MTU, one for Wattage the other for Voltage.
-If you want to enable the ted5000 sensor, add the following lines to your `configuration.yaml`:
+If you want to enable the ted5000 {% 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/telegram.markdown b/source/_integrations/telegram.markdown
index f4c16d70e2e..c391b091629 100644
--- a/source/_integrations/telegram.markdown
+++ b/source/_integrations/telegram.markdown
@@ -9,9 +9,12 @@ ha_domain: telegram
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `telegram` integration uses [Telegram](https://www.telegram.org) to deliver notifications from Home Assistant to your Telegram application(s).
+The `telegram` {% term integration %} uses [Telegram](https://www.telegram.org) to deliver notifications from Home Assistant to your Telegram application(s).
## Setup example
@@ -125,7 +128,8 @@ If you want to add new chat IDs then you will need to disable the active configu
## Configuration
-To enable Telegram notifications in your installation, add the following to your `configuration.yaml` file:
+To enable Telegram 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 for the Telegram Bot
diff --git a/source/_integrations/tellduslive.markdown b/source/_integrations/tellduslive.markdown
index 2b4b1a99ea4..550dfe47207 100644
--- a/source/_integrations/tellduslive.markdown
+++ b/source/_integrations/tellduslive.markdown
@@ -22,9 +22,12 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `tellduslive` integration let you connect to the [Telldus Live](https://live.telldus.com) API. It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.
+The `tellduslive` {% term integration %} let you connect to the [Telldus Live](https://live.telldus.com) API. It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.
@@ -36,7 +39,8 @@ Local API supports only one device at this stage. Local API is only supported wi
## Configuration
-To manually integrate your Telldus Live with Home Assistant, e.g., if your device is on another network or in another location, add the following section to your `configuration.yaml` file:
+To manually integrate your Telldus Live with Home Assistant, e.g., if your device is on another network or in another location, 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/tellstick.markdown b/source/_integrations/tellstick.markdown
index 84b8cad4c61..f98ac852a61 100644
--- a/source/_integrations/tellstick.markdown
+++ b/source/_integrations/tellstick.markdown
@@ -16,9 +16,12 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `tellstick` integration integrates [TellStick][tellstick-gateway] devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf).
+The `tellstick` {% term integration %} integrates [TellStick][tellstick-gateway] devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf).
There is currently support for the following device types within Home Assistant:
@@ -32,7 +35,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To get started, add the devices to your `configuration.yaml` file.
+To get started, add the {% term integration %} to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/telnet.markdown b/source/_integrations/telnet.markdown
index 3a2ea017425..ddbd13a1a5f 100644
--- a/source/_integrations/telnet.markdown
+++ b/source/_integrations/telnet.markdown
@@ -9,11 +9,15 @@ ha_domain: telnet
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `telnet` switch platform allows you to control devices with telnet commands.
+The `telnet` switch {% term integration %} allows you to control devices with telnet commands.
-To enable this switch, 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 %}
{% raw %}
diff --git a/source/_integrations/temper.markdown b/source/_integrations/temper.markdown
index 1013684a707..4efd31c9263 100644
--- a/source/_integrations/temper.markdown
+++ b/source/_integrations/temper.markdown
@@ -9,13 +9,17 @@ ha_domain: temper
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `temper` sensor platform allows you to get the current temperature from a TEMPer device.
+This `temper` sensor {% term integration %} allows you to get the current temperature from a TEMPer device.
## Configuration
-To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file:
+To use your TEMPer {% 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/tensorflow.markdown b/source/_integrations/tensorflow.markdown
index 3a2079de56f..356134cd467 100644
--- a/source/_integrations/tensorflow.markdown
+++ b/source/_integrations/tensorflow.markdown
@@ -7,9 +7,12 @@ ha_iot_class: Local Polling
ha_release: 0.82
ha_domain: tensorflow
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The TensorFlow image processing platform allows you to detect and recognize objects in a camera image using [TensorFlow](https://www.tensorflow.org/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
+The TensorFlow image processing {% term integration %} allows you to detect and recognize objects in a camera image using [TensorFlow](https://www.tensorflow.org/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
This integration is only available on Home Assistant Core installation types. Unfortunately, it cannot be used with Home Assistant OS, Supervised or Container.
@@ -74,7 +77,8 @@ Whichever model you choose, download it and extract in to the `tensorflow/models
## Configuration
-To enable this platform in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/teslemetry.markdown b/source/_integrations/teslemetry.markdown
index b0069fb3b17..397a0aa22b9 100644
--- a/source/_integrations/teslemetry.markdown
+++ b/source/_integrations/teslemetry.markdown
@@ -2,6 +2,7 @@
title: Teslemetry
description: Instructions on how to integrate Teslemetry within Home Assistant.
ha_category:
+ - Car
- Climate
- Sensor
ha_release: 2024.2
diff --git a/source/_integrations/tessie.markdown b/source/_integrations/tessie.markdown
index c0a63aa8c6a..cae04d9e927 100644
--- a/source/_integrations/tessie.markdown
+++ b/source/_integrations/tessie.markdown
@@ -4,6 +4,7 @@ description: Instructions on how to integrate Tessie within Home Assistant.
ha_category:
- Binary Sensor
- Button
+ - Car
- Climate
- Cover
- Device Tracker
diff --git a/source/_integrations/tfiac.markdown b/source/_integrations/tfiac.markdown
index cc1666a914b..60e8b51135a 100644
--- a/source/_integrations/tfiac.markdown
+++ b/source/_integrations/tfiac.markdown
@@ -12,13 +12,17 @@ ha_domain: tfiac
ha_platforms:
- climate
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `tfiac` integration integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398).
+The `tfiac` {% term integration %} integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398).
## Configuration
-To add your Tfiac device into your Home Assistant installation, add the following to your `configuration.yaml` file:
+To add your Tfiac {% term integration %} into your Home Assistant installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Full manual example configuration.yaml entry
diff --git a/source/_integrations/update.markdown b/source/_integrations/update.markdown
index f0b0368af33..3a9796d3b5c 100644
--- a/source/_integrations/update.markdown
+++ b/source/_integrations/update.markdown
@@ -73,11 +73,16 @@ this capability. Additionally, if allowed by the {% term integration %}, the ser
provides for installing a specific version and even could make a
backup before installing the update.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | String or list of strings that point at `entity_id`s of updates. To target all updates, set `entity_id` to `all`.
-| `version` | yes | A specific update version to install, if not provided, the latest available update will be installed. Availability of this atrribute is dependent on the {% term integration %}.
-| `backup` | yes | If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the {% term integration %}.
+#### Service data attributes
+
+{% configuration_basic %}
+entity_id (required):
+ description: "String or list of strings that point at `entity_id`s of updates. To target all updates, set `entity_id` to `all`."
+version:
+ description: "A specific update version to install, if not provided, the latest available update will be installed. Availability of this attribute is dependent on the {% term integration %}."
+backup:
+ description: "If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the {% term integration %}."
+{% endconfiguration_basic %}
Example service call:
diff --git a/source/_integrations/vasttrafik.markdown b/source/_integrations/vasttrafik.markdown
index 108c728bf7c..e95f839e5d2 100644
--- a/source/_integrations/vasttrafik.markdown
+++ b/source/_integrations/vasttrafik.markdown
@@ -9,13 +9,17 @@ ha_domain: vasttrafik
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `vasttrafik` sensor will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service.
+The `vasttrafik` {% term integration %} will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service.
You must create an application [here](https://developer.vasttrafik.se/applications) to obtain a `key` and a `secret`. Make sure to also subscribe to the API by clicking on `Prenumerera på nytt API`, and selecting the API `Planera Resa v4`.
-Add the data to your `configuration.yaml` file as shown in the example:
+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/versasense.markdown b/source/_integrations/versasense.markdown
index 839dcf2c11f..b9de6bcbfa6 100644
--- a/source/_integrations/versasense.markdown
+++ b/source/_integrations/versasense.markdown
@@ -15,12 +15,18 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **VersaSense** {% term integration %} supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
## Configuration
+To enable VersaSense in your installation, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
versasense:
diff --git a/source/_integrations/viaggiatreno.markdown b/source/_integrations/viaggiatreno.markdown
index dc1dd88b9a0..37446605202 100644
--- a/source/_integrations/viaggiatreno.markdown
+++ b/source/_integrations/viaggiatreno.markdown
@@ -9,11 +9,14 @@ ha_domain: viaggiatreno
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Trenitalia ViaggiaTreno** {% term integration %} will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
-To activate the sensor you need at least two parameters: the `train_id` and the `station_id`.
+To activate the {% term integration %}, you need at least two parameters: the `train_id` and the `station_id`.
The first is available just looking at the [ViaggiaTreno](http://viaggiatreno.it/) timetable, the latter can be obtained using the dedicated API endpoint:
`http://www.viaggiatreno.it/infomobilita/resteasy/viaggiatreno/autocompletaStazione/`
@@ -25,7 +28,8 @@ Note that the `station_id` is referred to the train's **departing station**. If
-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/vivotek.markdown b/source/_integrations/vivotek.markdown
index 1fade9eb67f..0f2923769a4 100644
--- a/source/_integrations/vivotek.markdown
+++ b/source/_integrations/vivotek.markdown
@@ -11,6 +11,9 @@ ha_domain: vivotek
ha_platforms:
- camera
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **VIVOTEK** camera {% term integration %} allows you to integrate a VIVOTEK IP camera into Home Assistant.
@@ -19,7 +22,8 @@ Home Assistant will serve the images via its server, making it possible to view
## Configuration
-To enable this camera in your installation, add the following to your `configuration.yaml` file:
+To enable this camera 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/vlc.markdown b/source/_integrations/vlc.markdown
index 5d9dbef2310..9097c3a5e8b 100644
--- a/source/_integrations/vlc.markdown
+++ b/source/_integrations/vlc.markdown
@@ -9,6 +9,9 @@ ha_domain: vlc
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html).
@@ -21,7 +24,8 @@ The **VLC media player** {% term integration %}, is currently only available for
## Configuration
-To add a VLC media player to your installation, add the following to your `configuration.yaml` file:
+To add a VLC media player 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/voicerss.markdown b/source/_integrations/voicerss.markdown
index 59fdadb6c9b..e445dad8bb3 100644
--- a/source/_integrations/voicerss.markdown
+++ b/source/_integrations/voicerss.markdown
@@ -9,13 +9,17 @@ ha_domain: voicerss
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **VoiceRSS** text-to-speech {% term integration %} uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
## Configuration
-To enable text-to-speech with VoiceRSS, add the following lines to your `configuration.yaml`:
+To enable text-to-speech with VoiceRSS, 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/volkszaehler.markdown b/source/_integrations/volkszaehler.markdown
index 852f41acdb7..34b68270da1 100644
--- a/source/_integrations/volkszaehler.markdown
+++ b/source/_integrations/volkszaehler.markdown
@@ -9,13 +9,17 @@ ha_domain: volkszaehler
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Volkszaehler** {% term integration %} is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
## Configuration
-To enable the Volkszaehler sensor, add the following lines to your `configuration.yaml`:
+To enable the Volkszaehler {% 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/vultr.markdown b/source/_integrations/vultr.markdown
index aee506b0242..70d9ff34409 100644
--- a/source/_integrations/vultr.markdown
+++ b/source/_integrations/vultr.markdown
@@ -14,6 +14,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Vultr** {% term integration %} allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
@@ -32,7 +35,8 @@ Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#set
Ensure you allow the public IP of Home Assistant under the Access Control heading.
-To integrate your Vultr subscriptions with Home Assistant, add the following section to your `configuration.yaml` file:
+To integrate your Vultr subscriptions 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/w800rf32.markdown b/source/_integrations/w800rf32.markdown
index 2dee4eb4651..6d39f942aee 100644
--- a/source/_integrations/w800rf32.markdown
+++ b/source/_integrations/w800rf32.markdown
@@ -10,6 +10,9 @@ ha_domain: w800rf32
ha_platforms:
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **WGL Designs W800RF32** {% term integration %} supports W800RF32 devices by WGL Designs which
@@ -18,7 +21,8 @@ communicate in the frequency range of 310MHz or if you are outside Canada or the
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices.
-To enable W800rf32 in your installation, add the following to your `configuration.yaml` file:
+To enable W800rf32 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/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown
index 65d8aef8d3e..2232b1069df 100644
--- a/source/_integrations/wake_on_lan.markdown
+++ b/source/_integrations/wake_on_lan.markdown
@@ -12,6 +12,9 @@ ha_platforms:
ha_codeowners:
- '@ntilley905'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Wake on LAN** {% term integration %} enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on.
@@ -22,7 +25,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To use this {% term integration %} in your installation, add the following to your `configuration.yaml` file:
+To use this {% 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
@@ -37,11 +41,11 @@ Available services: `send_magic_packet`.
Send a _magic packet_ to wake up a device with 'Wake on LAN' capabilities.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `mac` | no | MAC address of the device to wake up. |
-| `broadcast_address` | yes | Optional broadcast IP where to send the magic packet. |
-| `broadcast_port` | yes | Optional port where to send the magic packet. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------- |
+| `mac` | no | MAC address of the device to wake up. |
+| `broadcast_address` | yes | Optional broadcast IP where to send the magic packet. |
+| `broadcast_port` | yes | Optional port where to send the magic packet. |
Sample service data:
diff --git a/source/_integrations/waterfurnace.markdown b/source/_integrations/waterfurnace.markdown
index 57e91ce39e2..36c5cba0f18 100644
--- a/source/_integrations/waterfurnace.markdown
+++ b/source/_integrations/waterfurnace.markdown
@@ -9,6 +9,9 @@ ha_domain: waterfurnace
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **WaterFurnace** {% term integration %} communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
@@ -32,7 +35,8 @@ The sensors provided include:
## Configuration
-To use Waterfurnace in your installation, add the following to your `configuration.yaml` file:
+To use Waterfurnace 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/watson_iot.markdown b/source/_integrations/watson_iot.markdown
index d5d2827025a..580ec5b118e 100644
--- a/source/_integrations/watson_iot.markdown
+++ b/source/_integrations/watson_iot.markdown
@@ -7,6 +7,9 @@ ha_release: 0.72
ha_domain: watson_iot
ha_iot_class: Cloud Push
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **IBM Watson IoT Platform** {% term integration %} enables you to link the devices in Home Assistant
@@ -25,7 +28,8 @@ for your Home Assistant instance you'll need four pieces of information:
- Gateway device ID
- Authentication Token
-With this basic information you can configure the {% term integration %}:
+With this basic information you can add the {% term integration %} to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry:
diff --git a/source/_integrations/watson_tts.markdown b/source/_integrations/watson_tts.markdown
index 91e9260637a..bcf5ba0019a 100644
--- a/source/_integrations/watson_tts.markdown
+++ b/source/_integrations/watson_tts.markdown
@@ -11,9 +11,12 @@ ha_domain: watson_tts
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `watson_tts` text-to-speech platform that works with [IBM Watson Cloud](https://www.ibm.com/watson/services/text-to-speech/) to create the spoken output.
+The `watson_tts` text-to-speech {% term integration %} that works with [IBM Watson Cloud](https://www.ibm.com/watson/services/text-to-speech/) to create the spoken output.
Watson is a paid service via IBM Cloud but there is a decent [free tier](https://www.ibm.com/cloud/watson-text-to-speech/pricing) which offers 10000 free characters every month.
## Setup
@@ -24,7 +27,8 @@ To get started please read the [Getting started tutorial](https://cloud.ibm.com/
## Configuration
-To configure Watson TTS, add the following lines to your `configuration.yaml`:
+To configure Watson TTS, 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/wirelesstag.markdown b/source/_integrations/wirelesstag.markdown
index 481a5339742..7774e25fc38 100644
--- a/source/_integrations/wirelesstag.markdown
+++ b/source/_integrations/wirelesstag.markdown
@@ -16,6 +16,9 @@ ha_platforms:
ha_codeowners:
- '@sergeymaysak'
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Wireless Sensor Tags** {% term integration %} allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant.
@@ -28,7 +31,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To enable tags set up with your [wirelesstag.net](https://wirelesstag.net/) account, add the following to your `configuration.yaml` file:
+To enable tags set up with your [wirelesstag.net](https://wirelesstag.net/) account, 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/worldclock.markdown b/source/_integrations/worldclock.markdown
index ad0115af7da..920dbf0523a 100644
--- a/source/_integrations/worldclock.markdown
+++ b/source/_integrations/worldclock.markdown
@@ -12,13 +12,17 @@ ha_domain: worldclock
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `worldclock` sensor platform simply displays the current time in a different time zone.
+The `worldclock` {% term integration %} simply displays the current time in a different time zone.
## Configuration
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable this {% 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/worldtidesinfo.markdown b/source/_integrations/worldtidesinfo.markdown
index 26b90efa620..7b53e3a553c 100644
--- a/source/_integrations/worldtidesinfo.markdown
+++ b/source/_integrations/worldtidesinfo.markdown
@@ -9,9 +9,12 @@ ha_domain: worldtidesinfo
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world.
+The `worldtidesinfo` {% term integration %} uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world.
## Setup
@@ -19,7 +22,8 @@ Get your API key from your account at [https://www.worldtides.info/](https://www
## Configuration
-To use this sensor, add the following to your `configuration.yaml` file:
+To use this {% term integration %}, 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/worxlandroid.markdown b/source/_integrations/worxlandroid.markdown
index 19480745946..21c6b5a7a77 100644
--- a/source/_integrations/worxlandroid.markdown
+++ b/source/_integrations/worxlandroid.markdown
@@ -9,11 +9,15 @@ ha_domain: worxlandroid
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `worxlandroid` sensor platform allows you to get the current state, battery level and error status Worx Landroid WG796E.1 or WG797E.
+The `worxlandroid` {% term integration %} allows you to get the current state, battery level and error status Worx Landroid WG796E.1 or WG797E.
-To use your Worx Landroid mower in your installation, add the following to your `configuration.yaml` file:
+To use your Worx Landroid mower 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/wsdot.markdown b/source/_integrations/wsdot.markdown
index 61810227e8e..b6626190449 100644
--- a/source/_integrations/wsdot.markdown
+++ b/source/_integrations/wsdot.markdown
@@ -9,6 +9,9 @@ ha_domain: wsdot
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Washington State Department of Transportation (WSDOT)** {% term integration %} will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/).
@@ -19,7 +22,8 @@ First, you need to get a free Traveler Information `api_key` from the [WSDOT API
## Configuration
-Once you have the code, create `wsdot` sensors by editing your `configuration.yaml` file as follows:
+Once you have the code, create `wsdot` sensors by editing your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/x10.markdown b/source/_integrations/x10.markdown
index d9aa5a47b68..f80404c9e1e 100644
--- a/source/_integrations/x10.markdown
+++ b/source/_integrations/x10.markdown
@@ -9,13 +9,17 @@ ha_domain: x10
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `x10` light platform allows you to control your X10 based lights with Home Assistant.
+The `x10` light {% term integration %} allows you to control your X10 based lights with Home Assistant.
Requires [Heyu x10](https://www.heyu.org/) and a CM11A or a CM17A "FireCracker" interface.
-To enable those lights, add the following lines to your `configuration.yaml` file:
+To enable those lights, 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/xeoma.markdown b/source/_integrations/xeoma.markdown
index eeb1fc67e78..d29410551ca 100644
--- a/source/_integrations/xeoma.markdown
+++ b/source/_integrations/xeoma.markdown
@@ -9,13 +9,17 @@ ha_domain: xeoma
ha_platforms:
- camera
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](https://felenasoft.com/xeoma) video surveillance server.
+The `Xeoma` camera {% term integration %} allows you to view the video feeds from a [Xeoma](https://felenasoft.com/xeoma) video surveillance server.
## Configuration
-To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
+To enable Xeoma camera feeds, 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/xiaomi_tv.markdown b/source/_integrations/xiaomi_tv.markdown
index ce5fe0c560a..c2ce0557419 100644
--- a/source/_integrations/xiaomi_tv.markdown
+++ b/source/_integrations/xiaomi_tv.markdown
@@ -11,14 +11,18 @@ ha_domain: xiaomi_tv
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `xiaomi_tv` platform allows you to control a [Xiaomi TV](https://www.mi.com/global/mitv3s/65flat/).
+The `xiaomi_tv` {% term integration %} allows you to control a [Xiaomi TV](https://www.mi.com/global/mitv3s/65flat/).
The Xiaomi TV integration only supports Xiaomi TVs running MIUI.
You need to make sure the TV is connected to the internet, and that your Home Assistant instance is on the same network.
-To add a TV to your installation, add the following to your `configuration.yaml` file:
+To add a TV 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/xmpp.markdown b/source/_integrations/xmpp.markdown
index 8244b3ac2f4..d0c56ce2f03 100644
--- a/source/_integrations/xmpp.markdown
+++ b/source/_integrations/xmpp.markdown
@@ -12,13 +12,17 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `xmpp` notification platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](https://xmpp.org/) account.
+The `xmpp` notification {% term integration %} allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](https://xmpp.org/) account.
## Configuration
-To enable Jabber notifications in your installation, add the following to your `configuration.yaml` file:
+To enable Jabber 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/xs1.markdown b/source/_integrations/xs1.markdown
index 85d655ec848..f4109033faa 100644
--- a/source/_integrations/xs1.markdown
+++ b/source/_integrations/xs1.markdown
@@ -14,13 +14,17 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) {% term integration %} for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
## Configuration
-Add the following entry to the `configuration.yaml` file:
+Add the following entry to the {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -71,11 +75,11 @@ If you are using climate devices the "current temp" sensor will be automatically
### Actuators
-| Type | Supported | Notes |
-|---------------|-----------|--------------------------------------------------|
-| `switch` | Yes | |
-| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(|
-| `temperature` | Yes | |
+| Type | Supported | Notes |
+| ------------- | --------- | --------------------------------------------------------------------------------- |
+| `switch` | Yes | |
+| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :( |
+| `temperature` | Yes | |
### Climate actuator/sensor
diff --git a/source/_integrations/yalexs_ble.markdown b/source/_integrations/yalexs_ble.markdown
index 0cef396796a..9f3e212e167 100644
--- a/source/_integrations/yalexs_ble.markdown
+++ b/source/_integrations/yalexs_ble.markdown
@@ -101,3 +101,11 @@ Root access is required to read the `key` and `slot` stored in `/data/data/com.a
The Android app will only save the offline key to your device's filesystem if Auto-Unlock has been enabled and used at least once. Auto-Unlock can be disabled once the key has been loaded.
Root access is required to copy the `ModelDatabase.sql` from `/data/data/com.assaabloy.yale/databases`. Once copied, you can use [DB Broser for SQLite](https://sqlitebrowser.org/) to open the `ModelDatabase.sql`, navigate to the table `LockData` and find the column `offlineKeys`.There, you will find a JSON that includes the `key` and `slot` properties.
+
+## Troubleshooting
+
+### Lock frequently requires re-authentication
+
+If you use the key from an iOS or Android device that you also frequently use to operate the lock, you may find that the key is rotated, and the integration can no longer authenticate. If you are using the [August](/integrations/august) integration to keep the key up to date, it may need to be reloaded to update the key.
+
+To avoid the problem, create a second owner account in the August app, log in to it once on your iOS or Android device, operate the locks, log out of the account, remove the August integration, and set up the August integration with the secondary owner account. This method avoids the problem because there is no longer an iOS or Android device logged into the secondary owner account that can rotate the key unexpectedly.
diff --git a/source/_integrations/yamaha.markdown b/source/_integrations/yamaha.markdown
index fd2655f9e07..d184c62eddb 100644
--- a/source/_integrations/yamaha.markdown
+++ b/source/_integrations/yamaha.markdown
@@ -9,9 +9,12 @@ ha_domain: yamaha
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `yamaha` platform allows you to control [Yamaha Network Receivers](https://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant.
+The `yamaha` {% term integration %} allows you to control [Yamaha Network Receivers](https://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant.
Supported devices:
@@ -25,7 +28,8 @@ Supported devices:
- [RX-V3067](https://ca.yamaha.com/en/products/audio_visual/av_receivers_amps/rx-v3067/specs.html)
- And more
-To add a Yamaha Network Receiver to your installation, add the following to your `configuration.yaml` file:
+To add a Yamaha Network Receiver 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
@@ -127,26 +131,26 @@ script:
Enable or disable an output port (HDMI) on the receiver.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers.
-| `port` | no | Port to enable or disable, e.g., `hdmi1`.
-| `enabled` | no | To enable set true, otherwise set to false.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
+| `port` | no | Port to enable or disable, e.g., `hdmi1`. |
+| `enabled` | no | To enable set true, otherwise set to false. |
### Service `menu_cursor`
Control the menu cursor.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers.
-| `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return`
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
+| `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return` |
### Service `select_scene`
Select a scene on the receiver.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers.
-| `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
+| `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`. |
diff --git a/source/_integrations/yandex_transport.markdown b/source/_integrations/yandex_transport.markdown
index b5e2374b5ce..db240f2a8dc 100644
--- a/source/_integrations/yandex_transport.markdown
+++ b/source/_integrations/yandex_transport.markdown
@@ -13,9 +13,12 @@ ha_domain: yandex_transport
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `yandex_tranport` sensor platform uses [Yandex Maps](https://maps.yandex.ru/) it will give you the time until the next departure time from a bus/tramway/etc stop.
+The `yandex_tranport` {% term integration %} uses [Yandex Maps](https://maps.yandex.ru/) it will give you the time until the next departure time from a bus/tramway/etc stop.
The [Yandex Maps](https://maps.yandex.ru/) website can help to determine the id of your bus stop. You can select a bus stop by clicking on the map, and look to the URL:
@@ -27,7 +30,8 @@ If you want to track only specific routes, you can add them in the routes sectio
## Configuration
-To activate Yandex Transport, add the following lines to your `configuration.yaml`:
+To activate Yandex Transport, 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/yandextts.markdown b/source/_integrations/yandextts.markdown
index 43f8c75ff6d..2d6d2066f2f 100644
--- a/source/_integrations/yandextts.markdown
+++ b/source/_integrations/yandextts.markdown
@@ -9,9 +9,12 @@ ha_domain: yandextts
ha_platforms:
- tts
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `yandextts` text-to-speech platform uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) text-to-speech engine to read a text with natural sounding voices.
+The `yandextts` text-to-speech {% term integration %} uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) text-to-speech engine to read a text with natural sounding voices.
This integration is working only with old API keys. For the new API keys, this integration cannot be used.
@@ -19,7 +22,8 @@ This integration is working only with old API keys. For the new API keys, this i
## Configuration
-To enable text-to-speech with Yandex SpeechKit, add the following lines to your `configuration.yaml`:
+To enable text-to-speech with Yandex SpeechKit, 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/yeelightsunflower.markdown b/source/_integrations/yeelightsunflower.markdown
index 2c3494fdf70..f372a993488 100644
--- a/source/_integrations/yeelightsunflower.markdown
+++ b/source/_integrations/yeelightsunflower.markdown
@@ -11,15 +11,19 @@ ha_domain: yeelightsunflower
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `yeelightsunflower` light platform allows you to control your Yeelight Sunflower light bulbs with Home Assistant.
+The `yeelightsunflower` {% term integration %} allows you to control your Yeelight Sunflower light bulbs with Home Assistant.
The "Yeelight Sunflower" bulbs are not the same as the "Yeelight WiFi" bulbs.
-To enable your lights, add the following lines to your `configuration.yaml` file:
+To enable your lights, 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/zabbix.markdown b/source/_integrations/zabbix.markdown
index 75e5bb10b27..4aef704bbcd 100644
--- a/source/_integrations/zabbix.markdown
+++ b/source/_integrations/zabbix.markdown
@@ -10,6 +10,9 @@ ha_domain: zabbix
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Zabbix** {% term integration %} is the main {% term integration %} to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
@@ -22,7 +25,8 @@ There is currently also support for the following device types within Home Assis
## Configuration
-To set the Zabbix {% term integration %} up, add the following information to your `configuration.yaml` file:
+To set the Zabbix {% term integration %} up, add the following information to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/zengge.markdown b/source/_integrations/zengge.markdown
index a791ff666c0..38c72fbdfca 100644
--- a/source/_integrations/zengge.markdown
+++ b/source/_integrations/zengge.markdown
@@ -11,13 +11,17 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@emontnemery'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `zengge` platform allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant.
+The `zengge` {% term integration %} allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant.
## Configuration
-To enable the lights, add the following lines to your `configuration.yaml` file:
+To enable the lights, 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/ziggo_mediabox_xl.markdown b/source/_integrations/ziggo_mediabox_xl.markdown
index a7285bdf6cf..79e303e6045 100644
--- a/source/_integrations/ziggo_mediabox_xl.markdown
+++ b/source/_integrations/ziggo_mediabox_xl.markdown
@@ -9,11 +9,15 @@ ha_domain: ziggo_mediabox_xl
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Ziggo Mediabox XL** {% term integration %} allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant.
-To add a Ziggo Mediabox XL to your installation, add the following to your `configuration.yaml` file:
+To add a Ziggo Mediabox XL 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/zoneminder.markdown b/source/_integrations/zoneminder.markdown
index 4613ab07518..32e50499bf7 100644
--- a/source/_integrations/zoneminder.markdown
+++ b/source/_integrations/zoneminder.markdown
@@ -19,6 +19,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `zoneminder` integration sets up Home Assistant with your [ZoneMinder](https://www.zoneminder.com) instance.
@@ -32,6 +35,9 @@ There is currently support for the following device types within Home Assistant:
## Configuration
+To add the {% term integration %} to your installation, add it to the {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
zoneminder:
@@ -92,7 +98,7 @@ zoneminder:
Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) that can be used to change the current run state of ZoneMinder.
| Service data attribute | Optional | Description |
-|:-----------------------|:---------|:----------------------------------|
+| :--------------------- | :------- | :-------------------------------- |
| `id` | no | Host of the ZoneMinder instance. |
| `name` | no | Name of the new run state to set. |
diff --git a/source/_posts/2023-09-17-a-refreshed-logo-for-home-assistant.markdown b/source/_posts/2023-09-17-a-refreshed-logo-for-home-assistant.markdown
index e542e736958..80745d1f6ec 100644
--- a/source/_posts/2023-09-17-a-refreshed-logo-for-home-assistant.markdown
+++ b/source/_posts/2023-09-17-a-refreshed-logo-for-home-assistant.markdown
@@ -16,6 +16,8 @@ Hello all, this is Madelena. You may know me from [some](https://www.reddit.com/
As you may have heard from our celebration for [the 10th anniversary of Home Assistant](/blog/2023/09/17/10-years-home-assistant/), we are making some tweaks to our logo! This is no small feat, as the logo is a big part of the identity of Home Assistant, and by extension a representation of the contributions of our community. This logo has served us well for 8 years. When we see the logo, it represents the culmination of work that we are all proud of.
+_For those who want to use our logo and for more details, the latest brand guidelines and logo assets can be found [at our design repository.](https://design.home-assistant.io/#brand/logo)_
+
## Humble beginnings
@@ -80,7 +82,7 @@ We have also changed our logotype to something more cozy and modern like a home.
We have also toned the blue color to be slightly more saturated to make it feel brighter and more utopian, and expanded the palette to a wider gamut.
-For those who want to use our logo and for more details, the latest brand guidelines can be found [at our design repository.](https://design.home-assistant.io/)
+For those who want to use our logo and for more details, the latest brand guidelines and logo assets can be found [at our design repository.](https://design.home-assistant.io/#brand/logo)
## There’s more to come!
diff --git a/source/_posts/2024-16-03-voice-assistant-community-contest-winners-annoucement.markdown b/source/_posts/2024-03-16-voice-assistant-community-contest-winners-annoucement.markdown
similarity index 99%
rename from source/_posts/2024-16-03-voice-assistant-community-contest-winners-annoucement.markdown
rename to source/_posts/2024-03-16-voice-assistant-community-contest-winners-annoucement.markdown
index e629e1e7640..5c649466421 100644
--- a/source/_posts/2024-16-03-voice-assistant-community-contest-winners-annoucement.markdown
+++ b/source/_posts/2024-03-16-voice-assistant-community-contest-winners-annoucement.markdown
@@ -126,4 +126,4 @@ We are looking forward to having the winners on the livestream with us on the 10
I hope you enjoyed this first Home Assistant contest, rest assured that it won’t be the last.
-JLo, Over and Out.
\ No newline at end of file
+JLo, Over and Out.
diff --git a/source/_posts/2024-05-01-release-20245.markdown b/source/_posts/2024-05-01-release-20245.markdown
index e274a17497a..30a1826d274 100644
--- a/source/_posts/2024-05-01-release-20245.markdown
+++ b/source/_posts/2024-05-01-release-20245.markdown
@@ -50,6 +50,9 @@ Anyway, I will not hold you any longer. Enjoy the release!
- [Other noteworthy changes](#other-noteworthy-changes)
- [New integrations](#new-integrations)
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
+- [Release 2024.5.1 - May 3](#release-202451---may-3)
+- [Release 2024.5.2 - May 6](#release-202452---may-6)
+- [Release 2024.5.3 - May 10](#release-202453---may-10)
- [Need help? Join the community!](#need-help-join-the-community)
- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
@@ -71,7 +74,7 @@ so we've added a bunch of them in this release. 😎
One of the most requested features of these new tables' new
[item grouping](/blog/2024/04/03/release-20244/#item-grouping) was the
ability to collapse them, and we’ve added that!
-
+
Each item group can now be collapsed and expanded.
@@ -114,15 +117,15 @@ without leaving it:
## Lock features for the tile card
-The tile card is already amazing, but [@marcgeurts] made it even better by
+The tile card is already amazing, but [@marcgeurts] made it even better by
adding new features to the tile card: Locks!
When you now add a lock entity to the tile card, and if your lock supports it,
you can now add two new features to the tile card:
-- [**Lock commands**](/dashboards/features/#lock-commands)
+- [**Lock commands**](/dashboards/features/#lock-commands)
Adds buttons to your tile card to lock or unlock the lock.
-- [**Lock open door**](/dashboards/features/#lock-open-door)
+- [**Lock open door**](/dashboards/features/#lock-open-door)
Adds a button to open/unlatch the door (with confirmation).
@@ -185,7 +188,7 @@ In conjunction with [the latest release of ESPHome] (2024.4), we are bringing
a much improved and more reliable communication between [ESPHome] and
Home Assistant for transferring voice audio, guaranteeing no audio is lost in the process.
-Hear the difference in this side-by-side comparison:
+Hear the difference in this side-by-side comparison:
@@ -255,7 +258,7 @@ We welcome the following new {% term integrations %} in this release:
- **[Arve]**, added by [@ikalnyi]
Monitor real-life air quality data from your Arve devices.
- **[Energenie Power-Sockets]**, added by [@gnumpi]
- Control your Energie Power-Strips over USB.
+ Control your Energenie Power-Strips over USB.
- **[Epic Games Store]**, added by [@Quentame]
Provides a calendar for the Epic Games Store to monitor discounts and free games.
- **[eQ-3 Bluetooth Smart Thermostats]**, added by [@EuleMitKeule]
@@ -271,7 +274,7 @@ We welcome the following new {% term integrations %} in this release:
[@tomaszsluszniak]: https://github.com/tomaszsluszniak
[Ambient Weather Network]: /integrations/ambient_network
[Arve]: /integrations/arve
-[Energenie Power-Sockets]: /integratoins/egps
+[Energenie Power-Sockets]: /integrations/energenie_power_sockets
[Epic Games Store]: /integrations/epic_games_store
[eQ-3 Bluetooth Smart Thermostats]: /integrations/eq3btsmart
[Sanix]: /integrations/sanix
@@ -291,6 +294,203 @@ The following {% term integrations %} are now available via the Home Assistant U
[Folder watcher]: /integrations/folder_watcher
[LG Netcast]: /integrations/lg_netcast
+## Release 2024.5.1 - May 3
+
+- Fix nws forecast coordinators and remove legacy forecast handling ([@MatthewFlamm] - [#115857])
+- Bump opentherm_gw to 2.2.0 ([@GraceGRD] - [#116527])
+- Add a lock to homekit_controller platform loads ([@bdraco] - [#116539])
+- Fix MQTT discovery cooldown too short with large setup ([@jbouwh] - [#116550])
+- Bump upb_lib to 0.5.6 ([@gwww] - [#116558])
+- Bump elkm1_lib to 2.2.7 ([@gwww] - [#116564])
+- Fix Matter startup when Matter bridge is present ([@marcelveldt] - [#116569])
+- Bump sanix to 1.0.6 ([@tomaszsluszniak] - [#116570])
+- Fix Airthings BLE model names ([@LaStrada] - [#116579])
+- Improve coordinator in Ondilo ico ([@joostlek] - [#116596])
+- Fix inheritance order for KNX notify ([@farmio] - [#116600])
+- Bump Airthings BLE to 0.8.0 ([@LaStrada] - [#116616])
+- Bump pywaze to 1.0.1 ([@eifinger] - [#116621])
+- Add constraint for tuf ([@cdce8p] - [#116627])
+- Bump aiounifi to v77 ([@Kane610] - [#116639])
+- Bump govee-light-local library and fix wrong information for Govee lights ([@Galorhallen] - [#116651])
+- Bump ZHA dependency bellows to 0.38.4 ([@puddly] - [#116660])
+- Bump habluetooth to 2.8.1 ([@bdraco] - [#116661])
+- Bump env_canada lib to 0.6.2 ([@gwww] - [#116662])
+- Block dreame_vacuum versions older than 1.0.4 ([@bdraco] - [#116673])
+- Fix fyta test timezone handling ([@cdce8p] - [#116689])
+- Fix BroadlinkRemote._learn_command() ([@felipediel] - [#116692])
+
+[#115857]: https://github.com/home-assistant/core/pull/115857
+[#116527]: https://github.com/home-assistant/core/pull/116527
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116539]: https://github.com/home-assistant/core/pull/116539
+[#116550]: https://github.com/home-assistant/core/pull/116550
+[#116558]: https://github.com/home-assistant/core/pull/116558
+[#116564]: https://github.com/home-assistant/core/pull/116564
+[#116569]: https://github.com/home-assistant/core/pull/116569
+[#116570]: https://github.com/home-assistant/core/pull/116570
+[#116579]: https://github.com/home-assistant/core/pull/116579
+[#116596]: https://github.com/home-assistant/core/pull/116596
+[#116600]: https://github.com/home-assistant/core/pull/116600
+[#116616]: https://github.com/home-assistant/core/pull/116616
+[#116621]: https://github.com/home-assistant/core/pull/116621
+[#116627]: https://github.com/home-assistant/core/pull/116627
+[#116639]: https://github.com/home-assistant/core/pull/116639
+[#116651]: https://github.com/home-assistant/core/pull/116651
+[#116660]: https://github.com/home-assistant/core/pull/116660
+[#116661]: https://github.com/home-assistant/core/pull/116661
+[#116662]: https://github.com/home-assistant/core/pull/116662
+[#116673]: https://github.com/home-assistant/core/pull/116673
+[#116689]: https://github.com/home-assistant/core/pull/116689
+[#116692]: https://github.com/home-assistant/core/pull/116692
+[@Galorhallen]: https://github.com/Galorhallen
+[@GraceGRD]: https://github.com/GraceGRD
+[@Kane610]: https://github.com/Kane610
+[@LaStrada]: https://github.com/LaStrada
+[@MatthewFlamm]: https://github.com/MatthewFlamm
+[@bdraco]: https://github.com/bdraco
+[@cdce8p]: https://github.com/cdce8p
+[@eifinger]: https://github.com/eifinger
+[@farmio]: https://github.com/farmio
+[@felipediel]: https://github.com/felipediel
+[@frenck]: https://github.com/frenck
+[@gwww]: https://github.com/gwww
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@marcelveldt]: https://github.com/marcelveldt
+[@puddly]: https://github.com/puddly
+[@tomaszsluszniak]: https://github.com/tomaszsluszniak
+
+## Release 2024.5.2 - May 6
+
+- Add workaround for data entry flow show progress ([@emontnemery] - [#116704])
+- Improve logging of _TrackPointUTCTime objects ([@bdraco] - [#116711])
+- Bump aiohttp-isal to 0.3.1 ([@bdraco] - [#116720])
+- Fix Bosch-SHC switch state ([@joostlek] - [#116721])
+- Remove suggested UoM from Opower ([@joostlek] - [#116728])
+- Refactor statistics to avoid creating tasks ([@bdraco] - [#116743])
+- Bump bluetooth-adapters to 0.19.2 ([@bdraco] - [#116785])
+- fix UnboundLocalError on modified_statistic_ids in compile_statistics ([@pdecat] - [#116795])
+- Ensure all synology_dsm coordinators handle expired sessions ([@bdraco] - [#116796])
+- Fix IMAP config entry setup ([@jbouwh] - [#116797])
+- Fix airthings-ble data drop outs when Bluetooth connection is flakey ([@bdraco] - [#116805])
+- Hide conversation agents that are exposed as agent entities ([@balloob] - [#116813])
+- Fix non-thread-safe state write in lutron event ([@bdraco] - [#116829])
+- Increase default timeout to 30 seconds in Synology DSM ([@mib1185] - [#116836])
+- Avoid duplicate data fetch during Synologs DSM setup ([@mib1185] - [#116839])
+- Bump androidtvremote2 to v0.0.15 ([@tronikos] - [#116844])
+- Bump goodwe to 0.3.4 ([@mletenay] - [#116849])
+- Fix non-thread-safe operations in amcrest ([@bdraco] - [#116859])
+- fix radarr coordinator updates ([@tkdrob] - [#116874])
+- Fix initial mqtt subcribe cooldown timeout ([@jbouwh] - [#116904])
+- Update frontend to 20240501.1 ([@bramkragten] - [#116939])
+
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116696]: https://github.com/home-assistant/core/pull/116696
+[#116704]: https://github.com/home-assistant/core/pull/116704
+[#116711]: https://github.com/home-assistant/core/pull/116711
+[#116720]: https://github.com/home-assistant/core/pull/116720
+[#116721]: https://github.com/home-assistant/core/pull/116721
+[#116728]: https://github.com/home-assistant/core/pull/116728
+[#116743]: https://github.com/home-assistant/core/pull/116743
+[#116785]: https://github.com/home-assistant/core/pull/116785
+[#116795]: https://github.com/home-assistant/core/pull/116795
+[#116796]: https://github.com/home-assistant/core/pull/116796
+[#116797]: https://github.com/home-assistant/core/pull/116797
+[#116805]: https://github.com/home-assistant/core/pull/116805
+[#116813]: https://github.com/home-assistant/core/pull/116813
+[#116829]: https://github.com/home-assistant/core/pull/116829
+[#116836]: https://github.com/home-assistant/core/pull/116836
+[#116839]: https://github.com/home-assistant/core/pull/116839
+[#116844]: https://github.com/home-assistant/core/pull/116844
+[#116849]: https://github.com/home-assistant/core/pull/116849
+[#116859]: https://github.com/home-assistant/core/pull/116859
+[#116874]: https://github.com/home-assistant/core/pull/116874
+[#116904]: https://github.com/home-assistant/core/pull/116904
+[#116939]: https://github.com/home-assistant/core/pull/116939
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@bramkragten]: https://github.com/bramkragten
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@mib1185]: https://github.com/mib1185
+[@mletenay]: https://github.com/mletenay
+[@pdecat]: https://github.com/pdecat
+[@tkdrob]: https://github.com/tkdrob
+[@tronikos]: https://github.com/tronikos
+
+## Release 2024.5.3 - May 10
+
+- Fix Sonos select_source timeout error ([@PeteRager] - [#115640]) ([sonos docs])
+- Update strings for Bring notification service ([@tr4nt0r] - [#116181]) ([bring docs])
+- Bump Yolink api to 0.4.4 ([@matrixd2] - [#116967]) ([yolink docs])
+- Update jinja2 to 3.1.4 ([@cdce8p] - [#116986])
+- Simplify MQTT subscribe debouncer execution ([@bdraco] - [#117006]) ([mqtt docs])
+- Log an exception mqtt client call back throws ([@jbouwh] - [#117028]) ([mqtt docs])
+- Bump rokuecp to 0.19.3 ([@ctalkington] - [#117059]) ([roku docs])
+- Bump pyenphase to 1.20.3 ([@catsmanac] - [#117061]) ([enphase_envoy docs])
+- Add a missing `addon_name` placeholder to the SkyConnect config flow ([@puddly] - [#117089]) ([homeassistant_sky_connect docs])
+- Goodwe Increase max value of export limit to 200% ([@mletenay] - [#117090]) ([goodwe docs])
+- Improve config entry has already been setup error message ([@bdraco] - [#117091])
+- Fix nws blocking startup ([@MatthewFlamm] - [#117094]) ([nws docs])
+- Make the mqtt discovery update tasks eager and fix race ([@jbouwh] - [#117105]) ([mqtt docs])
+- Bump goodwe to 0.3.5 ([@mletenay] - [#117115]) ([goodwe docs])
+- Handle tilt position being None in HKC ([@bdraco] - [#117141]) ([homekit_controller docs])
+- Fix typo in xiaomi_ble translation strings ([@jbouwh] - [#117144]) ([xiaomi_ble docs])
+- Bump pytrydan to 0.6.0 ([@dgomes] - [#117162]) ([v2c docs])
+- Bump deebot-client to 7.2.0 ([@edenhaus] - [#117189]) ([ecovacs docs])
+
+[#115640]: https://github.com/home-assistant/core/pull/115640
+[#116181]: https://github.com/home-assistant/core/pull/116181
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116696]: https://github.com/home-assistant/core/pull/116696
+[#116937]: https://github.com/home-assistant/core/pull/116937
+[#116967]: https://github.com/home-assistant/core/pull/116967
+[#116986]: https://github.com/home-assistant/core/pull/116986
+[#117006]: https://github.com/home-assistant/core/pull/117006
+[#117028]: https://github.com/home-assistant/core/pull/117028
+[#117059]: https://github.com/home-assistant/core/pull/117059
+[#117061]: https://github.com/home-assistant/core/pull/117061
+[#117089]: https://github.com/home-assistant/core/pull/117089
+[#117090]: https://github.com/home-assistant/core/pull/117090
+[#117091]: https://github.com/home-assistant/core/pull/117091
+[#117094]: https://github.com/home-assistant/core/pull/117094
+[#117105]: https://github.com/home-assistant/core/pull/117105
+[#117115]: https://github.com/home-assistant/core/pull/117115
+[#117141]: https://github.com/home-assistant/core/pull/117141
+[#117144]: https://github.com/home-assistant/core/pull/117144
+[#117162]: https://github.com/home-assistant/core/pull/117162
+[#117189]: https://github.com/home-assistant/core/pull/117189
+[@MatthewFlamm]: https://github.com/MatthewFlamm
+[@PeteRager]: https://github.com/PeteRager
+[@bdraco]: https://github.com/bdraco
+[@catsmanac]: https://github.com/catsmanac
+[@cdce8p]: https://github.com/cdce8p
+[@ctalkington]: https://github.com/ctalkington
+[@dgomes]: https://github.com/dgomes
+[@edenhaus]: https://github.com/edenhaus
+[@frenck]: https://github.com/frenck
+[@jbouwh]: https://github.com/jbouwh
+[@matrixd2]: https://github.com/matrixd2
+[@mletenay]: https://github.com/mletenay
+[@puddly]: https://github.com/puddly
+[@tr4nt0r]: https://github.com/tr4nt0r
+[accuweather docs]: /integrations/accuweather/
+[bring docs]: /integrations/bring/
+[ecovacs docs]: /integrations/ecovacs/
+[enphase_envoy docs]: /integrations/enphase_envoy/
+[goodwe docs]: /integrations/goodwe/
+[homeassistant_sky_connect docs]: /integrations/homeassistant_sky_connect/
+[homekit_controller docs]: /integrations/homekit_controller/
+[mqtt docs]: /integrations/mqtt/
+[nws docs]: /integrations/nws/
+[roku docs]: /integrations/roku/
+[sonos docs]: /integrations/sonos/
+[v2c docs]: /integrations/v2c/
+[xiaomi_ble docs]: /integrations/xiaomi_ble/
+[yolink docs]: /integrations/yolink/
+
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
@@ -400,6 +600,19 @@ sidebar, has moved to the integration page in
{% enddetails %}
+{% details "LG Netcast" %}
+
+Turn on action for turning the TV on via a custom script
+within `configuration.yaml` has been changed to use a custom automation trigger
+`lg_netcast.turn_on` or a device trigger that can be set up from the UI.
+
+([@splinter98] - [#104913]) ([documentation](/integrations/lg_netcast))
+
+[@splinter98]: https://github.com/splinter98
+[#104913]: https://github.com/home-assistant/core/pull/104913
+
+{% enddetails %}
+
{% details "Netatmo" %}
The state of the Netatmo wind and gust direction sensor provided by
@@ -425,12 +638,12 @@ now exposes the state in lowercase.
{% details "Recorder" %}
Previously, `recorder.purge_entities` called with no arguments would purge all
-entities. This PR makes this call raise an error instead.
+entities. This PR makes this call raise an error instead.
It was too easy for users to accidentally purge their entire database using the
old logic. Users who want to purge all entities can still use
the `recorder.purge` service to achieve the same effect, and that service
-is more obvious in how it behaves.
+is more obvious in how it behaves.
([@karwosts] - [#110066]) ([documentation](/integrations/recorder))
diff --git a/source/_posts/2024-05-08-zwave-is-not-dead.markdown b/source/_posts/2024-05-08-zwave-is-not-dead.markdown
new file mode 100644
index 00000000000..f60eb8ec9d5
--- /dev/null
+++ b/source/_posts/2024-05-08-zwave-is-not-dead.markdown
@@ -0,0 +1,106 @@
+---
+layout: post
+title: "Z-Wave is not dead"
+description: "Z-Wave is alive and well, partly due to a strong community that is building new open-source resources."
+date: 2024-05-08 00:00:01
+date_formatted: "May 08, 2024"
+author: Paulus Schoutsen
+comments: true
+categories: Z-Wave
+og_image: /images/blog/2024-05-zwave-is-not-dead/art.jpg
+---
+
+
Art by Clelia Rella
+
+**TL;DR: Z-Wave is alive and well, partly due to a strong community that is building new open-source resources. To thrive well into the future, it must take further steps to open its technology.**
+
+Last week, Dominic, Uwe, and I (Paulus) attended the Z-Wave Alliance member meeting in Austin, Texas. It was the first meeting since we [became a member](/blog/2024/02/15/nabu-casa-joins-z-wave-alliance/) and we came with a mission: tell Alliance members about the work done by the open-source community for Z-Wave and find new avenues for collaboration.
+
+Three of us attended, each representing different facets of Z-Wave within the Open Home Foundation: Dominic is the founder and maintainer of Z-Wave JS, which powers the Z-Wave integration in Home Assistant. Uwe leads the development of the Home Assistant Z-Wave stick that we’re working on, and I was there to enable collaborations with other Z-Wave members. Big thanks to [Home Assistant Cloud subscribers](https://www.nabucasa.com/) – thanks to you we can do this work full-time at Nabu Casa.
+
+### A little background on Z-Wave
+
+To use Z-Wave in Home Assistant, our users buy a Z-Wave certified USB stick and combine it with Z-Wave certified devices. Home Assistant then connects to the stick using Z-Wave JS, developed by Dominic, and we’re off to the races. Z-Wave JS was developed completely outside of the Z-Wave Alliance, and is based on the published version of the Z-Wave specification.
+
+Z-Wave wasn’t always this open - Z-Wave used to be owned by a single company, which was later acquired by Silicon Labs. SiLabs decided it was time for change and turned the Z-Wave Alliance into a Standards Development Organization (SDO) that is controlled by its members and a standard that is open.
+
+As it stands, there are still parts of Z-Wave that are not open yet, including the firmware that is running on Z-Wave sticks. I might have mentioned _a couple of times,_ including in my keynote, that we should open up more. It is a good thing to let everyone help fix bugs, improve code quality, and improve diagnostics.
+
+
+
+## Opening Keynote
+
+One of the conditions that we negotiated when joining the Z-Wave Alliance was that we would be allowed to give an opening keynote to explain the work we have been doing. For the last 8 years, Home Assistant has been doing its own thing with Z-Wave. We have contact with manufacturers of Z-Wave devices via [our partner program](https://partner.home-assistant.io/), but never established an official relationship with the Alliance. We decided that it was time to change that.
+
+We launched the [Open Home Foundation](https://www.openhomefoundation.org/blog/announcing-the-open-home-foundation/) last month, a nonprofit that fights for privacy, choice, and sustainability in the smart home – and anyone who lives in one. Open smart home standards like Z-Wave are an important building block for this. With Z-Wave, your data stays at home as communication is fully local. It’s a standard meant to offer consumers choice, and with no reliance on the cloud, devices can continue to work long after a manufacturer ends support, or frankly doesn’t care anymore.
+
+If you follow tech news, you might be wondering now: What about Matter? With the OHF, we believe in choice, including at the standard level. Each standard is built on top of different technologies, and each has pros and cons. Z-Wave is great because it works without Wi-Fi, and its sub-GHz frequency is less busy, allowing it to travel further.
+
+
Paulus Schoutsen presenting
+
+In my keynote to the Alliance, I introduced the work we’ve been doing with Home Assistant, Z-Wave JS, and the Open Home Foundation. According to [our opt-in analytics](https://analytics.home-assistant.io), 9.7% of our users use Z-Wave. This also means that 90.3% of installations are one Z-Wave stick away from being able to use Z-Wave. Z-Wave JS has opt-in statistics, which show on average there are 17 Z-Wave devices per network. **Math time:**
+
+
+1 million active Home Assistant installations
+x
+9.7% using Z-Wave
+x
+17 Z-Wave devices
+=
+1.7 million Z-Wave devices in use
+
+When it comes to smart home standards, all big smart home platforms are all-in on Matter and have skipped or forgotten about Z-Wave – except for Home Assistant. We have always featured Z-Wave in our list of integrations and are big promoters of the standard.
+
+This is where I introduced our goal for Z-Wave to the Alliance: we want Z-Wave to be a successful consumer-facing brand. Z-Wave is very popular among companies in the US making security products (like Ring). However, the consumer doesn’t know they are using Z-Wave because it is an implementation detail. This holds Z-Wave back from becoming a rich ecosystem.
+
+For us, success means that there are many manufacturers making Z-Wave devices and that users have an abundance of choice in each product category.
+
+
+
+Z-Wave JS is an independent driver created from the ground up based on the published Z-Wave specification. Dominic has put a lot of effort into this, and his work has formed a community of people passionate about developing the best open Z-Wave driver. Our community has many power users who test Z-Wave JS and make sure it scales and works with both old and new devices.
+
+We are working on getting Z-Wave JS certified to get companies to consider adopting it. Good news on that front – there is already one company that has dropped their 20-year-old Z-Wave stack in favor of Z-Wave JS. Let’s get more on board!
+
+Our efforts to make Z-Wave a success go beyond making an open source Z-Wave driver and smart home platform. We also created the Z-Wave JS Firmware Update service to provide updates for Z-Wave devices. For this service we are currently working with 8 different manufacturers to provide firmware for 187 devices. In my keynote I told the audience that we want to help more manufacturers provide updates to their users.
+
+
The companies that contribute their firmware to the Z-Wave JS Firmware Update service.
+
+In the end, I wrapped up my talk pushing the Alliance to open up more: we all want Z-Wave to succeed. If it is more open, it will be easier for users to adopt. This will lead to more tooling, more apps, more everything. That will, in return, lead to a bigger Z-Wave ecosystem where we can all thrive. Some will do it for sales, or in our case, to drive forward products that value privacy, choice, and sustainability.
+
+We are all in this Alliance to have our devices work together. Let’s not compete on who can best control a Z-Wave light bulb.
+
+OPEN SOURCE!
+
+## Range testing our Z-Wave stick prototype
+
+One of our team's first stops at the Z-Wave Summit was attending [DrZWave](https://drzwave.blog/)’s range test down at the Colorado River. This was a perfect opportunity to see how well the prototype of our Z-Wave stick performs. While others tested with huge antennas on both sides to reach the longest range possible, we deliberately chose [end devices with tiny antennas](https://www.silabs.com/development-tools/wireless/efr32xg28-explorer-kit?tab=overview) to recreate a more real-world scenario. After all, many devices out in the wild don’t have room for big external antennas, and we want to have the best possible experience for our users with existing networks. Also, we tested both classic Z-Wave and Z-Wave Long Range because a majority of existing devices still use classic Z-Wave.
+
+Bikes and scooters weren’t allowed on the bridges and near the water, so Uwe got some exercise that day, walking several miles up and down the river with the end devices in his pockets. Dominic performed the range test using [Z-Wave JS UI](https://github.com/zwave-js/zwave-js-ui) and a simple script that sent on/off commands to the end devices to make them blink. Due to encryption, even a single corrupted bit would be noticeable by an interruption of the blinking pattern and missing responses from the end device.
+
+It is barely visible in the photo, but we reached the bridge behind the bridge all the way in the background. We used classic Z-Wave and Z-Wave Long Range, although classic Z-Wave was not as reliable at that distance. That is a 0.7-mile (1.13-km) **line of sight!** With a better antenna on the other side or using EU frequencies (which allow higher transmit power), even further ranges are definitely possible.
+
+
Left: Dominic, slightly jetlagged, with our stick prototype (green). Right: DrZWave with the controller reference design (purple). Background: Uwe, 0.7 miles away.
+
+## Unplug fest
+
+Afterward, everyone headed inside for the unplug fest, where manufacturers of end devices and controllers/gateways could connect and test how well they interact with each other. Here’s an example of a HomeSeer prototype that already has great support in Z-Wave JS:
+
+
+
+Since there was still some time left, we took the chance to perform more range tests with our prototype and the reference design, this time indoors going up through multiple layers of concrete. Depending on the end device, we were able to bridge between 2 and 8 floors.
+
+## Z-Wave JS is EVERYWHERE
+
+Besides powering the Z-Wave integration in Home Assistant, Z-Wave JS is a great tool for development. Built with diagnostics in mind, Z-Wave JS helps understand what the controller and devices are doing and whether they are behaving as expected.
+
+Although we set out to tell people about Z-Wave JS, we learned that a lot of engineers from established companies already use it for development – and in their presentations!
+
+
+
+They use it to reproduce issues, do load testing, write scripts to automate certain tasks, and run their own test suites. This includes using the CLI tools to update firmware, for example, to investigate changes between different Z-Wave SDK versions. The Javascript API makes it trivial to perform arbitrary actions and automate things that are hard or impossible to do using UI-based applications.
+
+Another valuable development tool is the Zniffer, a special Z-Wave controller that can capture and decode all Z-Wave radio traffic. Like most of the existing tooling, this requires using Windows. Prior to the summit, Dominic had started working on adding support for Zniffer devices to Z-Wave JS. Although this was still a work in progress, people were already using it for development purposes and told us they were looking forward to it being officially released.
+
+## Conclusion
+
+Z-Wave is a powerful technology with a large install base, and in certain use cases, it provides real advantages over other connectivity standards. Meeting Alliance members, I can see they are enthusiastic about the future, but it's the community that will drive the next chapter of Z-Wave. Further opening Z-Wave will empower both the vendors and the community - and help build an open home that serves everyone in it, providing greater privacy, choice, and sustainability.
\ No newline at end of file
diff --git a/source/_posts/2024-05-09-music-assistant-2.markdown b/source/_posts/2024-05-09-music-assistant-2.markdown
new file mode 100644
index 00000000000..5866d2f2c79
--- /dev/null
+++ b/source/_posts/2024-05-09-music-assistant-2.markdown
@@ -0,0 +1,126 @@
+---
+layout: post
+title: "Music Assistant 2.0: Your Music, Your Players"
+description: "Connecting multiple music libraries to almost any smart speaker."
+date: 2024-05-09 00:00:01
+date_formatted: "May 09, 2024"
+author: Marcel van der Veldt
+comments: true
+categories: Music-Assistant
+og_image: /images/blog/2024-05-music-assistant/art.jpg
+---
+
+
+Today, exactly five years ago, I, Marcel, started working on [Music Assistant
](https://music-assistant.io/). What began as a quick script, to sync my playlists so I could switch between streaming providers, grew into a beast on its own.
+
+Music Assistant is what I’d like to call a “music library manager” – it gives you full control of playing YOUR music on your players. Just like Home Assistant centralizes all your devices and services to work together, Music Assistant does the same with your music sources and smart audio-playing devices.
+
+To just play with Music Assistant without reading what it is (yes, we know you!):
+{% my supervisor_addon badge addon="d5369777_music_assistant" repository_url="https://github.com/music-assistant/home-assistant-addon" %}
+
+
+
+## Rainbow Connection
+
What is Music Assistant?
+
+**Your music, your players.** Click and play. It should be as simple as that.
+
+
From source to Music Assistant to speaker
+
+#### Connect and play anywhere
+Music Assistant allows you to quickly connect some of the
most popular streaming providers like Spotify and Tidal, with your local media files. Importing your liked tracks, artists, albums, and playlists, all displayed with the correct artwork.
+
+It supports the most ubiquitous
streaming protocols and devices like Airplay, Cast and DLNA, letting you play media on almost any device - if an old speaker doesn’t support new services, Music Assistant can bring it back to life.
+
+[Read more...](#freedom-of-choice)
+
+#### Unified music library with advanced features
+Your local and cloud libraries will be seamlessly merged together. If you have the same track on multiple place, it will appear once while helping you find the highest-quality version. You can even have multiple accounts from the same provider, allowing everyone in the house to have their playlists in one place.
+
+It can group supported players for synchronized playback. It also supports advanced playback features such as crossfade and volume normalization - regardless of whether the device supports them.
+
+[Read more...](#come-together)
+
+#### Built for Home Assistant
+Connecting this with the Home Assistant integration - automation and voice control supercharges the whole experience.
+
+[Read more...](#we-are-family)
+
+## Start me up
+
How to install Music Assistant
+
+After many years of development and testing with the amazing community, we can finally say this is ready for daily use.
+
+
+
+Even though Music Assistant is an HA Add-on, it can be installed from start to finish via [HACS
](https://hacs.xyz/). You simply install the integration, which will automatically install and manage the add-on for you. The integration allows you to control your devices with automations and voice control.
+
+{% my supervisor_addon badge addon="d5369777_music_assistant" repository_url="https://github.com/music-assistant/home-assistant-addon" %}
+
+_Music Assistant is distributed as a
Home Assistant add-on – our way to easily extend your Home Assistant installation with third party applications. To install it as a Docker container, follow the
MA installation instructions ._
+
+## Fight the power
+
Why Music Assistant?
+
+I started Music Assistant out of frustration about the mainstream available options;
+
+* You buy into an all-in-one ecosystem (such as Sonos), and then it's up to that ecosystem to decide which music sources to support now and in the future.
+
+* You choose a music streaming provider, and then somehow that streaming provider decides where/how you play their music.
+
+* You want to switch between streaming providers and keep your carefully curated playlists, regardless of which provider you want to play it with.
+
+* You still have your CD music collection that you’ve painstakingly ripped into high-quality files on local storage, and you want to play them, maybe even mix them with choices from streaming providers.
+
+* Or maybe you fall into the category of users who don’t want any subscriptions and have a carefully curated local media collection you want to play on these shiny new playback devices.
+
+When we pay for our music or devices, we shouldn’t be limited by arbitrary limitations. We are slowly moving into a world of greater walled gardens and more vendor lock-in, and it’s time we took back control.
+
+
Tidal on a Google Home
+
+I spent a long time and a good bit of my money looking at existing solutions to fill these gaps. They were either expensive, closed, or lacked the home approval factor - or a combination of all of these.
+
+## Freedom of choice
+
Connecting any sources and play anywhere
+
+Music Assistant connects to your favorite streaming providers and local music files, letting you play them on almost any connected playback equipment from the past 20 years. It’s basically a translator of music protocol A towards speaker/player protocol B.
+
+
+
+For instance, I have a traditional amplifier + speakers setup in my living room that allows for high-quality music playback, where I can sit down and hear every detail. I also have Sonos speakers in a very noisy kitchen and some DIY speakers that can only accept Airplay. I can play my music to all of these speakers without being tied down to any single ecosystem.
+
+Some people might say that the best way to prevent all that frustration is by buying into an ecosystem like Sonos which takes care of this for you entirely. While I am a big fan of Sonos (and I will recommend them to friends and family for ease of use), I am not a big fan of the vendor lock-in that comes with it. If Sonos or a streaming service decide to part ways, I don’t have to be locked out of my music. Also, they don’t make speakers at every price point, meaning you don’t get the advantages of the new higher-fidelity or more affordable hardware out there.
+
+## Come together
+
Unifying all your music in one library
+
+In the same interface as I can stream my kids’ music to their speakers, I can stream my Hi-Res favorites to my high-fidelity setup. It is an all-in-one interface. Gone are the days of needing five different apps to get playback going in multiple parts of the house or switching who is connected just to access their playlists.
+
+
+
+When you search in Music Assistant, it searches all your libraries. Every streaming service, or the local files you add, are available to choose for playback.
+
+## We are family
+
Built for Home Assistant
+
+Music Assistant has always been closely linked to Home Assistant (more on that below). I now even work for [Nabu Casa
](https://www.nabucasa.com/), partly because of my work on Music Assistant (but now I’m the Matter guy).
+
+
+
+Because of this strong link, Home Assistant seamlessly links with Music Assistant, unlocking several advanced features. MA players are exposed to HA and can be controlled via your dashboards, automations, and scripts. This allows HA users to control their music players and access MA’s powerful music search function. Players can provide TTS (Text-to-Speech) announcements and can be controlled by Home Assistant connected voice assistants.
+
+## Liner notes
+
+So, I started working on Music Assistant [exactly five years ago
](
), at first for my own personal use. It started as a learning exercise - thanks to it, I learned asyncio Python programming as well as the Vue frontend framework. I had the project on GitHub just to host the code, but it was not really meant to be used by others.
+
+At some point, it became clear to me that there was a real demand, and I posted some info on how to install it, which gained a little attention. In June 2022, we released the 1.0 version of Music Assistant, and it was still in rough shape but already suitable for many users. We even organized a Livestream, “[Let’s get Loud ](https://www.youtube.com/watch?v=SEH-DxOsywg)” hosted by Home Assistant, to promote [audio support for ESPHome ](https://esphome.io/components/media_player/i2s_audio.html) and the super cool things you can build when you combine these three open-source projects.
+
+Version 1.0 was not everything we hoped it would be. It had some structural bugs, specifically running as a custom component in Home Assistant. HA was created to give you the best experience for automating your home; it was never optimized for real-time audio streaming. On top of that, at some point, the dependencies of both projects got so conflicted that Music Assistant stopped working completely in the March 2023 release of HA.
+
+Six months after its initial version 1.0 launch, the project was beginning to look like it was going to die, so I decided to start over and go back to the drawing board. The engine of MA needed to be its own isolated component, responsible for giving you the best possible experience of streaming music (where audio quality and latency are very important), and the HA-side should be responsible for automating your house and music.
+
+So, the Music Assistant Server was born. It is a standalone application that you can run in docker (or Home Assistant add-on), all connected to HA via a HACS integration. The project was split up into multiple self-contained parts.
+
+Music Assistant Server has its own web interface, a modern interface written in Vue. Thanks to HA's add-on system, this web interface can be securely accessed from HA. The web interface is a Progressive Web App (PWA), so you can also visit it directly and [install it on your device ](https://support.google.com/chrome/answer/9658361?hl=en-GB&co=GENIE.Platform=Desktop). We also have an (experimental) [desktop app ](https://music-assistant.io/companion-app/).
+
+Over the past year, we have been iterating on this with an impressive number of beta testers. So, while technically this is a 2.0 release, to me personally this is the first real release, as this is finally something that feels good and has the right foundation. What is also super is that we attracted contributors to the project, folks helping create and maintain music integrations while providing support or translations. Even more exciting there are some really big features and streaming services on the horizon. My sincere thanks to everyone who has helped bring this release home.
diff --git a/source/_redirects b/source/_redirects
index bafbee11a59..5b30a5a2b51 100644
--- a/source/_redirects
+++ b/source/_redirects
@@ -9,7 +9,7 @@ layout: null
# General use redirects
/join-chat https://discord.gg/home-assistant
/twitter https://twitter.com/home_assistant/
-/newsletter https://building.open-home.io/
+/newsletter https://newsletter.openhomefoundation.org/
/suggest-community-highlight https://docs.google.com/forms/d/e/1FAIpQLSd9VWPeVM0xg0swWL6kT3wkQUKt8vWsTL5WtPO95LAy-0cYZw/viewform
/get-blueprints https://community.home-assistant.io/c/blueprints-exchange/53
/merch https://home-assistant-store.creator-spring.com
diff --git a/source/changelogs/core-2024.5.markdown b/source/changelogs/core-2024.5.markdown
index 03c969af620..3ffc8db6dd0 100644
--- a/source/changelogs/core-2024.5.markdown
+++ b/source/changelogs/core-2024.5.markdown
@@ -785,6 +785,132 @@ For a summary in a more readable format:
- Add blocklist for known Matter devices with faulty transitions ([@marcelveldt] - [#116524])
- Fix stop event cleanup when reloading MQTT ([@bdraco] - [#116525])
+## Release 2024.5.1 - May 3
+
+- Fix nws forecast coordinators and remove legacy forecast handling ([@MatthewFlamm] - [#115857])
+- Bump opentherm_gw to 2.2.0 ([@GraceGRD] - [#116527])
+- Add a lock to homekit_controller platform loads ([@bdraco] - [#116539])
+- Fix MQTT discovery cooldown too short with large setup ([@jbouwh] - [#116550])
+- Bump upb_lib to 0.5.6 ([@gwww] - [#116558])
+- Bump elkm1_lib to 2.2.7 ([@gwww] - [#116564])
+- Fix Matter startup when Matter bridge is present ([@marcelveldt] - [#116569])
+- Bump sanix to 1.0.6 ([@tomaszsluszniak] - [#116570])
+- Fix Airthings BLE model names ([@LaStrada] - [#116579])
+- Improve coordinator in Ondilo ico ([@joostlek] - [#116596])
+- Fix inheritance order for KNX notify ([@farmio] - [#116600])
+- Bump Airthings BLE to 0.8.0 ([@LaStrada] - [#116616])
+- Bump pywaze to 1.0.1 ([@eifinger] - [#116621])
+- Add constraint for tuf ([@cdce8p] - [#116627])
+- Bump aiounifi to v77 ([@Kane610] - [#116639])
+- Bump govee-light-local library and fix wrong information for Govee lights ([@Galorhallen] - [#116651])
+- Bump ZHA dependency bellows to 0.38.4 ([@puddly] - [#116660])
+- Bump habluetooth to 2.8.1 ([@bdraco] - [#116661])
+- Bump env_canada lib to 0.6.2 ([@gwww] - [#116662])
+- Block dreame_vacuum versions older than 1.0.4 ([@bdraco] - [#116673])
+- Fix fyta test timezone handling ([@cdce8p] - [#116689])
+- Fix BroadlinkRemote._learn_command() ([@felipediel] - [#116692])
+
+[#115857]: https://github.com/home-assistant/core/pull/115857
+[#116527]: https://github.com/home-assistant/core/pull/116527
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116539]: https://github.com/home-assistant/core/pull/116539
+[#116550]: https://github.com/home-assistant/core/pull/116550
+[#116558]: https://github.com/home-assistant/core/pull/116558
+[#116564]: https://github.com/home-assistant/core/pull/116564
+[#116569]: https://github.com/home-assistant/core/pull/116569
+[#116570]: https://github.com/home-assistant/core/pull/116570
+[#116579]: https://github.com/home-assistant/core/pull/116579
+[#116596]: https://github.com/home-assistant/core/pull/116596
+[#116600]: https://github.com/home-assistant/core/pull/116600
+[#116616]: https://github.com/home-assistant/core/pull/116616
+[#116621]: https://github.com/home-assistant/core/pull/116621
+[#116627]: https://github.com/home-assistant/core/pull/116627
+[#116639]: https://github.com/home-assistant/core/pull/116639
+[#116651]: https://github.com/home-assistant/core/pull/116651
+[#116660]: https://github.com/home-assistant/core/pull/116660
+[#116661]: https://github.com/home-assistant/core/pull/116661
+[#116662]: https://github.com/home-assistant/core/pull/116662
+[#116673]: https://github.com/home-assistant/core/pull/116673
+[#116689]: https://github.com/home-assistant/core/pull/116689
+[#116692]: https://github.com/home-assistant/core/pull/116692
+[@Galorhallen]: https://github.com/Galorhallen
+[@GraceGRD]: https://github.com/GraceGRD
+[@Kane610]: https://github.com/Kane610
+[@LaStrada]: https://github.com/LaStrada
+[@MatthewFlamm]: https://github.com/MatthewFlamm
+[@bdraco]: https://github.com/bdraco
+[@cdce8p]: https://github.com/cdce8p
+[@eifinger]: https://github.com/eifinger
+[@farmio]: https://github.com/farmio
+[@felipediel]: https://github.com/felipediel
+[@frenck]: https://github.com/frenck
+[@gwww]: https://github.com/gwww
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@marcelveldt]: https://github.com/marcelveldt
+[@puddly]: https://github.com/puddly
+[@tomaszsluszniak]: https://github.com/tomaszsluszniak
+
+## Release 2024.5.2 - May 6
+
+- Add workaround for data entry flow show progress ([@emontnemery] - [#116704])
+- Improve logging of _TrackPointUTCTime objects ([@bdraco] - [#116711])
+- Bump aiohttp-isal to 0.3.1 ([@bdraco] - [#116720])
+- Fix Bosch-SHC switch state ([@joostlek] - [#116721])
+- Remove suggested UoM from Opower ([@joostlek] - [#116728])
+- Refactor statistics to avoid creating tasks ([@bdraco] - [#116743])
+- Bump bluetooth-adapters to 0.19.2 ([@bdraco] - [#116785])
+- fix UnboundLocalError on modified_statistic_ids in compile_statistics ([@pdecat] - [#116795])
+- Ensure all synology_dsm coordinators handle expired sessions ([@bdraco] - [#116796])
+- Fix IMAP config entry setup ([@jbouwh] - [#116797])
+- Fix airthings-ble data drop outs when Bluetooth connection is flakey ([@bdraco] - [#116805])
+- Hide conversation agents that are exposed as agent entities ([@balloob] - [#116813])
+- Fix non-thread-safe state write in lutron event ([@bdraco] - [#116829])
+- Increase default timeout to 30 seconds in Synology DSM ([@mib1185] - [#116836])
+- Avoid duplicate data fetch during Synologs DSM setup ([@mib1185] - [#116839])
+- Bump androidtvremote2 to v0.0.15 ([@tronikos] - [#116844])
+- Bump goodwe to 0.3.4 ([@mletenay] - [#116849])
+- Fix non-thread-safe operations in amcrest ([@bdraco] - [#116859])
+- fix radarr coordinator updates ([@tkdrob] - [#116874])
+- Fix initial mqtt subcribe cooldown timeout ([@jbouwh] - [#116904])
+- Update frontend to 20240501.1 ([@bramkragten] - [#116939])
+
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116696]: https://github.com/home-assistant/core/pull/116696
+[#116704]: https://github.com/home-assistant/core/pull/116704
+[#116711]: https://github.com/home-assistant/core/pull/116711
+[#116720]: https://github.com/home-assistant/core/pull/116720
+[#116721]: https://github.com/home-assistant/core/pull/116721
+[#116728]: https://github.com/home-assistant/core/pull/116728
+[#116743]: https://github.com/home-assistant/core/pull/116743
+[#116785]: https://github.com/home-assistant/core/pull/116785
+[#116795]: https://github.com/home-assistant/core/pull/116795
+[#116796]: https://github.com/home-assistant/core/pull/116796
+[#116797]: https://github.com/home-assistant/core/pull/116797
+[#116805]: https://github.com/home-assistant/core/pull/116805
+[#116813]: https://github.com/home-assistant/core/pull/116813
+[#116829]: https://github.com/home-assistant/core/pull/116829
+[#116836]: https://github.com/home-assistant/core/pull/116836
+[#116839]: https://github.com/home-assistant/core/pull/116839
+[#116844]: https://github.com/home-assistant/core/pull/116844
+[#116849]: https://github.com/home-assistant/core/pull/116849
+[#116859]: https://github.com/home-assistant/core/pull/116859
+[#116874]: https://github.com/home-assistant/core/pull/116874
+[#116904]: https://github.com/home-assistant/core/pull/116904
+[#116939]: https://github.com/home-assistant/core/pull/116939
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@bramkragten]: https://github.com/bramkragten
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@mib1185]: https://github.com/mib1185
+[@mletenay]: https://github.com/mletenay
+[@pdecat]: https://github.com/pdecat
+[@tkdrob]: https://github.com/tkdrob
+[@tronikos]: https://github.com/tronikos
+
[#100780]: https://github.com/home-assistant/core/pull/100780
[#102424]: https://github.com/home-assistant/core/pull/102424
[#104343]: https://github.com/home-assistant/core/pull/104343
diff --git a/source/images/blog/2023-09-ha10/logo 2.png b/source/images/blog/2023-09-ha10/logo 2.png
index 6c708e44343..2017c577212 100644
Binary files a/source/images/blog/2023-09-ha10/logo 2.png and b/source/images/blog/2023-09-ha10/logo 2.png differ
diff --git a/source/images/blog/2024-05-music-assistant/art.jpg b/source/images/blog/2024-05-music-assistant/art.jpg
new file mode 100644
index 00000000000..06e0b73a474
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/art.jpg differ
diff --git a/source/images/blog/2024-05-music-assistant/come-together.png b/source/images/blog/2024-05-music-assistant/come-together.png
new file mode 100644
index 00000000000..b5d61e2832e
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/come-together.png differ
diff --git a/source/images/blog/2024-05-music-assistant/fight-the-power.jpg b/source/images/blog/2024-05-music-assistant/fight-the-power.jpg
new file mode 100644
index 00000000000..6fb993ba3f0
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/fight-the-power.jpg differ
diff --git a/source/images/blog/2024-05-music-assistant/freedom-of-choice.png b/source/images/blog/2024-05-music-assistant/freedom-of-choice.png
new file mode 100644
index 00000000000..7ada2d1209d
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/freedom-of-choice.png differ
diff --git a/source/images/blog/2024-05-music-assistant/how-it-works.jpg b/source/images/blog/2024-05-music-assistant/how-it-works.jpg
new file mode 100644
index 00000000000..278af5a6da7
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/how-it-works.jpg differ
diff --git a/source/images/blog/2024-05-music-assistant/start-me-up.png b/source/images/blog/2024-05-music-assistant/start-me-up.png
new file mode 100644
index 00000000000..67d0c25ecf2
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/start-me-up.png differ
diff --git a/source/images/blog/2024-05-music-assistant/we-are-family.png b/source/images/blog/2024-05-music-assistant/we-are-family.png
new file mode 100644
index 00000000000..a2a655322d1
Binary files /dev/null and b/source/images/blog/2024-05-music-assistant/we-are-family.png differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/art.jpg b/source/images/blog/2024-05-zwave-is-not-dead/art.jpg
new file mode 100644
index 00000000000..3eaf392aa5a
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/art.jpg differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/drzwave.jpeg b/source/images/blog/2024-05-zwave-is-not-dead/drzwave.jpeg
new file mode 100644
index 00000000000..cd39099189f
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/drzwave.jpeg differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/firmware.png b/source/images/blog/2024-05-zwave-is-not-dead/firmware.png
new file mode 100644
index 00000000000..4e31cd659e5
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/firmware.png differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/keynote.png b/source/images/blog/2024-05-zwave-is-not-dead/keynote.png
new file mode 100644
index 00000000000..10bc404af0e
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/keynote.png differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/paulus-z-wave.jpeg b/source/images/blog/2024-05-zwave-is-not-dead/paulus-z-wave.jpeg
new file mode 100644
index 00000000000..e2ab942d06a
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/paulus-z-wave.jpeg differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/slide.png b/source/images/blog/2024-05-zwave-is-not-dead/slide.png
new file mode 100644
index 00000000000..51c477456ac
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/slide.png differ
diff --git a/source/images/blog/2024-05-zwave-is-not-dead/unplug.jpeg b/source/images/blog/2024-05-zwave-is-not-dead/unplug.jpeg
new file mode 100644
index 00000000000..2f821612528
Binary files /dev/null and b/source/images/blog/2024-05-zwave-is-not-dead/unplug.jpeg differ
diff --git a/source/voice_control/s3-box-customize.markdown b/source/voice_control/s3-box-customize.markdown
index d873af398cb..65c044d5e0a 100644
--- a/source/voice_control/s3-box-customize.markdown
+++ b/source/voice_control/s3-box-customize.markdown
@@ -69,7 +69,7 @@ Before you can import new illustrations, you need to install the ESPHome add-on
### Option 1: Using images from a community repository
If you want new images but don't want to create your own, you can use images from the community.
-If you want to use your own images, skip this procedure and go to [Option 2: Using your own imagess](#option-2-using-your-own-illustrations) instead.
+If you want to use your own images, skip this procedure and go to [Option 2: Using your own images](#option-2-using-your-own-illustrations) instead.
#### To use images from the community
@@ -240,4 +240,4 @@ You can change the on-device wake word (microWakeWord) that is used on your S3-B
7. Now, speak a command to test the new setting. For example, *Hey Jarvis, turn on the light*.
[microWakeWord]: https://github.com/kahrendt/microWakeWord
-[Kevin Ahrendt]: https://www.kevinahrendt.com/
\ No newline at end of file
+[Kevin Ahrendt]: https://www.kevinahrendt.com/
@@ -28,7 +31,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `dweet` 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/ebox.markdown b/source/_integrations/ebox.markdown
index 61f9aae92ee..ef48ce54940 100644
--- a/source/_integrations/ebox.markdown
+++ b/source/_integrations/ebox.markdown
@@ -9,13 +9,17 @@ ha_domain: ebox
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant.
## Configuration
-To use your EBox sensor in your installation, add the following to your `configuration.yaml` file:
+To use your EBox 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/ebusd.markdown b/source/_integrations/ebusd.markdown
index 38c274dfa85..4b9441d9b37 100644
--- a/source/_integrations/ebusd.markdown
+++ b/source/_integrations/ebusd.markdown
@@ -9,13 +9,17 @@ ha_domain: ebusd
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integration between the [ebusd](https://github.com/john30/ebusd/) daemon (used for communication with the eBUS heating systems), and Home Assistant. The ebusd integrations uses the sensor integration.
## Configuration
-Enable the sensor by adding the following to your `configuration.yaml` file:
+Enable the sensor by adding 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/ecoal_boiler.markdown b/source/_integrations/ecoal_boiler.markdown
index 7c9d0e57e75..de4682478f3 100644
--- a/source/_integrations/ecoal_boiler.markdown
+++ b/source/_integrations/ecoal_boiler.markdown
@@ -10,13 +10,17 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
+The `ecoal_boiler` {% term integration %} is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
## Configuration
-To use your eCoal pumps or sensors in your installation, add the following to your `configuration.yaml` file:
+To use your eCoal pumps or 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/ecobee.markdown b/source/_integrations/ecobee.markdown
index 03442cea98c..59e9ec390d7 100644
--- a/source/_integrations/ecobee.markdown
+++ b/source/_integrations/ecobee.markdown
@@ -66,7 +66,8 @@ Your new application will now appear on the left. Upon clicking on the applicati
## Manual configuration
-If you prefer to set up the integration in [`configuration.yaml`](/docs/configuration/), add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel):
+If you prefer to set up the integration in your {% term "`configuration.yaml`" %} file, add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel).
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -197,44 +198,44 @@ Delete a vacation on the selected ecobee thermostat.
Resumes the standard active schedule of presets. This cancels any manual temperature settings or selected preset. This will not cancel vacation events, use `delete_vacation`.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of climate devices to control. Omit to target all ecobee thermostats. |
-| `resume_all` | no | `true` will resume the standard schedule. `false` will only cancel the latest active event, which is not used often. |
+| `resume_all` | no | `true` will resume the standard schedule. `false` will only cancel the latest active event, which is not used often. |
### Service `ecobee.set_fan_min_on_time`
Sets the minimum amount of time that the fan will run per hour.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Omit to target all ecobee thermostats. |
-| `fan_min_on_time` | no | integer (e.g., 5) |
+| `fan_min_on_time` | no | integer (e.g., 5) |
### Service `ecobee.set_dst_mode`
Enable/disable automatic daylight savings time.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------ |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set daylight savings time mode. Omit to target all ecobee thermostats. |
-| `dst_enabled` | no | true or false |
+| `dst_enabled` | no | true or false |
### Service `ecobee.set_mic_mode`
Enable/disable Alexa mic (only for ecobee 4).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ---------------------------------------------- |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set the mic mode. Omit to target all ecobee thermostats. |
-| `mic_enabled` | no | true or false |
+| `mic_enabled` | no | true or false |
### Service `ecobee.set_occupancy_modes`
Enable/disable Smart Home/Away and Follow Me modes.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------- |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set occupancy modes. Omit to target all ecobee thermostats. |
-| `auto_away` | yes | true or false |
-| `follow_me` | yes | true or false |
+| `auto_away` | yes | true or false |
+| `follow_me` | yes | true or false |
diff --git a/source/_integrations/eddystone_temperature.markdown b/source/_integrations/eddystone_temperature.markdown
index 2e41b72695d..02375677339 100644
--- a/source/_integrations/eddystone_temperature.markdown
+++ b/source/_integrations/eddystone_temperature.markdown
@@ -9,14 +9,17 @@ ha_domain: eddystone_temperature
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature).
-All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](https://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google.
+The `eddystone_temperature` sensor {% term integration %} reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature).
+All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this {% term integration %}. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](https://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google.
## Requirements
-As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed:
+As this {% term integration %} uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed:
```bash
sudo apt-get install libbluetooth-dev
@@ -29,7 +32,8 @@ sudo apt-get install libcap2-bin
sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))
```
-To use your Eddystone beacon in your installation, add the following to your `configuration.yaml` file:
+To use your Eddystone beacon 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/edimax.markdown b/source/_integrations/edimax.markdown
index f7a03bce6c4..c24ef5d03bc 100644
--- a/source/_integrations/edimax.markdown
+++ b/source/_integrations/edimax.markdown
@@ -9,11 +9,15 @@ ha_domain: edimax
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This `edimax` switch platform allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
+This `edimax` switch {% term integration %} allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
-To use your Edimax switch in your installation, add the following to your `configuration.yaml` file:
+To use your Edimax 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/egardia.markdown b/source/_integrations/egardia.markdown
index 024185e55a0..23f813938d6 100644
--- a/source/_integrations/egardia.markdown
+++ b/source/_integrations/egardia.markdown
@@ -14,6 +14,9 @@ ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Egardia** {% term integration %} enables the ability to control an [Egardia](https://egardia.com/)/[Woonveilig](https://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically.
@@ -22,7 +25,8 @@ You will need to know the IP of your alarm panel on your local network. Test if
## Basic configuration
-To enable the {% term integration %} with your alarm panel, add the following lines to your `configuration.yaml` file:
+To enable the {% term integration %} with your alarm panel, 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/eliqonline.markdown b/source/_integrations/eliqonline.markdown
index 5514d8b6335..cf42185de81 100644
--- a/source/_integrations/eliqonline.markdown
+++ b/source/_integrations/eliqonline.markdown
@@ -9,11 +9,15 @@ ha_domain: eliqonline
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
Integrate your [ELIQ Online](https://eliq.io/) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account.
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable 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/elkm1.markdown b/source/_integrations/elkm1.markdown
index 7f648909bbf..8b039efedc6 100644
--- a/source/_integrations/elkm1.markdown
+++ b/source/_integrations/elkm1.markdown
@@ -27,6 +27,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation.
@@ -90,13 +93,13 @@ code on a physical keypad.
If you are using the features below then these respective global options
should be enabled:
-| Option # | Option Name | Description |
-| ---------------------- | -------- | ----------- |
-| 36 | Transmit Zone Changes | If you are using Zones this allows Home Assistant to track the status of the Zones.
-| 37 | Transmit Output Changes | If you are using Outputs this allows Home Assistant to track the status of the Outputs.
-| 38 | Transmit Automation Task Changes | If you are using ElkM1 Tasks this allows Home Assistant to track the status of the Tasks.
-| 39 | Transmit Light Changes | If you are using ElkM1 Lights this allows Home Assistant to track the status of the lights.
-| 40 | Transmit Keypad Changes | Oddly, this option tracks keypad changes and alarm status. If you are wishing to track keypresses on ElkM1 keypad or if you are wishing to track the armed, disarmed, and alarm state of the ElkM1 then this option should be set.
+| Option # | Option Name | Description |
+| -------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 36 | Transmit Zone Changes | If you are using Zones this allows Home Assistant to track the status of the Zones. |
+| 37 | Transmit Output Changes | If you are using Outputs this allows Home Assistant to track the status of the Outputs. |
+| 38 | Transmit Automation Task Changes | If you are using ElkM1 Tasks this allows Home Assistant to track the status of the Tasks. |
+| 39 | Transmit Light Changes | If you are using ElkM1 Lights this allows Home Assistant to track the status of the lights. |
+| 40 | Transmit Keypad Changes | Oddly, this option tracks keypad changes and alarm status. If you are wishing to track keypresses on ElkM1 keypad or if you are wishing to track the armed, disarmed, and alarm state of the ElkM1 then this option should be set. |
## System Trouble Status
@@ -462,33 +465,33 @@ and Switch the ElkM1 integration offers these additional services:
Arms the ElkM1 area in "home instant", "night instant", or "vacation" modes
respectively.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 area which to arm.
-| `code` | no | Alarm code to arm the system (4 or 6 digits).
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------- |
+| `entity_id` | yes | ElkM1 area which to arm. |
+| `code` | no | Alarm code to arm the system (4 or 6 digits). |
### Services `elkm1.alarm_bypass` and `elkm1.alarm_clear_bypass`
For all zones associated with the specified alarm panel these services respectively
bypass or clear the bypass the zones.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 area which to bypass or clear bypass.
-| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits).
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------- |
+| `entity_id` | yes | ElkM1 area which to bypass or clear bypass. |
+| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits). |
### Service `elkm1.alarm_display_message`
Display text on an area's keypads.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 area which to display the message.
-| `clear` | yes | 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2
-| `beep` | yes | 0=no beep, 1=beep; default 0
-| `timeout` | yes | Time to display message, 0=forever, max 65535, default 0
-| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank.
-| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------- |
+| `entity_id` | yes | ElkM1 area which to display the message. |
+| `clear` | yes | 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2 |
+| `beep` | yes | 0=no beep, 1=beep; default 0 |
+| `timeout` | yes | Time to display message, 0=forever, max 65535, default 0 |
+| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
+| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
### Service `elkm1.sensor_counter_refresh`
@@ -496,63 +499,63 @@ Refresh the value of a counter. Note that under certain conditions the
panel does not automatically send a new value under certain
conditions. This service retrieves the current counter value.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 counter to refresh.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------- |
+| `entity_id` | yes | ElkM1 counter to refresh. |
### Service `elkm1.sensor_counter_set`
Set counter to value.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 counter to refresh.
-| `value` | no | Value to set the counter to Can be 0-65536.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------- |
+| `entity_id` | yes | ElkM1 counter to refresh. |
+| `value` | no | Value to set the counter to Can be 0-65536. |
### Service `elkm1.sensor_zone_bypass`
Bypass a zone. Note that the only mechanism ElkM1 offers to clear the bypass
is to clear all the bypassed zones in a given alarm panel (area).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 zone which to bypass.
-| `code` | no | Alarm code to bypass the zone (4 or 6 digits).
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | yes | ElkM1 zone which to bypass. |
+| `code` | no | Alarm code to bypass the zone (4 or 6 digits). |
### Service `elkm1.sensor_zone_trigger`
Cause a zone on the panel to trigger. This command creates a virtual momentary
open condition on the zone as if the EOL hardwired loop had been physically opened.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | ElkM1 zone which to trigger.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------- |
+| `entity_id` | yes | ElkM1 zone which to trigger. |
### Service `elkm1.set_time`
Set the time on the panel. Uses the current time on the instance of Home Assistant.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `prefix` | yes | Prefix to identify panel when multiple panels configured.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_phrase`
Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `phrase` | no | Phrase to speak.
-| `prefix` | yes | Prefix to identify panel when multiple panels configured.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `phrase` | no | Phrase to speak. |
+| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_word`
Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documentation.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `word` | no | Word to speak.
-| `prefix` | yes | Prefix to identify panel when multiple panels configured.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `word` | no | Word to speak. |
+| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
## Debugging
Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).
diff --git a/source/_integrations/elv.markdown b/source/_integrations/elv.markdown
index 62ca1d7dc02..5f57213f348 100644
--- a/source/_integrations/elv.markdown
+++ b/source/_integrations/elv.markdown
@@ -11,13 +11,17 @@ ha_domain: elv
ha_platforms:
- switch
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `pca` switch platform allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex).
+The `pca` switch {% term integration %} allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex).
## Configuration
-To use your PCA 301 switch or socket in your installation, add the following to your `configuration.yaml` file:
+To use your PCA 301 switch or socket 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
@@ -25,7 +29,7 @@ elv:
device: SERIAL_PORT
```
-This platform will add all PCA 301 switches which are in range. You can read the total used energy in kWh and the current power in Watt.
+This {% term integration %} will add all PCA 301 switches which are in range. You can read the total used energy in kWh and the current power in Watt.
{% configuration %}
device:
diff --git a/source/_integrations/emby.markdown b/source/_integrations/emby.markdown
index 2ac6a08e309..10421af4317 100644
--- a/source/_integrations/emby.markdown
+++ b/source/_integrations/emby.markdown
@@ -11,11 +11,15 @@ ha_domain: emby
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The **Emby** {% term integration %} allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant.
-To add Emby to your installation, add the following to your `configuration.yaml` file:
+To add Emby 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/emoncms.markdown b/source/_integrations/emoncms.markdown
index ed30814b9af..f38f791adb0 100644
--- a/source/_integrations/emoncms.markdown
+++ b/source/_integrations/emoncms.markdown
@@ -11,11 +11,15 @@ ha_codeowners:
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `emoncms` sensor platform creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org).
+The `emoncms` sensor {% term integration %} creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org).
-To enable this sensor, add the following lines to your `configuration.yaml`, it will list all feeds as a sensor:
+To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file. It will list all feeds as a sensor.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry using cloud based Emoncms
@@ -28,7 +32,7 @@ sensor:
As of Feb 2020, the integration will discover all sensors from Emoncms and will use the unit of measurement specified in the Feed from Emoncms, in preference to the one set in the configuration. Tested with [Emoncms](https://github.com/emoncms/emoncms) V10.1.13 - `unit` was added to the API around version V9.9.1.
-To write information from Home Assistant to Emoncms, you can use the [`emoncms_history`](/integrations/emoncms_history) integration.
+To write information from Home Assistant to Emoncms, you can use the [`emoncms_history`](/integrations/emoncms_history) {% term integration %}.
## Configuration variables
diff --git a/source/_integrations/emoncms_history.markdown b/source/_integrations/emoncms_history.markdown
index 303af8794ee..c94094e6e21 100644
--- a/source/_integrations/emoncms_history.markdown
+++ b/source/_integrations/emoncms_history.markdown
@@ -7,11 +7,15 @@ ha_iot_class: Local Polling
ha_release: 0.31
ha_domain: emoncms_history
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `emoncms_history` integration makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
+The `emoncms_history` {% term integration %} makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
-To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file:
+To use the `emoncms_history` {% 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/emulated_hue.markdown b/source/_integrations/emulated_hue.markdown
index 4e71e45bb56..f77700816f7 100644
--- a/source/_integrations/emulated_hue.markdown
+++ b/source/_integrations/emulated_hue.markdown
@@ -11,6 +11,9 @@ ha_integration_type: integration
ha_codeowners:
- '@bdraco'
- '@Tho85'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---