node-red-contrib-tts-ultimate 1.0.33 → 1.0.37

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 [![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.37</b> December 2021<br/>
+- Removed some unwanted startup logs.<br/>
+<p>
+<p>
+<b>Version 1.0.36</b> November 2021<br/>
+- NEW: Autosplit function: you can now set the maximum lenght of the text-parts, in case your spoken text is too long for the allowed TTS Engine limits.<br/>
+<p>
+<p>
+<b>Version 1.0.35</b> October 2021<br/>
+- NEW: You can force unmuting all players, then restore their previous state once finished playing.<br/>
+<p>
+<p>
+<b>Version 1.0.34</b> October 2021<br/>
+- FIX: fixed an issue in retrieving voices if you have more than one TTS engine enabled at the same time.<br/>
+<p>
 <p>
 <b>Version 1.0.33</b> October 2021<br/>
 - NEW VOICE ENGINE: Microsoft Azure TTS.<br/>

package/README.md

@@ -104,9 +104,10 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
 
 * **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/>
-   After your registration here https://portal.azure.com, you need to create a Voice Service, then click to Keys and Endpoint 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.   
-
+   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/>
 
 
@@ -124,6 +125,12 @@ On each deploy or node-red restart, delete all tts files in the cache. This is u
 ***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/> 
+
+**Autosplit max length
+<br/>
+Due to some limitations in text lenght, applied by the online TTS Engines, TTS-Ultimate is capable to split your long text to be spoken, in shorter texts in an intelligent way.<br/>
+This field allow you to set the maximum lenght (**in chars**) of each splitted text part. The default is **220** and is OK for most cases. You can change this valut to whatever you want but keep in mind, that your TTS engine can either cut the text or return an error, if the text is too long. As the cached filename is equal to the text being spoken, you could also hit the maximum filename lenght of your filesystem. So keep the default value, unless you absolute need to change it.<br/>
+<br/> 
 <br/>
 
 # TTS-ULTIMATE NODE
@@ -150,6 +157,9 @@ In case you select ***No player, only output file name***, you'll get a message
 **Volume** <br/>
 Set the preferred TTS volume, from "0" to "100" (can be overridden by passing <code>msg.volume = "40";</code> to the node)
 
+**Unmute** <br/>
+Unmute the main and the addotional players, then restore the previous mute state once finished. (Can be overridden by passing <code>msg.unmute = true;</code> to the node)
+
 **Main Sonos Player** <br/>
 Select your Sonos primary player. (It's strongly suggested to set a fixed IP for this player; you can reserve an IP using the DHCP Reservation function of your router/firewall's DHCP Server).<br/>
 It's possibile to group players, so your announcement can be played on all selected players. For this to happen, you need to select your primary coordinator player. All other players will be then controlled by this coordinator.
@@ -163,6 +173,10 @@ Here you can add all additional players that will be grouped toghether to the *M
 **msg.volume**<br/>
 Set the volume (values between "0" and "100" with quotes)</br>
 
+**msg.unmute**<br/>
+*true*: Unmute all players then mutes it again once finished playing.</br>
+*false*: Leave the player as they are.</br>
+
 **msg.nohailing**<br/>
 Temporarely doesn't play the Hailing sound prior to the message (values "true" or "1" with quotes)</br>
 
@@ -258,17 +272,19 @@ The property is a JSON object.
 <img src='https://github.com/Supergiovane/node-red-contrib-tts-ultimate/raw/master/img/setConfig.png' width="80%">
 
 **msg.setConfig**<br/>
-This is the property where you can set all the things. It must be an Object.
+This is the property where you can set all the things. It must be a JSON Object with the below specified properties.<br/>
+The setting is retained until the node receives another msg.setConfig or until node-red is restarted.<br/>
 
-**setMainPlayerIP**<br/>
-Sets the main player IP. This will also be the coordinator if you have a group of players
+ >  **property setMainPlayerIP**<br/>
+   Sets the main player IP. This will also be the coordinator if you have a group of players.
 
-**setPlayerGroupArray**<br/>
-Sets the array of players beloging to the group, if any.<br/>
-If you have only one additional player, you need to ever put it into an array. See below.
+ >  **property setPlayerGroupArray**<br/>
+   Sets the array of players beloging to the group, if any.<br/>
+   If you have only one additional player, you need to ever put it into an array. See below.
 
 ```js
-// Set player IP
+// Set main player IP
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109"
 };
@@ -278,6 +294,7 @@ return msg;
 
 ```js
 // Set player IP and additional players
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109",
     setPlayerGroupArray:[
@@ -292,6 +309,7 @@ return msg;
 
 ```js
 // If you have only one additional player
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109",
     setPlayerGroupArray:["192.168.1.110"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.33",
+  "version": "1.0.37",
   "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": {
@@ -16,6 +16,7 @@
     "google",
     "voice",
     "amazon",
+    "azure",
     "tts",
     "sonos",
     "IOT",

package/ttsultimate/ttsultimate-config.html

@@ -17,7 +17,8 @@
                 type: "text"
             },
             purgediratrestart: { value: "leave", required: false },
-            ttsservice: { value: "googletranslate", required: false }
+            ttsservice: { value: "googletranslate", required: false },
+            limitTTSFilenameLenght: { value: 220, required: false, validate: RED.validators.number() }
 
         },
         credentials: {
@@ -32,6 +33,10 @@
         oneditprepare: function () {
             var node = this;
 
+            // 01/11/2021
+            //if (node.limitTTSFilenameLenght === undefined) {
+            //    $("#node-config-input-limitTTSFilenameLenght").val(220);
+            //}
             // 21/03/2020 Check if the node is the absolute first in the flow. In this case, it has no http server instatiaced
             $.getJSON('ttsultimateGetEthAddress', (data) => {
                 $("#pleaseDeploy").hide();
@@ -61,16 +66,16 @@
             $("#node-config-input-ttsservice").change(function (e) {
                 if ($("#node-config-input-ttsservice").val() == "polly") {
                     $("#GoogleForm").hide();
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                     $("#pollyForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletts") {
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                     $("#pollyForm").hide();
                     $("#GoogleForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                 } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
@@ -192,12 +197,12 @@
         </div>
         <div id="microsoftAzureForm">
             <div class="form-row">
-                <label style="width:180px" for="node-config-input-mssubscriptionKey"><i class="fa fa-user"></i> Azure subscription key</label>
-                <input style="width:200px" type="text" id="node-config-input-mssubscriptionKey">
+                <label style="width:35%" for="node-config-input-mssubscriptionKey"><i class="fa fa-user"></i> Azure subscription key</label>
+                <input  style="width:58%" type="text" id="node-config-input-mssubscriptionKey">
             </div>
             <div class="form-row">
-                <label style="width:180px" for="node-config-input-mslocation"><i class="fa fa-user"></i> Azure location (ex:westeurope)</label>
-                <input style="width:200px" type="text" id="node-config-input-mslocation">
+                <label style="width:35%" for="node-config-input-mslocation"><i class="fa fa-user"></i> Azure location (ex:westeurope)</label>
+                <input style="width:58%" type="text" id="node-config-input-mslocation">
             </div>
         </div>
 
@@ -208,6 +213,12 @@
                 <option value="leave">Leave the TTS cache folder untouched (not suggested if you have less disk space)</option>
             </select>
         </div>
+
+        <div class="form-row">
+            <label for="node-config-input-limitTTSFilenameLenght"><i class="fa fa-file"></i> Autosplit max length (chars)</label>
+            <input type="text" id="node-config-input-limitTTSFilenameLenght">
+        </div>
+        
     </div>
     
 </script>

package/ttsultimate/ttsultimate-config.js

@@ -23,6 +23,11 @@ module.exports = function (RED) {
         node.userDir = path.join(RED.settings.userDir, "sonospollyttsstorage"); // 09/03/2020 Storage of ttsultimate (otherwise, at each upgrade to a newer version, the node path is wiped out and recreated, loosing all custom files)
         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.limitTTSFilenameLenght = config.limitTTSFilenameLenght === undefined ? 220 : config.limitTTSFilenameLenght;
+        // node.polly = null;
+        // node.googleTTS = null;
+        // node.googleTranslateTTS = null;
+        // node.microsoftAzureTTS = null;
 
         // 03/06/2019 you can select the temp dir
         //#region "SETUP PATHS"
@@ -40,22 +45,22 @@ module.exports = function (RED) {
             }
         }
         if (!setupDirectory(node.userDir)) {
-            RED.log.error('ttsultimate-config: Unable to set up MAIN directory: ' + node.userDir);
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up MAIN directory: ' + node.userDir);
         }
         if (!setupDirectory(path.join(node.userDir, "ttsfiles"))) {
-            RED.log.error('ttsultimate-config: Unable to set up cache directory: ' + path.join(node.userDir, "ttsfiles"));
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up cache directory: ' + path.join(node.userDir, "ttsfiles"));
         } else {
-            RED.log.info('ttsultimate-config: TTS cache set to ' + path.join(node.userDir, "ttsfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': TTS cache set to ' + path.join(node.userDir, "ttsfiles"));
         }
         if (!setupDirectory(path.join(node.userDir, "ttsultimategooglecredentials"))) {
-            RED.log.error('ttsultimate-config: Unable to set google creds directory: ' + path.join(node.userDir, "ttsultimategooglecredentials"));
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set google creds directory: ' + path.join(node.userDir, "ttsultimategooglecredentials"));
         } else {
-            RED.log.info('ttsultimate-config: google credentials path set to ' + path.join(node.userDir, "ttsultimategooglecredentials"));
+            RED.log.info('ttsultimate-config ' + node.id + ': google credentials path set to ' + path.join(node.userDir, "ttsultimategooglecredentials"));
         }
         if (!setupDirectory(path.join(node.userDir, "hailingpermanentfiles"))) {
-            RED.log.error('ttsultimate-config: Unable to set up hailing directory: ' + path.join(node.userDir, "hailingpermanentfiles"));
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up hailing directory: ' + path.join(node.userDir, "hailingpermanentfiles"));
         } else {
-            RED.log.info('ttsultimate-config: hailing path set to ' + path.join(node.userDir, "hailingpermanentfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': hailing path set to ' + path.join(node.userDir, "hailingpermanentfiles"));
             // 09/03/2020 Copy defaults to the userDir
             fs.readdirSync(path.join(__dirname, "hailingpermanentfiles")).forEach(file => {
                 try {
@@ -64,9 +69,9 @@ module.exports = function (RED) {
             });
         }
         if (!setupDirectory(path.join(node.userDir, "ttspermanentfiles"))) {
-            RED.log.error('ttsultimate-config: Unable to set up permanent files directory: ' + path.join(node.userDir, "ttspermanentfiles"));
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up permanent files directory: ' + path.join(node.userDir, "ttspermanentfiles"));
         } else {
-            RED.log.info('ttsultimate-config: permanent files path set to ' + path.join(node.userDir, "ttspermanentfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': permanent files path set to ' + path.join(node.userDir, "ttspermanentfiles"));
             // 09/03/2020 // Copy the samples of permanent files into the userDir
             fs.readdirSync(path.join(__dirname, "ttspermanentfiles")).forEach(file => {
                 try {
@@ -79,62 +84,75 @@ module.exports = function (RED) {
 
         //#region "INSTANTIATE SERVICE ENGINES"
         // POLLY
-        var params = {
-            accessKeyId: node.credentials.accessKey,
-            secretAccessKey: node.credentials.secretKey,
-            apiVersion: '2016-06-10'
-        };
-        try {
-            node.polly = new AWS.Polly(params);
-            RED.log.info("ttsultimate.config: Polly service enabled.")
-        } catch (error) {
-            RED.log.warn("ttsultimate.config: Polly service disabled. " + error.message)
+        if (node.ttsservice === "polly") {
+            var params = {
+                accessKeyId: node.credentials.accessKey,
+                secretAccessKey: node.credentials.secretKey,
+                apiVersion: '2016-06-10'
+            };
+            try {
+                node.polly = new AWS.Polly(params);
+                RED.log.info("ttsultimate-config " + node.id + ": Polly service enabled.")
+            } catch (error) {
+                RED.log.warn("ttsultimate-config " + node.id + ": Polly service disabled. " + error.message)
+            }
+        } else {
+            //RED.log.info("ttsultimate-config " + node.id + ": Polly service not used.");
         }
 
+
         // Google TTS with authentication
         if (node.ttsservice === "googletts") {
             try {
                 // 23/12/2020 Set environment path of googleTTS
-                RED.log.info("ttsultimate-config: Google credentials are stored in the file " + path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json"));
+                RED.log.info("ttsultimate-config " + node.id + ": Google credentials are stored in the file " + path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json"));
                 process.env.GOOGLE_APPLICATION_CREDENTIALS = path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json");
+                try {
+                    node.googleTTS = new GoogleTTS.TextToSpeechClient();
+                    RED.log.info("ttsultimate-config " + node.id + ": Google TTS service enabled. ")
+                } catch (error) {
+                    RED.log.warn("ttsultimate-config " + node.id + ": Google TTS service disabled. " + error.message)
+                }
             } catch (error) {
-                RED.log.warn("ttsultimate.config: Google Translate free service error: " + error.message)
+                RED.log.warn("ttsultimate-config " + node.id + ": Google TTS service error: " + error.message)
             }
 
-        }
-        try {
-            node.googleTTS = new GoogleTTS.TextToSpeechClient();
-            RED.log.info("ttsultimate.config: Google Translate free service enabled. ")
-        } catch (error) {
-            RED.log.warn("ttsultimate.config: Google Translate free service disabled. " + error.message)
+        } else {
+            // RED.log.info("ttsultimate-config " + node.id + ": Google TTS service not used.");
         }
 
 
-        // Google Translate without authentication
-        try {
-            node.googleTranslateTTS = GoogleTranslate;
-        } catch (error) {
+
+        // Google Translate without authentication 
+        if (node.ttsservice === "googletranslate") {
+            try {
+                node.googleTranslateTTS = GoogleTranslate;
+            } catch (error) {
+                //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
+            }
+        } else {
+            //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
         }
 
 
-        // 12/10/2021 Microsoft Azure TTS SpeechConfig.fromSubscription(subscriptionKey, serviceRegion)
-        // #########################################
-        node.setMicrosoftAzureVoice = function (_voiceName) {
-            console.log ("ILSIGNOREBUONO",_voiceName)
-            let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
-            speechConfig.speechSynthesisVoiceName = _voiceName;
-            speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
-            node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
-            return node.microsoftAzureTTS;
-        }
-        try {
-            let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
-            speechConfig.speechSynthesisLanguage = "it-IT";
-            speechConfig.speechSynthesisVoiceName = "it-IT-IsabellaNeural";
-            speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
-            node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
-            node.microsoftAzureTTSVoiceList = [];
-            if (node.ttsservice === "microsoftazuretts") {
+        // 12/10/2021 Microsoft Azure TTS SpeechConfig.fromSubscription(subscriptionKey, serviceRegion) 
+        if (node.ttsservice === "microsoftazuretts") {
+            // #########################################
+            node.setMicrosoftAzureVoice = function (_voiceName) {
+                let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
+                speechConfig.speechSynthesisVoiceName = _voiceName;
+                speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
+                node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
+                return node.microsoftAzureTTS;
+            }
+            try {
+
+                let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
+                //speechConfig.speechSynthesisLanguage = "it-IT";
+                //speechConfig.speechSynthesisVoiceName = "it-IT-IsabellaNeural";
+                speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
+                node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
+                node.microsoftAzureTTSVoiceList = [];
                 // Get the voices
                 async function listVoicesAzure() {
                     const httpsAzure = require('https')
@@ -155,33 +173,36 @@ module.exports = function (RED) {
                         resVoices.on('end', () => {
                             try {
                                 let oVoices = JSON.parse(sChunkResponse);
-                                RED.log.info('ttsultimate-config: Microsoft Azure voices count: ' + oVoices.length);
+                                RED.log.info('ttsultimate-config ' + node.id + ': Microsoft Azure voices count: ' + oVoices.length);
                                 for (let index = 0; index < oVoices.length; index++) {
                                     const element = oVoices[index];
                                     node.microsoftAzureTTSVoiceList.push({ name: element.ShortName + " (" + element.Gender + ")", id: element.ShortName })
                                 }
                             } catch (error) {
-                                RED.log.error('ttsultimate-config: listVoices: Error parsing Microsoft Azure TTS voices: ' + error.message);
+                                RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error parsing Microsoft Azure TTS voices: ' + error.message);
                                 node.microsoftAzureTTSVoiceList.push({ name: "Error parsing Microsoft Azure voices: " + error.message, id: "Ivy" });
                             }
                         })
                     })
                     reqAzure.on('error', error => {
-                        RED.log.error('ttsultimate-config: listVoices: Error contacting Azure for getting the voices list: ' + error.message);
+                        RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error contacting Azure for getting the voices list: ' + error.message);
                         node.microsoftAzureTTSVoiceList.push({ name: "Error getting Microsoft Azure voices: " + error.message, id: "Ivy" })
                         reqAzure.end();
                     })
                     reqAzure.end();
                 };
-                RED.log.info("ttsultimate.config: Microsoft AzureTTS service enabled.")
+                RED.log.info("ttsultimate-config " + node.id + ": Microsoft AzureTTS service enabled.")
                 try {
                     listVoicesAzure();
                 } catch (error) {
-                    RED.log.error('ttsultimate-config: listVoices: Error getting Microsoft Azure voices: ' + error.message);
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting Microsoft Azure voices: ' + error.message);
                 }
+
+            } catch (error) {
+                RED.log.warn("ttsultimate-config " + node.id + ": Microsoft AzureTTS service disabled. " + error.message)
             }
-        } catch (error) {
-            RED.log.warn("ttsultimate.config: Microsoft AzureTTS service disabled. " + error.message)
+        } else {
+            //RED.log.info("ttsultimate-config " + node.id + ": Microsoft AzureTTS service not used. ");
         }
         // #########################################
 
@@ -232,7 +253,7 @@ module.exports = function (RED) {
                         //return groups[0].CoordinatorDevice().togglePlayback()
                     })
                 }).catch(e => {
-                    RED.log.warn('ttsultimate-config: Error in discovery ' + e);
+                    RED.log.warn('ttsultimate-config ' + node.id + ': Error in discovery ' + e);
                     res.json("ERRORDISCOVERY");
                 })
             } catch (error) { }
@@ -327,7 +348,7 @@ module.exports = function (RED) {
         });
 
         // 26/10/2020 Supergiovane, get the updated voice list. 
-        RED.httpAdmin.get("/ttsgetvoices", RED.auth.needsPermission('TTSConfigNode.read'), function (req, res) {
+        RED.httpAdmin.get("/ttsgetvoices" + encodeURIComponent(node.id), RED.auth.needsPermission('TTSConfigNode.read'), function (req, res) {
             var ttsservice = req.query.ttsservice;// Retrieve the ttsservice engine
             var jListVoices = [];
 
@@ -343,7 +364,7 @@ module.exports = function (RED) {
                     };
                     node.polly.describeVoices(jfiltroVoci, function (err, data) {
                         if (err) {
-                            RED.log.warn('ttsultimate-config: Error getting polly voices ' + err);
+                            RED.log.warn('ttsultimate-config ' + node.id + ': Error getting polly voices ' + err);
                             jListVoices.push({ name: "Error retrieving voices. " + err, id: "Ivy" })
                             res.json(jListVoices)
                         } else {
@@ -371,7 +392,7 @@ module.exports = function (RED) {
                         });
                         res.json(jListVoices)
                     } catch (error) {
-                        RED.log.error('ttsultimate-config: Error getting google TTS voices ' + error.message);
+                        RED.log.error('ttsultimate-config ' + node.id + ': Error getting google TTS voices ' + error.message);
                         jListVoices.push({ name: "Error getting Google TTS voices. " + error.message, id: "Ivy" })
                         res.json(jListVoices)
                     }
@@ -379,7 +400,7 @@ module.exports = function (RED) {
                 try {
                     listVoices();
                 } catch (error) {
-                    RED.log.error('ttsultimate-config: listVoices: Error getting google TTS voices ' + error.message);
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google TTS voices ' + error.message);
                 }
 
             } else if (ttsservice === "googletranslate") {
@@ -391,7 +412,7 @@ module.exports = function (RED) {
                         });
                         res.json(jListVoices)
                     } catch (error) {
-                        RED.log.error('ttsultimate-config: Error getting google Translate voices ' + error.message);
+                        RED.log.error('ttsultimate-config ' + node.id + ': Error getting google Translate voices ' + error.message);
                         jListVoices.push({ name: "Error getting Google Translate voices. " + error.message, id: "Ivy" })
                         res.json(jListVoices)
                     }
@@ -399,7 +420,7 @@ module.exports = function (RED) {
                 try {
                     listVoices();
                 } catch (error) {
-                    RED.log.error('ttsultimate-config: listVoices: Error getting google Translate voices ' + error.message);
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google Translate voices ' + error.message);
                 }
 
             } else if (ttsservice === "microsoftazuretts") {
@@ -471,7 +492,7 @@ module.exports = function (RED) {
                         fs.readdir(path.join(node.userDir, "ttspermanentfiles"), (err, files) => {
                             files.forEach(function (file) {
                                 if (file.indexOf("OwnFile_") !== -1) {
-                                    RED.log.warn("ttsultimate-config: Deleted file " + path.join(node.userDir, "ttspermanentfiles", file));
+                                    RED.log.warn("ttsultimate-config " + node.id + ": Deleted file " + path.join(node.userDir, "ttspermanentfiles", file));
                                     try {
                                         fs.unlinkSync(path.join(node.userDir, "ttspermanentfiles", file));
                                     } catch (error) { }
@@ -502,11 +523,11 @@ module.exports = function (RED) {
         node.noderedport = typeof config.noderedport === "undefined" ? "1980" : config.noderedport;
         // 11/11/2019 NEW in V 1.1.0, changed webserver behaviour. Redirect pre V. 1.1.0 1880 ports to the nde default 1980
         if (node.noderedport.trim() == "1880") {
-            RED.log.warn("ttsultimate-config: The webserver port ist 1880. Please change it to another port, not to conflict with default node-red 1880 port. I've changed this temporarly for you to 1980");
+            RED.log.warn("ttsultimate-config " + node.id + ": The webserver port ist 1880. Please change it to another port, not to conflict with default node-red 1880 port. I've changed this temporarly for you to 1980");
             node.noderedport = "1980";
         }
         node.sNoderedURL = "http://" + node.noderedipaddress.trim() + ":" + node.noderedport.trim(); // 11/11/2019 New Endpoint to overcome https problem.
-        RED.log.info('ttsultimate-config: Node-Red node.js Endpoint will be created here: ' + node.sNoderedURL + "/tts");
+        RED.log.info('ttsultimate-config ' + node.id + ': Node-Red node.js Endpoint will be created here: ' + node.sNoderedURL + "/tts");
 
         // 26/02/2020
         if (node.purgediratrestart === "purge") {
@@ -516,7 +537,7 @@ module.exports = function (RED) {
                     try {
                         if (files.length > 0) {
                             files.forEach(function (file) {
-                                RED.log.info("ttsultimate-config: Deleted TTS file " + path.join(node.userDir, "ttsfiles", file));
+                                RED.log.info("ttsultimate-config " + node.id + ": Deleted TTS file " + path.join(node.userDir, "ttsfiles", file));
                                 try {
                                     fs.unlinkSync(path.join(node.userDir, "ttsfiles", file));
                                 } catch (error) {
@@ -552,7 +573,7 @@ module.exports = function (RED) {
                     if (path.extname(query.f) === ".mp3" && path.dirname(path.dirname(query.f)).endsWith("sonospollyttsstorage")) {
                         var readStream = fs.createReadStream(query.f);
                         readStream.on("error", function (error) {
-                            RED.log.error("ttsultimate-config: Playsonos error opening stream : " + query.f + ' : ' + error);
+                            RED.log.error("ttsultimate-config " + node.id + ": Playsonos error opening stream : " + query.f + ' : ' + error);
                             res.end();
                             return;
                         });
@@ -565,13 +586,13 @@ module.exports = function (RED) {
                     // http://localhost:1980/tts?f=/etc/passwd                 
 
                 } else {
-                    RED.log.error("ttsultimate-config: Playsonos RED.httpAdmin file not found: " + query.f);
+                    RED.log.error("ttsultimate-config " + node.id + ": Playsonos RED.httpAdmin file not found: " + query.f);
                     res.write("File not found");
                     res.end();
                 }
 
             } catch (error) {
-                RED.log.error("ttsultimate-config: Playsonos RED.httpAdmin error: " + error + " on: " + query.f);
+                RED.log.error("ttsultimate-config " + node.id + ": Playsonos RED.httpAdmin error: " + error + " on: " + query.f);
                 res.end();
             }
 
@@ -581,23 +602,23 @@ module.exports = function (RED) {
         try {
             node.oWebserver = http.createServer(requestHandler);
             node.oWebserver.on('error', function (e) {
-                RED.log.error("ttsultimate-config: " + node.ID + " error starting webserver on port " + sWebport + " " + e);
+                RED.log.error("ttsultimate-config " + node.id + ": " + node.ID + " error starting webserver on port " + sWebport + " " + e);
             });
         } catch (error) {
             // Already open. Close it and redo.
-            RED.log.error("ttsultimate-config: Webserver creation error: " + error);
+            RED.log.error("ttsultimate-config " + node.id + ": Webserver creation error: " + error);
         }
 
         try {
             node.oWebserver.listen(sWebport, (err) => {
                 if (err) {
-                    RED.log.error("ttsultimate-config: error listening webserver on port " + sWebport + " " + err);
+                    RED.log.error("ttsultimate-config " + node.id + ": error listening webserver on port " + sWebport + " " + err);
                 }
             });
 
         } catch (error) {
             // In case oWebserver is null
-            RED.log.error("ttsultimate-config: error listening webserver on port " + sWebport + " " + error);
+            RED.log.error("ttsultimate-config " + node.id + ": error listening webserver on port " + sWebport + " " + error);
         }
         // #################################
 
@@ -607,7 +628,7 @@ module.exports = function (RED) {
         node.on('close', function (done) {
             // 11/11/2019 Close the Webserver
             try {
-                node.oWebserver.close(function () { RED.log.info("ttsultimate-config: Webserver UP. Closing down."); });
+                node.oWebserver.close(function () { RED.log.info("ttsultimate-config " + node.id + ": Webserver UP. Closing down."); });
             } catch (error) {
 
             }

package/ttsultimate/ttsultimate.html

@@ -58,6 +58,11 @@
             <label for="node-input-sonosvolume"><i class="fa fa-volume-up"></i> Volume</label>
             <input type="text" id="node-input-sonosvolume" style="width:150px"> 
         </div>
+        <div class="form-row">
+            <label for="node-input-unmuteIfMuted"><i class="fa fa-bell-slash-o"></i> Unmute</label>
+            <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">
@@ -128,7 +133,9 @@
                 rules: { value: [] },
                 playertype: { value: "sonos", required: false },
                 speakingrate: { value: "1", required: false },
-                speakingpitch: { value: "0", required: false}
+                speakingpitch: { value: "0", required: false },
+                unmuteIfMuted: { value: true }
+
             },
             inputs: 1,
             outputs: 2,
@@ -216,7 +223,7 @@
                         .find('option')
                         .remove()
                         .end();
-                    $.getJSON("ttsgetvoices?ttsservice=" + oNodeServer.ttsservice, new Date().getTime(), (data) => {
+                    $.getJSON("ttsgetvoices" + encodeURIComponent(oNodeServer.id) + "?ttsservice=" + oNodeServer.ttsservice, new Date().getTime(), (data) => {
                         var aVoices = data.sort(compareVoices);
                         for (let index = 0; index < aVoices.length; index++) {
                             const oVoice = aVoices[index];

package/ttsultimate/ttsultimate.js

@@ -76,7 +76,9 @@ module.exports = function (RED) {
         node.playertype = config.playertype === undefined ? "sonos" : config.playertype; // 20/09/2021 Player type
         node.speakingpitch = config.speakingpitch === undefined ? "0" : config.speakingpitch; // 21/09/2021 AudioConfig speakingpitch
         node.speakingrate = config.speakingrate === undefined ? "1" : config.speakingrate; // 21/09/2021 AudioConfig speakingrate
-
+        node.unmuteIfMuted = config.unmuteIfMuted === undefined ? false : config.unmuteIfMuted; // 21/10/2021 Unmute if previiously muted.
+        node.sonosCoordinatorIsPreviouslyMuted = false;
+        
         if (typeof node.server !== "undefined" && node.server !== null) {
             node.sNoderedURL = node.server.sNoderedURL || "";
         }
@@ -243,18 +245,29 @@ module.exports = function (RED) {
             });
         }
 
-        // 28/08/2021 Sync wrapper
-        // function removeTracksFromQueueSync() {
-        //     return new Promise((resolve, reject) => {
-        //         // To remove current item from the queue
-        //         node.SonosClient.removeTracksFromQueue(1,1).then(result => {
-        //             resolve(result);
-        //         }).catch(err => {
-        //             RED.log.error("ttsultimate: Error removeTracksFromQueueSync: " + err.message);
-        //             reject(err);
-        //         });
-        //     });
-        // }
+        // 21/10/2021 Sync wrapper
+        function GETMutedSync() {
+            return new Promise((resolve, reject) => {
+                node.SonosClient.getMuted().then(state => {
+                    resolve(state);
+                }).catch(err => {
+                    RED.log.error("ttsultimate: Error GETMutedSync: " + err.message);
+                    reject(err);
+                });
+            });
+        }
+
+        // 21/10/2021 Sync wrapper
+        function SETMutedSync(_muted) {
+            return new Promise((resolve, reject) => {
+                node.SonosClient.setMuted(_muted).then(state => {
+                    resolve(state);
+                }).catch(err => {
+                    RED.log.error("ttsultimate: Error SETMutedSync: " + err.message);
+                    reject(err);
+                });
+            });
+        }
 
         // 20/03/2020 Join Coordinator queue
         // ######################################################
@@ -262,11 +275,12 @@ module.exports = function (RED) {
             // 05/07/2021 Get the main coordinator player previous volume set by app
             try {
                 node.sonosCoordinatorPreviousVolumeSetByApp = await GETVOLUMESync();
+                node.sonosCoordinatorIsPreviouslyMuted = await GETMutedSync();
             } catch (error) {
                 node.sonosCoordinatorPreviousVolumeSetByApp = node.sSonosVolume;
+                node.sonosCoordinatorIsPreviouslyMuted = false;
             }
             // 30/03/2020 in the middle of coronavirus emergency. Group Speakers
-            // You don't have to worry about who is the coordinator.
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                 const element = node.oAdditionalSonosPlayers[index];
                 try {
@@ -280,6 +294,12 @@ module.exports = function (RED) {
                 } catch (error) {
                     RED.log.warn("ttsultimate: Error setting volume of joined device " + error.message);
                 }
+                // 21/10/2021 set the previous mute/unmute state
+                try {
+                    element.isPreviouslyMuted = await element.getMuted();
+                } catch (error) {
+                    RED.log.warn("ttsultimate: Error getMuted of joined device " + error.message);
+                }
             };
         }
 
@@ -291,6 +311,14 @@ module.exports = function (RED) {
             } catch (error) {
                 RED.log.warn("ttsultimate: Error set preious volume on main coordinator in ungroupSpeakers " + error.message);
             }
+            // 21/10/2021 Unmute?
+            if (node.unmuteIfMuted && node.sonosCoordinatorIsPreviouslyMuted) {
+                try {
+                    await SETMutedSync(true);
+                } catch (error) {
+                    RED.log.warn("ttsultimate: Error set preivous mute state on main coordinator in ungroupSpeakers " + error.message);
+                }
+            }
 
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                 const element = node.oAdditionalSonosPlayers[index];
@@ -307,6 +335,14 @@ module.exports = function (RED) {
                         RED.log.warn("ttsultimate: Error set previous volume on group device " + error.message);
                     }
                 }
+                // 21/10/2021 Unmute?
+                if (node.unmuteIfMuted && element.isPreviouslyMuted) {
+                    try {
+                        await element.setMuted(true);
+                    } catch (error) {
+                        RED.log.warn("ttsultimate: Error set previous mute state on group device " + error.message);
+                    }
+                }
             }
         }
         // ######################################################
@@ -617,12 +653,15 @@ module.exports = function (RED) {
                                     volTemp = node.sSonosVolume;
                                 }
                                 await SETVOLUMESync(volTemp);
+                                if (node.unmuteIfMuted) await SETMutedSync(false); // 21/10/2021 Unmute
+
                                 if (node.oAdditionalSonosPlayers.length > 0) {
                                     // 05/07/2021 set the volume of additional coordinatores
                                     for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                                         const element = node.oAdditionalSonosPlayers[index];
                                         try {
                                             await element.setVolume(volTemp);
+                                            if (node.unmuteIfMuted) await element.setMuted(false); // 21/10/2021 Unmute
                                         } catch (error) {
                                             RED.log.error("ttsultimate: Handlequeue: Unable to set the volume on additional player " + error.message);
                                         }
@@ -767,6 +806,10 @@ module.exports = function (RED) {
         }
 
         node.on('input', function (msg) {
+            // if (msg.hasOwnProperty("banana")) {
+            //     node.SonosClient.setMuted(msg.banana);
+            //     return;
+            // }
 
             // 09/01/2021 Set the main player and groups IP on request
             // *********************************
@@ -819,6 +862,12 @@ module.exports = function (RED) {
                 return;
             }
 
+
+            // 21/10/2021 force unmute
+            if (msg.hasOwnProperty("unmute")) {
+                node.unmuteIfMuted = msg.unmute;
+            }
+
             // 05/12/2020 handling Hailing
             var hailingMSG = null;
             if (msg.hasOwnProperty("nohailing") && (msg.nohailing == "1" || msg.nohailing.toLowerCase() == "true")) {
@@ -894,8 +943,7 @@ module.exports = function (RED) {
 
 
             // 30/01/2021 split the text if it's too long, otherwies i'll have issues with filename too long.
-            const iLimitTTSFilenameLenght = 220;
-            if (msg.payload.length >= iLimitTTSFilenameLenght) {
+            if (msg.payload.length >= node.server.limitTTSFilenameLenght) {
                 let sTemp = "";
                 let aSeps = [".", ",", ":", ";", "!", "?"];
                 let sPayload = msg.payload.replace(/[\r\n]+/gm, "");
@@ -908,7 +956,7 @@ module.exports = function (RED) {
                         node.tempMSGStorage.push(oMsg);
                         sTemp = "";
                     }
-                    if (sTemp.length > iLimitTTSFilenameLenght && element === " ") {
+                    if (sTemp.length > node.server.limitTTSFilenameLenght && element === " ") {
                         // Split using space
                         const oMsg = RED.util.cloneMessage(msg);
                         oMsg.payload = sTemp;
@@ -998,7 +1046,7 @@ module.exports = function (RED) {
 
         // 12/10/2021 Microsoft Azure TTS Service
         async function synthesizeSpeechMicrosoftAzureTTS(ttsService, params) {
-    
+
             return new Promise(function (resolve, reject) {
                 try {
 
@@ -1009,14 +1057,14 @@ module.exports = function (RED) {
                         params.text,
                         result => {
                             ttsService.close();
-                            resolve (Buffer.from(result.audioData));
+                            resolve(Buffer.from(result.audioData));
                         },
                         error => {
                             ttsService.close();
-                            reject (error);
+                            reject(error);
                         });
                 } catch (error) {
-                    reject (error);
+                    reject(error);
                 }
             });
         };