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

Update tts notify (#28576)

Browse Source
This commit is contained in:
Martin Hjelmare 2023-08-14 13:09:48 +02:00 committed by GitHub
parent f0774b3b40
commit c3e346944c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/notify.tts.markdown
View File

@ -9,23 +9,19 @@ ha_quality_scale: internal
ha_domain: notify ha_domain: notify
--- ---
The notify TTS platform lets you use the TTS integration [Service Say](/integrations/tts/#service-say) and a [media_player](/integrations/media_player) to alert you of important events. This integration provides a simple interface to use in your automations and alerts. The notify TTS platform lets you use the TTS integration [speak](/integrations/tts/#service-speak) or legacy [say](/integrations/tts/#service-say-legacy) service and a [media_player](/integrations/media_player) to alert you of important events. This integration provides a simple interface to use in your automations and alerts.
In order to use this integration, you must already have a TTS platform installed and configured, and a media_player working with the TTS platform. In order to use this integration, you must already have a TTS platform installed and configured, and a media_player working with the TTS platform.
To enable this platform in your installation, consider the following example using [google_translate](/integrations/google_translate/) and an example `media_player.living_room`. To enable this platform in your installation, consider the following example using [google_translate](/integrations/google_translate/) and an example `media_player.living_room`.
In your `configuration.yaml` file type: In your `configuration.yaml` file type:
```yaml ```yaml
tts:
- platform: google_translate
service_name: google_translate_say
notify: notify:
- platform: tts - platform: tts
name: in_the_living_room name: in_the_living_room
tts_service: tts.google_translate_say entity_id: tts.google_en_com
media_player: media_player.living_room media_player: media_player.living_room
``` ```
@ -36,16 +32,20 @@ Please note that the `tts_service` parameter, must match the `service_name` defi
description: The name of the notify service. description: The name of the notify service.
required: true required: true
type: string type: string
entity_id:
description: "The `entity_id` of the TTS entity to target. Either use `entity_id` or `tts_service` to target a TTS platform."
required: exclusive
type: string
tts_service: tts_service:
description: "The `service_name` of a TTS platform." description: "The `service_name` of a TTS platform. Either use `entity_id` or `tts_service` to target a TTS platform."
required: true required: exclusive
type: string type: string
media_player: media_player:
description: "The `entity_id` of a media_player." description: "The `entity_id` of a media_player."
required: true required: true
type: string type: string
language: language:
description: "The `language` to be passed to the TTS `Service Say`" description: "The `language` to be passed to the TTS `speak` or `say` service."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}