node-red-contrib-weekly-schedule 1.0.0

package/README.md

@@ -0,0 +1,35 @@
+# node-red-contrib-weekly-schedule
+
+A Node-RED weekly scheduler with configurable time windows per day. Outputs a boolean or custom value based on the current time.
+
+## Installation
+
+```bash
+npm install node-red-contrib-weekly-schedule
+```
+
+## Inputs
+
+- **override** _(optional)_ `boolean`: Force ON (true) or OFF (false) regardless of schedule.
+- **clearOverride** _(optional)_ `boolean`: Remove override and return to schedule.
+
+## Outputs
+
+- **Output 1 payload** `any`: ON or OFF value on every input message.
+- **Output 2 payload** `any`: ON or OFF value only on state change (checked every 10s).
+
+## Configuration
+
+- **Schedule**: List of day + time window entries. Add multiple per day for multiple windows.
+- **ON/OFF Value**: Values to output when active/inactive (default: true / false).
+- **Timezone**: Optional timezone string (default: system timezone).
+
+## Tips
+
+- Midnight crossing supported: set From after To (e.g. 22:00-06:00).
+- Trigger Output 1 by injecting a message on Node-RED start.
+- Output 2 fires automatically every 10s when state changes.
+
+## License
+
+MIT (c) sr.rpo

package/locales/de/weekly-schedule.json

@@ -0,0 +1,10 @@
+{
+  "weekly-schedule": {
+    "label": {
+      "schedule": "Zeitplan",
+      "onValue": "EIN-Wert",
+      "offValue": "AUS-Wert",
+      "timezone": "Zeitzone"
+    }
+  }
+}

package/locales/en/weekly-schedule.json

@@ -0,0 +1,10 @@
+{
+  "weekly-schedule": {
+    "label": {
+      "schedule": "Schedule",
+      "onValue": "ON Value",
+      "offValue": "OFF Value",
+      "timezone": "Timezone"
+    }
+  }
+}

package/locales/es/weekly-schedule.json

@@ -0,0 +1,10 @@
+{
+  "weekly-schedule": {
+    "label": {
+      "schedule": "Horario",
+      "onValue": "Valor ON",
+      "offValue": "Valor OFF",
+      "timezone": "Zona horaria"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "node-red-contrib-weekly-schedule",
+  "version": "1.0.0",
+  "description": "Weekly scheduler with configurable time windows per day of week",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Wobi848/node-red-contrib-rpo-suite.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Wobi848/node-red-contrib-rpo-suite/issues"
+  },
+  "files": [
+    "weekly-schedule.js",
+    "weekly-schedule.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "schedule",
+    "weekly",
+    "timer",
+    "time",
+    "calendar",
+    "automation"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "weekly-schedule": "weekly-schedule.js"
+    }
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "test": "mocha \"test/**/*_spec.js\" --exit"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "node-red": "^3.1.0",
+    "node-red-node-test-helper": "^0.3.6"
+  }
+}

package/weekly-schedule.html

@@ -0,0 +1,128 @@
+<script type="text/javascript">
+    RED.nodes.registerType('weekly-schedule', {
+        category:  'rpo',
+        color:     '#D4600A',
+        defaults: {
+            name:     { value: '' },
+            schedule: { value: [] },
+            onValue:  { value: true },
+            offValue: { value: false },
+            timezone: { value: '' }
+        },
+        inputs:  1,
+        outputs: 2,
+        icon:    'font-awesome/fa-calendar',
+        label:   function() { return this.name || 'weekly schedule'; },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; },
+        outputLabels: ['Current state', 'On state change'],
+        oneditprepare: function() {
+            var node = this;
+            var DAYS = ['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday'];
+
+            $('#node-input-schedule-list').editableList({
+                addItem: function(container, i, data) {
+                    data = data || {};
+                    container.css({ overflow: 'hidden', whiteSpace: 'nowrap' });
+                    var row = $('<div style="display:flex;gap:6px;align-items:center;width:100%"></div>').appendTo(container);
+
+                    var daySelect = $('<select style="flex:1"></select>');
+                    for (var d = 0; d < 7; d++) {
+                        var opt = $('<option></option>').val(d).text(DAYS[d]);
+                        if (data.day !== undefined && parseInt(data.day) === d) opt.prop('selected', true);
+                        daySelect.append(opt);
+                    }
+
+                    var fromInput = $('<input type="time" style="flex:1" value="' + (data.from || '06:00') + '">');
+                    var toInput   = $('<input type="time" style="flex:1" value="' + (data.to   || '22:00') + '">');
+
+                    $('<span>Day</span>').appendTo(row);
+                    daySelect.appendTo(row);
+                    $('<span>From</span>').appendTo(row);
+                    fromInput.appendTo(row);
+                    $('<span>To</span>').appendTo(row);
+                    toInput.appendTo(row);
+
+                    container.data('daySelect', daySelect);
+                    container.data('fromInput', fromInput);
+                    container.data('toInput',   toInput);
+                },
+                removable: true,
+                sortable:  true
+            });
+
+            var items = node.schedule || [];
+            for (var i = 0; i < items.length; i++) {
+                $('#node-input-schedule-list').editableList('addItem', items[i]);
+            }
+        },
+        oneditsave: function() {
+            var node = this;
+            var items = $('#node-input-schedule-list').editableList('items');
+            node.schedule = [];
+            items.each(function() {
+                var container = $(this);
+                node.schedule.push({
+                    day:  parseInt(container.data('daySelect').val()),
+                    from: container.data('fromInput').val(),
+                    to:   container.data('toInput').val()
+                });
+            });
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="weekly-schedule">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
+    </div>
+    <div class="form-row">
+        <label><i class="fa fa-calendar"></i> <span data-i18n="weekly-schedule.label.schedule"></span></label>
+        <ol id="node-input-schedule-list" style="margin-bottom:0"></ol>
+    </div>
+    <div class="form-row">
+        <label for="node-input-onValue"><i class="fa fa-check-circle"></i> <span data-i18n="weekly-schedule.label.onValue"></span></label>
+        <input type="text" id="node-input-onValue" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-offValue"><i class="fa fa-times-circle"></i> <span data-i18n="weekly-schedule.label.offValue"></span></label>
+        <input type="text" id="node-input-offValue" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-timezone"><i class="fa fa-globe"></i> <span data-i18n="weekly-schedule.label.timezone"></span></label>
+        <input type="text" id="node-input-timezone" style="width:70%" placeholder="(system default)">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="weekly-schedule">
+    <p>Weekly scheduler with configurable time windows per day. Outputs <code>true</code>/<code>false</code> (or custom values) based on current time.</p>
+
+    <h3>Outputs</h3>
+    <ol>
+        <li><b>Current state</b> — fires on every input message with the current active/inactive state.</li>
+        <li><b>State change</b> — fires only when the state changes (on→off or off→on), checked every 10 seconds.</li>
+    </ol>
+
+    <h3>Input</h3>
+    <dl class="message-properties">
+        <dt class="optional">override <span class="property-type">boolean</span></dt>
+        <dd>Force ON (<code>true</code>) or OFF (<code>false</code>) regardless of schedule.</dd>
+        <dt class="optional">clearOverride <span class="property-type">boolean</span></dt>
+        <dd>Set to <code>true</code> to remove override and return to schedule.</dd>
+    </dl>
+
+    <h3>Output</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">any</span></dt>
+        <dd>Configured ON or OFF value.</dd>
+        <dt>schedule <span class="property-type">object</span></dt>
+        <dd><code>{ active, day, time, override }</code></dd>
+    </dl>
+
+    <h3>Tips</h3>
+    <ul>
+        <li>Midnight crossing is supported: set "From" after "To" (e.g. 22:00–06:00).</li>
+        <li>Multiple windows per day: add multiple entries with the same day.</li>
+        <li>Trigger Output 1 by injecting any message (e.g. on Node-RED start).</li>
+    </ul>
+</script>

package/weekly-schedule.js

@@ -0,0 +1,107 @@
+module.exports = function(RED) {
+    function WeeklyScheduleNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.schedule  = config.schedule  || [];
+        node.onValue   = config.onValue  !== undefined ? config.onValue  : true;
+        node.offValue  = config.offValue !== undefined ? config.offValue : false;
+        node.timezone  = config.timezone  || '';
+
+        node.override  = null; // null = no override, true = forced on, false = forced off
+        node.lastState = null;
+
+        updateStatus(node);
+
+        // Periodic check every 10 seconds for Output 2 (state change)
+        node.timer = setInterval(function() {
+            var active   = isActive(node);
+            var current  = (node.override !== null) ? node.override : active;
+
+            if (current !== node.lastState) {
+                node.lastState = current;
+                var changeMsg  = buildMsg(node, active, current);
+                updateStatus(node);
+                node.send([null, changeMsg]);
+            }
+        }, 10000);
+
+        node.on('input', function(msg) {
+            if (msg.override !== undefined) {
+                node.override = (msg.override === true || msg.override === 'true') ? true : false;
+            }
+            if (msg.clearOverride === true) {
+                node.override = null;
+            }
+
+            var active  = isActive(node);
+            var current = (node.override !== null) ? node.override : active;
+
+            if (current !== node.lastState) {
+                node.lastState = current;
+                node.send([buildMsg(node, active, current), buildMsg(node, active, current)]);
+            } else {
+                node.send([buildMsg(node, active, current), null]);
+            }
+
+            updateStatus(node);
+        });
+
+        node.on('close', function() {
+            clearInterval(node.timer);
+        });
+
+        function isActive(n) {
+            var now  = new Date();
+            var day  = now.getDay();                   // 0=Sun, 6=Sat
+            var hhmm = pad(now.getHours()) + ':' + pad(now.getMinutes());
+
+            for (var i = 0; i < n.schedule.length; i++) {
+                var entry = n.schedule[i];
+                if (parseInt(entry.day, 10) !== day) continue;
+                var from = entry.from || '00:00';
+                var to   = entry.to   || '24:00';
+                if (to === '24:00') to = '23:59';
+
+                if (from <= to) {
+                    if (hhmm >= from && hhmm <= to) return true;
+                } else {
+                    // midnight crossing
+                    if (hhmm >= from || hhmm <= to) return true;
+                }
+            }
+            return false;
+        }
+
+        function buildMsg(n, active, current) {
+            var now     = new Date();
+            var hhmm    = pad(now.getHours()) + ':' + pad(now.getMinutes());
+            var payload = current ? n.onValue : n.offValue;
+            return {
+                payload:  payload,
+                schedule: {
+                    active:   active,
+                    day:      now.getDay(),
+                    time:     hhmm,
+                    override: n.override !== null ? n.override : false
+                }
+            };
+        }
+
+        function updateStatus(n) {
+            var active  = isActive(n);
+            var current = (n.override !== null) ? n.override : active;
+            if (n.override !== null) {
+                n.status({ fill: 'yellow', shape: 'dot', text: 'OVERRIDE ' + (n.override ? 'ON' : 'OFF') });
+            } else if (current) {
+                n.status({ fill: 'green', shape: 'dot', text: 'ACTIVE' });
+            } else {
+                n.status({ fill: 'grey', shape: 'dot', text: 'INACTIVE' });
+            }
+        }
+
+        function pad(n) { return n < 10 ? '0' + n : String(n); }
+    }
+
+    RED.nodes.registerType('weekly-schedule', WeeklyScheduleNode);
+};