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

v-integrations: restart HA after changing config (#32744)

Browse Source 
- add note to restart HA after changing config
- add related topics
- rename 'platform' or 'sensor' to 'integration' to streamline terminology
- add glossary reference to Configuration file
This commit is contained in:
c0ffeeca7 2024-05-14 10:30:30 +02:00 committed by GitHub
parent 55d553c7a7
commit 1cea4cd373
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 43 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/vasttrafik.markdown
View File

@ -9,13 +9,17 @@ ha_domain: vasttrafik
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `vasttrafik` sensor will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service. The `vasttrafik` {% term integration %} will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service.
You must create an application [here](https://developer.vasttrafik.se/applications) to obtain a `key` and a `secret`. Make sure to also subscribe to the API by clicking on `Prenumerera på nytt API`, and selecting the API `Planera Resa v4`. You must create an application [here](https://developer.vasttrafik.se/applications) to obtain a `key` and a `secret`. Make sure to also subscribe to the API by clicking on `Prenumerera på nytt API`, and selecting the API `Planera Resa v4`.
Add the data to your `configuration.yaml` file as shown in the example: 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

6
source/_integrations/versasense.markdown
View File

@ -15,12 +15,18 @@ ha_platforms:
- sensor - sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **VersaSense** {% term integration %} supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network. The **VersaSense** {% term integration %} supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
## Configuration ## Configuration
To enable VersaSense in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
versasense: versasense:

8
source/_integrations/viaggiatreno.markdown
View File

@ -9,11 +9,14 @@ ha_domain: viaggiatreno
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Trenitalia ViaggiaTreno** {% term integration %} will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API. The **Trenitalia ViaggiaTreno** {% term integration %} will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
To activate the sensor you need at least two parameters: the `train_id` and the `station_id`. To activate the {% term integration %}, you need at least two parameters: the `train_id` and the `station_id`.
The first is available just looking at the [ViaggiaTreno](http://viaggiatreno.it/) timetable, the latter can be obtained using the dedicated API endpoint: The first is available just looking at the [ViaggiaTreno](http://viaggiatreno.it/) timetable, the latter can be obtained using the dedicated API endpoint:
`http://www.viaggiatreno.it/infomobilita/resteasy/viaggiatreno/autocompletaStazione/<Station name>` `http://www.viaggiatreno.it/infomobilita/resteasy/viaggiatreno/autocompletaStazione/<Station name>`
@ -25,7 +28,8 @@ Note that the `station_id` is referred to the train's **departing station**. If
</div> </div>
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

6
source/_integrations/vivotek.markdown
View File

@ -11,6 +11,9 @@ ha_domain: vivotek
ha_platforms: ha_platforms:
- camera - camera
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **VIVOTEK** camera {% term integration %} allows you to integrate a VIVOTEK IP camera into Home Assistant. The **VIVOTEK** camera {% term integration %} allows you to integrate a VIVOTEK IP camera into Home Assistant.
@ -19,7 +22,8 @@ Home Assistant will serve the images via its server, making it possible to view
## Configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

6
source/_integrations/vlc.markdown
View File

@ -9,6 +9,9 @@ ha_domain: vlc
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html). The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html).
@ -21,7 +24,8 @@ The **VLC media player** {% term integration %}, is currently only available for
## Configuration ## Configuration
To add a VLC media player to your installation, add the following to your `configuration.yaml` file: To add a VLC media player 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

6
source/_integrations/voicerss.markdown
View File

@ -9,13 +9,17 @@ ha_domain: voicerss
ha_platforms: ha_platforms:
- tts - tts
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **VoiceRSS** text-to-speech {% term integration %} uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices. The **VoiceRSS** text-to-speech {% term integration %} uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
## Configuration ## Configuration
To enable text-to-speech with VoiceRSS, add the following lines to your `configuration.yaml`: To enable text-to-speech with VoiceRSS, 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

6
source/_integrations/volkszaehler.markdown
View File

@ -9,13 +9,17 @@ ha_domain: volkszaehler
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Volkszaehler** {% term integration %} is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API. The **Volkszaehler** {% term integration %} is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
## Configuration ## Configuration
To enable the Volkszaehler sensor, add the following lines to your `configuration.yaml`: To enable the Volkszaehler {% term 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

6
source/_integrations/vultr.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- sensor - sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Vultr** {% term integration %} allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. The **Vultr** {% term integration %} allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
@ -32,7 +35,8 @@ Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#set
Ensure you allow the public IP of Home Assistant under the Access Control heading. Ensure you allow the public IP of Home Assistant under the Access Control heading.
</div> </div>
To integrate your Vultr subscriptions with Home Assistant, add the following section to your `configuration.yaml` file: To integrate your Vultr subscriptions 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