mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-10 23:22:02 +01:00
84 lines
4.6 KiB
Markdown
84 lines
4.6 KiB
Markdown
# Google Cloud Text-to-Speech
|
||
|
||
Google Cloud TTS Service uses the non-free Google Cloud Text-to-Speech API to convert text or Speech Synthesis Markup Language (SSML) input into audio data of natural human speech.
|
||
It provides multiple voices, available in different languages and variants and applies DeepMind’s groundbreaking research in WaveNet and Google’s powerful neural networks.
|
||
The implementation caches the converted texts to reduce the load on the API and make the conversion faster.
|
||
You can find them in the `$OPENHAB_USERDATA/cache/org.openhab.voice.googletts` folder.
|
||
Be aware, that using this service may incur cost on your Google Cloud account.
|
||
You can find pricing information on the [documentation page](https://cloud.google.com/text-to-speech/#pricing-summary).
|
||
|
||
## Table of Contents
|
||
|
||
<!-- MarkdownTOC -->
|
||
|
||
* [Obtaining Credentials](#obtaining-credentials)
|
||
* [Configuration](#configuration)
|
||
* [Voice Configuration](#voice-configuration)
|
||
|
||
<!-- /MarkdownTOC -->
|
||
|
||
## Obtaining Credentials
|
||
|
||
Before you can integrate this service with your Google Cloud Text-to-Speech, you must have a Google API Console project:
|
||
|
||
* Select or create a GCP project. [link](https://console.cloud.google.com/cloud-resource-manager)
|
||
* Make sure that billing is enabled for your project. [link](https://cloud.google.com/billing/docs/how-to/modify-project)
|
||
* Enable the Cloud Text-to-Speech API. [link](https://console.cloud.google.com/apis/dashboard)
|
||
* Set up authentication:
|
||
* Go to the "APIs & Services" -> "Credentials" page in the GCP Console and your project. [link](https://console.cloud.google.com/apis/credentials)
|
||
* From the "Create credentials" drop-down list, select "OAuth client ID".
|
||
* Select application type "Web application" and enter a name into the "Name" field.
|
||
* Add "https://www.google.com" to the "Authorized redirect URIs".
|
||
* Click Create. A pop-up appears, showing your "client ID" and "client secret".
|
||
|
||
## Configuration
|
||
|
||
Using your favorite configuration UI to edit **Settings / Other Services - Google Cloud Text-to-Speech** and set:
|
||
|
||
* **Client Id** - Google Cloud Platform OAuth 2.0-Client Id.
|
||
* **Client Secret** - Google Cloud Platform OAuth 2.0-Client Secret.
|
||
* **Authorization Code** - This code is used once for retrieving the Google Cloud Platform access and refresh tokens.
|
||
**Please go to your browser ...**
|
||
[https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/cloud-platform&access_type=offline&prompt=consent&include_granted_scopes=true&response_type=code&redirect_uri=https://www.google.com&client_id=<clientId>](https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/cloud-platform&access_type=offline&prompt=consent&include_granted_scopes=true&response_type=code&redirect_uri=https://www.google.com&client_id=<clientId>) (replace `<clientId>` by your Client Id)
|
||
**... to generate an authorization code and paste it here**.
|
||
After your browser has been redirected to https://www.google.com, the authorization code will be set in the browser URL as value of the "code" URL query parameter.
|
||
After initial authorization, this code is not needed anymore.
|
||
It is recommended to clear this configuration parameter afterwards.
|
||
* **Pitch** - The pitch of selected voice, up to 20 semitones.
|
||
* **Volume Gain** - The volume of the output between 16dB and -96dB.
|
||
* **Speaking Rate** - The speaking rate can be 4x faster or slower than the normal rate.
|
||
* **Purge Cache** - Purges the cache e.g. after testing different voice configuration parameters.
|
||
|
||
When enabled the cache is purged once.
|
||
Make sure to disable this setting again so the cache is maintained after restarts.
|
||
|
||
In case you would like to setup the service via a text file, create a new file in `$OPENHAB_ROOT/conf/services` named `googletts.cfg`
|
||
|
||
Its contents should look similar to:
|
||
|
||
```
|
||
org.openhab.voice.googletts:clientId=ID
|
||
org.openhab.voice.googletts:clientSecret=SECRET
|
||
org.openhab.voice.googletts:authcode=XXXXX
|
||
org.openhab.voice.googletts:pitch=0
|
||
org.openhab.voice.googletts:volumeGain=0
|
||
org.openhab.voice.googletts:speakingRate=1
|
||
org.openhab.voice.googletts:purgeCache=false
|
||
```
|
||
|
||
### Default Text-to-Speech and Voice Configuration
|
||
|
||
You can setup your preferred default Text-to-Speech and default voice in the UI:
|
||
|
||
* Go to **Settings**.
|
||
* Edit **System Services - Voice**.
|
||
* Set **Google Cloud** as **Default Text-to-Speech**.
|
||
* Choose your preferred **Default Voice** for your setup.
|
||
|
||
In case you would like to setup these settings via a text file, you can edit the file `runtime.cfg` in `$OPENHAB_ROOT/conf/services` and set the following entries:
|
||
|
||
```
|
||
org.openhab.voice:defaultTTS=googletts
|
||
org.openhab.voice:defaultVoice=googletts:XXX
|
||
```
|