smart-nodes 0.3.36 → 0.4.0

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

@@ -0,0 +1,21 @@
+{
+    "scene": {
+        "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",
+            "controlled_by_central": "Dieser Baustein wird von folgenden Zentralbausteinen gesteuert:",
+
+            "outputs": "Ausgänge",
+            "scenes": "Szenen",
+            "links": "Links",
+            
+            "milliseconds": "Millisekunden",
+            "seconds": "Sekunden",
+            "minutes": "Minuten",
+            "hours": "Stunden"
+
+        }
+    }
+}

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

@@ -0,0 +1,107 @@
+<script type="text/html" data-help-name="smart_scene-control">
+    <p>
+        This node controls several outputs that are switched on or off based on a defined scene.
+
+        <code>msg.payload = true</code> or <code>msg.payload = false</code> is always sent to each output to switch it 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 uses both the <code>name</code> and <code>number</code> parts. Depending on the message, both values may need to be set.
+    </p>
+    <p>
+        The following topics are accepted:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>status#2</code></td>
+                    <td>
+                        Indicates the current status of output <code>2</code> via <code>msg.payload = true</code> or <code>msg.payload = false</code>.<br />
+                        When an output changes, the time measurement is started for the stored or sent time, if available.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>on</code></td>
+                    <td>Switches all outputs on and starts the time measurement for the stored or sent time, if available.</td>
+                </tr>
+                <tr>
+                    <td><code>off</code></td>
+                    <td>Switches all outputs off.</td>
+                </tr>
+                <tr>
+                    <td><code>set</code></td>
+                    <td>
+                        Switches all outputs 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>
+                </tr>
+                <tr>
+                    <td><code>set_permanent</code></td>
+                    <td>
+                        Switches all outputs permanently on when <code>msg.payload = true</code> and off when <code>msg.payload = false</code>.<br />
+                        No time measurement is started.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>scene_x,y,z</code></td>
+                    <td>
+                        Switches the outputs on or off according to the specified scene numbers (x, y and z).<br />
+                        When the message arrives, it is checked which scene is currently active. If the number appears in the list, the next specified scene is activated.<br />
+                        If the scene does not appear in the list, the first scene listed is activated.<br />
+                        If only one scene is specified, the block switches between the specified scene and off.<br />
+                        If at least one output is switched on, the time measurement starts again.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>toggle</code> (default)</td>
+                    <td>
+                        Switches all outputs off if at least one is already switched on.<br />
+                        If all outputs are already switched off, all are switched on.
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        This node has an adjustable maximum runtime before all outputs are 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>

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

@@ -0,0 +1,20 @@
+{
+    "scene": {
+        "ui": {
+            "name": "Name",
+            "text": "Text",
+            "controlled_by_words": "This node can be controlled using the words entered. Multiple words are separated by a comma.",
+            "time_on": "Time On",
+            "controlled_by_central": "This block is controlled by the following central blocks:",
+
+            "outputs": "Outputs",
+            "scenes": "Scenes",
+            "links": "Links",
+
+            "milliseconds": "Milliseconds",
+            "seconds": "Seconds",
+            "minutes": "Minutes",
+            "hours": "Hours"
+        }
+    }
+}

package/{scene-control/scene-control.html → scene/scene.html}

@@ -204,7 +204,8 @@
             {
                 let value = $(inputs[i]).typedInput("value");
                 $(inputs[i]).typedInput("types", [{
-                    multiple: "true",
+                    value: "output",
+                    multiple: true,
                     options: options
                 }]);
                 $(inputs[i]).typedInput("value", value);
@@ -242,6 +243,7 @@
             oneditprepare: function ()
             {
                 let node = this;
+
                 onEditPrepare(this, ["smart_central-control"]);
                 initTreeList(node, ["smart_central-control"]);
 
@@ -268,7 +270,7 @@
                             .appendTo(row);
 
                         // Output name
-                        var outputName = $("<input/>", { class: "node-input-prop-name", placeholder: "Name", type: "text" })
+                        var outputName = $("<input/>", { class: "node-input-prop-name", placeholder: node._("scene.ui.name"), type: "text" })
                             .css("width", "80%")
                             .appendTo(row);
 
@@ -312,7 +314,7 @@
                             .appendTo(row);
 
                         // Scene name
-                        var sceneName = $("<input/>", { class: "node-input-prop-name", placeholder: "Name", type: "text" })
+                        var sceneName = $("<input/>", { class: "node-input-prop-name", placeholder: node._("scene.ui.name"), type: "text" })
                             .css("width", "30%")
                             .appendTo(row);
 
@@ -326,10 +328,11 @@
                             .css("width", "calc(70% - 55px)")
                             .appendTo(row)
                             .typedInput({
+                                type: "output",
                                 types: [{
-                                    multiple: "true",
-                                    options: [
-                                    ]
+                                    value: "output",
+                                    multiple: true,
+                                    options: []
                                 }]
                             });
 
@@ -370,19 +373,19 @@
                 tabs.addTab({
                     id: "scene-tab-outputs",
                     iconClass: "fa fa-lightbulb-o",
-                    label: "Ausgänge"
+                    label: node._("scene.ui.outputs")
                 });
 
                 tabs.addTab({
                     id: "scene-tab-scenes",
                     iconClass: "fa fa-list-ul",
-                    label: "Szenen"
+                    label: node._("scene.ui.scenes")
                 });
 
                 tabs.addTab({
                     id: "scene-tab-links",
                     iconClass: "fa fa-links",
-                    label: "Links"
+                    label: node._("scene.ui.links")
                 });
 
 
@@ -404,21 +407,22 @@
                 $("#node-input-max_time_on_unit")
                     .css("max-width", "10rem")
                     .typedInput({
-                        types: [
-                            {
-                                default: "s",
-                                options: [
-                                    { value: "ms", label: "Millisekunden" },
-                                    { value: "s", label: "Sekunden" },
-                                    { value: "min", label: "Minuten" },
-                                    { value: "h", label: "Stunden" },
-                                ],
-                            },
-                        ],
+                        types: [{
+                            default: "s",
+                            value: "max_time_on_unit",
+                            options: [
+                                { value: "ms", label: node._("scene.ui.milliseconds") },
+                                { value: "s", label: node._("scene.ui.seconds") },
+                                { value: "min", label: node._("scene.ui.minutes") },
+                                { value: "h", label: node._("scene.ui.hours") },
+                            ],
+                        }],
                     });
             },
             oneditsave: function ()
             {
+                let node = this;
+                
                 // Set scenes
                 var items = $("#node-input-property-scenes").editableList("items");
                 var result = getScenes(items);
@@ -441,16 +445,16 @@
 
 <script type="text/html" data-template-name="smart_scene-control">
     <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name" />
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="scene.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]scene.ui.name" />
     </div>
     <div class="form-row">
-        <label for="node-input-exec_text_names"><i class="fa fa-comments-o"></i> Text</label>
+        <label for="node-input-exec_text_names"><i class="fa fa-comments-o"></i> <span data-i18n="scene.ui.text"></span></label>
         <input id="node-input-exec_text_names" type="text" />
-        <div style="max-width: 450px;">Diese Node kann über die eingegebenen Wörter gesteuert werden. Mehrere Wörter werden durch ein Komma getrennt.</div>
+        <div style="max-width: 450px;" data-i18n="scene.ui.controlled_by_words"></div>
     </div>
     <div class="form-row">
-        <label for="node-input-max_time_on"><i class="fa fa-clock-o"></i> Zeit Ein</label>
+        <label for="node-input-max_time_on"><i class="fa fa-clock-o"></i> <span data-i18n="scene.ui.time_on"></span></label>
         <input id="node-input-max_time_on" value="0" />
         <input id="node-input-max_time_on_unit" />
     </div>
@@ -467,115 +471,9 @@
                 <ol id="node-input-property-scenes"></ol>
             </div>
             <div id="scene-tab-links" style="display: none;">
-                <span><i class="fa fa-link"></i> Dieser Baustein wird von folgenden Zentralbausteinen gesteuert:</span>
+                <span><i class="fa fa-link"></i> <span data-i18n="scene.ui.controlled_by_central"></span></span>
                 <div class="form-row node-input-link-row node-input-link-rows"></div>
             </div>
         </div>
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_scene-control">
-    <p>
-        Diese Node steuert mehrere Ausgänge die anhand einer definierten Szene ein- bzw. ausgeschaltet werden.
-        An jeden Ausgang wird immer <code>msg.payload = true</code> oder <code>msg.payload = false</code> gesendet um ihn 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 sowohl den Teil <code>name</code> als auch <code>nummer</code>. Je nach Nachricht müssen evtl. beide Werte gesetzt sein.
-    </p>
-    <p>
-        Folgende topics werden akzeptiert:
-        <table>
-            <thead>
-                <tr>
-                    <th>Topic</th>
-                    <th>Beschreibung</th>
-                </tr>
-            </thead>
-            <tbody>
-                <tr>
-                    <td><code>status#2</code></td>
-                    <td>
-                        Gibt über <code>msg.payload = true</code> oder <code>msg.payload = false</code> den aktuellen Status des Ausgangs <code>2</code> an.<br/>
-                        Bei einem Wechsel eines Ausgangs wird die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.
-                    </td>
-                </tr>
-                <tr>
-                    <td><code>on</code></td>
-                    <td>Schaltet alle Ausgänge ein und startet die Zeitmessung für die hinterlegte, bzw. mitgesendete Zeit gestartet, sofern vorhanden.</td>
-                </tr>
-                <tr>
-                    <td><code>off</code></td>
-                    <td>Schaltet alle Ausgänge aus.</td>
-                </tr>
-                <tr>
-                    <td><code>set</code></td>
-                    <td>
-                        Schaltet alle Ausgänge 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>
-                </tr>
-                <tr>
-                    <td><code>set_permanent</code></td>
-                    <td>
-                        Schaltet alle Ausgänge bei <code>msg.payload = true</code>dauerhaft ein und bei <code>msg.payload = false</code> aus.<br/>
-                        Es wird dabei keine Zeitmessung gestartet.
-                    </td>
-                </tr>
-                <tr>
-                    <td><code>scene_x,y,z</code></td>
-                    <td>
-                        Schaltet die Ausgänge entsprechend der mitgegebenen Szenennummern (x, y und z) an, bzw. aus.<br/>
-                        Beim Eintreffen der Nachricht wird geschaut welche Szene aktuell aktiv ist. Taucht die Nummer in der Liste auf, wird die nächste angegebene Szene aktiviert.<br/>
-                        Taucht die Szene nicht in der Liste auf, wird die erste aufgelistete Szene aktiviert.<br/>
-                        Wenn nur eine Szene angegeben ist, wechselt der Baustein zwischen der angegebenen Szene und aus.<br/>
-                        Sollte mindestens ein Ausgang eingeschaltet sein, startet die Zeitmessung erneut.
-                    </td>
-                </tr>
-                <tr>
-                    <td><code>toggle</code> (default)</td>
-                    <td>
-                        Schaltet alle Ausgänge aus, falls mindestens einer bereits eingeschaltet wahr.<br/>
-                        Sollten bereits alle Ausgänge ausgeschaltet sein, werden alle eingeschalten.
-                    </td>
-                </tr>
-            </tbody>
-        </table>
-    </p>
-    <p>
-        Diese Node hat eine einstellbare Maximallaufzeit, bevor alle Ausgänge automatisch wieder ausgeschalten werden.
-        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/{scene-control/scene-control.js → scene/scene.js}

@@ -7,29 +7,62 @@ 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_values: [], // light is on or off for a scene
         }, smart_context.get(node.id));
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let max_time_on = helper.getTimeInMs(config.max_time_on, config.max_time_on_unit);
 
-        // runtime values
-        let max_time_on_timeout = null;
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // 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;
-        let current_timeout_ms = 0;
 
-        // central handling
+
+        // Here the date is stored, when the light should go off.
+        // This is used to calculate the node status.
+        let timeout_end_date = null;
+
+
+        // #########################
+        // # Central node handling #
+        // #########################
         var event = "node:" + config.id;
         var handler = function (msg)
         {
@@ -38,14 +71,14 @@ module.exports = function (RED)
         RED.events.on(event, handler);
 
 
+        // Per default expect that all outputs are off
         if (node_settings.last_values.length != config.scenes.length)
-        {
-            // Per default expect that all outputs are off
             node_settings.last_values = new Array(config.outputs).fill(false);
-        }
 
-        node.status({});
 
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
             handleTopic(msg);
@@ -54,7 +87,7 @@ module.exports = function (RED)
             if (getCurrentScene() != 0)
                 startAutoOffIfNeeded(helper.getTimeInMsFromString(msg.time_on ?? max_time_on));
 
-            status();
+            setStatus();
             smart_context.set(node.id, node_settings);
         });
 
@@ -64,6 +97,12 @@ 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 currentScene = getCurrentScene();
@@ -211,7 +250,16 @@ module.exports = function (RED)
                 timeMs = max_time_on;
             }
 
-            current_timeout_ms = timeMs;
+            // calculate end date for status message
+            if (timeMs > 0)
+            {
+                timeout_end_date = new Date();
+                timeout_end_date.setMilliseconds(timeout_end_date.getMilliseconds() + timeMs);
+            }
+            else
+            {
+                timeout_end_date = null;
+            }
 
             // Stop if any timeout is set
             stopAutoOff();
@@ -220,35 +268,36 @@ module.exports = function (RED)
             if (timeMs <= 0 || isPermanent || getCurrentScene() == 0)
                 return;
 
-            max_time_on_timeout = setTimeout(() =>
+            timeout = setTimeout(() =>
             {
+                timeout = null;
                 node_settings.last_values = new Array(config.outputs).fill(false);
                 node.send(node_settings.last_values.map(val => { return { payload: val }; }));
                 notifyCentral();
 
-                status();
+                setStatus();
                 smart_context.set(node.id, node_settings);
             }, timeMs);
         }
 
         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;
             }
         }
 
-        let status = () =>
+        let setStatus = () =>
         {
             let scene = getCurrentScene();
             if (scene != 0)
             {
-                if (isPermanent || current_timeout_ms <= 0)
+                if (isPermanent || timeout_end_date == null)
                     node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active" });
-                else if (max_time_on_timeout)
-                    node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active, wait " + helper.formatMsToStatus(current_timeout_ms, "until") + " for auto off" });
+                else if (timeout)
+                    node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active, wait " + helper.formatDateToStatus(timeout_end_date, "until") + " for auto off" });
             }
             else
             {
@@ -265,8 +314,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 });
             });
         }
@@ -275,7 +324,8 @@ module.exports = function (RED)
         if (getCurrentScene() != 0)
             startAutoOffIfNeeded(helper.getTimeInMsFromString(max_time_on));
 
-        status();
+        setStatus();
     }
+
     RED.nodes.registerType("smart_scene-control", SceneControlNode);
 };

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

@@ -0,0 +1,30 @@
+<script type="text/html" data-help-name="smart_scheduler">
+    <p>
+        Diese Node sendet zu den angegebenen Zeitpunkten die entsprechenden Nachrichten an den Ausgang.
+    </p>
+    <p>
+        Folgende topics werden akzeptiert:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>enable</code></td>
+                    <td>Aktiviert den Scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deaktiviert den Scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Aktiviert den Scheduler, wenn <code>msg.payload = true</code> oder deaktiviert den Scheduler, wenn <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,21 @@
+{
+    "scheduler": {
+        "ui": {
+            "name": "Name",
+            "scheduler_enabled": "Scheduler aktiviert",
+            "schedules": "Schedules",
+
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "monday": "Montag",
+            "tuesday": "Dienstag",
+            "wednesday": "Mittwoch",
+            "thursday": "Donnerstag",
+            "friday": "Freitag",
+            "saturday": "Samstag",
+            "sunday": "Sonntag"
+        }
+    }
+}