node-red-contrib-tts-ultimate 2.0.4 → 2.0.6

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
+<p>
+<b>Version 2.0.6</b> January 2024<br/>
+- Minor fixes.<br/>
+- Moved log into the log tab of node-red.<br/>
+</p>
+<p>
+<b>Version 2.0.5</b> October 2023<br/>
+- Speed up emitting msg, when not using Sonos.<br/>
+</p>
 <p>
 <b>Version 2.0.4</b> August 2023<br/>
 - Removed unused new AWS api.<br/>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "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, ElevenLabs.io TTS 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": {
@@ -41,7 +41,6 @@
   "homepage": "https://github.com/Supergiovane/node-red-contrib-tts-ultimate",
   "dependencies": {
     "aws-sdk": "2.1444.0",
-    
     "fs": "0.0.1-security",
     "sonos": "1.14.1",
     "formidable": "1.2.2",
@@ -49,7 +48,7 @@
     "@google-cloud/text-to-speech": "4.2.2",
     "google-translate-tts": ">=0.3.0",
     "microsoft-cognitiveservices-speech-sdk": "1.29.0",
-    "elevenlabs-node":"1.1.3"
+    "elevenlabs-node": "1.1.3"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",
@@ -58,4 +57,4 @@
   "engines": {
     "node": ">=14.0.0"
   }
-}
+}

package/ttsultimate/ttsultimate-config.html

@@ -27,7 +27,7 @@
             secretKey: { type: "password" },
             mssubscriptionKey: { type: "text" },
             mslocation: { type: "text" },
-            elevenlabsKey:{ type: "text" }
+            elevenlabsKey: { type: "text" }
         },
         label: function () {
             return this.name || "";
@@ -66,28 +66,28 @@
                 if ($("#node-config-input-ttsservice").val() == "polly") {
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
-                    $("#elevenlabsForm").hide(); 
+                    $("#elevenlabsForm").hide();
                     $("#pollyForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletts") {
                     $("#microsoftAzureForm").hide();
                     $("#pollyForm").hide();
-                    $("#elevenlabsForm").hide(); 
+                    $("#elevenlabsForm").hide();
                     $("#GoogleForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
-                    $("#elevenlabsForm").hide(); 
+                    $("#elevenlabsForm").hide();
                 } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
-                    $("#elevenlabsForm").hide();    
+                    $("#elevenlabsForm").hide();
                     $("#microsoftAzureForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "elevenlabs") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
-                    $("#elevenlabsForm").show();                    
+                    $("#elevenlabsForm").show();
                 }
             });
             // ##########################################################
@@ -238,11 +238,86 @@
 
 
 <script type="text/markdown" data-help-name="ttsultimate-config">
+<p>Here you can configure your TTS engine to be used.</p>
+
+# TTS Service node
+Here you can set all parameters you need. All nodes will refer to this config node, so you need to set it only once.<br/> 
+IF YOU RUN NODE-RED BEHIND DOCKER OR SOMETHING ELSE, BE AWARE: <br/>
+PORT USED BY THE NODE ARE 1980 (DEFAULT) AND 1400 (FOR SONOS DISCOVER). <br/>
+PLEASE ALLOW MDNS AND UDP AS WELL
+
+**TTS Service**<br/>
+You can choose between Google (without credentials), Amazon AWS (Polly), Google TTS (require credentials and registration to google) or Microsoft Azure TTS engines.<br/>
+For Google TTS Engine, you can choose pitch and speed rate of the voice.
+<br/>
+<br/>
+
+* **TTS Service using Amazon AWS (Polly)**<br/>
+    > HOW-TO in Deutsch: for german users, there is a very helpful how-to, where you can learn how to use the node and how to register to Amazon AWS Polly as well: here: https://technikkram.net/blog/2020/09/26/sonos-sprachausgabe-mit-raspberry-pi-node-red-und-amazon-polly-fuer-homematic-oder-knx-systeme
+    
+    **AWS Access key**<br/>
+    AWS access key credential
+    <br/><br/>
+    **AWS Secret key**<br/>
+    AWS access Secret key. 
+<br/>
+
+* **TTS Service using Google (without credentials)**<br/>
+    This is the simplest way. Just select the voice and you're done. You don't need any credential and you don't even need to be registered to any google service. The voice list is more limited than other services, but it works without hassles.
+    
+<br/>
+
+* **TTS Service using Google TTS**<br/>
+    For Google TTS Engine, you can choose pitch and speed rate of the voice.<br/>
+    **Google credentials file path**<br/>
+    Here you must select your credential file, previously downloaded from Google, [with these steps](https://www.npmjs.com/package/@google-cloud/text-to-speech):
+    > [Select or create a Cloud Platform project](https://console.cloud.google.com/project)<br/>
+    > [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing)<br/>
+    > [Enable the Google Cloud Text-to-Speech API](https://console.cloud.google.com/flows/enableapi?apiid=texttospeech.googleapis.com)<br/>
+    
+
+<br/>
+
+* **TTS Service using Microsot Azure TTS**<br/>
+    For Microsoft Azure TTS Engine, you need to have a microsoft account and register to the Azure portal.<br/>
+    See my **YOUTUBE video**, here! https://youtu.be/asXajNpRWME<br/>
+    You need to register here https://portal.azure.com, then ceate a Voice Service (please click here https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices), then click on the left "Keys and Endpoint" menu and copy/paste the KEY and your Location (for example westus).<br/>
+    Then paste both into the TTS-Ultimate engine configuration window and restart node-red.<br/>
+    
+<br/>
+
+
+**Node-Red IP**<br/>
+set IP of your node-red machine. Write **AUTODISCOVER** to allow the node to auto discover your IP.
+
+**Host Port**<br/>
+Sonos will connect to this port in order to play TTS. Default 1980. Choose a free port. Do not use 1880 or any other port already in use on your computer.
+
+**TTS Cache**
+<br/>
+***Purge and delete the TTS cache folder at deploy or restart***<br/>
+On each deploy or node-red restart, delete all tts files in the cache. This is useful not to run out of disk space, in case you've a lot of TTS speech files.
+<br/>
+***Leave the TTS cache folder untouched*** (suggested only if you have enough disk space)<br/>
+Don't delete the files cached. Useful if you wish to keep the tts files, even in case of internet outages, node-red restart or reboots.
+<br/> 
+
+**Cache root folder**
+<br/>
+Set your preferred output folder for the files downloaded by the TTS Engine.<br/>
+This is useful if you wish to save the TTS cached files in a folder accessible, for example, by a third party web servers to serve an AirPlay2 speaker.<br/>
+Leave this field blank for the default.<br/>
+<br/> 
+<br/>
+
+
+
+
     <p>
         <a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
     </p>
      <p>
-      Configuration help is in the <a href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate/blob/master/README.md">README</a><br/>
+      Configuration help is also here <a href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate/blob/master/README.md">README</a><br/>
     </p>
    
 </script>

package/ttsultimate/ttsultimate.html

@@ -50,6 +50,10 @@
         <label for="node-input-sonoshailing"><i class="fa fa-bell"></i> Hailing</label>
         <select id="node-input-sonoshailing"></select> <input id="deleteSelectedFile" type="button" value="DELETE" style="width:100px">
     </div>
+    <div class="form-row">
+        <label><i class="fa fa-upload"></i> Upload hail</label>
+        <input id="ownFileUpload" type="file" multiple="multiple">
+    </div>
     <div class="form-row">
         <label for="node-input-playertype"><i class="fa fa-play"></i> Player</label>
         <select id="node-input-playertype">
@@ -68,10 +72,6 @@
             <input type="checkbox" id="node-input-unmuteIfMuted" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Unmute, then restore previous state after play.</label>
         </div>
         
-        <div class="form-row">
-            <label><i class="fa fa-upload"></i> Upload hail</label>
-            <input id="ownFileUpload" type="file" multiple="multiple">
-        </div>
         <div class="form-row">
             <label for="node-input-sonosipaddress"><i class="fa fa-globe"></i> Main Sonos Player</label>
             <label style="width:200px;" id="node-input-sonosipaddress">Discovering.... wait...</label>
@@ -178,11 +178,11 @@
                         } else if (oNodeServer.ttsservice === "elevenlabs") {
                             $("#divGoogleTTSAudioConfig").hide();
                             $("#divElevenLabsOptions").show();
-                            $("#divSSML").hide();                            
+                            $("#divSSML").hide();
                         } else {
                             $("#divGoogleTTSAudioConfig").hide();
                             $("#divElevenLabsOptions").hide();
-                             $("#divSSML").show();
+                            $("#divSSML").show();
                         }
                     } catch (error) {
                     }
@@ -537,7 +537,8 @@
 | Enable SSML | Enable the SSML XML notation. Please be aware, not all the TTS engines supports that.|
 | Rate | Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech speed (Between 0.25 and 4.0, default 1). |
 | Pitch | Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech pitch (Between -20.0 and 20.0, default 0). |
-| Hailing | Before the first TTS message of the message queues, Sonos will play an "hailing" sound. You can select the hailing or totally disable it. |
+| Hailing | Before the first TTS message of the message queues, the node will play an "hailing" sound. You can select the hailing, upload your own, or totally disable it. |
+| Upload hail | It allows you to upload your own hailing file. |
 | Player | Select the player. If you select not to use a player, the node will output a msg with an array of files, ready to be played by third party nodes. In case you select No player, only output file name, you'll get a message with an additional property filesArray, containing an array of all mp3 files ready to be played with third party nodes. Please see below the OUTPUT MESSAGES FROM THE NODE section. |
 | Volume | Set the preferred TTS volume, from "0" to "100" (can be overridden by passing msg.volume = "40"; to the node). |
 | Unmute | Unmute the main and the addotional players, then restore the previous mute state once finished. (Can be overridden by passing msg.unmute = true; to the node). |

package/ttsultimate/ttsultimate.js

@@ -369,7 +369,7 @@ module.exports = function (RED) {
         // 27/11/2019 Check Sonos connection health
 
         node.CheckSonosConnection = () => {
-            if (node.playertype !== "noplayer") {
+            if (node.playertype === "sonos") {
                 node.SonosClient.getCurrentState().then(state => {
 
                     // 11/12/202020 The connection with Sonos is OK. 
@@ -392,7 +392,7 @@ module.exports = function (RED) {
                     node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 10000);
                 });
             } else {
-                node.setNodeStatus({ fill: "green", shape: "dot", text: "Sonos is connected." });
+                node.setNodeStatus({ fill: "green", shape: "dot", text: "Ready." });
                 node.msg.connectionerror = false;
                 node.send([null, { payload: node.msg.connectionerror }]);
             }
@@ -417,8 +417,6 @@ module.exports = function (RED) {
                 node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(element.host), hostVolumeAdjust: Number(element.hostVolumeAdjust) });
                 RED.log.info("ttsultimate: FOUND ADDITIONAL PLAYER " + element.host + " Adjusted volume: " + element.hostVolumeAdjust);
             }
-
-
             // 27/11/2019 Start the connection healty check
             node.oTimerSonosConnectionCheck = setTimeout(function () { node.CheckSonosConnection(); }, 5000);
         } else if (node.playertype === "noplayer") {
@@ -427,7 +425,6 @@ module.exports = function (RED) {
 
         node.setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Initialized.' });
 
-
         // 22/09/2020 Flush Queue and set to stopped
         node.flushQueue = () => {
             // 10/04/2018 Remove the TTS message from the queue
@@ -439,8 +436,6 @@ module.exports = function (RED) {
             if (node.server.whoIsUsingTheServer === node.id) node.server.whoIsUsingTheServer = "";
         }
 
-
-
         // 30/12/2020 Supergiovane resume queue for radio, queue music, TV in , line in etc.
         async function resumeMusicQueue(_oTrack, _oPlayer = node.SonosClient) {
 
@@ -526,43 +521,46 @@ module.exports = function (RED) {
             let t = setTimeout(() => { return true; }, 5000); // Wait some seconds 
         };
 
-
         // Handle the queue
         async function HandleQueue() {
             node.bBusyPlayingQueue = true;
             node.server.whoIsUsingTheServer = node.id; // Signal to other ttsultimate node, that i'm using the Sonos device
             try {
 
-                // Get the current music queue, if one
-                var oCurTrack = null;
-                try {
-                    oCurTrack = await getMusicQueue();
-                    // 19/04/2022 The current track of additional players is read in the groupSpeakerySync function
-                } catch (error) {
-                    oCurTrack = null;
-                }
+                if (node.playertype !== "noplayer") {
+                    // Get the current music queue, if one
+                    var oCurTrack = null;
+                    try {
+                        oCurTrack = await getMusicQueue();
+                        // 19/04/2022 The current track of additional players is read in the groupSpeakerySync function
+                    } catch (error) {
+                        oCurTrack = null;
+                    }
 
-                // 05/12/2020 Set "completed" to false and send it
-                node.msg.completed = false;
-                try {
-                    await groupSpeakersSync(); // 20/03/2020 Group Speakers toghether and reads each current track   
-                } catch (error) {
-                    // Don't care.
-                    node.setNodeStatus({ fill: "red", shape: "ring", text: "Error grouping speakers: " + error.message });
-                    RED.log.error("ttsultimate: Error grouping speakers: " + error.message);
-                }
+                    // 05/12/2020 Set "completed" to false and send it
+                    node.msg.completed = false;
+                    try {
+                        await groupSpeakersSync(); // 20/03/2020 Group Speakers toghether and reads each current track   
+                    } catch (error) {
+                        // Don't care.
+                        node.setNodeStatus({ fill: "red", shape: "ring", text: "Error grouping speakers: " + error.message });
+                        RED.log.error("ttsultimate: Error grouping speakers: " + error.message);
+                    }
 
-                node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
+                    node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
 
-                // 24/08/2021 If something was playing, stop the player https://github.com/Supergiovane/node-red-contrib-tts-ultimate/issues/32
-                try {
-                    //await node.SonosClient.stop(); //.then(result => {
-                    await STOPSync();
-                } catch (error) {
-                    //RED.log.error("ttsultimate: Error stopping in HandleSend: " + error.message);
+                    // 24/08/2021 If something was playing, stop the player https://github.com/Supergiovane/node-red-contrib-tts-ultimate/issues/32
+                    try {
+                        //await node.SonosClient.stop(); //.then(result => {
+                        await STOPSync();
+                    } catch (error) {
+                        //RED.log.error("ttsultimate: Error stopping in HandleSend: " + error.message);
+                    }
+                } else {
+                    node.msg.completed = false;
+                    node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
                 }
 
-
                 while (node.tempMSGStorage.length > 0) {
                     node.currentMSGbeingSpoken = node.tempMSGStorage.shift()//node.tempMSGStorage[0];// Advise the whole node of the currently spoken MSG
                     const msg = node.currentMSGbeingSpoken.payload.toString(); // Get the text to be spoken
@@ -874,20 +872,19 @@ module.exports = function (RED) {
                         node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
                         node.bBusyPlayingQueue = false
                         node.server.whoIsUsingTheServer = ""; // Signal to other ttsultimate node, that i'm not using the Sonos device anymore
-                    }, 1000)
+                    }, 500)
 
                 } else if (node.playertype === "noplayer") {
                     // End task if no player is selected.
                     // Output the array of files
-
                     // Signal end playing
-                    let t = setTimeout(() => {
-                        node.msg.completed = true;
-                        node.currentMSGbeingSpoken = {};
-                        node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed, filesArray: noPlayerFileArray }, null]);
-                        node.bBusyPlayingQueue = false
-                        node.server.whoIsUsingTheServer = ""; // Signal to other ttsultimate node, that i'm not using the Sonos device anymore
-                    }, 1000)
+                    //let t = setTimeout(() => {
+                    node.msg.completed = true;
+                    node.currentMSGbeingSpoken = {};
+                    node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed, filesArray: noPlayerFileArray }, null]);
+                    node.bBusyPlayingQueue = false
+                    node.server.whoIsUsingTheServer = ""; // Signal to other ttsultimate node, that i'm not using the Sonos device anymore
+                    //}, 1000)
                 }
 
             } catch (error) {
@@ -1028,14 +1025,18 @@ module.exports = function (RED) {
                     // There is already a priority message being spoken, do nothing
                     node.setNodeStatus({ fill: 'grey', shape: 'ring', text: 'There is already a priority message being spoken...queuing' });
                 } else {
-                    node.SonosClient.stop().then(result => {
-                        node.bTimeOutPlay = true;
+                    if (node.playertype !== 'noplayer') {
+                        node.SonosClient.stop().then(result => {
+                            node.bTimeOutPlay = true;
+                            node.currentMSGbeingSpoken = msg; // Set immediately, otherwise if comes new flow messages, currentMSGbeingSpoken is too old.
+                        }).catch(err => {
+                            // Don't care
+                            node.bTimeOutPlay = true;
+                            node.currentMSGbeingSpoken = msg;// Set immediately, otherwise if comes new flow messages, currentMSGbeingSpoken is too old.
+                        })
+                    } else {
                         node.currentMSGbeingSpoken = msg; // Set immediately, otherwise if comes new flow messages, currentMSGbeingSpoken is too old.
-                    }).catch(err => {
-                        // Don't care
-                        node.bTimeOutPlay = true;
-                        node.currentMSGbeingSpoken = msg;// Set immediately, otherwise if comes new flow messages, currentMSGbeingSpoken is too old.
-                    })
+                    }
                 }
 
             } else {
@@ -1047,44 +1048,6 @@ module.exports = function (RED) {
             }
             // ########################
 
-            // // 03/01/2022 if ssml is enabled, disable the auto split function
-            // if (!node.ssml) {
-            //     // SSML disabled
-            //     // 30/01/2021 split the text if it's too long, otherwies i'll have issues with filename too long.
-            //     if (msg.payload.length >= node.server.limitTTSFilenameLenght) {
-            //         let sTemp = "";
-            //         let aSeps = [".", ",", ":", ";", "!", "?"];
-            //         let sPayload = msg.payload.replace(/[\r\n]+/gm, "");
-            //         for (let index = 0; index < sPayload.length; index++) {
-            //             const element = sPayload.substr(index, 1);
-            //             sTemp += element;
-            //             if (aSeps.indexOf(element) > -1 && sTemp.length > 20) {
-            //                 const oMsg = RED.util.cloneMessage(msg);
-            //                 oMsg.payload = sTemp;
-            //                 node.tempMSGStorage.push(oMsg);
-            //                 sTemp = "";
-            //             }
-            //             if (sTemp.length > node.server.limitTTSFilenameLenght && element === " ") {
-            //                 // Split using space
-            //                 const oMsg = RED.util.cloneMessage(msg);
-            //                 oMsg.payload = sTemp;
-            //                 node.tempMSGStorage.push(oMsg);
-            //                 sTemp = "";
-            //             }
-            //         }
-            //         // Remaining
-            //         const oMsg = RED.util.cloneMessage(msg);
-            //         oMsg.payload = sTemp;
-            //         node.tempMSGStorage.push(oMsg);
-
-            //     } else {
-            //         node.tempMSGStorage.push(msg);
-            //     }
-            // } else {
-            //     // SSML enabled
-            //     node.tempMSGStorage.push(msg);
-            // }
-
             // Starts main queue watching
             node.tempMSGStorage.push(msg);
             node.waitForQueue();
@@ -1107,7 +1070,8 @@ module.exports = function (RED) {
                     node.setNodeStatus({ fill: 'yellow', shape: 'ring', text: "Sonos is occupied by " + node.server.whoIsUsingTheServer + " Retry..." });
                 }
                 node.waitForQueue();
-            }, 1000);
+            }, node.playertype === "noplayer" ? 100 : 1000);
+
         }
 
         node.on('close', function (done) {