Chime TTS 项目教程

Chime TTS 项目教程

chime_ttsA custom Home Assistant integration to play an audio file before and/or after text-to-speech (TTS) messages项目地址:https://gitcode.com/gh_mirrors/ch/chime_tts

1. 项目的目录结构及介绍

Chime TTS 是一个自定义的 Home Assistant 集成项目，用于在播放 TTS 音频通知之前播放铃声或通知音效，以消除音频延迟。以下是项目的目录结构及介绍：

chime_tts/
├── custom_components/
│   ├── chime_tts/
│   │   ├── __init__.py
│   │   ├── manifest.json
│   │   ├── services.yaml
│   │   ├── config_flow.py
│   │   ├── const.py
│   │   ├── helpers.py
│   │   ├── media_player.py
│   │   ├── notify.py
│   │   ├── options.py
│   │   ├── replay.py
│   │   ├── say.py
│   │   ├── say_url.py
│   │   ├── clear_cache.py
│   │   ├── translations/
│   │   │   ├── en.json
│   │   │   ├── zh.json
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   ├── feature_request.md
│   │   └── ...
│   ├── workflows/
│   │   ├── ci.yml
│   │   └── ...
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── ...

• custom_components/chime_tts/: 包含 Chime TTS 集成的核心文件。
  • __init__.py: 初始化文件。
  • manifest.json: 项目的元数据文件。
  • services.yaml: 服务配置文件。
  • config_flow.py: 配置流程文件。
  • const.py: 常量定义文件。
  • helpers.py: 辅助函数文件。
  • media_player.py: 媒体播放器相关文件。
  • notify.py: 通知相关文件。
  • options.py: 选项配置文件。
  • replay.py: 重放服务文件。
  • say.py: 播放音频和 TTS 消息的服务文件。
  • say_url.py: 生成公开访问 URL 的服务文件。
  • clear_cache.py: 清除缓存的服务文件。
  • translations/: 多语言翻译文件。
• .github/: GitHub 相关配置文件。
  • ISSUE_TEMPLATE/: 问题模板文件。
  • workflows/: CI/CD 工作流文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

Chime TTS 项目的启动文件主要是 custom_components/chime_tts/__init__.py。该文件负责初始化 Chime TTS 集成，并注册相关服务。

# custom_components/chime_tts/__init__.py

import logging
from homeassistant.core import HomeAssistant
from .const import DOMAIN

_LOGGER = logging.getLogger(__name__)

async def async_setup(hass: HomeAssistant, config: dict):
    """Set up the Chime TTS component."""
    hass.data.setdefault(DOMAIN, {})
    # Register services
    hass.helpers.service.async_register_admin_service(
        DOMAIN, 'say', say.async_handle_say_service
    )
    hass.helpers.service.async_register_admin_service(
        DOMAIN, 'say_url', say_url.async_handle_say_url_service
    )
    hass.helpers.service.async_register_admin_service(
        DOMAIN, 'replay', replay.async_handle_replay_service
    )
    hass.helpers.service.async_register_admin_service(
        DOMAIN, 'clear_cache', clear_cache.async_handle_clear_cache_service
    )
    return True

3. 项目的配置文件介绍

Chime TTS 项目的配置文件主要是

chime_ttsA custom Home Assistant integration to play an audio file before and/or after text-to-speech (TTS) messages项目地址:https://gitcode.com/gh_mirrors/ch/chime_tts