{"id":13584993,"url":"https://github.com/nimroddolev/chime_tts","last_synced_at":"2025-04-07T06:32:12.568Z","repository":{"id":172470244,"uuid":"646875198","full_name":"nimroddolev/chime_tts","owner":"nimroddolev","description":"A custom Home Assistant integration to play combined audio files before and/or after text-to-speech (TTS) messages","archived":false,"fork":false,"pushed_at":"2024-10-29T19:27:32.000Z","size":93637,"stargazers_count":190,"open_issues_count":7,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T21:36:43.104Z","etag":null,"topics":["hacs","hacs-integration","home-assistant","python"],"latest_commit_sha":null,"homepage":"https://nimroddolev.github.io/chime_tts/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nimroddolev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["nimroddolev"],"buy_me_a_coffee":"nimroddolev"}},"created_at":"2023-05-29T14:34:59.000Z","updated_at":"2024-10-29T13:56:15.000Z","dependencies_parsed_at":"2024-03-10T08:25:37.722Z","dependency_job_id":"b008dee2-f2a6-438b-8952-69408aa21dda","html_url":"https://github.com/nimroddolev/chime_tts","commit_stats":null,"previous_names":["nimroddolev/chime_tts"],"tags_count":116,"template":false,"template_full_name":"ludeeus/integration_blueprint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimroddolev%2Fchime_tts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimroddolev%2Fchime_tts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimroddolev%2Fchime_tts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimroddolev%2Fchime_tts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nimroddolev","download_url":"https://codeload.github.com/nimroddolev/chime_tts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247607249,"owners_count":20965942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacs","hacs-integration","home-assistant","python"],"created_at":"2024-08-01T15:04:38.922Z","updated_at":"2025-04-07T06:32:12.553Z","avatar_url":"https://github.com/nimroddolev.png","language":"Python","funding_links":["https://github.com/sponsors/nimroddolev","https://buymeacoffee.com/nimroddolev","https://www.buymeacoffee.com/nimroddolev"],"categories":["Python"],"sub_categories":[],"readme":"![Chime TTS](https://raw.githubusercontent.com/nimroddolev/chime_tts/main/icon.png)\r\n\r\n[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://github.com/hacs/integration)\r\n![version](https://img.shields.io/github/v/release/nimroddolev/chime_tts)\r\n[![Community Forum][forum-shield]][forum]\r\n\u003ca href=\"https://www.buymeacoffee.com/nimroddolev\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" height=\"0px\"\u003e\u003c/a\u003e\r\n\r\nChime TTS is a custom Home Assistant integration that eliminates the audio lag between playing a chime/notification sound effect before a TTS audio notification.\r\n\r\n#### If you find Chime TTS useful, consider showing your support: \u003ca href=\"https://www.buymeacoffee.com/nimroddolev\" target=\"_blank\"\u003e\u003cimg src=\"https://i.ibb.co/D1sqFY8/buy-me-a-coffee.png\" alt=\"Buy Me A Coffee\"\u003e\u003c/a\u003e\r\n\r\n\r\n- [What is Chime TTS?](https://nimroddolev.github.io/chime_tts/docs/getting-started#what-is-chime-tts)\r\n- [Features](https://nimroddolev.github.io/chime_tts/docs/getting-started#features)\r\n- [Quick Start](https://nimroddolev.github.io/chime_tts/docs/getting-started#quick-start)\r\n- [How Do I Use It?](https://nimroddolev.github.io/chime_tts/docs/getting-started#how-do-i-use-it)\r\n- [Support \u0026 Discussion](https://nimroddolev.github.io/chime_tts/docs/getting-started#support-and-discussion)\r\n\r\n---\r\n\r\n## What is Chime TTS?\r\n\r\nChime TTS is a custom Home Assistant integration that locally combines TTS audio and sound effects into seamless audio for playback in a single action call, eliminating the lag. Chime TTS includes a [suite of options](https://nimroddolev.github.io/chime_tts/docs/getting-started#features) to further customize the audio.\r\n\r\n### The Problem:\r\n\r\n\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/no_chime_tts-dark.png\"\u003e\r\n\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/no_chime_tts-light.png\"\u003e\r\n\u003cimg alt=\"Latency is introduced between the notification chime and the TTS audio\" src=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/no_chime_tts-dark.png\"\u003e\r\n\r\nAdding a notification chime before Text-To-Speech (TTS) audio messages requires two separate action calls, which introduces lag due to networking latency of cloud TTS platforms, audio processing, and delays before media_player playback begins.\r\n\r\n### The Solution:\r\n\r\n\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/wuth_chime_tts-dark.png\"\u003e\r\n\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/with_chime_tts-light.png\"\u003e\r\n\u003cimg alt=\"Chime TTS removes the latency between the notification chime and the TTS audio\" src=\"https://raw.githubusercontent.com/nimroddolev/chime_tts/main/images/wiki/home/with_chime_tts-dark.png\"\u003e\r\n\r\n**Chime TTS** addresses this issue by combining the audio files into _a single file_ locally on your Home Assistant device. This combined file is then played through your speakers in one seamless event, eliminating any lag.\r\n\r\n***\r\n\r\n##  Features\r\n\r\nChime TTS offers various features that enhance TTS audio playback experience:\r\n\r\n- **No lag or timing issues:** Precise timing between audio files without cloud TTS delays.\r\n- **Customizable audio cues:** Play preset or custom audio before and after TTS messages.\r\n- **Flexible TTS platform selection:** Supports various [TTS platform integrations](https://www.home-assistant.io/integrations/#text-to-speech).\r\n-  **Easy action invocation:** Use the [`chime_tts.say`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/) and [`chime_tts.say_url`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say_url-action/) actions in automations and scripts.\r\n-  **Set media player  volume:** Notifications can be played at a defined volume and restored after playback.\r\n- **Restore previous audio:** Chime TTS supports pausing and resuming currently playing audio beyond the media player platforms supported by Home Assistant *(eg: HomePods)*.\r\n-  **Mix and match TTS platforms:** Combine TTS audio using multiple TTS platforms within the same audio announcement.\r\n- **Configurable TTS speed:** Set the TTS audio speed anywhere from 1-500%.\r\n- **Configurable TTS pitch:** Set the pitch for TTS audio, allowing for more customization.\r\n- **Support for FFmpeg arguments:** Apply FFmpeg jobs to the generated audio, or specific jobs to specific chimes and TTS audio segments.\r\n-  **Configurable delay:** Set custom delays between chimes \u0026 TTS audio.\r\n-  **Configurable overlay:** Set custom overlay durations between chimes \u0026 TTS audio.\r\n-  **Caching:** Cache audio for faster playback.\r\n-  **Speaker Groups:** Group speakers for simultaneous playback *(on supported platforms)*.\r\n\r\n***\r\n\r\n## Quick Start\r\n\r\nFollow these easy steps to get started with Chime TTS:\r\n\r\n1. [Installation](https://nimroddolev.github.io/chime_tts/docs/quick-start/installing-chime-tts) - Quickly install Chime TTS via HACS or manually.\r\n2. [Add the Integration](https://nimroddolev.github.io/chime_tts/docs/quick-start/adding-the-integration) - Add Chime TTS to your Home Assistant instance.\r\n\r\n***\r\n\r\n## How Do I Use It?\r\n\r\n### Actions\r\n\r\nChime TTS adds 4 new actions to your Home Assistant instance: `chime_tts.say`, `chime_tts.say_url`, `chime_tts.replay` and `chime_tts.clear_cache`. Discover how you can use these actions and the features they offer:\r\n\r\n- [`chime_tts.say`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/): Play audio and TTS messages with various settings.\r\n- [`chime_tts.say_url`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say_url-action/): Generates a publicly accessible URL to the MP3 file generated by `chime_tts.say`.\r\n- [`chime_tts.replay`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/replay-action): Repeats the previous action call made to `chime_tts.say`.\r\n- [`chime_tts.clear_cache`](https://nimroddolev.github.io/chime_tts/docs/documentation/actions/clear_cache-action): Clear generated audio cache.\r\n\r\n### Notify Entities\r\nChime TTS adds a [notify platform](https://www.home-assistant.io/integrations/notify/): \"[chime_tts](https://nimroddolev.github.io/chime_tts/docs/documentation/notify)\", which allows you to create fully customised notify entries for use in your automations and scripts.\r\n\r\n***\r\n\r\n## Configuration \u0026 Documentation\r\n\r\nFor configuration, examples and documentation check out [the official Chime TTS site](https://nimroddolev.github.io/chime_tts).\r\n\r\n## Support and Discussion\r\n\r\nFor questions, suggestions, and community discussion about Chime TTS, visit our [Community Forum](https://community.home-assistant.io/t/chime-tts-play-audio-before-after-tts-audio-lag-free/578430).\r\n\r\n***\r\n\r\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=popout\r\n[forum]: https://community.home-assistant.io/t/chime-tts-play-audio-before-after-tts-audio-lag-free/578430\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimroddolev%2Fchime_tts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnimroddolev%2Fchime_tts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimroddolev%2Fchime_tts/lists"}