ioBroker sayit adapter

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

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 iobroker.vis page. It is supported almost by every desktop browser and by few mobile Browsers.

• Home24- MediaPlayer - 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 - 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 ioBroker 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 how to set up 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.

• Heos - play text on HEOS device. Be sure the Web Adapter is enabled. It is required to enable HEOS 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/. [This service will be disabled 1st of Jan 2019 and replaced by Yandex.cloud] To use Yandex.cloud you should register here: [https://cloud.yandex.ru/], install SpeechKIT API in the Cloud and get Auth Token and Folder ID as described in API instructions.
• 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.
• 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. The Amazon documentation can you find here.

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.

Most useful features:

• <break time="3s"/>- make a pause for x seconds (max 10 seconds).
• <emphasis> big </emphasis> - make an emphasis on some word.
• <prosody volume="+6dB" rate="90%">I am speaking this</prosody> - control speed and volume parameters.
• <say-as interpret-as="digits">12345</say-as> - say every digit separately.

More info.

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/iobroker/node_modules/iobroker.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/iobroker/node_modules/iobroker.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 you 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 be pronounced. Of course cache must be enabled.

State tts.text supports extended syntax, so the language/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 using Google-Deutsch speech engine.

With ru;75;Погода хорошая we can force using 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 Wetterand "announce volume" is 50%, the announcement 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.

Priorities

To immediately pronounce the text despite the queued texts you have 2 possibilities:

• place "!" as a first character in text, so this text will be pronounced immediately after current one.
• write true into "tts.clearQueue" state and the queue will be cleared. After that you can write a new text into "tts.text", but all queued texts are thrown away.

Engines

Following values for engines are possible:

Google

• en - English
• de - Deutsch
• pl - Polski
• ru - Русский
• uk - український
• it - Italiano
• es - Espaniol
• fr - Français
• nl - Nederlands
• zh-CN - 简体中文
• pt - Português

Yandex

• ru_YA:Yandex - Русский
• ru_YA_CLOUD:Yandex Cloud - Русский [Yandex.Cloud API generates files in OGG format. To play ogg files on linux mplayer should be installed and selected as system player]

Amazon polly via cloud

• ru-RU_CLOUD_Female - Русский - Татьяна
• ru-RU_CLOUD_Male - Русский - Максим
• de-DE_CLOUD_Female - Deutsch - Marlene
• de-DE_CLOUD_Male - Deutsch - Hans
• de-DE_CLOUD_Female_Vicki - Deutsch - Vicki
• 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_Female_Camila - pt-BR - Female - Camila
• 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
• pt-BR_CLOUD_Female_Camila - pt-BR - Female - Camila

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_Female_Vicki - Deutsch - Vicki
• 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
• ko-KR_AP_Female - ko-KR - Female - Seoyeon

Changelog

1.12.6 (2022-02-09)

• (bluefox) used setForeignBinaryState if possible

1.12.5 (2022-02-09)

• (bluefox) Fixed errors in io-package.json

1.12.3 (2021-06-25)

• (bluefox) corrected the Google engine
• (bluefox) Added new voices: german, korean, brasil, Dutch

1.12.2 (2020-11-07)

• (Apollon77) Prevent crash case (Sentry IOBROKER-SAYIT-Q, IOBROKER-SAYIT-S, IOBROKER-SAYIT-T)

1.12.0 (2020-10-19)

• (withstu) Support for HEOS was added

1.11.5 (2020-09-24)

• (Apollon77) prevent scheduled restart problems

1.11.3 (2020-09-17)

• (Apollon77) make sure initialize errors do not crash adapter (Sentry IOBROKER-SAYIT-N)

1.11.2 (2020-08-08)

• (Apollon77) catch errors in MDNS discovery (Sentry IOBROKER-SAYIT-E)

1.11.1 (2020-08-06)

• (Apollon77) handle errors from process spawn better (Sentry IOBROKER-SAYIT-D)

1.11.0 (2020-08-02)

• (Apollon77) Move the generated mp3 file to an own directory in iobroker-data instead of inside node_modules (Hopefully not breaking)
• (Apollon77) Change File write to use Sync methods to make sure they can not run in parallel

1.10.2 (2020-07-19)

• (Apollon77) Crash case prevented (Sentry IOBROKER-SAYIT-8)

1.10.1 (2020-07-16)

• (Apollon77) Handle edge cases and prevent crashes (Sentry IOBROKER-SAYIT-4, IOBROKER-SAYIT-6)
• (Apollon77) try to get caching working again for Yandex

1.10.0 (2020-07-07)

• (algar42) GUI updated to fill drop-downs correctly. Premium voices added to Yandex.Cloud engine

1.9.8 (2020-06-11)

• (Apollon77) fix error handling on file copy

1.9.7 (2020-06-11)

• (algar42) tts.ogg state added for ogg file type

1.9.6 (2020-05-24)

• (bluefox) Show names of SONOS devices

1.9.4 (2020-05-11)

• (Apollon77) Fix Blockly
• (Apollon77) Update dependencies

1.9.3 (2020-04-24)

• (bluefox) Fixed blockly with missing languages

1.9.2 (2020-04-21)

Changed type of top-level object to "meta" in order to comply with js-controller v3

1.9.1 (2020-03-12)

• (foxriver76) removed usage of adapter.getMessage

1.9.0 (2019-11-06)

• (algar42) Output file extension is changed dynamically based on the engine selected

1.8.2 (2019-07-11)

• (bluefox) Web server URL will be updated if web server was updated

1.8.1

• Add Ukrainian Google Language

1.8.0 (2018-12-04)

• (bluefox) Priority for the text was added

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
• (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-2022, bluefox [email protected]

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.