smart-nodes 0.6.7 → 0.7.0

package/CHANGELOG.md

@@ -252,3 +252,8 @@
 
 - Added crit temp change options to mixing-valve node.
 - Added UTC time usage in scheduler node.
+
+## Version 0.7.0:
+
+- Added support of home assistant boolean values "on" and "off"
+- BREAKING CHANGE: The forwarder node is only using set_forwarder and set_forwarder_state topics.

package/SmartNodesContext.json

@@ -1 +1 @@
-{"idn1":{"last_position":0,"last_direction_up":true,"last_position_before_alarm":0,"alarm_active":false}}666666666666667,"alarm_active":false}}":false,"critical_temp_max":null,"crit_temp_change_percent":0,"last_direction_up":false,"last_position_before_alarm":0.006666666666666667}}
+{"idn1":{"last_position":0,"last_direction_up":false}}

package/forwarder/forwarder.html

@@ -8,6 +8,7 @@
             enabled: { value: true },
             always_forward_true: { value: false },
             always_forward_false: { value: false },
+            always_forward_other: { value: true },
             forward_last_on_enable: { value: false },
             save_state: { value: false },
             resend_on_start: { value: false },
@@ -62,6 +63,10 @@
         <input type="checkbox" id="node-input-always_forward_false" style="width: 20px;" />
         <label for="node-input-always_forward_false" style="width: calc(100% - 30px);" data-i18n="[html]forwarder.ui.always_forward_false"></label>
     </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-always_forward_other" style="width: 20px;" />
+        <label for="node-input-always_forward_other" style="width: calc(100% - 30px);" data-i18n="[html]forwarder.ui.always_forward_other"></label>
+    </div>
     <hr/>
     <h4 style="margin: 0.5rem 0;" data-i18n="forwarder.ui.system_start"></h4>
     <div class="form-row">

package/forwarder/forwarder.js

@@ -42,6 +42,7 @@ module.exports = function (RED)
         // ##################
         let forward_true = config.always_forward_true;
         let forward_false = config.always_forward_false;
+        let forward_other = config.always_forward_other;
         let forward_last_on_enable = config.forward_last_on_enable;
 
 
@@ -85,18 +86,21 @@ module.exports = function (RED)
 
             if (real_topic != null)
             {
-                if (real_topic.startsWith("set_state"))
-                    real_topic = real_topic.replace("set_state", "set");
+                if (real_topic == "set_forwarder_state")
+                    real_topic = "set_forwarder";
 
-                if (real_topic == "set_inverted")
+                if (real_topic == "set_forwarder_state_inverted")
+                    real_topic = "set_forwarder_inverted";
+
+                if (real_topic == "set_forwarder_inverted")
                 {
-                    real_topic = "set";
-                    msg.payload = !msg.payload;
+                    real_topic = "set_forwarder";
+                    msg.payload = !helper.toBool(msg.payload);
                 }
 
-                if (real_topic == "enable" || (real_topic == "set" && msg.payload))
+                if (real_topic == "enable" || (real_topic == "set_forwarder" && helper.toBool(msg.payload)))
                     new_state = true;
-                else if (real_topic == "disable" || (real_topic == "set" && !msg.payload))
+                else if (real_topic == "disable" || (real_topic == "set_forwarder" && !helper.toBool(msg.payload)))
                     new_state = false;
             }
 
@@ -133,7 +137,7 @@ module.exports = function (RED)
 
                         default:
                             // Forward if enabled or forced
-                            if (node_settings.enabled || (forward_true && msg.payload) || (forward_false && !msg.payload))
+                            if (node_settings.enabled || (forward_true && helper.toBool(msg.payload) === true) || (forward_false && helper.toBool(msg.payload) === false) || (forward_other && typeof msg.payload !== "boolean"))
                             {
                                 node.send(helper.cloneObject(msg));
                                 node_settings.last_msg_was_sended = true;

package/forwarder/locales/de-DE/forwarder.html

@@ -27,11 +27,11 @@
                     <td>Deaktiviert das Weiterleiten.</td>
                 </tr>
                 <tr>
-                    <td><code>set</code> oder <code>set_state</code></td>
+                    <td><code>set_forwarder</code> oder <code>set_forwarder_state</code></td>
                     <td>Aktiviert das Weiterleiten, wenn <code>msg.payload = true</code> oder deaktiviert das Weiterleiten, wenn <code>msg.payload = false</code>.</td>
                 </tr>
                 <tr>
-                    <td><code>set_inverted</code> oder <code>set_state_inverted</code></td>
+                    <td><code>set_forwarder_inverted</code> oder <code>set_forwarder_state_inverted</code></td>
                     <td>Aktiviert das Weiterleiten, wenn <code>msg.payload = false</code> oder deaktiviert das Weiterleiten, wenn <code>msg.payload = true</code>.</td>
                 </tr>
             </tbody>

package/forwarder/locales/de-DE/forwarder.json

@@ -6,6 +6,7 @@
             "forward_last_on_enable": "Letzte nicht gesendete Nachricht senden,<br>wenn die Node aktiviert wird.",
             "always_forward_true": "Leite <code>msg.payload = true</code> immer weiter.",
             "always_forward_false": "Leite <code>msg.payload = false</code> immer weiter.",
+            "always_forward_other": "Leite alle anderen <code>msg.payload</code> Werte immer weiter.",
 
             "system_start": "Systemstart",
             "save_state": "Zustand speichern",

package/forwarder/locales/en-US/forwarder.html

@@ -27,11 +27,11 @@
                     <td>Disables forwarding.</td>
                 </tr>
                 <tr>
-                    <td><code>set</code> or <code>set_state</code></td>
+                    <td><code>set_forwarder</code> or <code>set_forwarder_state</code></td>
                     <td>Enables forwarding if <code>msg.payload = true</code> or disables forwarding if <code>msg.payload = false</code>.</td>
                 </tr>
                 <tr>
-                    <td><code>set_inverted</code> or <code>set_state_inverted</code></td>
+                    <td><code>set_forwarder_inverted</code> or <code>set_forwarder_state_inverted</code></td>
                     <td>Enables forwarding if <code>msg.payload = false</code> or disables forwarding if <code>msg.payload = true</code>.</td>
                 </tr>
             </tbody>

package/forwarder/locales/en-US/forwarder.json

@@ -4,8 +4,9 @@
             "name": "Name",
             "enabled": "Enabled",
             "forward_last_on_enable": "Send last unsent message when node is activated.",
-            "always_forward_true": "Always forward <code>msg.payload = true</code> .",
-            "always_forward_false": "Always forward <code>msg.payload = false</code> .",
+            "always_forward_true": "Always forward <code>msg.payload = true</code>.",
+            "always_forward_false": "Always forward <code>msg.payload = false</code>.",
+            "always_forward_other": "Always forward all other <code>msg.payload</code> values.",
 
             "system_start": "System start",
             "save_state": "Save state",

package/light/light.js

@@ -117,7 +117,7 @@ module.exports = function (RED)
                 real_topic = "set";
 
                 if (mode == "BOOL")
-                    msg.payload = !msg.payload;
+                    msg.payload = !helper.toBool(msg.payload);
                 else if (mode == "PERCENTAGE")
                     msg.payload = 100 - boolToInt(msg.payload);
             }
@@ -141,22 +141,22 @@ module.exports = function (RED)
 
                     // Make sure it is bool or int
                     if (mode == "BOOL")
-                        msg.payload = !!msg.payload;
+                        msg.payload = helper.toBool(msg.payload);
                     else if (mode == "PERCENTAGE")
                         msg.payload = boolToInt(msg.payload);
 
                     // Output is already in the state of the status value and the timeout is running.
                     // No need to restart the timeout.
-                    if (node_settings.last_value == msg.payload && timeout != null)
+                    if (node_settings.last_value == helper.toBool(msg.payload) && timeout != null)
                         doRestartTimer = false;
 
-                    node_settings.last_value = msg.payload;
+                    node_settings.last_value = helper.toBool(msg.payload);
                     current_output_state = node_settings.last_value;
                     break;
 
                 case "off":
                     // If button is released, don't handle this message
-                    if (msg.payload === false)
+                    if (helper.toBool(msg.payload) === false)
                         return;
 
                     isBlinking = false;
@@ -171,7 +171,7 @@ module.exports = function (RED)
 
                 case "on":
                     // If button is released, don't handle this message
-                    if (msg.payload === false)
+                    if (helper.toBool(msg.payload) === false)
                         return;
 
                     isBlinking = false;
@@ -187,33 +187,33 @@ module.exports = function (RED)
                 case "set":
                     // Make sure it is bool or int
                     if (mode == "BOOL")
-                        msg.payload = !!msg.payload;
+                        msg.payload = helper.toBool(msg.payload);
                     else if (mode == "PERCENTAGE")
                         msg.payload = boolToInt(msg.payload);
 
                     isBlinking = false;
 
-                    node_settings.last_value = msg.payload;
+                    node_settings.last_value = helper.toBool(msg.payload);
                     node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "set_permanent":
                     // Make sure it is bool or int
                     if (mode == "BOOL")
-                        msg.payload = !!msg.payload;
+                        msg.payload = helper.toBool(msg.payload);
                     else if (mode == "PERCENTAGE")
                         msg.payload = boolToInt(msg.payload);
 
                     isBlinking = false;
-                    isPermanent = !!msg.payload; // false or 0 => not permanent
+                    isPermanent = helper.toBool(msg.payload);
 
-                    node_settings.last_value = msg.payload;
+                    node_settings.last_value = helper.toBool(msg.payload);
                     node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "motion":
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
                     isMotion = msg.payload;
                     isBlinking = false;
 
@@ -248,7 +248,7 @@ module.exports = function (RED)
                     isBlinking = false;
 
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
 
                     // No alarm change, do nothing
                     if (node_settings.alarm_active == msg.payload)
@@ -321,7 +321,7 @@ module.exports = function (RED)
                 case "toggle":
                 default:
                     // If button is released, don't handle this message
-                    if (msg.payload === false)
+                    if (helper.toBool(msg.payload) === false)
                         return;
 
                     if (mode == "BOOL")

package/logic/logic.js

@@ -91,9 +91,9 @@ module.exports = function (RED)
             }
 
             if (inverts.includes(real_topic_number))
-                node_settings.input_states[real_topic_number - 1] = !msg.payload;
+                node_settings.input_states[real_topic_number - 1] = !helper.toBool(msg.payload);
             else
-                node_settings.input_states[real_topic_number - 1] = !!msg.payload; // !! => Convert to boolean
+                node_settings.input_states[real_topic_number - 1] = helper.toBool(msg.payload);
 
             let result = getResult();
 

package/long-press/long-press.js

@@ -70,7 +70,7 @@ module.exports = function (RED)
          */
         let handleTopic = msg =>
         {
-            if (msg.payload)
+            if (helper.toBool(msg.payload))
             {
                 on_time = Date.now();
                 startAutoLongPress();

package/mixing-valve/mixing-valve.js

@@ -175,11 +175,11 @@ module.exports = function (RED)
             if (real_topic == "set_inverted")
             {
                 real_topic = "set";
-                msg.payload = !msg.payload;
+                msg.payload = !helper.toBool(msg.payload);
             }
 
             if (real_topic == "set")
-                real_topic = (!!msg.payload) ? "enable" : "disable";
+                real_topic = helper.toBool(msg.payload) ? "enable" : "disable";
 
             switch (real_topic)
             {
@@ -307,7 +307,7 @@ module.exports = function (RED)
 
                 case "alarm":
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
 
                     // No alarm change -> nothing to do
                     if (node_settings.alarm_active == msg.payload)

package/mode-selector/mode-selector.js

@@ -84,8 +84,10 @@ module.exports = function (RED)
                         if (msg.payload == null)
                             return;
 
-                        if (typeof msg.payload === "boolean")
+                        if (typeof msg.payload === "boolean" || msg.payload === "on" || msg.payload === "off")
                         {
+                            msg.payload = msg.payloadhelper.toBool(msg.payload);
+                            
                             // Syntax: set_mode#MODE_NAME and payload is boolean
                             // If payload is true, set to MODE_NAME
                             // if payload is false, set to default mode

package/multi-press/multi-press.js

@@ -55,7 +55,7 @@ module.exports = function (RED)
         // ###############
         node.on("input", function (msg)
         {
-            if (msg.payload)
+            if (helper.toBool(msg.payload))
                 startTimeout();
         });
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "smart-nodes",
-    "version": "0.6.7",
+    "version": "0.7.0",
     "description": "Controls light, shutters and more. Includes common used logic and statistic nodes to control your home.",
     "keywords": [
         "node-red",

package/scene/scene.js

@@ -123,7 +123,7 @@ module.exports = function (RED)
 
                 case "status":
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
                     node_settings.last_values[number] = msg.payload;
 
                     notifyCentral();
@@ -145,7 +145,7 @@ module.exports = function (RED)
 
                 case "set":
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
                     node_settings.last_values = new Array(config.outputs).fill(msg.payload);
 
                     // This happens because of splitting by _ for scenes
@@ -155,7 +155,7 @@ module.exports = function (RED)
 
                 case "scene":
                     // Skip if button is released;
-                    if (msg.payload === false)
+                    if (helper.toBool(msg.payload) === false)
                         return;
 
                     if (typeof scenes === "undefined")
@@ -204,7 +204,7 @@ module.exports = function (RED)
 
                 case "toggle":
                     // Skip if button is released;
-                    if (msg.payload === false)
+                    if (helper.toBool(msg.payload) === false)
                         return;
 
                     node_settings.last_values = new Array(config.outputs).fill(currentScene == 0);

package/scheduler/scheduler.js

@@ -111,11 +111,11 @@ module.exports = function (RED)
             if (real_topic == "set_inverted")
             {
                 real_topic = "set";
-                msg.payload = !msg.payload;
+                msg.payload = !helper.toBool(msg.payload);
             }
 
             if (real_topic == "set")
-                real_topic = (!!msg.payload) ? "enable" : "disable";
+                real_topic = helper.toBool(msg.payload) ? "enable" : "disable";
 
             switch (real_topic)
             {

package/shutter/shutter.js

@@ -107,7 +107,7 @@ module.exports = function (RED)
             // Correct next topic to avoid handling up_stop, down_stop or toggle separately.
             if (real_topic == "short_up_down")
             {
-                real_topic = msg.payload ? "down" : "up";
+                real_topic = helper.toBool(msg.payload) ? "down" : "up";
                 if (msg.time_on == null)
                     msg.time_on = short_time_on_ms;
             }
@@ -150,7 +150,7 @@ module.exports = function (RED)
 
                 case "up_down":
                     // This is only used to track starting of the shutter
-                    node_settings.last_direction_up = !msg.payload;
+                    node_settings.last_direction_up = !helper.toBool(msg.payload);
                     is_running = true;
                     return;
 

package/shutter-complex/shutter-complex.js

@@ -125,13 +125,13 @@ module.exports = function (RED)
             let real_topic = helper.getRealTopic(msg.topic, "toggle", ["up", "up_stop", "down", "down_stop", "stop", "toggle", "up_down", "position", "alarm"]);
 
             // skip if button is released
-            if (msg.payload === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(real_topic))
+            if (helper.toBool(msg.payload) === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(real_topic))
                 return;
 
             // Convert up_down from HA UI to next command
             if (real_topic == "up_down")
             {
-                if (msg.payload)
+                if (helper.toBool(msg.payload))
                     real_topic = "down";
                 else
                     real_topic = "up";
@@ -192,13 +192,13 @@ module.exports = function (RED)
                 case "position":
                     startAction(ACTION_POSITION, msg.payload ?? null);
                     break;
-                
+
                 case "status_up":
                     // TODO: if status changed from false to true, start time measurement to calculate position
                     // if status changed from true to false, stop time measurement and save position
                     // if alarm is active, check if current action is allowed and stop if not
                     break;
-                
+
                 case "status_down":
                     // TODO: if status changed from false to true, start time measurement to calculate position
                     // if status changed from true to false, stop time measurement and save position
@@ -207,7 +207,7 @@ module.exports = function (RED)
 
                 case "alarm":
                     // Make sure it is bool
-                    msg.payload = !!msg.payload;
+                    msg.payload = helper.toBool(msg.payload);
 
                     // No alarm change, do nothing
                     if (node_settings.alarm_active == msg.payload)

package/smart_helper.js

@@ -1,5 +1,23 @@
 module.exports = {
 
+    toBool(value)
+    {
+        if (typeof value == "boolean")
+            return value;
+
+        if (typeof value == "string")
+        {
+            value = value.toLowerCase();
+            if (value == "true" || value == "yes" || value == "on")
+                return true;
+
+            if (value == "false" || value == "no" || value == "off")
+                return false;
+        }
+
+        return null;
+    },
+
     /**
      * This functions converts a value into the given type.
      * If a type is unknown the NodeRed function is used for conversation.