node-red-contrib-tts-ultimate 1.0.43 → 1.0.44

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 [![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.44</b> April 2022<br/>
+- NEW: you can now adjust the additional player's volume, adapting it to the main sonos player volume. This is useful in case you've some recessed speakers, "speaking" too low or some too near speakers, "speaking" too high. You can adapt the volume in the config window or dinamically via msg input.<br/>
+- Updated the README.<br/>
+</p>
 <p>
 <b>Version 1.0.43</b> March 2022<br/>
 - Simplified the configuration by auto discover some IP.<br/>

package/README.md

@@ -169,7 +169,8 @@ Select your Sonos primary player. (It's strongly suggested to set a fixed IP for
 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.
 
 **Additional Players** <br/>
-Here you can add all additional players that will be grouped toghether to the *Main Sonos Player* coordinator group. You can add a player using the "ADD" button, below the list.
+Here you can add all additional players that will be grouped toghether to the *Main Sonos Player* coordinator group. You can add a player using the "ADD" button, below the list.<br/>
+For each additional player, you can adjust their volume, based on the **Main Sonos Player** volume -+100.
 
 
 ## INPUT MESSAGES TO THE NODE <br/>
@@ -287,7 +288,9 @@ The setting is retained until the node receives another msg.setConfig or until n
 
  >  **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.
+   You can also specify the volume variation from the main volume player, to adapt the additional player's perceived volume to the main sonos player volume.<br/>
+   For example, if you have a speaker mounted in celiling, having less perceived volume, you can "push" the volume up, to match the whole perceived volume. Just add **#** after the IP and a number from -100 to 100 to subtract or add volume ***compared to the main sonos volume***. For example, if the sonos main player volume is 40, you can push this celing speaker's volume to further 10, so it'll have the real volume of 50. See below, the example.<br/>
+   Note: Even if you have only one additional player, you need to put it into an array.
 
 ```js
 // Set main player IP
@@ -300,14 +303,15 @@ return msg;
 ```
 
 ```js
-// Set player IP and additional players
+// Set player IP and additional players with their optional adapted volume, relative to the main sonos player volume.
+// You can specify the aditional player's volume adaptation
 // 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",
-        "192.168.1.111",
-        "192.168.1.112"
+        "192.168.1.110", // This additional player will use the same volume as the main sonos player.
+        "192.168.1.111#-10", // This additional player will use the main sonos player's volume, minus 10.
+        "192.168.1.112#20" // This additional player will use the main sonos player's volume, plus 20.
     ]
 };
 msg.setConfig = config;
@@ -315,7 +319,7 @@ return msg;
 ```
 
 ```js
-// If you have only one additional player
+// If you have only one additional player, without setting their adjusted volume.
 // The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.43",
+  "version": "1.0.44",
   "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": {

package/ttsultimate/ttsultimate.html

@@ -402,16 +402,32 @@
                 //#region ADDITIONAL PLAYERS
                 // 20/03/2020 ADDITIONAL PLAYERS
                 // ##########################################################
-                var previousValueType = { value: "prev", label: this._("switch.previous"), hasValue: false };
+                //var previousValueType = { value: "prev", label: this._("switch.previous"), hasValue: false };
+
+                // Add Selectbox with the volume for the additional players
+                function addAdditionalPlayerVolumeUI(row, _currentVolume = 0) {
+                    let oAdjustVolume = $('<select/>', { class: "rowRulePlayerHostAdjustVolume", type: "text", style: "width:200px; margin-left: 5px; text-align: left;" }).appendTo(row);
+                    for (let index = -100; index < 100; index += 5) {
+                        let sTesto = "";
+                        if (index === 0) sTesto = "Same volume as Main Sonos Player";
+                        if (index < 0) sTesto = "Decrease volume by " + Math.abs(index) ;
+                        if (index > 0) sTesto = "Increase volume by " + index;
+                        oAdjustVolume.append($("<option></option>")
+                            .attr("value", index)
+                            .text(sTesto)
+                        )
+                    }
+                    oAdjustVolume.val(_currentVolume);
+                }
                 function resizeRule(rule) { }
+
                 $("#node-input-rule-container").css('min-height', '150px').css('min-width', '450px').editableList({
                     addItem: function (container, i, opt) { // row, index, data
-                        // opt.r is: { topic: rowRuleTopic, devicename: rowRuleDeviceName, dpt:rowRuleDPT, send: rowRuleSend}
 
                         if (!opt.hasOwnProperty('r')) {
                             opt.r = {};
                         }
-                        var rule = opt.r;
+                        let rule = opt.r;
                         if (!opt.hasOwnProperty('i')) {
                             opt._i = Math.floor((0x99999 - 0x10000) * Math.random()).toString();
                         }
@@ -422,8 +438,7 @@
 
 
                         var row = $('<div class="form-row"/>').appendTo(container);
-                        var oPlayer = $('<label>Discovering.... wait...</label>', { class: "rowRulePlayerHost", type: "text", style: "width:300px; margin-left: 5px; text-align: left;" }).appendTo(row);
-
+                        var oPlayer = $('<label>Discovering.... wait...</label>', { class: "rowRulePlayerHost", type: "text", style: "width:200px; margin-left: 5px; text-align: left;" }).appendTo(row);
                         oPlayer.on("change", function () {
                             resizeRule(container);
                         });
@@ -432,16 +447,18 @@
                             if (typeof data === "string" && data == "ERRORDISCOVERY") { // 10/04/2020 if error in discovery, fallback to manual IP input
                                 // Transform the dropdown to a simple input
                                 oPlayer.remove();
-                                oPlayer = $('<input/>', { class: "rowRulePlayerHost", type: "text", style: "width:300px; margin-left: 5px; text-align: left;" }).appendTo(row);
+                                oPlayer = $('<input/>', { class: "rowRulePlayerHost", type: "text", style: "width:200px; margin-left: 5px; text-align: left;" }).appendTo(row);
+                                addAdditionalPlayerVolumeUI(row, rule.hostVolumeAdjust);
                             } else {
                                 oPlayer.remove();
-                                oPlayer = $('<select/>', { class: "rowRulePlayerHost", type: "text", style: "width:300px; margin-left: 5px; text-align: left;" }).appendTo(row);
+                                oPlayer = $('<select/>', { class: "rowRulePlayerHost", type: "text", style: "width:200px; margin-left: 5px; text-align: left;" }).appendTo(row);
                                 data.sort().forEach(oGroup => {
                                     oPlayer.append($("<option></option>")
                                         .attr("value", oGroup.host)
                                         .text(oGroup.name + " (" + oGroup.host + ")")
                                     )
                                 });
+                                addAdditionalPlayerVolumeUI(row, rule.hostVolumeAdjust);
                             }
                             oPlayer.val(rule.host);
                         });
@@ -460,7 +477,7 @@
 
                 // 20/03/2020 For each rule, create a row
                 for (var i = 0; i < this.rules.length; i++) {
-                    var rule = this.rules[i];
+                    let rule = this.rules[i];
                     $("#node-input-rule-container").editableList('addItem', { r: rule, i: i });
                 }
                 // ##########################################################
@@ -469,14 +486,14 @@
                 node.refreshHailingList();
 
             }, oneditsave: function () {
-                var node = this;
-
-                var rules = $("#node-input-rule-container").editableList('items');
+                let node = this;
+                let rules = $("#node-input-rule-container").editableList('items');
                 node.rules = [];
                 rules.each(function (i) {
-                    var rule = $(this);
-                    var rowRulePlayerHost = rule.find(".rowRulePlayerHost").val();
-                    node.rules.push({ host: rowRulePlayerHost });
+                    let rule = $(this);
+                    let rowRulePlayerHost = rule.find(".rowRulePlayerHost").val();
+                    let rowRulePlayerHostAdjustVolume = rule.find(".rowRulePlayerHostAdjustVolume").val();
+                    node.rules.push({ host: rowRulePlayerHost, hostVolumeAdjust: rowRulePlayerHostAdjustVolume });
                 });
                 this.propertyType = $("#node-input-property").typedInput('type');
             },

package/ttsultimate/ttsultimate.js

@@ -283,7 +283,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++) {
-                const element = node.oAdditionalSonosPlayers[index];
+                const element = node.oAdditionalSonosPlayers[index].oPlayer;
                 try {
                     await element.joinGroup(node.sonosCoordinatorGroupName);
                 } catch (error) {
@@ -322,7 +322,7 @@ module.exports = function (RED) {
             }
 
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
-                const element = node.oAdditionalSonosPlayers[index];
+                const element = node.oAdditionalSonosPlayers[index].oPlayer;
                 try {
                     await element.leaveGroup();
                 } catch (error) {
@@ -401,9 +401,10 @@ module.exports = function (RED) {
             });
             // Fill the node.oAdditionalSonosPlayers with all sonos object in the rules
             for (let index = 0; index < node.rules.length; index++) {
-                const element = node.rules[index];
-                node.oAdditionalSonosPlayers.push(new sonos.Sonos(element.host));
-                RED.log.info("ttsultimate: FOUND ADDITIONAL PLAYER " + element.host);
+                const element = node.rules[index]; // Rule row is {host:"192.168.1.12,hostVolumeAdjust:0}
+                // 12/04/2022 Create an object containing the addidtional player and the adapted volume
+                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);
             }
 
 
@@ -655,21 +656,26 @@ module.exports = function (RED) {
 
                             // Set Volume
                             try {
-                                let volTemp = 0
+                                let volTemp = 0;
                                 if (node.currentMSGbeingSpoken.hasOwnProperty("volume")) {
-                                    volTemp = node.currentMSGbeingSpoken.volume;
+                                    volTemp = Number(node.currentMSGbeingSpoken.volume);
                                 } else {
-                                    volTemp = node.sSonosVolume;
+                                    volTemp = Number(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
+                                    // 05/07/2021 set the volume of additional coordinators
                                     for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
-                                        const element = node.oAdditionalSonosPlayers[index];
+                                        const element = node.oAdditionalSonosPlayers[index].oPlayer;
+                                        //node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(element.host), hostVolumeAdjust: element.hostVolumeAdjust });
                                         try {
-                                            await element.setVolume(volTemp);
+                                            // 12/04/20222 Set the adjusted volume, based on the main player volume + the adjusted volume in %
+                                            let iAdjustedVol = Number(volTemp) + Number((node.oAdditionalSonosPlayers[index].hostVolumeAdjust || 0));
+                                            if (iAdjustedVol < 0) iAdjustedVol = 0;
+                                            if (iAdjustedVol > 100) iAdjustedVol = 100;
+                                            await element.setVolume(iAdjustedVol);
                                             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);
@@ -843,9 +849,18 @@ module.exports = function (RED) {
                     // Fill the node.oAdditionalSonosPlayers with all sonos IPs in the setPlayerGroupArray
                     node.oAdditionalSonosPlayers = [];
                     for (let index = 0; index < msg.setConfig.setPlayerGroupArray.length; index++) {
-                        const element = msg.setConfig.setPlayerGroupArray[index];
-                        node.oAdditionalSonosPlayers.push(new sonos.Sonos(element));
-                        RED.log.info("ttsultimate: new group player set by msg: " + element);
+                        const sRow = msg.setConfig.setPlayerGroupArray[index];
+                        let host = "";
+                        let hostVolumeAdjust = 0;
+                        if (sRow.includes("#")) {
+                            host = sRow.split("#")[0];
+                            hostVolumeAdjust = sRow.split("#")[1];
+                        } else {
+                            host = sRow;
+                        }
+                        //node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(element.host), hostVolumeAdjust: element.hostVolumeAdjust });
+                        node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(host), hostVolumeAdjust: Number(hostVolumeAdjust) });
+                        RED.log.info("ttsultimate: new group player set by msg: " + host + " adjusted volume: " + Number(hostVolumeAdjust));
                     }
                 };
             };