Skip to content

A custom Home Assistant integration to play an audio file before and/or after text-to-speech (TTS) messages

License

Notifications You must be signed in to change notification settings

oka4henry/chime_tts

 
 

Repository files navigation

Chime TTS

hacs_badge version Community Forum

Chime TTS is a Home Assistant integration that eliminates the audio lag between playing a chime/notification sound effect before a TTS audio notification.

Chime TTS


What is Chime TTS?

The Problem:

Latency is introduced between the notification chime and the TTS audio

Home Assistant allows audio files and Text-To-Speech (TTS) audio messages to be played on speakers around your home. While TTS messages are a great way to provide real-time updates, by the time you realize a message is playing, you've missed the start of the message.

It makes sense to add a notification chime before the TTS audio, but in practice this introduces a delay between the two, caused by latency from network requests to the cloud TTS platform and latency from audio processing & networking before playback begins on the speakers.

The Solution:

Chime TTS removes the latency between the notification chime and the TTS audio

Chime TTS is a custom Home Assistant integration that solves this issue by stitching these audio files together. Chime TTS generates a single audio file locally on your Home Assistant device, and plays it to your speakers in a single event, eliminating any lag.


Features

Chime TTS offers various features that enhance TTS audio playback experience:

  • No lag or timing issues: Precise timing between audio files without cloud TTS delays.
  • Customizable audio cues: Play preset or custom audio before and after TTS messages.
  • Flexible TTS platform selection: Supports various TTS platform integrations.
  • Easy service invocation: Use the 'chime_tts.say' service in automations and scripts.
  • Set media player notification volume: Restore volume after playback.
  • Configurable TTS playback speed: Set the TTS audio speed anywhere from 100-200%.
  • Configurable delay: Set custom delays between audio and TTS.
  • Caching: Cache audio for faster playback.
  • Speaker Groups: Group speakers for simultaneous playback.

Quick Start

Follow these easy steps to get started with Chime TTS:

  1. Installation - Quickly install Chime TTS via HACS or manually.
  2. Add the Integration - Add Chime TTS to your Home Assistant instance.

How Do I Use It?

Chime TTS adds three new services to your Home Assistant instance: chime_tts.say, chime_tts.say_url and chime_tts.clear_cache. Discover how you can use these services and the features they offer:


Configuration

chime_tts_options

You can customise the following elements for the chime_tts.say and chime_tts.say_url services:

Config Option Description Default Value
Timeout Set the maximum number of seconds before the service call is terminated (useful if you have long TTS messages and don't want the service end prematurely) 60
Media Folder Media Folder - Media folder for storing temporary files. local
Temporary MP3 Folder Temporary MP3 Folder - Path to the local folder where the generated mp3 files are saved. /media/sounds/temp/chime_tts/
Public MP3 Folder Public MP3 Folder - Path to the publicly accessible folder used to store MP3 files generated by chime_tts.say_url service. /www/chime_tts/

Support and Discussion

For questions, suggestions, and community discussion about Chime TTS, visit our Community Forum.


Show Your Support

If you find Chime TTS useful, consider showing your support: Buy Me A Coffee

About

A custom Home Assistant integration to play an audio file before and/or after text-to-speech (TTS) messages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.6%
  • Shell 1.4%