jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

d-integrations: restart HA after adding the integration to the configuration.yaml (#32633)

Browse Source 
Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7 2024-05-09 22:14:02 +02:00 committed by GitHub
parent 85c91b3c5e
commit 0ea2127c91
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
19 changed files with 110 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
source/_integrations/danfoss_air.markdown
View File

@ -26,6 +26,9 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor) - [Sensor](#sensor)
- [Switch](#switch) - [Switch](#switch)
To enable Danfoss Air, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
danfoss_air: danfoss_air:

6
source/_integrations/datadog.markdown
View File

@ -7,6 +7,9 @@ ha_iot_class: Local Push
ha_release: 0.45 ha_release: 0.45
ha_domain: datadog ha_domain: datadog
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Datadog** {% term integration %} sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/). The **Datadog** {% term integration %} sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
@ -31,7 +34,8 @@ In the [Datadog Agent configuration](https://github.com/DataDog/datadog-agent/bl
## Configuration ## Configuration
To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file: To use the `datadog` integration in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/ddwrt.markdown
View File

@ -9,11 +9,15 @@ ha_domain: ddwrt
ha_platforms: ha_platforms:
- device_tracker - device_tracker
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
This platform offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router. The `ddwrt` {% term integration %} offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router.
To use a DD-WRT router in your installation, add the following to your `configuration.yaml` file: To use a DD-WRT router in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

6
source/_integrations/debugpy.markdown
View File

@ -10,6 +10,9 @@ ha_domain: debugpy
ha_quality_scale: internal ha_quality_scale: internal
ha_iot_class: Local Push ha_iot_class: Local Push
ha_integration_type: service ha_integration_type: service
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Remote Python debugger** {% term integration %} allows you to use the Visual Studio Code The **Remote Python debugger** {% term integration %} allows you to use the Visual Studio Code
@ -27,7 +30,8 @@ performance when not injected.
## Configuration ## Configuration
To enable the remote Python debugger integration add the following to To enable the remote Python debugger integration add the following to
your `configuration.yaml` file: your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/delijn.markdown
View File

@ -13,9 +13,12 @@ ha_domain: delijn
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `delijn` sensor will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium). The `delijn` {% term integration %} will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium).
## Setup ## Setup
@ -24,7 +27,8 @@ For valid stop IDs check for the 6 digits at the physical stops or visit the [st
## Configuration ## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file: To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/demo.markdown
View File

@ -45,9 +45,12 @@ ha_platforms:
- water_heater - water_heater
- weather - weather
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) but combined with your own real/functional platforms. The `demo` {% term integration %} allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) but combined with your own real/functional platforms.
Available demo platforms: Available demo platforms:
@ -81,7 +84,8 @@ Available demo platforms:
- [Water heater](/integrations/water_heater/) (`water_heater`) - [Water heater](/integrations/water_heater/) (`water_heater`)
- [Weather](/integrations/weather/) (`weather`) - [Weather](/integrations/weather/) (`weather`)
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file: To integrate a demo platform in Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/denon.markdown
View File

@ -9,9 +9,12 @@ ha_domain: denon
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `denon` platform allows you to control a Denon Network Receiver from Home Assistant. It might be that your device is supported by the [Denon AVR] platform. The `denon` {% term integration %} allows you to control a Denon Network Receiver from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
Supported devices: Supported devices:
@ -20,7 +23,8 @@ Supported devices:
- Denon RCD-N9 (partial support) - Denon RCD-N9 (partial support)
- Denon AVR receivers with integrated Network support (partial support) - Denon AVR receivers with integrated Network support (partial support)
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file: To add a Denon Network Receiver to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
## Telnet platform ## Telnet platform

8
source/_integrations/device_sun_light_trigger.markdown
View File

@ -10,9 +10,12 @@ ha_release: pre 0.7
ha_quality_scale: internal ha_quality_scale: internal
ha_domain: device_sun_light_trigger ha_domain: device_sun_light_trigger
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will: Home Assistant has a built-in {% term integration %} called `device_sun_light_trigger` to help you automate your lights. The integration will:
- Fade in the lights when the sun is setting and there are people home - Fade in the lights when the sun is setting and there are people home
- Turn on the lights when people get home after the sun has set - Turn on the lights when people get home after the sun has set
@ -20,7 +23,8 @@ Home Assistant has a built-in integration called `device_sun_light_trigger` to h
This integration requires the integrations [sun](/integrations/sun/), [device_tracker](/integrations/device_tracker/), [person](/integrations/person/) and [light](/integrations/light/) to be enabled. This integration requires the integrations [sun](/integrations/sun/), [device_tracker](/integrations/device_tracker/), [person](/integrations/person/) and [light](/integrations/light/) to be enabled.
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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

3
source/_integrations/dialogflow.markdown
View File

@ -8,6 +8,9 @@ ha_config_flow: true
ha_iot_class: Cloud Push ha_iot_class: Cloud Push
ha_domain: dialogflow ha_domain: dialogflow
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). After each phrase a user says, Dialogflow sends an action and parameters to the webhook. The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). After each phrase a user says, Dialogflow sends an action and parameters to the webhook.

6
source/_integrations/digital_ocean.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- binary_sensor - binary_sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Digital Ocean** {% term integration %} allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. The **Digital Ocean** {% term integration %} allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
@ -29,7 +32,8 @@ Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitaloce
## Configuration ## Configuration
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: To integrate your Digital Ocean droplets with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/discogs.markdown
View File

@ -11,9 +11,12 @@ ha_domain: discogs
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection. The `discogs` {% term integration %} allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection.
## Setup ## Setup
@ -22,7 +25,8 @@ You can generate a token from your profile's [Developer settings](https://www.di
## Configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/dlib_face_detect.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Push
ha_release: 0.44 ha_release: 0.44
ha_domain: dlib_face_detect ha_domain: dlib_face_detect
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes. The `dlib_face_detect` image processing {% term integration %} allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
This can be used to trigger an automation rule. Further info is on the [integration](/integrations/image_processing/) page. This can be used to trigger an automation rule. Further info is on the [integration](/integrations/image_processing/) page.
@ -19,6 +22,9 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration ## Configuration
To enable Dlib Face Detect, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
image_processing: image_processing:

8
source/_integrations/dlib_face_identify.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Push
ha_release: 0.44 ha_release: 0.44
ha_domain: dlib_face_identify ha_domain: dlib_face_identify
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons. The `dlib_face_identify` image processing {% term integration %} allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
For using the result inside an automation rule, take a look at the [integration](/integrations/image_processing/) page. For using the result inside an automation rule, take a look at the [integration](/integrations/image_processing/) page.
@ -19,6 +22,9 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration ## Configuration
To enable Dlib Face Identify, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
image_processing: image_processing:

8
source/_integrations/doods.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Polling
ha_release: '0.100' ha_release: '0.100'
ha_domain: doods ha_domain: doods
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `doods` image processing integration allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). 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 `doods` image processing {% term integration %} allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). 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.
## Setup ## Setup
@ -20,7 +23,8 @@ The DOODS software needs to be running before this integration can be used. Opti
## Configuration ## Configuration
To enable this integration in your installation, add the following to your `configuration.yaml` file: To enable this integration in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/dovado.markdown
View File

@ -12,16 +12,20 @@ ha_platforms:
- notify - notify
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `dovado` integration manages communication with the [Dovado](https://www.dovado.com/) router. The `dovado` {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- [Notifications](/integrations/dovado/#notifications) - [Notifications](/integrations/dovado/#notifications)
- [Sensor](/integrations/dovado/#sensor) - [Sensor](/integrations/dovado/#sensor)
To add a Dovado integration to your installation, add the following to your `configuration.yaml` file: To add a Dovado integration to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/dte_energy_bridge.markdown
View File

@ -9,9 +9,12 @@ ha_domain: dte_energy_bridge
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
A sensor platform for [DTE](https://www.newlook.dteenergy.com/) using an early model of the Energy Bridge. To find out which version of the DTE Energy Bridge you have, find the status LED on your box. A sensor {% term integration %} for [DTE](https://www.newlook.dteenergy.com/) using an early model of the Energy Bridge. To find out which version of the DTE Energy Bridge you have, find the status LED on your box.
- If the status LED is on the top, you have a v1. - If the status LED is on the top, you have a v1.
- If the status LED is on the front, you have a v2. - If the status LED is on the front, you have a v2.
@ -27,7 +30,8 @@ Later model DTE Energy Bridge hardware uses [MQTT](https://www.home-assistant.io
</div> </div>
To enable this sensor, add the following lines to your `configuration.yaml` file: To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/dublin_bus_transport.markdown
View File

@ -9,15 +9,19 @@ ha_domain: dublin_bus_transport
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `dublin_bus_transport` sensor will give you the time until the next two departures from a Dublin bus stop using the RTPI information. The `dublin_bus_transport` {% term integration %} will give you the time until the next two departures from a Dublin bus stop using the RTPI information.
The [Dublin Bus](https://www.dublinbus.ie/RTPI/) website can help to determine the id of your bus stop. You can check if this is correct by going to The [Dublin Bus](https://www.dublinbus.ie/RTPI/) website can help to determine the id of your bus stop. You can check if this is correct by going to
https://data.dublinked.ie/cgi-bin/rtpi/realtimebusinformation?stopid=[Stop ID] https://data.dublinked.ie/cgi-bin/rtpi/realtimebusinformation?stopid=[Stop ID]
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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

10
source/_integrations/duckdns.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Cloud Polling
ha_release: 0.55 ha_release: 0.55
ha_domain: duckdns ha_domain: duckdns
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The DuckDNS integration allows you to keep your DuckDNS subdomain always in sync with your public IP address. [DuckDNS](https://www.duckdns.org) is a free service that allows you to bind your own favorite subdomain under `duckdns.org` to the public IP address in use from your router, even though such address is dynamically allocated by your internet service provider and therefore changes over time. The DuckDNS {% term integration %} allows you to keep your DuckDNS subdomain always in sync with your public IP address. [DuckDNS](https://www.duckdns.org) is a free service that allows you to bind your own favorite subdomain under `duckdns.org` to the public IP address in use from your router, even though such address is dynamically allocated by your internet service provider and therefore changes over time.
<div class='note'> <div class='note'>
@ -19,7 +22,8 @@ If you are running the Home Assistant DuckDNS add-on this integration is not req
## Configuration ## Configuration
To use the integration in your installation, add the following to your `configuration.yaml` file: To use the integration in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -44,5 +48,5 @@ duckdns:
Set the TXT record of your DuckDNS subdomain. Set the TXT record of your DuckDNS subdomain.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | --------------------------- |
| `txt` | no | Payload for the TXT record. | | `txt` | no | Payload for the TXT record. |

8
source/_integrations/dweet.markdown
View File

@ -10,9 +10,12 @@ ha_domain: dweet
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `dweet` integration makes it possible to transfer details collected with Home Assistant to [Dweet.io](https://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public! The `dweet` {% term integration %} makes it possible to transfer details collected with Home Assistant to [Dweet.io](https://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public!
<p class='img'> <p class='img'>
<img src='/images/screenshots/dweet-freeboard.png' /> <img src='/images/screenshots/dweet-freeboard.png' />
@ -28,7 +31,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry