From 4dd8196a62b037fc3a51813ebff677e5acdecb96 Mon Sep 17 00:00:00 2001
From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Date: Mon, 13 May 2024 17:41:50 +0200
Subject: [PATCH] s-integrations-3: restart HA after changing config (#32724)
---
source/_integrations/spc.markdown | 6 ++-
source/_integrations/splunk.markdown | 6 ++-
source/_integrations/sql.markdown | 8 +++-
source/_integrations/starlingbank.markdown | 8 +++-
source/_integrations/startca.markdown | 6 ++-
source/_integrations/statsd.markdown | 8 +++-
source/_integrations/stiebel_eltron.markdown | 8 +++-
source/_integrations/sun.markdown | 48 ++++++++++---------
source/_integrations/supervisord.markdown | 8 +++-
.../swiss_hydrological_data.markdown | 8 +++-
source/_integrations/swisscom.markdown | 8 +++-
source/_integrations/synology_chat.markdown | 8 +++-
source/_integrations/synology_srm.markdown | 8 +++-
source/_integrations/syslog.markdown | 48 ++++++++++---------
14 files changed, 121 insertions(+), 65 deletions(-)
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).