Skip to main content

1. Installation

Adding the Chime TTS Integration​

The easiest way to install Chime TTS is though HACS (the Home Assistant Community Store), but you can also add the files manually:

  1. If you don't have HACS installed yet, follow the official installation guide.

  2. Add the Chime TTS repository to HACS by clicking here:

  3. Click ADD:

  1. Click DOWNLOAD:

  2. Restart Home Assistant.

Or:

Option #2: Manual Installation​

  1. Using your file browser of choice open the directory for your HA configuration (where you find configuration.yaml).

  2. Create a custom_components directory if it does not already exist.

  3. Add a subdirectory inside custom_components named chime_tts.

  4. Download all the files from the custom_components/chime_tts/ directory in this repository.

  5. Place them into the new custom_components/chime_tts directory you created.

  6. Restart Home Assistant.

First run​

After restart, add Chime TTS in Settings → Devices & services → Add integration. Then open Chime TTS from the Home Assistant sidebar to select TTS defaults and manage chimes, Chime Sets, and Notification Profiles.

Try a first announcement from Developer Tools:

action: chime_tts.say
target:
  entity_id: media_player.kitchen
data:
  chime_path: bells
  message: "Welcome home"

Continue with Configuration and Chimes.

Beta Versions​

To install beta versions of Chime TTS, which may include new features, bugfixes and enhanced performance optimizations, follow these steps:

  1. Open the Chime TTS repository in HACS

  2. Click on the ⋮ button in the top right

  3. Select the ⤓ Download option

  4. Click on Need a different version?

  5. From the Releases drop-down list, select a beta (pre-release) version

  6. Click Download

  7. Restart Home Assistant