node-red-contrib-eskomsepush 0.0.11 → 0.0.13

package/README.md

@@ -53,6 +53,18 @@ Then you need to fill out which status to follow. This can be either _National_
 
 If the _test_ checkbox has been selected, test data for the specified area will be fetched instead of the actual schedule. This is useful when debugging.
 
+### Inputs
+
+The input side is not needed in most cases. The node will output its status every ten minutes and won't update the information it gets from the API more often. The input node however can be used to overrule this behaviour. When inserting a timestamp, the node will output the latest information it got and re-calculate all fields.
+
+There are also special strings that can be injected as payload to force updates:
+
+- `allowance` - for retrieving the latest API count values
+- `stage` - for retrieving the latest active load shedding stage
+- `area` - for retrieving the latest schedule information
+
+So usually there is no reason to connect anything to the input. It is only needed if you want to have more control over the node.
+
 ### Outputs
 
 The note has two outputs. In most cases, the first (upper) output will be used.
@@ -61,46 +73,34 @@ The first output of the node outputs a boolean value and some related data. When
 
 ```
 {
-  "payload":false,
-  "LoadShedding":{
-    "schedule":{
-       "next":{
-         "start":1683561600000,
-         "end":1683570600000,
-         "type":"schedule"
-       },
-       "active":false
-    },
-    "event":{
-      "next":{
-        "start":1683561600000,
-        "end":1683570600000
-      },
-      "active":false
-    },
-    "checked":"13:35",
-    "next":{
-      "start":1683561600000,
-      "end":1683570600000,
-      "type":"schedule"
-    },
-    "active":false
+  "payload": false,
+  "stage": "0",
+  "statusselect": "capetown",
+  "api": {
+    "count": 30,
+    "limit": 50
   },
-  "stage":"5",
-  "statusselect":"capetown",
-  "api":{
-    "count":12,
-    "limit":50,
-    "lastStatusUpdate":"Mon May 08 2023 13:34:30 GMT+0200 (Central European Summer Time)",
-    "lastScheduleUpdate":"Mon May 08 2023 13:34:30 GMT+0200 (Central European Summer Time)"
+  "calc": {
+    "sleeptime": "58",
+    "stage": "0",
+    "active": false,
+    "type": "event",
+    "next": {
+      "type": "schedule",
+      "start": 1686830400000,
+      "end": 1686839400000,
+      "duration": 9000,
+      "islong": false
+    },
+    "secondstostatechange": 84912
   },
-  "\_msgid":"6e77b593b7f9eda4"
+  "_msgid": "9fa5d503c47f083e"
 }
 ```
 
-The start and end objects contain the time of next load shedding period as unix timestamps in the Javascript format (milliseconds after the epoch).
+The _start_ and _end_ objects contain the time as unix timestamp in the Javascript format (milliseconds after the epoch), while the duration is in seconds. The `msg.calc.next.islong` value is boolean and will be _true_ if the shedding lasts 4 hours or longer.
 
-The second output shows `msg.stage` and `msg.schedule`, containing the latest information as retrieved from the API. This output is mainly useful when writing your own functions and logic.
+The second output shows `msg.stage` and `msg.schedule`, containing the latest information as retrieved from the API, with the lastUpdate field added. This output is mainly useful when debugging or writing your own functions and logic.
 
 ### Status
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-eskomsepush",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Node-RED interface for the Eskomsepush API",
   "main": "index.js",
   "scripts": {

package/src/nodes/eskomsepush.html

@@ -39,7 +39,7 @@
             test: { value: false },
             verbose: {value: false}
         },
-        inputs:0,
+        inputs:1,
         outputs:2,
         icon: "eskomsepush.svg",
         label: function() {
@@ -126,7 +126,7 @@
         <ul id="list-areas"></ul>
 
         <p>
-            Queries left: <span id="api_info">unknown/unknown</span><br />
+            Queries used: <span id="api_info">unknown/unknown</span><br />
         <input type="text" id="searchAreaText" placeholder="Area" disabled />
         <button id="searchAreaId">Search</button><br />
     </p>
@@ -159,60 +159,65 @@ see how many queries you have left.</p>
 <p>Next you need to insert the correct area. Once a valid license is filled out, the API can be used for searching the correct area id. Do note that this will cost some of the daily queries. If you don&#39;t want that and you already know the id of the area, fill out the area id manually.</p>
 <p>Then you need to fill out which status to follow. This can be either <em>National</em> (eskom) or <em>Capetown</em>.</p>
 <p>If the <em>test</em> checkbox has been selected, test data for the area will be fetched instead of the actual schedule. This is useful when debugging.</p>
+<p>The <em>verbose</em> checkbox will give some additional <tt>node.warn()</tt> messages, appearing in the debug tab. This is also useful when debugging.</p>
+
+<h3 id=""inputs">Inputs</h3>
+
+<p>
+    The input side is not needed in most cases. The node will output its status every ten minutes and won't update the information it gets from the API more 
+    often. The input node however can be used to overrule this behaviour. When inserting a timestamp, the node will output the latest information it got and
+    re-calculate all fields.
+</p>
+
+<p>There are also special strings that can be injected as payload to force updates:
+    <ul>
+        <li><code>allowance</code> - for retrieving the latest API count values</li>
+        <li><code>stage</code> - for retrieving the latest active load shedding stage</li>
+        <li><code>area</code> - for retrieving the latest schedule information</li>
+    </ul>
+</p>
+
+<p>
+    So usually there is no reason to connect anything to the input. It is only needed if you want to have more control over the node.
+</p>
 
 <h3 id="outputs">Outputs</h3>
 
 <p>The first output of the node outputs a boolean value. When load shedding is active, the <code>msg.payload</code> will be <em>true</em>, otherwise it will be <em>false</em>. It also outputs some extra values:</p>
 
 <pre>
-{
-    "payload": false,
-    "LoadShedding": {
-        "schedule": {
-        "next": {
-            "start": 1684267200000,
-            "end": 1684276200000,
+    {
+        "payload": false,
+        "stage": "0",
+        "statusselect": "capetown",
+        "api": {
+          "count": 30,
+          "limit": 50
+        },
+        "calc": {
+          "sleeptime": "58",
+          "stage": "0",
+          "active": false,
+          "type": "event",
+          "next": {
             "type": "schedule",
+            "start": 1686830400000,
+            "end": 1686839400000,
             "duration": 9000,
             "islong": false
+          },
+          "secondstostatechange": 84912
         },
-        "active": false
-        },
-        "event": {
-        "next": {
-            "start": 1684267200000,
-            "end": 1684276200000
-        },
-        "active": false
-        },
-        "checked": "15:38",
-        "next": {
-        "start": 1684267200000,
-        "end": 1684276200000,
-        "type": "schedule",
-        "duration": 9000,
-        "islong": false
-        },
-        "active": false
-    },
-    "stage": "3",
-    "statusselect": "capetown",
-    "api": {
-        "count": 45,
-        "limit": 50,
-        "lastStatusUpdate": "Tue May 16 2023 15:38:15 GMT+0200 (Central European Summer Time)",
-        "lastScheduleUpdate": "Tue May 16 2023 15:38:15 GMT+0200 (Central European Summer Time)"
-    },
-    "_msgid": "dfa429a93a16472d"
-    }
+        "_msgid": "9fa5d503c47f083e"
+      }
 </pre>
 
 <p>The <tt>start</tt> and <tt>end</tt> objects contain the time as unix timestamp in the Javascript format (milliseconds after the epoch),
-    while the <tt>duration</tt> is in seconds. The <code>msg.LoadShedding.next.islong</code> value is boolean and will be <em>true</em> if the
+    while the <tt>duration</tt> is in seconds. The <code>msg.calc.next.islong</code> value is boolean and will be <em>true</em> if the
     shedding lasts 4 hours or longer.</p>
 
-<p>The second output shows <code>msg.stage</code> and <code>msg.schedule</code>, containing the latest information as retrieved from the API.
-This output is mainly useful when debugging or writing your own functions and logic.</p>
+<p>The second output shows <code>msg.stage</code> and <code>msg.schedule</code>, containing the latest information as retrieved from the API,
+    with the <tt>lastUpdate</tt> field added. This output is mainly useful when debugging or writing your own functions and logic.</p>
 
 <h3 id="status">Status</h3>
 

package/src/nodes/eskomsepush.js

@@ -18,10 +18,13 @@ module.exports = function (RED) {
     calc: {}
   }
 
-  function getMinutesLeftInDay () {
-    const currentDate = new Date()
-    const tomorrow = new Date(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDate() + 1)
-    const timeDiff = tomorrow.getTime() - currentDate.getTime()
+  function getMinutesToAPIReset () {
+    const now = new Date()
+    const targetTime = new Date(now.getFullYear(), now.getMonth(), now.getDate(), 2, 0, 0);
+    if (now > targetTime) {
+      targetTime.setDate(targetTime.getDate() + 1);
+    }
+    const timeDiff = targetTime - now;
     const minutesLeft = Math.floor(timeDiff / (1000 * 60))
 
     return minutesLeft
@@ -102,11 +105,11 @@ module.exports = function (RED) {
       })
   }
 
-  function updateSheddingStatus (node) {
+  function updateSheddingStatus (node, msg) {
     const now = new Date()
 
     // Check allowance every ten minutes
-    if (EskomSePushInfo.api.lastUpdate === null || (now.getTime() - EskomSePushInfo.api.lastUpdate.getTime()) > 600000) {
+    if ((msg && msg.payload === 'allowance' ) || EskomSePushInfo.api.lastUpdate === null || (now.getTime() - EskomSePushInfo.api.lastUpdate.getTime()) > 600000) {
       checkAllowance(node)
     }
 
@@ -122,19 +125,20 @@ module.exports = function (RED) {
       return
     }
 
-    // Fetching actual information takes 2 calls, so calculate how long the day lasts and see how we
-    // can divide the available calls over the day
+    // Fetching actual information takes 2 calls, so calculate how long until the next API count
+    // reset and divide the calls over the day. Wait at least 10 minutes between calls
     if ((EskomSePushInfo.api.info.allowance.limit - EskomSePushInfo.api.info.allowance.count) > 0) {
-      EskomSePushInfo.calc.sleeptime = (getMinutesLeftInDay() / ((EskomSePushInfo.api.info.allowance.limit - EskomSePushInfo.api.info.allowance.count) / 2)).toFixed(0)
+      EskomSePushInfo.calc.sleeptime = (getMinutesToAPIReset() / ((EskomSePushInfo.api.info.allowance.limit - EskomSePushInfo.api.info.allowance.count) / 2)).toFixed(0)
+      if (EskomSePushInfo.calc.sleeptime < 10) { EskomSePushInfo.calc.sleeptime = 10 }
     } else {
       EskomSePushInfo.calc.sleeptime = 30
     }
 
-    if (EskomSePushInfo.status.lastUpdate === null || (now.getTime() - EskomSePushInfo.status.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
+    if (( msg && msg.payload === 'stage' ) || EskomSePushInfo.status.lastUpdate === null || (now.getTime() - EskomSePushInfo.status.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
       checkStage(node)
     }
 
-    if (EskomSePushInfo.area.lastUpdate === null || (now.getTime() - EskomSePushInfo.area.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
+    if (( msg && msg.payload === 'area' ) || EskomSePushInfo.area.lastUpdate === null || (now.getTime() - EskomSePushInfo.area.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
       checkArea(node)
     }
 
@@ -167,6 +171,8 @@ module.exports = function (RED) {
         if (EskomSePushInfo.area.info.events[0].note.match(/Stage (\d+)/i)) {
           EskomSePushInfo.calc.stage = EskomSePushInfo.area.info.events[0].note.match(/Stage (\d+)/i)[1]
         }
+        EskomSePushInfo.calc.start = EventStart
+        EskomSePushInfo.calc.end = EventEnd
       } else {
         EskomSePushInfo.calc.next = {
           type: 'event',
@@ -181,9 +187,12 @@ module.exports = function (RED) {
     // So not just like events, where they are in UTC with an offset
     let BreakLoop = false
     for (const dates of EskomSePushInfo.area.info.schedule.days) {
-      for (const schedule of dates.stages[EskomSePushInfo.calc.stage]) {
+      for (const schedule of dates.stages[EskomSePushInfo.calc.stage-1]) {
         const ScheduleStart = Date.parse(dates.date + ' ' + schedule.split('-')[0])
-        const ScheduleEnd = Date.parse(dates.date + ' ' + schedule.split('-')[1])
+        let ScheduleEnd = Date.parse(dates.date + ' ' + schedule.split('-')[1])
+        if (ScheduleEnd < ScheduleStart) {
+          ScheduleEnd += (24 * 60 * 60 * 1000)
+        }
         if (now < ScheduleEnd) {
           BreakLoop = true
           // This schedule is either active or will be next
@@ -239,18 +248,23 @@ module.exports = function (RED) {
     // And update the status
     let fill = 'green'
     let shape = 'ring'
-    let statusText = 'Stage ' + EskomSePushInfo.calc.stage
+    let statusText = 'Stage ' + EskomSePushInfo.calc.stage + ': '
 
     if (EskomSePushInfo.calc.active) {
       fill = 'yellow'
       if (EskomSePushInfo.calc.type === 'event') {
         shape = 'dot'
       }
-      statusText += ' - ' + new Date(EskomSePushInfo.calc.start).toLocaleTimeString()
-      statusText += ' - ' + new Date(EskomSePushInfo.calc.end).toLocaleTimeString()
+      if ( EskomSePushInfo.calc.start ) {
+        statusText += new Date(EskomSePushInfo.calc.start).toLocaleTimeString([], {timeStyle: 'short'})
+        statusText += ' - ' + new Date(EskomSePushInfo.calc.end).toLocaleTimeString([], {timeStyle: 'short'})
+      }
     } else {
-      statusText += ' - ' + new Date(EskomSePushInfo.calc.next.start).toLocaleTimeString()
-      statusText += ' - ' + new Date(EskomSePushInfo.calc.next.end).toLocaleTimeString()
+      if (new Date(EskomSePushInfo.calc.next.start).getUTCDay() !==  now.getUTCDate) {
+        statusText += new Date(EskomSePushInfo.calc.next.start).toLocaleString([], {weekday: 'short'}) + ' '
+      }
+      statusText += new Date(EskomSePushInfo.calc.next.start).toLocaleTimeString([], {timeStyle: 'short'})
+      statusText += ' - ' + new Date(EskomSePushInfo.calc.next.end).toLocaleTimeString([], {timeStyle: 'short'})
     }
 
     statusText += ' (API: ' + EskomSePushInfo.api.info.allowance.count + '/' + EskomSePushInfo.api.info.allowance.limit + ')'
@@ -270,6 +284,10 @@ module.exports = function (RED) {
       updateSheddingStatus(node)
     }, 60000)
 
+    node.on('input', function(msg) {
+      updateSheddingStatus(node, msg)
+    })
+
     node.on('close', function () {
       clearInterval(intervalId)
     })