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

y-z-integrations: restart HA after changing config (#32747)

Browse Source 
* y-z-integrations: restart HA after changing config
- 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

* Update source/_integrations/yandextts.markdown

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>

---------

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
c0ffeeca7 2024-05-14 11:16:39 +02:00 committed by GitHub
parent 36cba79f66
commit f3e52e0aa4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 60 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_integrations/yamaha.markdown
View File

@ -9,9 +9,12 @@ ha_domain: yamaha
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `yamaha` platform allows you to control [Yamaha Network Receivers](https://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant. The `yamaha` {% term integration %} allows you to control [Yamaha Network Receivers](https://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant.
Supported devices: Supported devices:
@ -25,7 +28,8 @@ Supported devices:
- [RX-V3067](https://ca.yamaha.com/en/products/audio_visual/av_receivers_amps/rx-v3067/specs.html) - [RX-V3067](https://ca.yamaha.com/en/products/audio_visual/av_receivers_amps/rx-v3067/specs.html)
- And more - And more
To add a Yamaha Network Receiver to your installation, add the following to your `configuration.yaml` file: To add a Yamaha Network Receiver 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
@ -127,26 +131,26 @@ script:
Enable or disable an output port (HDMI) on the receiver. Enable or disable an output port (HDMI) on the receiver.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `port` | no | Port to enable or disable, e.g., `hdmi1`. | `port` | no | Port to enable or disable, e.g., `hdmi1`. |
| `enabled` | no | To enable set true, otherwise set to false. | `enabled` | no | To enable set true, otherwise set to false. |
### Service `menu_cursor` ### Service `menu_cursor`
Control the menu cursor. Control the menu cursor.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return` | `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return` |
### Service `select_scene` ### Service `select_scene`
Select a scene on the receiver. Select a scene on the receiver.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`. | `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`. |

8
source/_integrations/yandex_transport.markdown
View File

@ -13,9 +13,12 @@ ha_domain: yandex_transport
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `yandex_tranport` sensor platform uses [Yandex Maps](https://maps.yandex.ru/) it will give you the time until the next departure time from a bus/tramway/etc stop. The `yandex_tranport` {% term integration %} uses [Yandex Maps](https://maps.yandex.ru/) it will give you the time until the next departure time from a bus/tramway/etc stop.
The [Yandex Maps](https://maps.yandex.ru/) website can help to determine the id of your bus stop. You can select a bus stop by clicking on the map, and look to the URL: The [Yandex Maps](https://maps.yandex.ru/) website can help to determine the id of your bus stop. You can select a bus stop by clicking on the map, and look to the URL:
@ -27,7 +30,8 @@ If you want to track only specific routes, you can add them in the routes sectio
## Configuration ## Configuration
To activate Yandex Transport, add the following lines to your `configuration.yaml`: To activate Yandex Transport, 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/yandextts.markdown
View File

@ -9,9 +9,12 @@ ha_domain: yandextts
ha_platforms: ha_platforms:
- tts - tts
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `yandextts` text-to-speech platform uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) text-to-speech engine to read a text with natural sounding voices. The `yandextts` text-to-speech {% term integration %} uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) text-to-speech engine to read a text with natural sounding voices.
<div class='note warning'> <div class='note warning'>
This integration is working only with old API keys. For the new API keys, this integration cannot be used. This integration is working only with old API keys. For the new API keys, this integration cannot be used.
@ -19,7 +22,8 @@ This integration is working only with old API keys. For the new API keys, this i
## Configuration ## Configuration
To enable text-to-speech with Yandex SpeechKit, add the following lines to your `configuration.yaml`: To enable text-to-speech with Yandex SpeechKit, 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/yeelightsunflower.markdown
View File

@ -11,15 +11,19 @@ ha_domain: yeelightsunflower
ha_platforms: ha_platforms:
- light - light
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `yeelightsunflower` light platform allows you to control your Yeelight Sunflower light bulbs with Home Assistant. The `yeelightsunflower` {% term integration %} allows you to control your Yeelight Sunflower light bulbs with Home Assistant.
<div class='note warning'> <div class='note warning'>
The "Yeelight Sunflower" bulbs are not the same as the "Yeelight WiFi" bulbs. The "Yeelight Sunflower" bulbs are not the same as the "Yeelight WiFi" bulbs.
</div> </div>
To enable your lights, add the following lines to your `configuration.yaml` file: To enable your lights, 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/zabbix.markdown
View File

@ -10,6 +10,9 @@ ha_domain: zabbix
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Zabbix** {% term integration %} is the main {% term integration %} to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API. The **Zabbix** {% term integration %} is the main {% term integration %} to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
@ -22,7 +25,8 @@ There is currently also support for the following device types within Home Assis
## Configuration ## Configuration
To set the Zabbix {% term integration %} up, add the following information to your `configuration.yaml` file: To set the Zabbix {% term integration %} up, add the following information 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/zengge.markdown
View File

@ -11,13 +11,17 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
ha_codeowners: ha_codeowners:
- '@emontnemery' - '@emontnemery'
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `zengge` platform allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant. The `zengge` {% term integration %} allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant.
## Configuration ## Configuration
To enable the lights, add the following lines to your `configuration.yaml` file: To enable the lights, 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/ziggo_mediabox_xl.markdown
View File

@ -9,11 +9,15 @@ ha_domain: ziggo_mediabox_xl
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The **Ziggo Mediabox XL** {% term integration %} allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. The **Ziggo Mediabox XL** {% term integration %} allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant.
To add a Ziggo Mediabox XL to your installation, add the following to your `configuration.yaml` file: To add a Ziggo Mediabox XL 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/zoneminder.markdown
View File

@ -19,6 +19,9 @@ ha_platforms:
- sensor - sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `zoneminder` integration sets up Home Assistant with your [ZoneMinder](https://www.zoneminder.com) instance. The `zoneminder` integration sets up Home Assistant with your [ZoneMinder](https://www.zoneminder.com) instance.
@ -32,6 +35,9 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## Configuration
To add the {% term integration %} to your installation, add it to the {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
zoneminder: zoneminder:
@ -92,7 +98,7 @@ zoneminder:
Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) that can be used to change the current run state of ZoneMinder. Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) that can be used to change the current run state of ZoneMinder.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|:-----------------------|:---------|:----------------------------------| | :--------------------- | :------- | :-------------------------------- |
| `id` | no | Host of the ZoneMinder instance. | | `id` | no | Host of the ZoneMinder instance. |
| `name` | no | Name of the new run state to set. | | `name` | no | Name of the new run state to set. |