https://github.com/hasscc/hass-edge-tts
🗣️ Microsoft Edge TTS for Home Assistant, no need for app_key
https://github.com/hasscc/hass-edge-tts
custom-component home-assistant tts
Last synced: 22 days ago
JSON representation
🗣️ Microsoft Edge TTS for Home Assistant, no need for app_key
- Host: GitHub
- URL: https://github.com/hasscc/hass-edge-tts
- Owner: hasscc
- Created: 2021-09-27T12:04:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T21:58:34.000Z (11 months ago)
- Last Synced: 2024-05-22T22:47:02.363Z (11 months ago)
- Topics: custom-component, home-assistant, tts
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 306
- Watchers: 8
- Forks: 55
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 to `custom_components` folder in your HomeAssistant config folder
```shell
# Auto install via terminal shell
wget -O - https://hacs.vip/get | DOMAIN=edge_tts REPO_PATH=hasscc/hass-edge-tts ARCHIVE_TAG=main bash -
```
## Config
```yaml
# configuration.yaml
tts:
- platform: edge_tts
language: zh-CN # Default language or voice (Optional)
```
#### Configure default options:
```yaml
tts:
- platform: edge_tts
service_name: xiaomo_say # service: tts.xiaomo_say
language: zh-CN-XiaoxiaoNeural
volume: +10%
```
#### Supported languages
- [speaking languages](https://docs.microsoft.com/zh-CN/azure/cognitive-services/speech-service/speech-synthesis-markup?tabs=csharp#adjust-speaking-languages)
- [list of voices](https://github.com/hasscc/hass-edge-tts/blob/29587ecf05ecd9d40269e13d7bd37f7f7f70c874/custom_components/edge_tts/tts.py#L14-L314)
## Using
- [](https://my.home-assistant.io/redirect/developer_call_service/?service=tts.edge_tts_say)
- [REST API: /api/tts_get_url](https://www.home-assistant.io/integrations/tts#post-apitts_get_url)
### Options
- [`voice`](https://docs.microsoft.com/zh-CN/azure/cognitive-services/speech-service/speech-synthesis-markup?tabs=csharp#use-multiple-voices)
- [`pitch` / `rate` / `volume`](https://docs.microsoft.com/zh-CN/azure/cognitive-services/speech-service/speech-synthesis-markup?tabs=csharp#adjust-prosody)
> `style` / `styledegree` / `role` / `contour` are no longer supported ([#8](https://github.com/hasscc/hass-edge-tts/issues/8)).
### Basic example
```yaml
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
```yaml
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
```shell
curl -X POST -H "Authorization: Bearer " \
-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
```
## Thanks
- https://github.com/rany2/edge-tts
- https://github.com/ag2s20150909/TTS