smart-nodes 0.3.36 → 0.4.0

package/{light-control/light-control.js → light/light.js}

@@ -7,32 +7,69 @@ module.exports = function (RED)
         const node = this;
         RED.nodes.createNode(node, config);
 
+        // ###################
+        // # Class constants #
+        // ###################
+
+
+        // #######################
+        // # Global help objects #
+        // #######################
         const smart_context = require("../persistence.js")(RED);
         const helper = require("../smart_helper.js");
 
-        // used from text-exec node
+
+        // ############################
+        // # Used from text-exec node #
+        // ############################
         if (typeof config.exec_text_names == "string")
             node.exec_text_names = config.exec_text_names.split(",").map(n => n.trim().toLowerCase());
         else
             node.exec_text_names = [];
 
-        // persistent values
-        var node_settings = Object.assign({}, {
+
+        // #####################
+        // # persistent values #
+        // #####################
+        var node_settings = helper.cloneObject({
             last_value: false,
+            last_value_before_alarm: false,
+            last_value_sended: false,
+            alarm_active: false,
         }, smart_context.get(node.id));
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let max_time_on = helper.getTimeInMs(config.max_time_on, config.max_time_on_unit);
         let alarm_action = config.alarm_action || "NOTHING";
+        let alarm_off_action = config.alarm_off_action || "NOTHING";
+
+        // ##################
+        // # Runtime values #
+        // ##################
 
-        // runtime values
-        let max_time_on_timeout = null;
+        // Here the setTimeout return value is stored to turn off the light.
+        // That means if it is null, the light will not be turned off automatically.
+        let timeout = null;
+
+        // If isPermanent is true, then a default on time value is ignored
+        // Also if the motion sensor turns off, no timeout is started.
         let isPermanent = false;
+
+        // If this is on, a motion sensor has detected a move, so the on time value is ignored.
+        // The timeout starts only if the motion sensor goes off.
         let isMotion = false;
+
+        // Here the date is stored, when the light should go off.
+        // This is used to calculate the node status.
         let timeout_end_date = null;
-        let alarm_active = false;
 
-        // central handling
+
+        // #########################
+        // # Central node handling #
+        // #########################
         var event = "node:" + node.id;
         var handler = function (msg)
         {
@@ -41,6 +78,9 @@ module.exports = function (RED)
         RED.events.on(event, handler);
 
 
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
             handleTopic(msg);
@@ -55,17 +95,26 @@ module.exports = function (RED)
             RED.events.off(event, handler);
         });
 
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
         let handleTopic = msg =>
         {
             let doRestartTimer = true;
+            let real_topic = helper.getTopicName(msg.topic);
 
-            switch (helper.getTopicName(msg.topic))
+            switch (real_topic)
             {
                 case "status":
                     // Make sure it is bool
                     msg.payload = !!msg.payload;
 
-                    if (node_settings.last_value == msg.payload && max_time_on_timeout != null)
+                    // 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)
                         doRestartTimer = false;
 
                     node_settings.last_value = msg.payload;
@@ -77,6 +126,7 @@ module.exports = function (RED)
                         return;
 
                     node_settings.last_value = false;
+                    node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "on":
@@ -85,19 +135,24 @@ module.exports = function (RED)
                         return;
 
                     node_settings.last_value = true;
+                    node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "set":
                     // Make sure it is bool
                     msg.payload = !!msg.payload;
+
                     node_settings.last_value = msg.payload;
+                    node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "set_permanent":
                     // Make sure it is bool
                     msg.payload = !!msg.payload;
-                    node_settings.last_value = msg.payload;
                     isPermanent = msg.payload;
+
+                    node_settings.last_value = msg.payload;
+                    node_settings.last_value_sended = node_settings.last_value;
                     break;
 
                 case "motion":
@@ -119,21 +174,67 @@ module.exports = function (RED)
                     {
                         node_settings.last_value = true;
                     }
+                    node_settings.last_value_sended = node_settings.last_value;
+                    break;
+
+                case "toggle":
+                    // If button is released, don't handle this message
+                    if (msg.payload === false)
+                        return;
+
+                    node_settings.last_value_sended = !node_settings.last_value;
+
+                    if (!node_settings.alarm_active)
+                        node_settings.last_value = !node_settings.last_value;
                     break;
 
                 case "alarm":
                     // Make sure it is bool
                     msg.payload = !!msg.payload;
-                    alarm_active = msg.payload;
+
+                    // No alarm change, do nothing
+                    if (node_settings.alarm_active == msg.payload)
+                        return;
+
+                    node_settings.alarm_active = msg.payload;
+                    if (node_settings.alarm_active)
+                    {
+                        // Alarm turned on
+                        node_settings.last_value_before_alarm = node_settings.last_value;
+                    }
+                    else
+                    {
+                        // Alarm turned off
+                        switch (alarm_off_action)
+                        {
+                            case "NOTHING":
+                                break;
+
+                            case "ON":
+                                node_settings.last_value = true;
+                                break;
+
+                            case "OFF":
+                                node_settings.last_value = false;
+                                break;
+
+                            case "LAST":
+                                node_settings.last_value = node_settings.last_value_before_alarm;
+                                break;
+
+                            case "LAST_SENDED":
+                                node_settings.last_value = node_settings.last_value_sended;
+                                break;
+                        }
+                    }
+
                     break;
 
-                case "toggle":
                 default:
-                    // If button is released, don't handle this message
-                    if (msg.payload === false)
-                        return;
+                    node_settings.last_value_sended = !node_settings.last_value;
 
-                    node_settings.last_value = !node_settings.last_value;
+                    if (!node_settings.alarm_active)
+                        node_settings.last_value = !node_settings.last_value;
                     break;
             }
 
@@ -141,7 +242,7 @@ module.exports = function (RED)
                 stopAutoOff();
 
             // Check alarm values
-            if (alarm_active)
+            if (node_settings.alarm_active)
             {
                 isPermanent = false;
 
@@ -151,14 +252,17 @@ module.exports = function (RED)
                         node_settings.last_value = true;
                         break;
 
-                    default:
                     case "OFF":
                         node_settings.last_value = false;
                         break;
+
+                    case "NOTHING":
+                    default:
+                        break;
                 }
             }
 
-            if (alarm_active || helper.getTopicName(msg.topic) != "status")
+            if (node_settings.alarm_active || helper.getTopicName(msg.topic) != "status")
                 node.send({ payload: node_settings.last_value });
 
             // Output is on, now
@@ -168,17 +272,22 @@ module.exports = function (RED)
             notifyCentral(node_settings.last_value);
         }
 
+
+        /**
+         * This function sets a timeout to turn off the light after the defined time is over.
+         * @param {*} origTimeMs The on time
+         */
         let startAutoOffIfNeeded = origTimeMs =>
         {
             // No timer when alarm is active
-            if (alarm_active)
+            if (node_settings.alarm_active)
                 return;
 
             let timeMs = parseInt(origTimeMs);
 
             if (isNaN(timeMs))
             {
-                node.error("Invalid time_on value send: " + origTimeMs);
+                console.warn("Invalid time_on value send: " + origTimeMs);
                 timeMs = max_time_on;
             }
 
@@ -193,9 +302,9 @@ module.exports = function (RED)
             if (timeMs <= 0 || isPermanent || isMotion || !node_settings.last_value)
                 return;
 
-            max_time_on_timeout = setTimeout(() =>
+            timeout = setTimeout(() =>
             {
-                max_time_on_timeout = null;
+                timeout = null;
                 node_settings.last_value = false;
                 node.send({ payload: false });
                 notifyCentral(false);
@@ -205,26 +314,32 @@ module.exports = function (RED)
             }, timeMs);
         };
 
+        /**
+         * Stops the current running timeout
+         */
         let stopAutoOff = () =>
         {
-            if (max_time_on_timeout != null)
+            if (timeout != null)
             {
-                clearTimeout(max_time_on_timeout);
-                max_time_on_timeout = null;
+                clearTimeout(timeout);
+                timeout = null;
             }
         };
 
+        /**
+         * Set the current node status
+         */
         let setStatus = () =>
         {
-            if (alarm_active)
+            if (node_settings.alarm_active)
             {
                 node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": ALARM is active" });
             }
             else if (node_settings.last_value)
             {
-                if (isPermanent || isMotion || max_time_on_timeout == null)
+                if (isPermanent || isMotion || timeout == null)
                     node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": On" });
-                else if (max_time_on_timeout)
+                else if (timeout)
                     node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Wait " + helper.formatDateToStatus(timeout_end_date, "until") + " for auto off" });
             }
             else
@@ -233,6 +348,10 @@ module.exports = function (RED)
             }
         }
 
+        /**
+         * Notify all connected central nodes
+         * @param {boolean} state The state if the light is on
+         */
         let notifyCentral = state =>
         {
             if (!config.links)
@@ -240,8 +359,8 @@ module.exports = function (RED)
 
             config.links.forEach(link =>
             {
-                // console.log(node.id + " -> " + link);
-                // console.log({ source: node.id, state: state });
+                helper.log(node.id + " -> " + link);
+                helper.log({ source: node.id, state: state });
                 RED.events.emit("node:" + link, { source: node.id, state: state });
             });
         }

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

@@ -0,0 +1,149 @@
+<script type="text/html" data-help-name="smart_light-control">
+    <p>
+        Diese Node steuert einen Ausgang. Dies kann ein Licht, eine Steckdose oder ähnliches sein.
+        Als Ausgang wird immer <code>msg.payload = true</code> oder <code>msg.payload = false</code> gesendet um den Ausgang ein-, bzw. auszuschalten.
+    </p>
+    <p>
+        <b>Hinweis:</b> Smart Nodes verwenden Topics im Format <code>name#nummer</code>, damit können verschiedene Smart Nodes mit dem gleichen Topic angesteuert werden.<br/>
+        Diese Node verwendet nur den Teil <code>name</code>. <code>#</code> und <code>nummer</code> sind dabei optional.
+    </p>
+    <p>
+        Folgende topics werden akzeptiert:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Beschreibung</th>
+                    <th>msg.payload == false wird ignoriert</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>status</code></td>
+                    <td>
+                        Gibt über <code>msg.payload = true</code> oder <code>msg.payload = false</code> den aktuellen Status des Ausgangs an.<br/>
+                        Bei einem Wechsel von ausgeschaltet nach eingeschaltet wird die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.
+                    </td>
+                    <td>Nein</td>
+                </tr>
+                <tr>
+                    <td><code>on</code></td>
+                    <td>Schaltet den Ausgang ein und startet die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.</td>
+                    <td>Ja</td>
+                </tr>
+                <tr>
+                    <td><code>off</code></td>
+                    <td>Schaltet den Ausgang aus.</td>
+                    <td>Ja</td>
+                </tr>
+                <tr>
+                    <td><code>set</code></td>
+                    <td>
+                        Schaltet den Ausgang bei <code>msg.payload = true</code> ein und bei <code>msg.payload = false</code> aus.<br/>
+                        Bei einem Wechsel von ausgeschaltet nach eingeschaltet wird die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.
+                    </td>
+                    <td>Nein</td>
+                </tr>
+                <tr>
+                    <td><code>set_permanent</code></td>
+                    <td>
+                        Schaltet den Ausgang bei <code>msg.payload = true</code> dauerhaft ein und bei <code>msg.payload = false</code> aus.<br/>
+                        Es wird dabei keine Zeitmessung gestartet.
+                    </td>
+                    <td>Nein</td>
+                </tr>
+                <tr>
+                    <td><code>motion</code></td>
+                    <td>
+                        Schaltet den Ausgang bei <code>msg.payload = true</code> ein ohne eine Zeitmessung.<br/>
+                        Bei <code>msg.payload = false</code> wird die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.<br/>
+                        Ist keine Zeit angegeben oder hinterlegt, schaltet sich der Ausgang sofort aus.
+                    </td>
+                    <td>Nein</td>
+                </tr>
+                <tr>
+                    <td><code>alarm</code></td>
+                    <td>
+                        Setzt den aktuellen Alarmzustand auf den Wert von <code>msg.payload</code> und löst die entsprechende Aktion aus.<br/>
+
+                        <table>
+                            <thead>
+                                <tr>
+                                    <th>Einstellung</th>
+                                    <th>Beschreibung</th>
+                                </tr>
+                            </thead>
+                            <tbody>
+                                <tr>
+                                    <td>Keine Aktion</td>
+                                    <td>Es passiert nichts</td>
+                                </tr>
+                                <tr>
+                                    <td>Einschalten</td>
+                                    <td>Der Ausgang wird eingeschalten.</td>
+                                </tr>
+                                <tr>
+                                    <td>Ausschalten</td>
+                                    <td>Der Ausgang wird ausgeschalten.</td>
+                                </tr>
+                                <tr>
+                                    <td>Letzen Zustand</td>
+                                    <td>Der Zustand bevor der Alarm gesetzt wurde wird wiederhergestellt.</td>
+                                </tr>
+                                <tr>
+                                    <td>Zuletzt gesendeten Zustand</td>
+                                    <td>Der Zustand der zuletzt empfangen wurde, auch während der Alarm aktiv war, wird wiederhergestellt.</td>
+                                </tr>
+                            </tbody>
+                        </table>
+                    </td>
+                    <td>Nein</td>
+                </tr>
+                <tr>
+                    <td><code>toggle</code> (default)</td>
+                    <td>
+                        Schaltet den Ausgang abwechselnd ein und aus.<br/>
+                        Bei einem Wechsel von ausgeschaltet nach eingeschaltet wird die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.
+                    </td>
+                    <td>Ja</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Diese Node hat eine einstellbare Maximallaufzeit, bevor der Ausgang automatisch wieder ausgeschalten wird.
+        Diese Zeitmessung wird wie in der Tabelle oben verwendet.
+        Die eingestellte Zeit kann gezielt überschrieben werden.
+        Beispiel: <code>msg = { "topic": "on", "time_on": 5000 }</code> oder <code>msg = { "topic": "on", "time_on": "5s" }</code><br/>
+        Diese Nachricht schaltet das Licht für 5000 Millisekunden / 5 Sekunden an und anschließend wieder aus.
+        Die nächste Nachricht ohne <code>time_on</code> Angabe verwendet wieder die voreingestellte Zeit.
+        Ist die Zeit auf 0 eingestellt, wird das Licht <b>nicht</b> automatisch ausgeschalten.<br/>
+        Als Einheit für die Zeit können folgende Werte verwendet werden:
+        <table>
+            <thead>
+                <tr>
+                    <th>Einheit</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>ms</code> (default)</td>
+                    <td>Millisekunden</td>
+                </tr>
+                <tr>
+                    <td><code>s</code> oder <code>sec</code></td>
+                    <td>Sekunden</td>
+                </tr>
+                <tr>
+                    <td><code>m</code> oder <code>min</code></td>
+                    <td>Mintun.</td>
+                </tr>
+                <tr>
+                    <td><code>h</code></td>
+                    <td>Stunden</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,24 @@
+{
+    "light": {
+        "ui": {
+            "name": "Name",
+            "text": "Text",
+            "controlled_by_words": "Diese Node kann über die eingegebenen Wörter gesteuert werden. Mehrere Wörter werden durch ein Komma getrennt.",
+            "time_on": "Zeit Ein",
+            "alarm_on": "Alarm Ein",
+            "alarm_off": "Alarm Aus",
+            "controlled_by_central": "Dieser Baustein wird von folgenden Zentralbausteinen gesteuert:",
+
+            "milliseconds": "Millisekunden",
+            "seconds": "Sekunden",
+            "minutes": "Minuten",
+            "hours": "Stunden",
+
+            "no_action": "Keine Aktion",
+            "turn_on": "Einschalten",
+            "turn_off": "Ausschalten",
+            "last_state": "Letzen Zustand",
+            "last_sended_state": "Zuletzt gesendeten Zustand"
+        }
+    }
+}

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

@@ -0,0 +1,148 @@
+<script type="text/html" data-help-name="smart_light-control">
+    <p>
+        This node controls an output. This can be a light, a socket or something similar.
+        The output is always <code>msg.payload = true</code> or <code>msg.payload = false</code> to switch the output on or off.
+    </p>
+    <p>
+        <b>Note:</b> Smart nodes use topics in the format <code>name#number</code>, so different smart nodes can be controlled with the same topic.<br />
+        This node only uses the <code>name</code> part. <code>#</code> and <code>number</code> are optional.
+    </p>
+    <p>
+        The following topics are accepted:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Description</th>
+                    <th>msg.payload == false is ignored</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>status</code></td>
+                    <td>
+                        Specifies the current status of the output via <code>msg.payload = true</code> or <code>msg.payload = false</code>.<br />
+                        When changing from switched off to switched on, the time measurement is started for the stored or  time, if available. </td>
+                    <td>No</td>
+                </tr>
+                <tr>
+                    <td><code>on</code></td>
+                    <td>Switches the output on and starts the time measurement for the stored or sent time, if available.</td>
+                    <td>Yes</td>
+                </tr>
+                <tr>
+                    <td><code>off</code></td>
+                    <td>Switches the output off.</td>
+                    <td>Yes</td>
+                </tr>
+                <tr>
+                    <td><code>set</code></td>
+                    <td>
+                        Switches the output on when <code>msg.payload = true</code> and off when <code>msg.payload = false</code>.<br />
+                        When changing from switched off to switched on, the time measurement is started for the stored or sent time, if available.
+                    </td>
+                    <td>No</td>
+                </tr>
+                <tr>
+                    <td><code>set_permanent</code></td>
+                    <td>
+                        Switches the output on permanently when <code>msg.payload = true</code> and off when <code>msg.payload = false</code>.<br />
+                        No time measurement is started.
+                    </td>
+                    <td>No</td>
+                </tr>
+                <tr>
+                    <td><code>motion</code></td>
+                    <td>
+                        Switches the output on when <code>msg.payload = true</code> without a time measurement.<br />
+                        When <code>msg.payload = false</code> the time measurement is started for the stored or sent time, if available.<br />
+                        If no time is specified or stored, the output switches off immediately.
+                    </td>
+                    <td>No</td>
+                </tr>
+                <tr>
+                    <td><code>alarm</code></td>
+                    <td>
+                        Sets the current alarm state to the value of <code>msg.payload</code> and triggers the corresponding action.<br />
+
+                        <table>
+                            <thead>
+                                <tr>
+                                    <th>Setting</th>
+                                    <th>Description</th>
+                                </tr>
+                            </thead>
+                            <tbody>
+                                <tr>
+                                    <td>No action</td>
+                                    <td>Nothing happens</td>
+                                </tr>
+                                <tr>
+                                    <td>Switch on</td>
+                                    <td>The output is switched on.</td>
+                                </tr>
+                                <tr>
+                                    <td>Switch off</td>
+                                    <td>The output is switched off.</td>
+                                </tr>
+                                <tr>
+                                    <td>Last state</td>
+                                    <td>The state before the alarm was set is restored.</td>
+                                </tr>
+                                <tr>
+                                    <td>Last sent state</td>
+                                    <td>The state that was last received, even while the alarm was active, is restored.</td>
+                                </tr>
+                            </tbody>
+                        </table>
+                    </td>
+                    <td>No</td>
+                </tr>
+                <tr>
+                    <td><code>toggle</code> (default)</td>
+                    <td>
+                        Switches the output on and off alternately.<br />
+                        When switching from off to on, the time measurement is started for the stored or sent time, if available.
+                    </td>
+                    <td>Yes</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        This node has an adjustable maximum runtime before the output is automatically switched off again.
+        This time measurement is used as in the table above.
+        The set time can be overwritten specifically.
+        Example: <code>msg = { "topic": "on", "time_on": 5000 }</code> or <code>msg = { "topic": "on", "time_on": "5s" }</code><br />
+        This message switches the light on for 5000 milliseconds / 5 seconds and then off again.
+        The next message without <code>time_on</code> specification uses the preset time again.
+        If the time is set to 0, the light will <b>not</b> be switched off automatically.<br />
+        The following values can be used as the unit for the time:
+        <table>
+            <thead>
+                <tr>
+                    <th>Unit</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>ms</code> (default)</td>
+                    <td>Milliseconds</td>
+                </tr>
+                <tr>
+                    <td><code>s</code> or <code>sec</code></td>
+                    <td>Seconds</td>
+                </tr>
+                <tr>
+                    <td><code>m</code> or <code>min</code></td>
+                    <td>Mintun.</td>
+                </tr>
+                <tr>
+                    <td><code>h</code></td>
+                    <td>Hours</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>