From 1339cd9760d46aa5b6151f2c01153dd8dc9600f1 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 8 May 2024 22:13:36 +0200 Subject: [PATCH] i-integrations: restart HA after changing config (#32643) --- source/_integrations/iammeter.markdown | 8 +++-- source/_integrations/iglo.markdown | 8 +++-- source/_integrations/ign_sismologia.markdown | 30 +++++++++++-------- source/_integrations/ihc.markdown | 8 +++-- source/_integrations/incomfort.markdown | 8 +++-- source/_integrations/influxdb.markdown | 10 +++++-- source/_integrations/iperf3.markdown | 10 +++++-- .../irish_rail_transport.markdown | 6 +++- source/_integrations/itach.markdown | 8 +++-- source/_integrations/itunes.markdown | 8 +++-- source/_integrations/izone.markdown | 27 +++++++++-------- 11 files changed, 86 insertions(+), 45 deletions(-) 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 |