]> git.basschouten.com Git - openhab-addons.git/commitdiff
[pollytts] Small changes in configuration in documentation (#12086)
authorlolodomo <lg.hc@free.fr>
Sat, 22 Jan 2022 09:45:01 +0000 (10:45 +0100)
committerGitHub <noreply@github.com>
Sat, 22 Jan 2022 09:45:01 +0000 (10:45 +0100)
Signed-off-by: Laurent Garnier <lg.hc@free.fr>
bundles/org.openhab.voice.pollytts/README.md

index 7ff60ddbee0b18db737dc2bcfabda958889fc979..ec28c16483a4604982ce580d4b13b1531c18eb3b 100644 (file)
@@ -21,7 +21,7 @@ Within the AWS console, you can create access keys for your AWS account to acces
 
 To use the service you will need the **access key**, **secret key** and **server region**.
 
-## Service Configuration
+## Configuration
 
 The following configurations can be edited using the "Polly Text-to-Speech" settings in the UI:
 
@@ -29,11 +29,10 @@ The following configurations can be edited using the "Polly Text-to-Speech" sett
 * **Secret Key** - The AWS credentials secret key (required).
 * **Service Region** - The service region used for accessing Polly (required). To reduce latency select the region closest to you. E.g. "eu-west-1" (see [regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region))
 
-The PollyTTS service caches audio files from previous requests.
-This reduces traffic, improves performance, reduces the number of requests and provides offline functionality.
-
 * **Cache Expiration** - Cache expiration in days.
 
+The PollyTTS service caches audio files from previous requests.
+This reduces traffic, improves performance, reduces the number of requests and provides offline functionality.
 When cache files are used their time stamps are updated, unused files are purged if their time stamp exceeds the specified age.
 The default value of 0 disables this functionality.
 A value of 365 removes files that have been unused for a year.
@@ -44,21 +43,18 @@ Use "default" to select the system default audio format.
 The default audio format can be overriden with the value "mp3" or "ogg".
 
 
-### Service Configuration via Text files
-
-Create a new file in `$OPENHAB_ROOT/conf/services` named `pollytts.cfg`
+In case you would like to setup the service via a text file, create a new file in `$OPENHAB_ROOT/conf/services` named `pollytts.cfg`
 
 It's contents should look similar to:
 
 ```
-org.openhab.voice.pollytts:accessKey=ACCESS_KEY_ID
+org.openhab.voice.pollytts:accessKey=ACCESS_KEY
 org.openhab.voice.pollytts:secretKey=SECRET_KEY
-org.openhab.voice.pollytts:serviceRegion=SERVICE_REGION
-org.openhab.voice.pollytts:cacheExpiration=EXPIRATION_IN_DAYS
+org.openhab.voice.pollytts:serviceRegion=eu-west-1
+org.openhab.voice.pollytts:cacheExpiration=0
+org.openhab.voice.pollytts:audioFormat=default
 ```
 
-These have the same meanings as described in the **Service Configuration** block above.
-
 ## Rule Examples
 
 ```