node-red-contrib-eskomsepush 0.0.13 → 0.0.15

package/package.json

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

package/src/nodes/eskomsepush.html

@@ -37,7 +37,8 @@
             area: {value:""},
             statusselect: {value:"", validate: RED.validators.regex(/^(eskom|capetown)$/)},
             test: { value: false },
-            verbose: {value: false}
+            verbose: {value: false},
+            api_allowance_buffer: {value: 0, validate: RED.validators.regex(/^[0-9]+$/)}
         },
         inputs:1,
         outputs:2,
@@ -110,6 +111,10 @@
             <option value="capetown">Cape Town</option>
         </select>
     </div>
+    <div class="form-row">
+        <label for="node-input-api_allowance_buffer"><i class="fa fa-shopping-bag"></i> API allowance buffer</label>
+        <input type="text" id="node-input-api_allowance_buffer" placeholder="0">
+    </div>
     <div class="form-row">
         <label style="min-width:190px" for="node-input-test"><i class="fa fa-volume-up"></i> Use test data</label>
         <input type="checkbox" checked id="node-input-test" style="max-width:30px">
@@ -130,6 +135,7 @@
         <input type="text" id="searchAreaText" placeholder="Area" disabled />
         <button id="searchAreaId">Search</button><br />
     </p>
+
     </div>
     <div class="form-row" style="margin-bottom:0px;">
         <input type="checkbox" checked id="node-input-verbose" style="display:inline-block; margin-left:8px; width:auto; vertical-align:top;">
@@ -158,6 +164,7 @@ see how many queries you have left.</p>
 <p>First you will need a <em>licence key</em>. You can get one from <a href="https://eskomsepush.gumroad.com/l/api">here</a>, by subsribing to the Free model. Note that this is for personal use only.</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>The <i>API allowance buffer</i> allows you to reserve some daily unused API calls (so you can use your API key for other integrations too). If you don't use that, set this to _0_ (zero).</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>
 

package/src/nodes/eskomsepush.js

@@ -20,11 +20,11 @@ module.exports = function (RED) {
 
   function getMinutesToAPIReset () {
     const now = new Date()
-    const targetTime = new Date(now.getFullYear(), now.getMonth(), now.getDate(), 2, 0, 0);
+    const targetTime = new Date(now.getFullYear(), now.getMonth(), now.getDate(), 2, 0, 0)
     if (now > targetTime) {
-      targetTime.setDate(targetTime.getDate() + 1);
+      targetTime.setDate(targetTime.getDate() + 1)
     }
-    const timeDiff = targetTime - now;
+    const timeDiff = targetTime - now
     const minutesLeft = Math.floor(timeDiff / (1000 * 60))
 
     return minutesLeft
@@ -109,7 +109,7 @@ module.exports = function (RED) {
     const now = new Date()
 
     // Check allowance every ten minutes
-    if ((msg && msg.payload === 'allowance' ) || 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)
     }
 
@@ -126,19 +126,38 @@ module.exports = function (RED) {
     }
 
     // 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 = (getMinutesToAPIReset() / ((EskomSePushInfo.api.info.allowance.limit - EskomSePushInfo.api.info.allowance.count) / 2)).toFixed(0)
-      if (EskomSePushInfo.calc.sleeptime < 10) { EskomSePushInfo.calc.sleeptime = 10 }
+    // reset and divide the calls over the day. Wait at least 60 minutes between calls
+    // reduce limit by api_allowance_buffer to cater for units consumed by other API calls
+    if (node.config.verbose === true) {
+      node.warn('Minutes to API Reset: ' + getMinutesToAPIReset())
+    }
+    const allowanceRemaining = EskomSePushInfo.api.info.allowance.limit - node.config.api_allowance_buffer - EskomSePushInfo.api.info.allowance.count
+
+    if (allowanceRemaining > 0) {
+      EskomSePushInfo.calc.sleeptime = Math.round(getMinutesToAPIReset() / Math.ceil(allowanceRemaining / 2))
+      if (node.config.verbose === true) {
+        node.warn('API allowance limit: ' + EskomSePushInfo.api.info.allowance.limit)
+        node.warn('API allowance count: ' + EskomSePushInfo.api.info.allowance.count)
+        node.warn('Calculated sleeptime: ' + EskomSePushInfo.calc.sleeptime)
+      }
+      if (EskomSePushInfo.calc.sleeptime < 60) {
+        EskomSePushInfo.calc.sleeptime = 60
+        if (node.config.verbose === true) {
+          node.warn('Calculated sleeptime was less than 60. Set it to 60: ' + EskomSePushInfo.calc.sleeptime)
+        }
+      }
     } else {
-      EskomSePushInfo.calc.sleeptime = 30
+      EskomSePushInfo.calc.sleeptime = 120
+      if (node.config.verbose === true) {
+        node.warn('Set sleeptime to 120 since allowance count is low: ' + EskomSePushInfo.calc.sleeptime)
+      }
     }
 
-    if (( msg && msg.payload === 'stage' ) || 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 (( msg && msg.payload === 'area' ) || 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)
     }
 
@@ -163,10 +182,10 @@ module.exports = function (RED) {
 
     // Are there any events going on?
     if (Object.entries(EskomSePushInfo.area.info.events).length > 0) {
-      EskomSePushInfo.calc.type = 'event'
       const EventStart = Date.parse(EskomSePushInfo.area.info.events[0].start)
       const EventEnd = Date.parse(EskomSePushInfo.area.info.events[0].end)
       if (now >= EventStart && now < EventEnd) {
+        EskomSePushInfo.calc.type = 'event'
         EskomSePushInfo.calc.active = true
         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]
@@ -187,29 +206,39 @@ 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-1]) {
-        const ScheduleStart = Date.parse(dates.date + ' ' + schedule.split('-')[0])
-        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
-          if (now >= ScheduleStart) {
-            EskomSePushInfo.calc.active = true
-            EskomSePushInfo.calc.type = 'schedule'
-            EskomSePushInfo.calc.start = ScheduleStart
-            EskomSePushInfo.calc.end = ScheduleEnd
-          } else {
-            EskomSePushInfo.calc.next = {
-              type: 'schedule',
-              start: ScheduleStart,
-              end: ScheduleEnd
+      const stageIndex = EskomSePushInfo.calc.stage - 1
+      if (stageIndex >= 0 && stageIndex < dates.stages.length) {
+        if (Array.isArray(dates.stages[stageIndex])) {
+          for (const schedule of dates.stages[stageIndex]) {
+            const ScheduleStart = Date.parse(dates.date + ' ' + schedule.split('-')[0])
+            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
+              if (now >= ScheduleStart) {
+                EskomSePushInfo.calc.active = true
+                EskomSePushInfo.calc.type = 'schedule'
+                EskomSePushInfo.calc.start = ScheduleStart
+                EskomSePushInfo.calc.end = ScheduleEnd
+              } else {
+                EskomSePushInfo.calc.next = {
+                  type: 'schedule',
+                  start: ScheduleStart,
+                  end: ScheduleEnd,
+                  stage: EskomSePushInfo.calc.stage
+                }
+              }
+            }
+            if (BreakLoop) { break }
           }
+        } else {
+          console.warn('Not an array:', dates.stages[stageIndex]) // Warning if not an array
         }
-        if (BreakLoop) { break }
+      } else {
+        console.warn('Invalid stage index:', stageIndex) // Warning if stage index is out of bounds
       }
       if (BreakLoop) { break }
     }
@@ -218,6 +247,7 @@ module.exports = function (RED) {
       EskomSePushInfo.calc.next.duration = (EskomSePushInfo.calc.next.end - EskomSePushInfo.calc.next.start) / 1000
       EskomSePushInfo.calc.next.islong = EskomSePushInfo.calc.next.duration >= (4 * 3600)
       EskomSePushInfo.calc.secondstostatechange = parseInt((EskomSePushInfo.calc.next.start - now) / 1000)
+      EskomSePushInfo.calc.next.isHigherStage = EskomSePushInfo.calc.next.stage > EskomSePushInfo.calc.stage
     }
 
     if (EskomSePushInfo.calc.active) {
@@ -255,16 +285,16 @@ module.exports = function (RED) {
       if (EskomSePushInfo.calc.type === 'event') {
         shape = 'dot'
       }
-      if ( EskomSePushInfo.calc.start ) {
-        statusText += new Date(EskomSePushInfo.calc.start).toLocaleTimeString([], {timeStyle: 'short'})
-        statusText += ' - ' + new Date(EskomSePushInfo.calc.end).toLocaleTimeString([], {timeStyle: 'short'})
+      if (EskomSePushInfo.calc.start) {
+        statusText += new Date(EskomSePushInfo.calc.start).toLocaleTimeString([], { timeStyle: 'short' })
+        statusText += ' - ' + new Date(EskomSePushInfo.calc.end).toLocaleTimeString([], { timeStyle: 'short' })
       }
     } else {
-      if (new Date(EskomSePushInfo.calc.next.start).getUTCDay() !==  now.getUTCDate) {
-        statusText += new Date(EskomSePushInfo.calc.next.start).toLocaleString([], {weekday: 'short'}) + ' '
+      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 += 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 + ')'
@@ -284,7 +314,7 @@ module.exports = function (RED) {
       updateSheddingStatus(node)
     }, 60000)
 
-    node.on('input', function(msg) {
+    node.on('input', function (msg) {
       updateSheddingStatus(node, msg)
     })