node-red-contrib-tts-ultimate 1.0.46 → 1.0.50

package/CHANGELOG.md

@@ -2,7 +2,23 @@
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
-
+<p>
+<b>Version 1.0.50</b> August 2022<br/>
+- Fixed a wrong "sonos unreachable" message when you select to simply save the file instead of using it with sonos<br/>
+- FIX: temporary fix for chinese language in google translate engine, that was not working anymore.<br/>
+</p>
+<p>
+<b>Version 1.0.49</b> June 2022<br/>
+- Due to Microsoft Azure SDK limitation, the node can only be installed on systems with NodeJS versions: (^12.22.0, ^14.17.0, or >=16.0.0) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.). Currently, the Microsoft Azure SDK and, thus, TTS-Ultimate, doesn't run on NodeJS 18.x.x !!<br/>
+</p>
+<p>
+<b>Version 1.0.48</b> Mai 2022<br/>
+- Try to fixe a clunky issue with microsoft azure package, on nodejs versions that are not supported by Microsoft.<br/>
+</p>
+<p>
+<b>Version 1.0.47</b> Mai 2022<br/>
+- Fixed other compatibility issue with some Node version.<br/>
+</p>
 <p>
 <b>Version 1.0.46</b> Mai 2022<br/>
 - Fixed a compatibility issue with Node 18, where a breaking change has been introduced.<br/>

package/README.md

@@ -20,13 +20,16 @@
 ```
 </details>
 
+ ## WARNING 
+ Due to Microsoft Azure SDK limitation, the node can only be installed on systems with **NodeJS** versions: (^12.22.0, ^14.17.0, or >=16.0.0) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.). Currently, the **Microsoft Azure SDK and, thus, TTS-Ultimate, doesn't run on NodeJS 18.x.x !!**
 
 ## DESCRIPTION
-This node transforms a text into a speech audio. You can generate an audio file, or hear the voice through Sonos, bluetooth speakers, web pages, etc.<br/>
+This node transforms a text into a speech audio that you can hear natively via <b>SONOS</b> speakers.<br/>
+You can also generate an audio file for bluetooth speakers, web pages, etc.<br/>
 Uses Amazon Polly (standard and neural engines), Google TTS voices (even without credentials nor registration) and Microsoft TTS Azure voices, and you can use it with **your own audio file** as well and it can be used **totally offline** even without the use of TTS, without internet connection.<br/>
 The node can also create a ***TTS file (without the use of any Sonos device)***, to be read by third parties nodes.<br/>
 This is a major ***upgrade from the previously popular node SonosPollyTTS*** (SonosPollyTTS is not developed anymore).<br/>
-**Node v.12.0.0 or newer is needed**.
+
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday)
 
@@ -34,6 +37,7 @@ This is a major ***upgrade from the previously popular node SonosPollyTTS*** (So
 * See <a href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate/blob/master/CHANGELOG.md">here the changelog</a>
 
 ## FEATURES
+* **Native Sonos support**: hear the TTS audio directly via Sonos. You can also group speakers, set an hailing sound, choose the volume of each speaker etc.
 * **Output audio file**: the node can just create the TTS file to be used by other nodes. In this case, you doesn't need to use Sonos as player.
 * **Amazon Voices, Gooogle Translate Voices, Google TTS Voices and Microsoft TTS Azure voices** are all supported, with all avaiables languages and genders.
 * **Automatic grouping** is supported. You can group all players you want to play your announcements.
@@ -215,9 +219,16 @@ return msg;
 ```
 
 ```js
-// Play custom hailing and custom mp3 taken from anywhere
-msg.sonoshailing = "IntruderAlert";
-msg.payload = "http://192.125.22.44/intruderalarm.mp3";
+// Play smoke detection
+msg.sonoshailing = "SmokeAlert";
+msg.payload = "Warning, smoke detected. Fire extinguishers are in the kitchen, hall and garage.";
+return msg;
+```
+
+```js
+// Play an mp3
+msg.sonoshailing = "MeteoJingle";
+msg.payload = "http://192.125.22.44/meteotoday.mp3";
 return msg;
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.46",
+  "version": "1.0.50",
   "description": "Transforms the text in speech and hear it using Sonos player or generate an audio file to be used with third parties nodes. Works with voices from Amazon, Google (without credentials as well), Microsoft TTS Azure, or your own voice. You can also only create a TTS file to be read by third party nodes. Update of the popular SonosPollyTTS node.",
   "main": "index.js",
   "scripts": {
@@ -47,8 +47,8 @@
     "os": ">=0.1.1",
     "path": ">=0.12.7",
     "@google-cloud/text-to-speech": "3.4.0",
-    "google-translate-tts": ">=0.2.1",
-    "microsoft-cognitiveservices-speech-sdk": ">=1.19.0"
+    "google-translate-tts": ">=0.3.0",
+    "microsoft-cognitiveservices-speech-sdk": "1.21.1"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",

package/ttsultimate/ttsultimate-config.js

@@ -1,6 +1,16 @@
+const { Redshift } = require('aws-sdk');
+
 module.exports = function (RED) {
     'use strict';
 
+    // 31/05/2022 checking nodejs version due to Microsoft Azure SDK bad nodejs compatibility.
+    let nodejsVersion = process.version.match(/^v(\d+\.\d+)/)[1];
+    if (nodejsVersion.startsWith("18")) {
+        RED.log.error('ttsultimate-config: YOUR NODEJS VERSION IS CURRENTLY INCOMPATIBLE WITH Microsoft Azure SDK. Your NodeJS version: ' + nodejsVersion + ", please install one of these: (^12.22.0, ^14.17.0, or >=16.0.0), with SSL support.");
+    }
+
+
+
     const AWS = require('aws-sdk');
     const GoogleTTS = require('@google-cloud/text-to-speech');
     const GoogleTranslate = require('google-translate-tts'); // TTS without credentials, limited to 200 chars per row.
@@ -27,10 +37,7 @@ module.exports = function (RED) {
         node.whoIsUsingTheServer = ""; // Client node.id using the server, because only a ttsultimate node can use the serve at once.
         node.ttsservice = config.ttsservice || "googletranslate";
         node.TTSRootFolderPath = (config.TTSRootFolderPath === undefined || config.TTSRootFolderPath === "") ? path.join(RED.settings.userDir, "sonospollyttsstorage") : path.join(config.TTSRootFolderPath, "sonospollyttsstorage");
-        // node.polly = null;
-        // node.googleTTS = null;
-        // node.googleTranslateTTS = null;
-        // node.microsoftAzureTTS = null;
+
 
         // 03/06/2019 you can select the temp dir
         //#region "SETUP PATHS"
@@ -229,19 +236,19 @@ module.exports = function (RED) {
                     } else {
                         var sAddresses = "";
                         oiFaces[ifname].forEach(function (iface) {
-                            if (iface.internal == false && iface.family.toString().includes("4")) sAddresses = iface.address;
+                            if (iface.internal == false && iface.family !== undefined && iface.family.toString().includes("4")) sAddresses = iface.address;
                         });
                         if (sAddresses !== "") jListInterfaces.push({ name: ifname, address: sAddresses });
                     }
                 })
             } catch (error) { }
             if (jListInterfaces.length > 0) {
-                return(jListInterfaces[0].address); // Retunr the first usable IP
+                return (jListInterfaces[0].address); // Retunr the first usable IP
             } else {
-                return("NO ETH INTERFACE FOUND");
+                return ("NO ETH INTERFACE FOUND");
             }
         }
-    
+
         // 20/03/2020 in the middle of coronavirus, get the sonos groups
         RED.httpAdmin.get("/sonosgetAllGroups", RED.auth.needsPermission('TTSConfigNode.read'), function (req, res) {
             var jListGroups = [];

package/ttsultimate/ttsultimate.js

@@ -285,7 +285,7 @@ module.exports = function (RED) {
             // 30/03/2020 in the middle of coronavirus emergency. Group Speakers
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                 let element = node.oAdditionalSonosPlayers[index].oPlayer;
-               
+
                 // 02/07/2021 Get the additional's player's volume set by app and the current track, to be set again in ungroupspealers
                 try {
                     element.additionalPlayerPreviousVolumeSetByApp = await element.getVolume();
@@ -366,29 +366,35 @@ module.exports = function (RED) {
 
 
         // 27/11/2019 Check Sonos connection health
-        node.CheckSonosConnection = () => {
 
-            node.SonosClient.getCurrentState().then(state => {
+        node.CheckSonosConnection = () => {
+            if (node.playertype !== "noplayer") {
+                node.SonosClient.getCurrentState().then(state => {
+
+                    // 11/12/202020 The connection with Sonos is OK. 
+                    if (node.msg.connectionerror == true) {
+                        node.flushQueue();
+                        node.setNodeStatus({ fill: "green", shape: "dot", text: "Sonos is connected." });
+                        node.msg.connectionerror = false;
+                        node.send([null, { payload: node.msg.connectionerror }]);
+                    }
+                    node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 5000);
 
-                // 11/12/202020 The connection with Sonos is OK. 
-                if (node.msg.connectionerror == true) {
+                }).catch(err => {
+                    node.setNodeStatus({ fill: "red", shape: "dot", text: "Sonos connection is DOWN: " + err.message });
                     node.flushQueue();
-                    node.setNodeStatus({ fill: "green", shape: "dot", text: "Sonos is connected." });
-                    node.msg.connectionerror = false;
-                    node.send([null, { payload: node.msg.connectionerror }]);
-                }
-                node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 5000);
-
-            }).catch(err => {
-                node.setNodeStatus({ fill: "red", shape: "dot", text: "Sonos connection is DOWN: " + err.message });
-                node.flushQueue();
-                // 11/12/2020 Set node output to signal connectio error
-                if (node.msg.connectionerror == false) {
-                    node.msg.connectionerror = true;
-                    node.send([null, { payload: node.msg.connectionerror }]);
-                }
-                node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 10000);
-            });
+                    // 11/12/2020 Set node output to signal connectio error
+                    if (node.msg.connectionerror == false) {
+                        node.msg.connectionerror = true;
+                        node.send([null, { payload: node.msg.connectionerror }]);
+                    }
+                    node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 10000);
+                });
+            } else {
+                node.setNodeStatus({ fill: "green", shape: "dot", text: "Sonos is connected." });
+                node.msg.connectionerror = false;
+                node.send([null, { payload: node.msg.connectionerror }]);
+            }
 
         }
 
@@ -614,6 +620,7 @@ module.exports = function (RED) {
                                 } else if (node.server.ttsservice === "googletranslate") {
                                     node.setNodeStatus({ fill: 'green', shape: 'ring', text: 'Downloading from Google Translate...' });
                                     // VoiceId is: code. SSML is not supported by google translate
+                                    if (node.voiceId === "cmn-Hant-TW") node.voiceId = "zh-CN"; // 06/08/2022 fix for a wrong voiceid sent by google translate as voice code
                                     const params = {
                                         text: msg,
                                         voice: node.voiceId,
@@ -894,7 +901,7 @@ module.exports = function (RED) {
             // *********************************
 
             // In case of connection error, doesn't accept any message
-            if (node.msg.connectionerror) {
+            if (node.msg.connectionerror && node.playertype !== "noplayer") {
                 RED.log.warn("ttsultimate: Sonos is offline. The new msg coming from the flow will be rejected.");
                 node.setNodeStatus({ fill: 'red', shape: 'ring', text: "Sonos is offline. The msg has been rejected." });
                 return;