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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add information to restart Home Assistant after adding the integratio… (#32627)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-07 16:10:50 +02:00 committed by GitHub
parent d1396200be
commit 66145b0d5a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 140 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/acer_projector.markdown
View File

@ -9,13 +9,17 @@ ha_domain: acer_projector
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](https://www.acer.com/).
## Configuration
To use your Acer Projector in your installation, add the following to your `configuration.yaml` file:
To use your Acer Projector 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

6
source/_integrations/actiontec.markdown
View File

@ -9,6 +9,9 @@ ha_domain: actiontec
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Actiontec** {% term integration %} allows you to detect presence by looking at devices connected to an [Actiontec](https://www.actiontec.com/) device.
@ -21,7 +24,8 @@ Supported devices (tested):
This device tracker needs telnet to be enabled on the router.
</div>
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

6
source/_integrations/ads.markdown
View File

@ -18,6 +18,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.com/en-en/products/automation/twincat/) and other devices implementing this interface.
@ -32,7 +35,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To enable ADS, add the following lines to your `configuration.yaml` file:
To enable ADS, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

16
source/_integrations/alert.markdown
View File

@ -11,6 +11,9 @@ ha_codeowners:
- '@home-assistant/core'
- '@frenck'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `alert` integration is designed to notify you when problematic issues arise.
@ -23,17 +26,18 @@ Alerts will add an entity to the front end.
This entity allows you to silence an alert until it is resolved and has three
possible states:
State | Description
-|-
`idle` | The condition for the alert is false.
`on` | The condition for the alert is true.
`off` | The condition for the alert is true but it was acknowledged.
| State | Description |
| ------ | ------------------------------------------------------------ |
| `idle` | The condition for the alert is false. |
| `on` | The condition for the alert is true. |
| `off` | The condition for the alert is true but it was acknowledged. |
### Basic example
The `alert` integration makes use of any of the `notification` integrations. To
setup the `alert` integration, first, you must set up a [notification integration](/integrations/notify).
Then, add the following to your configuration file:
Then, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/alpha_vantage.markdown
View File

@ -9,11 +9,15 @@ ha_domain: alpha_vantage
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market. This platform also provides detail about exchange rates.
To enable the `alpha_vantage` platform, add the following lines to your `configuration.yaml` file:
To enable the `alpha_vantage` platform, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/amazon_polly.markdown
View File

@ -9,6 +9,9 @@ ha_iot_class: Cloud Push
ha_platforms:
- tts
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
@ -22,7 +25,8 @@ Available voices are listed in the [Amazon Documentation](https://docs.aws.amazo
## Configuration
To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly):
To get started, add the following lines to your {% term "`configuration.yaml`" %} file (example for Amazon Polly).
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

56
source/_integrations/amcrest.markdown
View File

@ -17,6 +17,9 @@ ha_platforms:
ha_codeowners:
- '@flacjacket'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) or Dahua IP camera or doorbell in Home Assistant.
@ -29,7 +32,8 @@ There is currently support for the following {% term device %} types within Home
## Configuration
To enable your camera in your installation, add the following to your `configuration.yaml` file:
To enable your 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
@ -204,61 +208,61 @@ Available {% term services %}:
These {% term services %} enable or disable the camera's audio stream.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `enable_motion_recording`/`disable_motion_recording`
These {% term services %} enable or disable the camera to record a clip to its configured storage location when motion is detected.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `enable_recording`/`disable_recording`
These services enable or disable the camera to continuously record to its configured storage location.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `goto_preset`
This service will cause the camera to move to one of the <abbr title="pan, tilt, and zoom">PTZ</abbr> locations configured within the camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`preset` | no | Preset number, starting from 1.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `preset` | no | Preset number, starting from 1. |
### Service `set_color_bw`
This service will set the color mode of the camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`color_bw` | no | One of `auto`, `bw` or `color`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `color_bw` | no | One of `auto`, `bw` or `color`. |
### Service `start_tour`/`stop_tour`
These services start or stop the camera's <abbr title="pan, tilt, and zoom">PTZ</abbr> tour function.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `ptz_control`
If your Amcrest or Dahua camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan, tilt or zoom your camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no| The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down`
`travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down` |
| `travel_time` | yes | Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`. |
## Notes

6
source/_integrations/ampio.markdown
View File

@ -10,6 +10,9 @@ ha_domain: ampio
ha_platforms:
- air_quality
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog.ampio.pl/) to monitor air quality sensor station.
@ -20,7 +23,8 @@ To get the ID of a station you need to contact Ampio directly.
## Manual 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

6
source/_integrations/anel_pwrctrl.markdown
View File

@ -9,6 +9,9 @@ ha_domain: anel_pwrctrl
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `anel_pwrctrl` switch platform allows you to control [ANEL PwrCtrl](https://en.anel.eu/index.htm?src=/produkte/produkte.htm) devices on firmware 6.x and older. [ANEL PwrCtrl](https://en.anel.eu/index.htm?src=/produkte/produkte.htm) devices on firmware 7.x are not supported.
@ -19,7 +22,8 @@ Supported devices (tested):
- PwrCtrl Advanced
- PwrCtrl Advanced Power
To add this platform to your installation, add the following to your `configuration.yaml` file:
To add this platform 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

6
source/_integrations/apprise.markdown
View File

@ -11,13 +11,17 @@ ha_domain: apprise
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.)
## Configuration
To use Apprise supported notifications, add the following to your `configuration.yaml` file:
To use Apprise supported notifications, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry using URLs

6
source/_integrations/aprs.markdown
View File

@ -11,13 +11,17 @@ ha_domain: aprs
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
## Configuration
To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`:
To enable APRS tracking in Home Assistant, add the following section to {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/aqualogic.markdown
View File

@ -12,6 +12,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
@ -23,7 +26,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file:
To add the AquaLogic 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

6
source/_integrations/aquostv.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aquostv
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aquostv` platform allows you to control a [Sharp Aquos TV](https://global.sharp/aquos/index.html).
@ -17,7 +20,8 @@ When the TV is first connected, you will need to accept Home Assistant on the TV
## Configuration
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

6
source/_integrations/arest.markdown
View File

@ -14,6 +14,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,8 @@ There is currently support for the following device types within Home Assistant:
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
To use your aREST binary 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

6
source/_integrations/arris_tg2492lg.markdown
View File

@ -11,6 +11,9 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: hub
related:
- docs: /docs/configuration/
title: Configuration file
---
This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router.
@ -24,7 +27,8 @@ This is one of the routers provided by:
The router prevents the admin user from logging in twice. This can cause problems with accessing the router's configuration pages while this platform is active.
</div>
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

6
source/_integrations/aruba.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aruba
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 an [Aruba Instant](https://www.arubanetworks.com/products/networking/aruba-instant/) device.
@ -27,7 +30,8 @@ Supported devices (tested):
This device tracker needs telnet to be enabled on the router.
</div>
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

6
source/_integrations/arwn.markdown
View File

@ -9,11 +9,15 @@ ha_domain: arwn
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](https://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree.
To use your ARWN setup, you must already have configured the [MQTT](/integrations/mqtt/) platform. Then add the following to your `configuration.yaml` file:
To use your ARWN setup, you must already have configured the [MQTT](/integrations/mqtt/) platform. Then add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/assist_pipeline.markdown
View File

@ -13,6 +13,9 @@ ha_integration_type: integration
ha_quality_scale: internal
ha_platforms:
- select
related:
- docs: /docs/configuration/
title: Configuration file
---
The Assist pipeline integration provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant.

6
source/_integrations/atome.markdown
View File

@ -12,6 +12,9 @@ ha_domain: atome
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `atome` sensor platform is retrieving the consumption of your home from the [Direct Energy Atome electric meter](https://total.direct-energie.com/particuliers/electricite/compteur-linky/atome).
@ -24,7 +27,8 @@ As there is no official documentation for the API, the integration retrieves dat
To use it, you need to order the device directly from "Total Direct Energie" Mobile App. Then you need to follow up the installation (covered in the Atome App).
The configuration (see below) needs your Atome username & password you created during the initialization of the Atome device.
Next, add the Atome sensor to your `configuration.yaml` file like below:
Next, add the Atome sensor to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/avea.markdown
View File

@ -11,13 +11,17 @@ ha_domain: avea
ha_platforms:
- light
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[Elgato Avea](https://www.evehome.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
## Configuration
To enable Avea, add the following lines to your `configuration.yaml` file:
To enable Avea, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/avion.markdown
View File

@ -27,7 +27,8 @@ with the email and password fields replaced with those used when registering the
## 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

6
source/_integrations/aws.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aws
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
@ -23,7 +26,8 @@ The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/docu
## Configuration
To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
To use the `aws` integration and the `notify` platform in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/azure_service_bus.markdown
View File

@ -11,6 +11,9 @@ ha_domain: azure_service_bus
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `Azure Service Bus` integration allows you to send messages to [Azure Service Bus](https://azure.microsoft.com/products/service-bus/) from within Home Assistant.
@ -33,7 +36,8 @@ The queue or topic that you are sending to needs to exists with the service bus
## 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