Skip to main content

Configuration

The Chime TTS can be configured via the sidebar panel.

Beta

The Settings Panel workflow is currently in beta. Settings and panel behavior may change between releases.

Settings Panel overview

Open Settings → Devices & services → Chime TTS → Configure. The panel groups TTS defaults and fallback, playback options, audio file folders, action and script defaults, Chimes, Chime Sets, Notification Profiles, and session logs/support information. Use the detailed Chimes, Chime Sets, and Notification Profiles pages rather than duplicating those workflows here.

Restart Home Assistant after adding a TTS provider, changing custom-chime folder paths or contents, adding/removing/renaming a Chime Set, or adding/removing/renaming a Notification Profile. Changing members of an existing Chime Set does not require a restart.

You can configure the following options for the chime_tts.say and chime_tts.say_url actions through the integration's configuration panel:

Configuration sections

Chimes

Manage custom and downloaded chime audio in the panel's Chimes section. See Chimes for chime previews and per-chime offsets.

Chime Sets

Create reusable groups of chimes and randomly select a member for an action. See Chime Sets for setup, selection, and restart behaviour.

Notification Profiles

Create reusable Chime TTS notify services for automations and scripts. See Notification Profiles for configuration and YAML examples.

Logs

Review Chime TTS events and raw logs captured during the current Home Assistant session. See Logs for details.

Support & Info

Use the panel's Support & Info section for documentation, community support, bug reports, feature requests, and project support links.

The following legacy links redirect to their new locations. They are retained for existing bookmarks, automations, and links from older documentation.

Custom Chimes Folder

This setting is now documented in Chimes.

Downloaded Chimes Folder

This setting is now documented in Chimes.

chime_tts.say_url Folder

This setting is now documented in Audio Files Folders.

Configuration reference

This table is generated from the current Chime TTS configuration metadata. Changes to settings should be reflected here by running npm run generate:references.

FieldDescriptionDefault / example
queue_timeout
Action timeout
Maximum seconds to wait for queued Chime TTS work.60
tts_timeout
TTS generation timeout
Maximum seconds to wait for a TTS platform response. Use -1 to disable this timeout.30
tts_platform
Default TTS platform
Used when an action does not specify a TTS platform.Provider default
fallback_tts_platform
Fallback TTS platform
Used when the requested TTS platform is unavailable.None
default_language
Default language
Applied with the default TTS platform when supported.Provider default
default_voice
Default voice
Applied with the default TTS platform when supported.Provider default
default_tld
Default dialect
Google Translate dialect fallback.Provider default
chime_path
Default start chime
Optional chime played before generated speech.None
end_chime_path
Default end chime
Optional chime played after generated speech.None
offset
Default offset
Milliseconds between chimes and TTS; negative values overlay audio.450
crossfade
Default crossfade
Milliseconds to fade one audio segment out while the next fades in.0
fade_transition
Fade transition
Milliseconds used for announce and fade_audio transitions.500
remove_temp_file_delay
Temporary-file cleanup delay
Milliseconds to wait before deleting uncached temporary files.Built-in timing
add_cover_art
Add cover art
Embed Chime TTS cover art in generated MP3 files.false
custom_chimes_path
Custom chimes folder
Folder containing your own chimes. Changes require a Home Assistant restart.None
temp_chimes_path
Downloaded chimes folder
Where downloaded chime files are cached./media/sounds/temp/chime_tts/chimes/
temp_path
Temporary audio folder
Generated-audio folder; it must be inside a configured media directory./media/sounds/temp/chime_tts/
www_path
say_url output folder
Generated public-audio folder; it must be allowlisted, /media, or /config/www./config/www/chime_tts/
default_pre_script
Default pre-playback script
Runs before playback unless an action or profile overrides it.None
default_post_script
Default post-playback script
Runs after playback unless an action or profile overrides it.None