diff --git a/README.md b/README.md index 5417bdd..075ac42 100644 --- a/README.md +++ b/README.md @@ -1,408 +1,129 @@ -![Logo](admin/sayit.png) -yunkong2 sayit adapter -================= -[![NPM version](http://img.shields.io/npm/v/yunkong2.sayit.svg)](https://www.npmjs.com/package/yunkong2.sayit) -[![Downloads](https://img.shields.io/npm/dm/yunkong2.sayit.svg)](https://www.npmjs.com/package/yunkong2.sayit) - -[![NPM](https://nodei.co/npm/yunkong2.sayit.png?downloads=true)](https://nodei.co/npm/yunkong2.sayit/) - - -SayIt Adapter can convert text to speech and play it on some device. - -## Configuration -Actual following outputs are supported: - -- *Browser* - the text will be played by browser with opened yunkong2.vis page. It is supported almost by every desktop browser and by few mobily Browsers. - - -- *[Home24- MediaPlayer](http://www.home-24.net/index.php?app=media)* - the text will be sent and played to the Android device with Home24 - MediaPlayer installed. For this will be used build in Android text to speech engine. The port cannot be changed and set to 50000. - - -- *Home24 - MediaPlayer and [FTP Server](https://play.google.com/store/apps/details?id=lutey.FTPServer)* - the text will be sent and played on the Android device with Home24 - MediaPlayer installed. For this will be used the Google text to speech engine. Generated mp3 file will be copied over FTP to android device and played with Home24 - MediaPlayer. - Both apps have to have same home directories. (E.g. root directory of \"sd card\"). - - -- *System* - the text will be played by OS, where the yunkong2 adapter runs. Following OS are supported: Windows, linux, Mac OSx. - - -- *Windows engine* - the text will be played by windows, where the sayIt adapter runs. For this will be used windows text to speech engine, that should be preconfigured by user. You can check [here](http://windows.microsoft.com/en-us/windows/setting-speech-options#1TC=windows-7) how to setup it. - - -- *Sonos* - play text on sonos device. Be sure the Web Adapter is enabled. It is required to enable SONOS to read the generated mp3 files. - -- *Chromecast* - play text on Chromecast device. - -- *MPD* - play text on Music Player Daemon. Use only **http** for web adapter, don't use https. - -To enable the text to speech on RaspberryPI or linux system call one time following command ```sudo apt-get -y install mpg321``` to install mpg321. - -The mp3/wav files can be played to by writing its name into the object. (e.g. "/vis.0/main/img/door-bell.mp3") - -The file must be first loaded. - -### TTS engines -online: -- Google: English, German, Russian, Italian, Spanish, French -- Yandex: Russian - To use Yandex voices you must request the API key here: [https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/About-docpage/](https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/About-docpage/). -- Ivona: English, German, Russian, Italian, Spanish, French, Dansk, Welsh, Icelandic, Dutch, Polish, Portuguese, Romanian, Swedish, Turkish - To use Amazon(Ivona) voices you need to get access key and secret key [here](http://www.ivona.com/us/for-business/speech-cloud/). -- Cloud: - To use Cloud voices you need configured cloud adapter. (It can be disabled, but must be configured). This service use AWS Polly and it can be used directly. -- Amazon Web Services Polly: - To use AWS Polly voices you need to create access key and secret key [here](https://console.aws.amazon.com/iam/home). The Amazon documentation can you find [here](http://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html). - -offline: -- PicoTTS (linux only): English, German, Italian, Spanish, French - For PicoTTS it is necessary to install the following packages: libttspico-utils and lame. - Installation command: 'sudo apt-get install libttspico-utils lame' - -### Cloud and Amazon Web Services Polly text formatting -You can format your text with [Speech Synthesis Markup Language](http://docs.aws.amazon.com/polly/latest/dg/ssml.html). - -Most useful features: -- ``````- make a pause for x seconds (max 10 seconds). -- ``` big ``` - make an emphasis on some word. -- ```I am speaking this``` - control speed and volume parameters. -- ```12345``` - say every digit separately. - -More [info](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference). - -### System command -If you have some program, that can play audio files locally or somewhere else, you can write this command here. E.g. - -```myCustomPlayer --option``` - -If **System** output is selected, the sayit adapter will execute following command on local system: - -```myCustomPlayer --option /opt/yunkong2/node_modules/yunkong2.sayit/say.mp3``` - -If file name must stay somewhere in the middle you can use *%s* to specify where the file name must be placed: - -```myCustomPlayer --option "%s" > /dev/null``` - -sayIt will make ```myCustomPlayer --option "/opt/yunkong2/node_modules/yunkong2.sayit/say.mp3" > /dev/null``` from it. - -## Usage -SayIt adapter cannot be used alone. It must be controlled from javascript adapter or from "vis" with specific widget. -After creation of adapter instance will can find following objects: -- sayit.N.tts.text: Phrase to be spoken. -- sayit.N.tts.volume: volume which will be used by playing of the phrase. -- sayit.N.tts.playing: true if text is now playing and false if not. Supported only for "windows" and "system" play mode. -- sayit.N.tts.cachetext: Phrase to be cached and then it can be used without internet. - E.g. you can enter here manually "No internet" and if ping to google.com is negative, write "No internet" to "tts.text" and it will pronounced. Of course cache must be enabled. - -State **tts.text** supports extended syntax, so the langugage/engine and volume can be defined together with text. It is used to enable multi-language text2speech engines. -E.g. if adapter has engine "Google-english", it is possible with phrase ```de:Sag es``` to force to use Google-Deustch speech engine. - -With ```ru;75;Погода хорошая``` we can force to use russian language and volume 75%. - -You can specify the volume of announcement in percent from current or given volume (not from maximal). E.g. if command is ```de;75;Gutes Wetter```and "announce volume" is 50%, the announce will be played with volume 38% from 100% possible. - -The system command to play the mp3 file can be specified too. If you leave it blank, the default settings will be used: windows - cmdmp3.exe, OSX - /usr/bin/afplay, linux - mpg321 or omxplayer (recommended). - -To install omxplayer write ```sudo apt-get install omxplayer``` or write ```sudo apt-get install mpg321``` to install mpg321. - -**Note:** The default announce selection will be possible only after start of the instance. - -### Engines -Following values for engines are possible: - -#### Google -- **en** - English -- **de** - Deutsch -- **ru** - Русский -- **it** - Italiano -- **es** - Espaniol -- **fr** - Français - -#### Yandex -- **ru_YA:Yandex** - Русский - -#### Amazon polly via cloud -- **ru-RU_CLOUD_Female** - Русский - Татьяна -- **ru-RU_CLOUD_Male** - Русский - Максим -- **de-DE_CLOUD_Female** - Deutsch - Marlene -- **de-DE_CLOUD_Male** - Deutsch - Hans -- **en-US_CLOUD_Female** - en-US - Female - Salli -- **en-US_CLOUD_Male** - en-US - Male - Joey -- **da-DK_CLOUD_Female** - da-DK - Female - Naja -- **da-DK_CLOUD_Male** - da-DK - Male - Mads -- **en-AU_CLOUD_Female** - en-AU - Female - Nicole -- **en-AU_CLOUD_Male** - en-AU - Male - Russell -- **en-GB_CLOUD_Female_Amy** - en-GB - Female - Amy -- **en-GB_CLOUD_Male** - en-GB - Male - Brian -- **en-GB_CLOUD_Female_Emma** - en-GB - Female - Emma -- **en-GB-WLS_CLOUD_Female** - en-GB-WLS - Female - Gwyneth -- **en-GB-WLS_CLOUD_Male** - en-GB-WLS - Male - Geraint -- **cy-GB_CLOUD_Female** - cy-GB - Female - Gwyneth -- **cy-GB_CLOUD_Male** - cy-GB - Male - Geraint -- **en-IN_CLOUD_Female** - en-IN - Female - Raveena -- **en-US_CLOUD_Male_Chipmunk** - en-US - Male - Chipmunk -- **en-US_CLOUD_Male_Eric** - en-US - Male - Eric -- **en-US_CLOUD_Female_Ivy** - en-US - Female - Ivy -- **en-US_CLOUD_Female_Jennifer** - en-US - Female - Jennifer -- **en-US_CLOUD_Male_Justin** - en-US - Male - Justin -- **en-US_CLOUD_Female_Kendra** - en-US - Female - Kendra -- **en-US_CLOUD_Female_Kimberly** - en-US - Female - Kimberly -- **es-ES_CLOUD_Female** - es-ES - Female - Conchita -- **es-ES_CLOUD_Male** - es-ES - Male - Enrique -- **es-US_CLOUD_Female** - es-US - Female - Penelope -- **es-US_CLOUD_Male** - es-US - Male - Miguel -- **fr-CA_CLOUD_Female** - fr-CA - Female - Chantal -- **fr-FR_CLOUD_Female** - fr-FR - Female - Celine -- **fr-FR_CLOUD_Male** - fr-FR - Male - Mathieu -- **is-IS_CLOUD_Female** - is-IS - Female - Dora -- **is-IS_CLOUD_Male** - is-IS - Male - Karl -- **it-IT_CLOUD_Female** - it-IT - Female - Carla -- **it-IT_CLOUD_Male** - it-IT - Male - Giorgio -- **nb-NO_CLOUD_Female** - nb-NO - Female - Liv -- **nl-NL_CLOUD_Female** - nl-NL - Female - Lotte -- **nl-NL_CLOUD_Male** - nl-NL - Male - Ruben -- **pl-PL_CLOUD_Female_Agnieszka** - pl-PL - Female - Agnieszka -- **pl-PL_CLOUD_Male_Jacek** - pl-PL - Male - Jacek -- **pl-PL_CLOUD_Female_Ewa** - pl-PL - Female - Ewa -- **pl-PL_CLOUD_Male_Jan** - pl-PL - Male - Jan -- **pl-PL_CLOUD_Female** - pl-PL - Female - Maja -- **pt-BR_CLOUD_Female** - pt-BR - Female - Vitoria -- **pt-BR_CLOUD_Male** - pt-BR - Male - Ricardo -- **pt-PT_CLOUD_Male** - pt-PT - Male - Cristiano -- **pt-PT_CLOUD_Female** - pt-PT - Female - Ines -- **ro-RO_CLOUD_Female** - ro-RO - Female - Carmen -- **sv-SE_CLOUD_Female** - sv-SE - Female - Astrid -- **tr-TR_CLOUD_Female** - tr-TR - Female - Filiz - -#### Pico TTS -- **en-US** - Englisch US -- **en-GB** - Englisch GB -- **de-DE** - Deutsch -- **it-IT** - Italiano -- **es-ES** - Espaniol -- **fr-FR** - Français - -#### Amazon polly direct -- **(ru-RU_AP_Female)** - Русский - Татьяна -- **(ru-RU_AP_Male)** - Русский - Максим -- **(de-DE_AP_Female)** - Deutsch - Marlene -- **(de-DE_AP_Male)** - Deutsch - Hans -- **(en-US_AP_Female)** - en-US - Female - Salli -- **(en-US_AP_Male)** - en-US - Male - Joey -- **(da-DK_AP_Female)** - da-DK - Female - Naja -- **(da-DK_AP_Male)** - da-DK - Male - Mads -- **(en-AU_AP_Female)** - en-AU - Female - Nicole -- **(en-AU_AP_Male)** - en-AU - Male - Russell -- **(en-GB_AP_Female_Amy)** - en-GB - Female - Amy -- **(en-GB_AP_Male)** - en-GB - Male - Brian -- **(en-GB_AP_Female_Emma)** - en-GB - Female - Emma -- **(en-GB-WLS_AP_Female)** - en-GB-WLS - Female - Gwyneth -- **(en-GB-WLS_AP_Male)** - en-GB-WLS - Male - Geraint -- **(cy-GB_AP_Female)** - cy-GB - Female - Gwyneth -- **(cy-GB_AP_Male)** - cy-GB - Male - Geraint -- **(en-IN_AP_Female)** - en-IN - Female - Raveena -- **(en-US_AP_Male_Chipmunk)** - en-US - Male - Chipmunk -- **(en-US_AP_Male_Eric)** - en-US - Male - Eric -- **(en-US_AP_Female_Ivy)** - en-US - Female - Ivy -- **(en-US_AP_Female_Jennifer)** - en-US - Female - Jennifer -- **(en-US_AP_Male_Justin)** - en-US - Male - Justin -- **(en-US_AP_Female_Kendra)** - en-US - Female - Kendra -- **(en-US_AP_Female_Kimberly)** - en-US - Female - Kimberly -- **(es-ES_AP_Female)** - es-ES - Female - Conchita -- **(es-ES_AP_Male)** - es-ES - Male - Enrique -- **(es-US_AP_Female)** - es-US - Female - Penelope -- **(es-US_AP_Male)** - es-US - Male - Miguel -- **(fr-CA_AP_Female)** - fr-CA - Female - Chantal -- **(fr-FR_AP_Female)** - fr-FR - Female - Celine -- **(fr-FR_AP_Male)** - fr-FR - Male - Mathieu -- **(is-IS_AP_Female)** - is-IS - Female - Dora -- **(is-IS_AP_Male)** - is-IS - Male - Karl -- **(it-IT_AP_Female)** - it-IT - Female - Carla -- **(it-IT_AP_Male)** - it-IT - Male - Giorgio -- **(nb-NO_AP_Female)** - nb-NO - Female - Liv -- **(nl-NL_AP_Female)** - nl-NL - Female - Lotte -- **(nl-NL_AP_Male)** - nl-NL - Male - Ruben -- **(pl-PL_AP_Female_Agnieszka)** - pl-PL - Female - Agnieszka -- **(pl-PL_AP_Male_Jacek)** - pl-PL - Male - Jacek -- **(pl-PL_AP_Female_Ewa)** - pl-PL - Female - Ewa -- **(pl-PL_AP_Male_Jan)** - pl-PL - Male - Jan -- **(pl-PL_AP_Female)** - pl-PL - Female - Maja -- **(pt-BR_AP_Female)** - pt-BR - Female - Vitoria -- **(pt-BR_AP_Male)** - pt-BR - Male - Ricardo -- **(pt-PT_AP_Male)** - pt-PT - Male - Cristiano -- **(pt-PT_AP_Female)** - pt-PT - Female - Ines -- **(ro-RO_AP_Female)** - ro-RO - Female - Carmen -- **(sv-SE_AP_Female)** - sv-SE - Female - Astrid -- **(tr-TR_AP_Female)** - tr-TR - Female - Filiz - -## Changelog -### 1.7.1 (2018-09-19) -* (BuZZy1337) fixed error in Blockly-Block - -### 1.7.0 (2018-06-08) -* (bluefox) Ivona removed -* (bluefox) Error was fixed by upload of file to FTP -* (bluefox) admin3 - -### 1.6.8 (2018-04-11) -* (BuZZy1337) Generate separate mp3 files for each instance. -* Fixes [Issue#34](https://git.spacen.net/yunkong2/yunkong2.sayit/issues/34) -* (BuZZy1337) Always upload mp3 files to the state sayit.X.tts.mp3 - -### 1.6.7 (2018-02-05) -* (Apollon77) Remove unneeded logging -* (bondrogeen) Admin3 Fixes - -### 1.6.6 (2017-11-27) -* (angelnu) Wait for Google Home announcement to complete - -### 1.6.5 (2017-11-04) -* (bluefox) Fix cloud .pro - -### 1.6.4 (2017-10-18) -* (bluefox) Fix system commands - -### 1.6.3 (2017-10-04) -* (bluefox) Code refactoring -* (bluefox) Add google home as output -* (bluefox) Remove ivona because not more supported - -### 1.5.2 (2017-03-09) -* (bluefox) Catch error if some directory in mp3 folder - -### 1.5.1 (2017-02-15) -* (bluefox) Fix blockly language - -### 1.5.0 (2017-01-27) -* (DarkChaos) Add AWS Polly as source -* (bluefox) Add cloud as source - -### 1.4.0 (2017-01-16) -* (bluefox) fix install problem -* (bluefox) add PicoTTS as source - -### 1.3.3 (2017-01-13) -* (bluefox) show only installed instances in blockly - -### 1.3.2 (2017-01-10) -* (angelnu) changes for new chromecast tts - -### 1.3.1 (2016-12-27) -* (bluefox) small fix of config dialog -* (AirKing555) Fix Volume change - -### 1.3.0 (2016-12-20) -* (instalator) add mpd - -### 1.2.1 (2016-10-31) -* (bluefox) Fix cache - -### 1.2.0 (2016-10-28) -* (bluefox) Finish sayit - -### 1.1.3 (2016-10-24) -* (bluefox) Fix changing of engine - -### 1.1.2 (2016-10-20) -* (bluefox) Add omxplayer option - -### 1.0.1 (2016-10-12) -* (bluefox) support of blockly - -### 1.0.0 (2016-05-14) -* (bluefox) Make the type of mp3 as file - -### 0.3.16 (2015-12-26) -* (Vegetto) Support for Chromecast devices - -### 0.3.16 (2015-12-26) -* (bluefox) enable play of mp3 files from disk - -### 0.3.15 (2015-11-10) -* (bluefox) fill default settings by first start - -### 0.3.14 (2015-11-01) -* (bluefox) fix error with sayItWindows - -### 0.3.13 (2015-10-27) -* (bluefox) fix error with sayItSystem - -### 0.3.12 (2015-10-06) -* (bluefox) fix error if received mp3 file is too short -* (bluefox) try to implement cache datapoint (you can use sayit.0.tts.cachetext to create cache for phrases and use sayit without internet) - -### 0.3.11 (2015-08-03) -* (bluefox) change google requests from http to https - -### 0.3.10 (2015-07-26) -* (bluefox) add new voice Russian-Maxim -* (bluefox) fix error with mp24ftp - -### 0.3.9 (2015-07-09) -* (bluefox) fix error by mediaplayer24 - -### 0.3.8 (2015-06-09) -* (bluefox) make the volume for announce configurable -* (bluefox) make the command for "system" configurable - -### 0.3.7 (2015-05-28) -* (bluefox) fix volume for announce -* (bluefox) support of play files from internal filesystem, like "/sayit.0/tts.userfiles/myGong.mp3" - -### 0.3.6 (2015-03-24) -* (bluefox) fix error with volume by sonos - -### 0.3.5 (2015-03-22) -* (bluefox) fix error in announcement - -### 0.3.4 (2015-03-20) -* (bluefox) fix error in announcement - -### 0.3.3 (2015-03-20) -* (bluefox) enable announcement - -### 0.3.2 (2015-03-16) -* (bluefox) clear cache if engine changed - -### 0.3.1 (2015-03-15) -* (bluefox) fix small error with log - -### 0.3.0 (2015-03-08) -* (bluefox) add ivona/Amazon voices - -### 0.2.2 (2015-03-08) -* (bluefox) fix error by buffering of non-generated texts. - -### 0.2.1 (2015-03-07) -* (bluefox) fix error by buffering of non-generated texts. - -### 0.2.0 (2015-03-02) -* (bluefox) add yandex-russian support - -### 0.1.0 (2015-03-02) -* (bluefox) queue texts - -### 0.0.1 (2015-02-06) -* (bluefox) initial commit - -## License - -The MIT License (MIT) - -Copyright (c) 2014-2017, bluefox - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +![Logo](admin/sayit.png) +yunkong2 sayit adapter +SayIt Adapter可以将文本转换为语音并在某些设备上播放。 + + +## 配置 + +- *Browser* - 浏览器 - 文本将由浏览器在打开的iobroker.vis页面上播放。它几乎被每个桌面浏览器和少数mobily浏览器支持。 + +- *[Home24- MediaPlayer](http://www.home-24.net/index.php?app=media)* - 文本将被发送并播放到安装了Home24 - MediaPlayer的Android设备。为此将用于构建Android文本到语音引擎。端口无法更改并设置为50000。 + +- *Home24 - MediaPlayer and [FTP Server](https://play.google.com/store/apps/details?id=lutey.FTPServer)* - 将在安装了Home24 - MediaPlayer的Android设备上发送和播放文本。对于这将使用谷歌文本到语音引擎。生成的mp3文件将通过FTP复制到Android设备并与Home24 - MediaPlayer一起播放。两个应用程序必须具有相同的主目录。（例如“sd card”的根目录）。 + +- *System* - 文本将由运行yongkong2适配器的OS播放。支持以下操作系统：Windows，Linux，Mac OSx。 + +- *Windows engine* - the text will be played by windows, where the sayIt adapter runs. For this will be used windows text to speech engine, that should be preconfigured by user. You can check [here](http://windows.microsoft.com/en-us/windows/setting-speech-options#1TC=windows-7) how to setup it. + + +- *Sonos* - 在sonos设备上播放文本。确保已启用Web Adaptor。需要启用SONOS才能读取生成的mp3文件。 + +- *Chromecast* - play text on Chromecast device. + +- *MPD* - 在音乐播放器守护程序上播放文本。仅使用http作为Web适配器，不要使用https。 + +要在RaspberryPI或linux系统上启用文本到语音，请按照以下命令调用以安装mpg321。 + +```sudo apt-get -y install mpg321``` + +mp3 / wav文件可以通过将其名称写入对象来播放。（例如“/vis.0/main/img/door-bell.mp3”） + +必须首先加载该文件。 + + +## 用法 + +SayIt适配器不能单独使用。它必须通过javascript适配器或来自特定小部件的“vis”进行控制。创建适配器实例后，可以找到以下对象： + +sayit.N.tts.text： +要说的短语。 + +sayit.N.tts.volume：播放短语将使用的音量。 + +sayit.N.tts.playing：如果正在播放文本则为true，否则为false。仅支持“windows”和“system”播放模式。 + +sayit.N.tts.cachetext：要缓存的短语然后可以在没有互联网的情况下使用。例如，您可以手动输入“无互联网”，如果ping到google.com是否定的，请将“No internet”写入“tts.text”，它将发音。当然，必须启用缓存。 +State tts.text支持扩展语法，因此langugage / engine和volume可以与文本一起定义。它用于启用多语言text2speech引擎。例如，如果适配器具有引擎“Google-english”，则可以使用短语de:Sag es来强制使用Google-Deustch语音引擎。 + + +您可以从当前或给定的卷（而不是从最大值）指定公告的百分比。例如，如果命令是de;75;Gutes Wetter并且“宣布音量”是50％，则宣布将从100％可能播放38％的音量。 + +也可以指定播放mp3文件的系统命令。如果将其留空，将使用默认设置：windows - cmdmp3.exe，OSX - / usr / bin / afplay，linux - mpg321或omxplayer（推荐）。 + +安装omxplayer写入sudo apt-get install omxplayer或写入sudo apt-get install mpg321以安装mpg321。 + +注意：只有在实例启动后才能进行默认的通知选择。 + + +### TTS engines +online: +- Google: English, German, Russian, Italian, Spanish, French +- Yandex: Russian + To use Yandex voices you must request the API key here: [https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/About-docpage/](https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/About-docpage/). +- Ivona: English, German, Russian, Italian, Spanish, French, Dansk, Welsh, Icelandic, Dutch, Polish, Portuguese, Romanian, Swedish, Turkish + To use Amazon(Ivona) voices you need to get access key and secret key [here](http://www.ivona.com/us/for-business/speech-cloud/). +- Cloud: + To use Cloud voices you need configured cloud adapter. (It can be disabled, but must be configured). This service use AWS Polly and it can be used directly. +- Amazon Web Services Polly: + To use AWS Polly voices you need to create access key and secret key [here](https://console.aws.amazon.com/iam/home). The Amazon documentation can you find [here](http://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html). + +offline: +- PicoTTS (linux only): English, German, Italian, Spanish, French + For PicoTTS it is necessary to install the following packages: libttspico-utils and lame. + Installation command: 'sudo apt-get install libttspico-utils lame' + +### Cloud and Amazon Web Services Polly text formatting +You can format your text with [Speech Synthesis Markup Language](http://docs.aws.amazon.com/polly/latest/dg/ssml.html). + +Most useful features: +- ``````- make a pause for x seconds (max 10 seconds). +- ``` big ``` - make an emphasis on some word. +- ```I am speaking this``` - control speed and volume parameters. +- ```12345``` - say every digit separately. + +More [info](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference). + +### System command +If you have some program, that can play audio files locally or somewhere else, you can write this command here. E.g. + +```myCustomPlayer --option``` + +If **System** output is selected, the sayit adapter will execute following command on local system: + +```myCustomPlayer --option /opt/yunkong2/node_modules/yunkong2.sayit/say.mp3``` + +If file name must stay somewhere in the middle you can use *%s* to specify where the file name must be placed: + +```myCustomPlayer --option "%s" > /dev/null``` + +sayIt will make ```myCustomPlayer --option "/opt/yunkong2/node_modules/yunkong2.sayit/say.mp3" > /dev/null``` from it. + +## Usage +SayIt adapter cannot be used alone. It must be controlled from javascript adapter or from "vis" with specific widget. +After creation of adapter instance will can find following objects: +- sayit.N.tts.text: Phrase to be spoken. +- sayit.N.tts.volume: volume which will be used by playing of the phrase. +- sayit.N.tts.playing: true if text is now playing and false if not. Supported only for "windows" and "system" play mode. +- sayit.N.tts.cachetext: Phrase to be cached and then it can be used without internet. + E.g. you can enter here manually "No internet" and if ping to google.com is negative, write "No internet" to "tts.text" and it will pronounced. Of course cache must be enabled. + +State **tts.text** supports extended syntax, so the langugage/engine and volume can be defined together with text. It is used to enable multi-language text2speech engines. +E.g. if adapter has engine "Google-english", it is possible with phrase ```de:Sag es``` to force to use Google-Deustch speech engine. + +With ```ru;75;Погода хорошая``` we can force to use russian language and volume 75%. + +You can specify the volume of announcement in percent from current or given volume (not from maximal). E.g. if command is ```de;75;Gutes Wetter```and "announce volume" is 50%, the announce will be played with volume 38% from 100% possible. + +The system command to play the mp3 file can be specified too. If you leave it blank, the default settings will be used: windows - cmdmp3.exe, OSX - /usr/bin/afplay, linux - mpg321 or omxplayer (recommended). + +To install omxplayer write ```sudo apt-get install omxplayer``` or write ```sudo apt-get install mpg321``` to install mpg321. + +**Note:** The default announce selection will be possible only after start of the instance. + + + +## Changelog +### 1.7.1 (2018-09-19) +* (BuZZy1337) fixed error in Blockly-Block + +