@mschaeffler/node-red-hourmeter 0.2.5 → 1.0.0

package/README.md

@@ -29,7 +29,7 @@ The counter is started / stopped according to the value of the payload:
 ||on|started|
 ||start|started|
 
-A [local filesystem context store](https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system) called `storeInFile` is needed to store the internal data.
+A [local filesystem context store](https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system) is needed to store the internal data.
 
 ### Input
 
@@ -37,7 +37,8 @@ A [local filesystem context store](https://nodered.org/docs/user-guide/context#s
 |:-------|:-------|:----------------------------------|
 |payload | | Starts or stopps the counting. |
 |reset   |boolean |If true, resets the counter to 0.|
-|querry  |boolean |If true, just querries the state of the counter.|
+|set     |boolean |If true, sets the counter to `payload`.|
+|query   |boolean |If true, just querries the state of the counter.|
 
 ### Outputs
 
@@ -45,13 +46,15 @@ A [local filesystem context store](https://nodered.org/docs/user-guide/context#s
 
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
-|payload | boolean | Is counting active?|
+|payload | boolean| Is counting active?|
+|reason  | string | Reason of the message output.|
 
 #### hour counter
 
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
 |payload | number | Value of the hour counter.|
+|reason  | string | Reason of the message output.|
 
 ### Parameters
 
@@ -59,6 +62,8 @@ A [local filesystem context store](https://nodered.org/docs/user-guide/context#s
 |:-----|:-------|:----------------------------------|
 |topic| string | Topic to send output values with.|
 |cycle| number |Cyclic time of output; 0 is only at state change.|
+|Contextstore|context store| context store for storing the values.|
+|Status|boolean| the actual value as a node status.|
 
 ## Example Flow
 

package/examples/hourmeter.json

@@ -1,12 +1,4 @@
 [
-    {
-        "id": "5535ca07b24e93fb",
-        "type": "tab",
-        "label": "Flow 1",
-        "disabled": false,
-        "info": "",
-        "env": []
-    },
     {
         "id": "3412a0829ce8c730",
         "type": "inject",
@@ -25,11 +17,11 @@
         "crontab": "",
         "once": false,
         "onceDelay": 0.1,
-        "topic": "",
-        "payload": "on",
-        "payloadType": "str",
-        "x": 430,
-        "y": 300,
+        "topic": "FooBar",
+        "payload": "true",
+        "payloadType": "bool",
+        "x": 470,
+        "y": 320,
         "wires": [
             [
                 "fd93870645a4a85f"
@@ -54,11 +46,11 @@
         "crontab": "",
         "once": false,
         "onceDelay": 0.1,
-        "topic": "",
-        "payload": "0",
-        "payloadType": "num",
-        "x": 430,
-        "y": 340,
+        "topic": "FooBar",
+        "payload": "false",
+        "payloadType": "bool",
+        "x": 470,
+        "y": 360,
         "wires": [
             [
                 "fd93870645a4a85f"
@@ -70,7 +62,7 @@
         "type": "debug",
         "z": "5535ca07b24e93fb",
         "name": "debug 8",
-        "active": false,
+        "active": true,
         "tosidebar": true,
         "console": false,
         "tostatus": true,
@@ -92,10 +84,6 @@
                 "p": "reset",
                 "v": "true",
                 "vt": "bool"
-            },
-            {
-                "p": "topic",
-                "vt": "str"
             }
         ],
         "repeat": "",
@@ -103,8 +91,8 @@
         "once": false,
         "onceDelay": 0.1,
         "topic": "",
-        "x": 430,
-        "y": 180,
+        "x": 470,
+        "y": 200,
         "wires": [
             [
                 "fd93870645a4a85f"
@@ -121,10 +109,6 @@
                 "p": "querry",
                 "v": "true",
                 "vt": "bool"
-            },
-            {
-                "p": "topic",
-                "vt": "str"
             }
         ],
         "repeat": "",
@@ -132,8 +116,8 @@
         "once": false,
         "onceDelay": 0.1,
         "topic": "",
-        "x": 430,
-        "y": 240,
+        "x": 470,
+        "y": 260,
         "wires": [
             [
                 "fd93870645a4a85f"
@@ -147,6 +131,8 @@
         "name": "",
         "topic": "test",
         "cycle": "15",
+        "contextStore": "memoryOnly",
+        "showState": true,
         "x": 650,
         "y": 260,
         "wires": [
@@ -163,7 +149,7 @@
         "type": "debug",
         "z": "5535ca07b24e93fb",
         "name": "debug 9",
-        "active": false,
+        "active": true,
         "tosidebar": true,
         "console": false,
         "tostatus": true,
@@ -174,5 +160,43 @@
         "x": 840,
         "y": 300,
         "wires": []
+    },
+    {
+        "id": "a831f554dd6fce40",
+        "type": "inject",
+        "z": "5535ca07b24e93fb",
+        "name": "set",
+        "props": [
+            {
+                "p": "set",
+                "v": "true",
+                "vt": "bool"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "12",
+        "payloadType": "num",
+        "x": 470,
+        "y": 160,
+        "wires": [
+            [
+                "fd93870645a4a85f"
+            ]
+        ]
+    },
+    {
+        "id": "55acd484dd996916",
+        "type": "global-config",
+        "env": [],
+        "modules": {
+            "@mschaeffler/node-red-hourmeter": "1.0.0"
+        }
     }
 ]

package/hourmeter.html

@@ -5,7 +5,9 @@
         defaults: {
             name: {value:""},
             topic:{value:""},
-            cycle:{value:"0", required:true, validate:RED.validators.number()}
+            cycle:{value:"0", required:true, validate:RED.validators.number()},
+            contextStore:{value:"",required:true},
+            showState:{value:false}
         },
         inputs:1,
         outputs:2,
@@ -18,7 +20,23 @@
         },
         inputLabels: 'on/off message',
         outputLabels: ['boolean value','hour counter'],
-        paletteLabel: "hour meter"
+        paletteLabel: "hour meter",
+        oneditprepare: function() {
+            const node = this
+            // populate store names
+            $("#node-input-contextStore").empty();
+            //$("#node-input-contextStore").append(`<option value="none">None</option>`);
+            const defaultStore = RED.settings.hasOwnProperty('context') ? RED.settings.context.default : ''
+            RED.settings.context.stores.forEach(function(item){
+                if( item ) {
+                   const opt = $(`<option value="${item}">${item}${item===defaultStore?" (default)":""}</option>`);
+                   $("#node-input-contextStore").append(opt);
+                }
+            });
+            const currentStore = node.contextStore || '';
+            // select the current option
+            $("#node-input-contextStore").val(currentStore);
+        }
     });
 </script>
 
@@ -35,6 +53,14 @@
         <label for="node-input-cycle"><i class="fa fa-hourglass-o"></i> Cycle [min]</label>
         <input type="text" id="node-input-cycle">
     </div>
+    <div class="form-row">
+        <label for="node-input-contextStore"><i class="fa fa-database"></i> Contextstore</label>
+        <select type="text" id="node-input-contextStore"></select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
+        <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="hourmeter">
@@ -56,7 +82,7 @@
     </table>
     
     <p>A <a href="https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system">local filesystem context store</a> 
-    called <code>storeInFile</code> is needed to store the internal data.</p>
+    is needed to store the internal data.</p>
     
     <h3>Input</h3>
     <dl class="message-properties">
@@ -64,7 +90,9 @@
         <dd> Starts or stopps the counting.</dd>
         <dt>reset <span class="property-type">boolean</span></dt>
         <dd> If true, resets the counter to 0.</dd>
-        <dt>querry <span class="property-type">boolean</span></dt>
+        <dt>set <span class="property-type">boolean</span></dt>
+        <dd> If true, sets the counter to <code>payload</code>.</dd>
+        <dt>query <span class="property-type">boolean</span></dt>
         <dd> If true, just querries the state of the counter.</dd>
     </dl>
 
@@ -74,12 +102,16 @@
     <dl class="message-properties">
         <dt>payload <span class="property-type">boolean</span></dt>
         <dd> Is counting active?</dd>
+        <dt>reason <span class="property-type">string</span></dt>
+        <dd> Reason of the message output.</dd>
     </dl>
     
     <h4>hour counter</h4>
     <dl class="message-properties">
         <dt>payload <span class="property-type">number</span></dt>
         <dd> Value of the hour counter.</dd>
+        <dt>reason <span class="property-type">string</span></dt>
+        <dd> Reason of the message output.</dd>
     </dl>
     
     <h3>Parameters</h3>
@@ -88,6 +120,10 @@
         <dd> Topic to send output values with.</dd>
         <dt>cycle <span class="property-type">number</span></dt>
         <dd> Cyclic time of output; 0 is only at state change.</dd>
+        <dt>Contextstore <span class="property-type">context store</span></dt>
+        <dd> context store for storing the values; <code>none</code> is no storage.</dd>
+        <dt>Status <span class="property-type">boolean</span></dt>
+        <dd> shows the actual value as a node status.</dd>
     </dl>
 
 </script>

package/hourmeter.js

@@ -4,37 +4,86 @@ module.exports = function(RED)
     function HourMeterNode(config)
     {
         RED.nodes.createNode(this,config);
-        this.config = config;
-        this.topic  = config.topic;
-        this.cycle  = config.cycle;
-        this.interval_id = null;
+        this.config       = config;
+        this.topic        = config.topic ?? "";
+        this.cycle        = Number( config.cycle ?? 0 );
+        this.contextStore = config.contextStore ?? "none";
+        this.showState    = Boolean( config.showState );
+        this.interval_id  = null;
         var node    = this;
         var context = this.context();
+        node.status( "" );
 
         if( this.cycle > 0 )
         {
-            this.interval_id = setInterval( function()
+            function emitQuery()
             {
-                node.emit( "input", {querry:true} );
-            }, this.cycle*60*1000 );
+                node.emit( "input", {query:true} );
+            }
+            setTimeout( emitQuery, 75 );
+            this.interval_id = setInterval( emitQuery, this.cycle*60*1000 );
         }
 
         node.on( 'input', function(msg,send,done)
         {
+            let   data;
+            const now = Date.now();
+
+            function sendOutput(reason)
+            {
+                const out = data.counter/3600;
+                if( node.showState )
+                {
+                    node.status( `${data.state} / ${out.toFixed(1)}` );
+                }
+                send( [
+                    { topic:node.topic, payload:data.switchOn!==undefined, reason:reason },
+                    { topic:node.topic, payload:out,                       reason:reason }
+                ] );
+            }
+
             if( msg.reset )
             {
-                context.set( "data", undefined, "storeInFile" );
-                node.status( "-" );
-                send( [ { topic:this.topic, payload:false }, { topic:this.topic, payload:0 } ] );
+                data = { counter:0 }
+                context.set( "data", data, node.contextStore );
+                sendOutput( "reset" );
             }
             else
             {
-                const now  = Date.now();
-                let   data = context.get( "data", "storeInFile" ) ?? { counter:0 };
-                if( ( !msg.querry ) && ( msg.payload!==undefined ) )
+                data = context.get( "data", node.contextStore ) ?? { counter:0 };
+                if( msg.set )
+                {
+                    const value = Number( msg.payload );
+                    if( value >= 0 )
+                    {
+                        data.counter = msg.payload * 3600;
+                        if( data.switchOn !== undefined )
+                        {
+                            data.switchOn = now;
+                        }
+                        context.set( "data", data, node.contextStore );
+                        sendOutput( "set" );
+                    }
+                    else
+                    {
+                        done( `invalid set value: ${msg.payload}` )
+                        return;
+                    }
+                }
+                else
                 {
-                    if( msg.payload !== data.state )
+                    if( msg.query )
                     {
+                        if( data.switchOn !== undefined )
+                        {
+                            data.counter += (now - data.switchOn)/1000;
+                            data.switchOn = now;
+                        }
+                        sendOutput( "query" );
+                    }
+                    else
+                    {
+                        data.state = msg.payload;
                         switch( msg.payload )
                         {
                             case true:
@@ -46,6 +95,7 @@ module.exports = function(RED)
                                 if( data.switchOn === undefined )
                                 {
                                     data.switchOn = now;
+                                    sendOutput( "on" );
                                 }
                                 break;
                             case false:
@@ -59,36 +109,23 @@ module.exports = function(RED)
                                 {
                                     data.counter += (now - data.switchOn)/1000;
                                     delete data.switchOn;
+                                    sendOutput( "off" );
                                 }
                                 break;
+                            default:
+                                node.warn( `invalid payload: ${msg.payload}` );
                         }
-                        data.state = msg.payload;
+                        context.set( "data", data, node.contextStore );
                     }
-                    context.set( "data", data, "storeInFile" );
                 }
-                else
-                {
-                    if( data.switchOn !== undefined )
-                    {
-                        data.counter += (now - data.switchOn)/1000;
-                        data.switchOn = now;
-                    }
-                }
-                const out = data.counter/3600;
-                node.status( `${data.state} / ${out.toFixed(1)}` );
-                send( [ { topic:this.topic, payload:data.switchOn!==undefined }, { topic:this.topic, payload:out } ] );
             }
             done();
         } );
+
+        node.on('close', function() {
+            clearInterval( node.interval_id );
+        });
     }
 
     RED.nodes.registerType("hourmeter",HourMeterNode);
-
-    HourMeterNode.prototype.close = function()
-    {
-        if( this.interval_id != null )
-        {
-            clearInterval( this.interval_id );
-        }
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mschaeffler/node-red-hourmeter",
-  "version": "0.2.5",
+  "version": "1.0.0",
   "description": "A working hour meter for NodeRed.",
   "license": "LGPL-2.1",
   "homepage": "https://github.com/m-schaeffler/node-red-my-nodes/tree/main/node-red-hourmeter",
@@ -9,13 +9,13 @@
     "url": "git+https://github.com/m-schaeffler/node-red-my-nodes.git"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "keywords": [
     "node-red"
   ],
   "node-red": {
-    "version": ">=1.3.7",
+    "version": ">=3.1.0",
     "nodes": {
       "nop": "hourmeter.js"
     }
@@ -23,5 +23,8 @@
   "author": {
     "name": "Mathias Schäffler",
     "url": "https://github.com/m-schaeffler"
+  },
+  "scripts": {
+    "test": "mocha \"test/*_spec.js\""
   }
 }