Microsoft Edge TTS for Home Assistant
This component is based on the TTS service of Microsoft Edge browser, no need to apply for app_key
.
Install
Download and copy
custom_components/edge_tts
folder tocustom_components
folder in your HomeAssistant config folder
# Auto install via terminal shell
wget -O - https://raw.githubusercontent.com/hasscc/get/main/get | DOMAIN=edge_tts REPO_PATH=hasscc/hass-edge-tts ARCHIVE_TAG=main bash -
# Or
wget -O - https://ghproxy.com/raw.githubusercontent.com/hasscc/get/main/get | HUB_DOMAIN=ghproxy.com/github.com DOMAIN=edge_tts REPO_PATH=hasscc/hass-edge-tts ARCHIVE_TAG=main bash -
Config
# configuration.yaml
tts:
- platform: edge_tts
language: zh-CN # Default language or voice (Optional)
Configure default options:
tts:
- platform: edge_tts
service_name: xiaomo_say # service: tts.xiaomo_say
language: zh-CN-XiaoxiaoNeural
volume: +10%
Supported languages
Using
Options
pitch
is no longer supported (#24).
style
/styledegree
/role
/contour
are no longer supported (#8).
Basic example
service: tts.edge_tts_say
data:
entity_id: media_player.your_player_entity_id
message: Hello
language: zh-CN-XiaoyiNeural # Language or voice (Optional)
Full example
service: tts.edge_tts_say
data:
entity_id: media_player.your_player_entity_id
message: 吃葡萄不吐葡萄皮,不吃葡萄倒吐葡萄皮
language: zh-CN
cache: true
options:
voice: zh-CN-XiaoyiNeural
rate: +0%
volume: +10%
Curl example
curl -X POST -H "Authorization: Bearer <ACCESS TOKEN>" \
-H "Content-Type: application/json" \
-d '{"platform": "edge_tts", "message": "欢迎回家", "language": "zh-CN-XiaoyiNeural", "cache": true, "options": {"volume": "+10%"}}' \
http://home-assistant.local:8123/api/tts_get_url