node-red-contrib-scheduler-plus 1.1.0 → 1.1.3

package/LICENSE

@@ -0,0 +1,4 @@
+Copyright (c) Peter Scargill (http://tech.scargill.net)
+
+Free to use for whatever purpose you like. If you redesign it, please keep the
+original author's name and link (http://tech.scargill.net).

package/README.md

@@ -1,7 +1,7 @@
 # Scheduler for Node-RED
 
-[![CI](https://github.com/ltoinel/scheduler/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/ltoinel/scheduler/actions/workflows/ci.yml)
-[![Coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fltoinel%2Fscheduler%2Fbadges%2Fcoverage.json)](https://github.com/ltoinel/scheduler/actions/workflows/ci.yml)
+[![CI](https://github.com/ltoinel/node-red-contrib-scheduler-plus/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/ltoinel/node-red-contrib-scheduler-plus/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fltoinel%2Fnode-red-contrib-scheduler-plus%2Fbadges%2Fcoverage.json)](https://github.com/ltoinel/node-red-contrib-scheduler-plus/actions/workflows/ci.yml)
 [![npm version](https://img.shields.io/npm/v/node-red-contrib-scheduler-plus?logo=npm)](https://www.npmjs.com/package/node-red-contrib-scheduler-plus)
 [![npm downloads](https://img.shields.io/npm/dm/node-red-contrib-scheduler-plus)](https://www.npmjs.com/package/node-red-contrib-scheduler-plus)
 [![Node-RED](https://img.shields.io/badge/Node--RED-%3E%3D1.0-8f0000?logo=nodered)](https://flows.nodered.org/node/node-red-contrib-scheduler-plus)
@@ -20,6 +20,8 @@ Originally written by Peter Scargill — see http://tech.scargill.net/node-red-s
 
 ## Installation
 
+The node is listed in the [Node-RED Flow Library](https://flows.nodered.org/node/node-red-contrib-scheduler-plus).
+
 From the Node-RED palette manager, search for **node-red-contrib-scheduler-plus**, or from your
 Node-RED user directory (usually `~/.node-red`):
 
@@ -63,7 +65,7 @@ dawn or dusk on that day (polar day or night at high latitudes).
 ## Development
 
 ```sh
-git clone https://github.com/ltoinel/scheduler.git
+git clone https://github.com/ltoinel/node-red-contrib-scheduler-plus.git
 cd scheduler
 npm install        # also enables the git hooks
 npm run lint       # ESLint
@@ -80,10 +82,21 @@ Git hooks (in `.githooks/`, enabled by `npm install`):
 
 1. Bump `version` in `package.json` and update the changelog.
 2. Create a GitHub release with the tag `v<version>` (e.g. `v1.1.0`).
-3. The [Publish](.github/workflows/publish.yml) workflow lints, tests and publishes to npm with provenance.
+3. The [Release](.github/workflows/release.yml) workflow lints, tests and publishes to npm with provenance.
 
 ## Changelog
 
+### 1.1.3
+- **Breaking change:** the node type is renamed from `scheduler` to `scheduler-plus`, so it no longer clashes with `node-red-contrib-scheduler` and `node-red-contrib-majordomus`. Existing flows show the old nodes as unknown: export the flow, replace `"type": "scheduler"` with `"type": "scheduler-plus"`, then import it again.
+- Added a `LICENSE` file and the `license` field in `package.json` (same terms as before).
+- Added an example flow, available in Node-RED under Import > Examples.
+
+### 1.1.2
+- Repository URLs updated to `ltoinel/node-red-contrib-scheduler-plus` (fixes npm provenance on publish).
+
+### 1.1.1
+- The npm publishing workflow is renamed to `release.yml`.
+
 ### 1.1.0
 - Fixed wrong On Time values between 21:45 and 23:45 (offset by 10 minutes); existing flows are migrated automatically.
 - Fixed a one-minute delay and negative values in the time computation.
@@ -101,5 +114,5 @@ Git hooks (in `.githooks/`, enabled by `npm install`):
 
 ## License
 
-Free to use for whatever purpose you like. If you redesign it, please keep the original author's name and link
+See [LICENSE](LICENSE). Free to use for whatever purpose you like. If you redesign it, please keep the original author's name and link
 (http://tech.scargill.net).

package/examples/basic-schedules.json

@@ -0,0 +1,164 @@
+[
+    {
+        "id": "c1",
+        "type": "comment",
+        "z": "",
+        "name": "Weekdays 07:00-08:00, and from dusk to 23:00 every day (Paris). Output 1 = on/off changes, output 2 = status every minute.",
+        "info": "",
+        "x": 400,
+        "y": 40,
+        "wires": []
+    },
+    {
+        "id": "s1",
+        "type": "scheduler-plus",
+        "z": "",
+        "name": "Weekday mornings",
+        "outtopic": "lights/morning",
+        "outpayload1": "on",
+        "outpayload2": "off",
+        "lat": "48.85",
+        "lon": "2.35",
+        "start": "sunrise",
+        "end": "sunset",
+        "starttime": "420",
+        "endtime": "480",
+        "duskoff": "0",
+        "dawnoff": "0",
+        "x": 180,
+        "y": 100,
+        "wires": [
+            [
+                "d1"
+            ],
+            [
+                "d2"
+            ]
+        ],
+        "sun": false,
+        "mon": true,
+        "tue": true,
+        "wed": true,
+        "thu": true,
+        "fri": true,
+        "sat": false,
+        "jan": true,
+        "feb": true,
+        "mar": true,
+        "apr": true,
+        "may": true,
+        "jun": true,
+        "jul": true,
+        "aug": true,
+        "sep": true,
+        "oct": true,
+        "nov": true,
+        "dec": true
+    },
+    {
+        "id": "s2",
+        "type": "scheduler-plus",
+        "z": "",
+        "name": "Dusk to 23:00",
+        "outtopic": "lights/evening",
+        "outpayload1": "on",
+        "outpayload2": "off",
+        "lat": "48.85",
+        "lon": "2.35",
+        "start": "sunrise",
+        "end": "sunset",
+        "starttime": "6000",
+        "endtime": "1380",
+        "duskoff": "0",
+        "dawnoff": "0",
+        "x": 180,
+        "y": 200,
+        "wires": [
+            [
+                "d3"
+            ],
+            [
+                "d4"
+            ]
+        ],
+        "sun": true,
+        "mon": true,
+        "tue": true,
+        "wed": true,
+        "thu": true,
+        "fri": true,
+        "sat": true,
+        "jan": true,
+        "feb": true,
+        "mar": true,
+        "apr": true,
+        "may": true,
+        "jun": true,
+        "jul": true,
+        "aug": true,
+        "sep": true,
+        "oct": true,
+        "nov": true,
+        "dec": true
+    },
+    {
+        "id": "d1",
+        "type": "debug",
+        "z": "",
+        "name": "morning change",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "x": 450,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "d2",
+        "type": "debug",
+        "z": "",
+        "name": "morning status",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "x": 450,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "d3",
+        "type": "debug",
+        "z": "",
+        "name": "evening change",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "x": 450,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "d4",
+        "type": "debug",
+        "z": "",
+        "name": "evening status",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "x": 450,
+        "y": 220,
+        "wires": []
+    }
+]

package/package.json

@@ -1,19 +1,20 @@
 {
     "name": "node-red-contrib-scheduler-plus",
-    "version": "1.1.0",
+    "version": "1.1.3",
     "description": "A Node Red Timer with dusk, dawn and months",
     "author": "Peter Scargill <pete@scargill.org>",
     "contributors": [
         "Ludovic Toinel"
     ],
+    "license": "SEE LICENSE IN LICENSE",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/ltoinel/scheduler.git"
+        "url": "git+https://github.com/ltoinel/node-red-contrib-scheduler-plus.git"
     },
     "bugs": {
-        "url": "https://github.com/ltoinel/scheduler/issues"
+        "url": "https://github.com/ltoinel/node-red-contrib-scheduler-plus/issues"
     },
-    "homepage": "https://github.com/ltoinel/scheduler#readme",
+    "homepage": "https://github.com/ltoinel/node-red-contrib-scheduler-plus#readme",
     "dependencies": {
         "suncalc": "^2.1.1"
     },
@@ -27,7 +28,9 @@
     "files": [
         "scheduler.js",
         "scheduler.html",
-        "icons/"
+        "icons/",
+        "examples/",
+        "LICENSE"
     ],
     "scripts": {
         "lint": "eslint .",
@@ -41,7 +44,7 @@
     "node-red": {
         "version": ">=1.0.0",
         "nodes": {
-            "scheduler": "scheduler.js"
+            "scheduler-plus": "scheduler.js"
         }
     },
     "devDependencies": {

package/scheduler.html

@@ -9,7 +9,7 @@
 	once every minute.
 -->
 
-<script type="text/html" data-template-name="scheduler">
+<script type="text/html" data-template-name="scheduler-plus">
 	<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">
@@ -97,7 +97,7 @@
 	</div>
 </script>
 
-<script type="text/html" data-help-name="scheduler">
+<script type="text/html" data-help-name="scheduler-plus">
 	<p>Turns something on and off according to a schedule based on fixed times,
 	dawn/dusk (computed with the <code>suncalc</code> module), days of the week and months.
 	The schedule is evaluated every minute.</p>
@@ -163,7 +163,7 @@
 			[10001, 10002, 10005, 10010, 10015, 10030, 10060, 10090, 10120].indexOf(t) !== -1;
 	}
 
-	RED.nodes.registerType("scheduler", {
+	RED.nodes.registerType("scheduler-plus", {
 		category: "input",
 		color: "#6699ff",
 		defaults: {
@@ -230,7 +230,7 @@
 			onclick: function () {
 				var label = this.name || "scheduler";
 				$.ajax({
-					url: "scheduler/" + this.id,
+					url: "scheduler-plus/" + this.id,
 					type: "POST",
 					success: function () {
 						RED.notify("Successfully injected: " + label, "success");

package/scheduler.js

@@ -168,9 +168,9 @@ module.exports = function (RED) {
 		});
 	}
 
-	RED.nodes.registerType("scheduler", SchedulerNode);
+	RED.nodes.registerType("scheduler-plus", SchedulerNode);
 
-	RED.httpAdmin.post("/scheduler/:id", RED.auth.needsPermission("scheduler.write"), function (req, res) {
+	RED.httpAdmin.post("/scheduler-plus/:id", RED.auth.needsPermission("scheduler-plus.write"), function (req, res) {
 		var node = RED.nodes.getNode(req.params.id);
 		if (node === null || node === undefined) {
 			res.sendStatus(404);