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 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

p-q-integrations: restart HA after changing config (#32716)

Browse Source 
Co-authored-by: Johann Kellerman <kellerza@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7 2024-05-13 17:21:22 +02:00 committed by GitHub
parent 502179872c
commit e16346db9f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 150 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_integrations/panasonic_viera.markdown
View File

@ -12,9 +12,12 @@ ha_platforms:
- media_player
- remote
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Panasonic Viera integration allows you to control a Panasonic Viera TV.
The Panasonic Viera {% term integration %} allows you to control a Panasonic Viera TV.
There is currently support for the following device types within Home Assistant:
@ -30,6 +33,8 @@ To allow your TV to be turned on or controlled while off, enable `Powered On By
## Manual configuration
If you prefer to use YAML to set up your Panasonic Viera TV, you can still do it. It also allows for some extra settings.
To enable the integration via YAML, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/pandora.markdown
View File

@ -9,6 +9,9 @@ ha_domain: pandora
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
If you have a Pandora account, you can control it from Home Assistant with this media player.
@ -53,7 +56,8 @@ Test it out by running `pianobar` in the command line. You should be able to lis
### Configuration in Home Assistant
The Pandora player can be loaded by adding the following lines to your `configuration.yaml`:
The Pandora player can be loaded by adding the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/panel_custom.markdown
View File

@ -9,11 +9,15 @@ ha_codeowners:
- '@home-assistant/frontend'
ha_domain: panel_custom
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `panel_custom` integration allows you to write your own panels in JavaScript and add them to Home Assistant. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/frontend/custom-ui/creating-custom-panels/).
The `panel_custom` {% term integration %} allows you to write your own panels in JavaScript and add them to Home Assistant. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/frontend/custom-ui/creating-custom-panels/).
To enable customized panels in your installation, add the following to your `configuration.yaml` file:
To enable customized panels in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/pencom.markdown
View File

@ -9,13 +9,17 @@ ha_domain: pencom
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[Pencom Design](https://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
## Configuration
The Pencom relays can be daisy-chained to allow for up to 8 boards.
The Pencom relays can be daisy-chained to allow for up to 8 boards. To enable Pencom in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
``` yaml
# Example configuration.yaml entry

8
source/_integrations/picotts.markdown
View File

@ -9,14 +9,18 @@ ha_domain: picotts
ha_platforms:
- tts
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `picotts` text-to-speech platform uses [Pico TTS library](https://github.com/naggety/picotts) to read out text with natural sounding voices.
The `picotts` text-to-speech {% term integration %} uses [Pico TTS library](https://github.com/naggety/picotts) to read out text with natural sounding voices.
Pico TTS is a powerful open-source engine that runs locally (cloudless) so it can work even without an internet connection.
## Configuration
To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`:
To enable text-to-speech with Pico, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/pilight.markdown
View File

@ -17,6 +17,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://manual.pilight.org/protocols/) are already available.
@ -34,7 +37,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
To integrate pilight into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/pioneer.markdown
View File

@ -9,11 +9,15 @@ ha_domain: pioneer
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `pioneer` platform allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/integrations/onkyo) platform instead.
The `pioneer` {% term integration %} allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/integrations/onkyo) platform instead.
To add a Pioneer receiver to your installation, add the following to your `configuration.yaml` file:
To add a Pioneer receiver to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/pjlink.markdown
View File

@ -9,13 +9,17 @@ ha_domain: pjlink
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](https://pjlink.jbmia.or.jp/english/index.html).
The `pjlink` {% term integration %} allows you to control from Home Assistant, projectors with support for the [PJLink protocol](https://pjlink.jbmia.or.jp/english/index.html).
## Configuration
To add a PJLink projector to your installation, add the following to your `configuration.yaml` file:
To add a PJLink projector to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/plant.markdown
View File

@ -7,13 +7,17 @@ ha_release: 0.44
ha_quality_scale: internal
ha_domain: plant
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This `plant` integration lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits.
This `plant` {% term integration %} lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits.
## Configuration
To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file:
To use your `plant` sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/pocketcasts.markdown
View File

@ -9,13 +9,17 @@ ha_domain: pocketcasts
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `pocketcasts` sensor platform lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work!
The `pocketcasts` sensor {% term integration %} lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work!
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/point.markdown
View File

@ -18,6 +18,9 @@ ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account and have a Pro subscription](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://homeassistant.local:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
@ -32,6 +35,9 @@ There is currently support for the following device types within Home Assistant:
### Configuration
To use the Minut Point {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
point:

8
source/_integrations/prometheus.markdown
View File

@ -9,13 +9,17 @@ ha_domain: prometheus
ha_codeowners:
- '@knyar'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read.
The `prometheus` {% term integration %} exposes metrics in a format which [Prometheus](https://prometheus.io/) can read.
## Configuration
To use the `prometheus` integration in your installation, add the following to your `configuration.yaml` file:
To use the `prometheus` {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

16
source/_integrations/prowl.markdown
View File

@ -9,13 +9,17 @@ ha_domain: prowl
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `prowl` platform uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
The `prowl` {% term integration %} uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
Go to the [Prowl website](https://www.prowlapp.com/) and create a new API key.
To add Prowl notifications to your installation, add the following to your `configuration.yaml` file:
To add Prowl notifications to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -41,9 +45,9 @@ api_key:
The following attributes can be placed `data` for extended functionality.
| Service data attribute | Optional | Default | Description |
| ---------------------- | -------- | ------- | ----------- |
| `priority` | yes | 0 | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
| `url` | yes | n/a | URL to be attached, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
| Service data attribute | Optional | Default | Description |
| ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- |
| `priority` | yes | 0 | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
| `url` | yes | n/a | URL to be attached, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

8
source/_integrations/proxmoxve.markdown
View File

@ -12,11 +12,14 @@ ha_domain: proxmoxve
ha_platforms:
- binary_sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[Proxmox VE](https://www.proxmox.com/en/) is an open-source server virtualization environment. This integration allows you to poll various data from your instance.
After configuring this integration, the binary sensors automatically appear.
After configuring this {% term integration %}, the binary sensors automatically appear.
## Configuration
@ -24,7 +27,8 @@ After configuring this integration, the binary sensors automatically appear.
You should have at least one VM or container entry configured, else this integration won't do anything.
</div>
To use the `proxmoxve` integration, add the following configuration to your `configuration.yaml` file:
To use the `proxmoxve` {% term integration %}, add the following configuration to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/proxy.markdown
View File

@ -8,9 +8,12 @@ ha_domain: proxy
ha_platforms:
- camera
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output.
The `proxy` camera {% term integration %} allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output.
The current post-processing supports resizing and/or cropping the image/MJPEG as well as limiting the maximum refresh rate.
@ -18,7 +21,8 @@ The current proxy capabilities are intended to reduce the camera bandwidth for s
## Configuration
To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your `configuration.yaml` file:
To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/pulseaudio_loopback.markdown
View File

@ -9,6 +9,9 @@ ha_domain: pulseaudio_loopback
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The goal behind this switch is to allow a very flexible whole home audio system based upon [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/).
@ -17,9 +20,10 @@ For example, for a system with a 7.1 surround sound card, and 3 instances of [MP
The benefit of this approach is that this audio routing can occur without modifying the design-time configuration of MPD or PulseAudio.
This integration uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies.
This {% term integration %} uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies.
To enable this switch, add the following lines to your `configuration.yaml` file:
To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/push.markdown
View File

@ -11,9 +11,12 @@ ha_domain: push
ha_platforms:
- camera
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `push` camera platform allows you to integrate images sent over HTTP POST to Home Assistant as a camera. External applications/daemons/scripts are therefore able to "stream" images through Home Assistant.
The `push` camera {% term integration %} allows you to integrate images sent over HTTP POST to Home Assistant as a camera. External applications/daemons/scripts are therefore able to "stream" images through Home Assistant.
Optionally the Push Camera can **buffer** a given number of images, creating an animation of the detected motion after the event has been recorded.
@ -44,7 +47,8 @@ camera:
## Configuration
To enable this camera in your installation, add the following to your `configuration.yaml` file:
To enable this camera in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/pushsafer.markdown
View File

@ -9,13 +9,17 @@ ha_domain: pushsafer
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The [Pushsafer service](https://www.pushsafer.com/) is a platform for the notify integration. This allows you to send messages to the user using Pushsafer.
In order to get a private or alias key you need to go to the [Pushsafer website](https://www.pushsafer.com) and register.
To use Pushsafer notifications, add the following to your `configuration.yaml` file:
To use Pushsafer notifications, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/pyload.markdown
View File

@ -9,11 +9,15 @@ ha_domain: pyload
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `pyload` platform allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information.
The `pyload` {% term integration %} allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information.
To enable this sensor, add the following lines to your `configuration.yaml`:
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

24
source/_integrations/qld_bushfire.markdown
View File

@ -11,6 +11,9 @@ ha_domain: qld_bushfire
ha_platforms:
- geo_location
ha_integration_type: service
related:
- docs: /docs/configuration/
title: Configuration file
---
The `qld_bushfire` platform lets you integrate a
@ -41,7 +44,8 @@ Please refer to the [creator's copyright notice](https://www.qfes.qld.gov.au/cop
## Configuration
To integrate the Queensland Bushfire Alert feed, add the following lines to
your `configuration.yaml`.
your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -77,16 +81,16 @@ longitude:
The following state attributes are available for each entity in addition to
the standard ones:
| Attribute | Description |
|------------------|-------------|
| latitude | Latitude of the bushfire alert. |
| longitude | Longitude of the bushfire alert. |
| Attribute | Description |
| ---------------- | -------------------------------------------------------------------------------- |
| latitude | Latitude of the bushfire alert. |
| longitude | Longitude of the bushfire alert. |
| source | `qld_bushfire` to be used in conjunction with `geo_location` automation trigger. |
| external_id | The external ID used in the feed to identify the bushfire alert in the feed. |
| title | Original title from the feed. |
| publication_date | Date and time when this alert was first published. |
| updated_date | Date and time when this alert was last updated. |
| status | Status of the alert, for example, "Patrolled", "Going", "Contained" |
| external_id | The external ID used in the feed to identify the bushfire alert in the feed. |
| title | Original title from the feed. |
| publication_date | Date and time when this alert was first published. |
| updated_date | Date and time when this alert was last updated. |
| status | Status of the alert, for example, "Patrolled", "Going", "Contained" |
## Full configuration

8
source/_integrations/qrcode.markdown
View File

@ -7,15 +7,19 @@ ha_iot_class: Calculated
ha_release: 0.87
ha_domain: qrcode
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `qrcode` image processing platform enables QR code recognition from cameras.
The `qrcode` image processing {% term integration %} enables QR code recognition from cameras.
To get this running, please install `zbar-tools` (Ubuntu 18.04)
## Configuration
To enable this, add the following lines to your `configuration.yaml` file:
To enable this, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/quantum_gateway.markdown
View File

@ -11,6 +11,9 @@ ha_domain: quantum_gateway
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `quantum_gateway` device tracker platform offers presence detection by looking at devices connected to a Verizon Fios gateway.
@ -19,7 +22,8 @@ It was tested with a Verizon Fios-G1100 and G3100 Quantum Gateway.
## Configuration
To use a Verizon Fios Quantum Gateway in your installation, add the following to your `configuration.yaml` file:
To use a Verizon Fios Quantum Gateway 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/qvr_pro.markdown
View File

@ -11,6 +11,9 @@ ha_codeowners:
ha_platforms:
- camera
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[QVR Pro](https://www.qnap.com/en/software/qvr-pro) allows you to create
@ -22,7 +25,8 @@ Currently, only cameras are supported by this integration.
## Configuration
To enable QVR Pro integration, add the following to your
`configuration.yaml` file:
{% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/qwikswitch.markdown
View File

@ -18,6 +18,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `qwikswitch` integration is the main integration to integrate various [QwikSwitch](https://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application.
@ -33,6 +36,9 @@ The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Re
## Configuration
To use the QwickSwitch integration in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
qwikswitch: