mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
4549c25fd9
* Move tts_service from example to configuration * Implement feedback by the author of this PR --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
50 lines
1.8 KiB
Markdown
50 lines
1.8 KiB
Markdown
---
|
|
title: "Notify using TTS"
|
|
description: "Instructions on how to set up a Notify integration using TTS service and media_player within Home Assistant."
|
|
ha_category:
|
|
- Notifications
|
|
ha_release: 0.117
|
|
ha_iot_class: Local Push
|
|
ha_quality_scale: internal
|
|
ha_domain: notify
|
|
---
|
|
|
|
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.
|
|
|
|
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:
|
|
|
|
```yaml
|
|
notify:
|
|
- platform: tts
|
|
name: in_the_living_room
|
|
entity_id: tts.google_en_com
|
|
media_player: media_player.living_room
|
|
```
|
|
|
|
{% configuration %}
|
|
name:
|
|
description: The name of the notify service.
|
|
required: true
|
|
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:
|
|
description: "The `service_name` of a TTS platform. Either use `entity_id` or `tts_service` to target a TTS platform."
|
|
required: exclusive
|
|
type: string
|
|
media_player:
|
|
description: "The `entity_id` of a media_player."
|
|
required: true
|
|
type: string
|
|
language:
|
|
description: "The `language` to be passed to the TTS `speak` or `say` service."
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|