node-red-contrib-eskomsepush 0.0.9 → 0.0.11

package/README.md

@@ -108,7 +108,7 @@ The status will show the situation regarding the API calls and when the next
 shedding wil start or end.  It also shows the count of API calls that have been
 done and how many are left. This updates every 10 minutes.
 
-The red color status can be either filled (dot) or not (ring). In case of a dot,
+The yellow color status can be either filled (dot) or not (ring). In case of a dot,
 the load schedding is because of an _event_. When it is a ring, it is caused by
 a matching _schedule_.
 

package/package.json

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

package/src/nodes/eskomsepush.html

@@ -36,7 +36,8 @@
             licensekey: {value:"", validate: RED.validators.regex(/^[0-9A-F\-]{35}$/)},
             area: {value:""},
             statusselect: {value:"", validate: RED.validators.regex(/^(eskom|capetown)$/)},
-            test: { value: false }
+            test: { value: false },
+            verbose: {value: false}
         },
         inputs:0,
         outputs:2,
@@ -130,6 +131,10 @@
         <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;">
+        <label style="min-width:390px" for="node-input-verbose"><i class="fa fa-power"></i> Verbose: add extra logging when running</label>
+    </div>
 </script>
 
 <script type="text/html" data-help-name="eskomsepush">
@@ -216,11 +221,24 @@ This output is mainly useful when debugging or writing your own functions and lo
 how many are left. This updates every 10 minutes.</p>
 
 <p>
-The red color status can be either filled (dot) or not (ring). In case of a dot,
+The yellow color status can be either filled (dot) or not (ring). In case of a dot,
 the load schedding is because of an <em>event</em>. When it is a ring, it is caused by
 a matching <em>schedule</em>.
 </p>
 
+<div id="legend">
+    <ul>
+        <li><svg class="bullet" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect x="5" y="5" width="9" height="9" rx="2" ry="2" stroke-width="3" fill="#fff" stroke="#5a8"></rect>
+        </svg> - grid available, working properly</li>
+        <li><svg class="bullet" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect x="5" y="5" width="9" height="9" rx="2" ry="2" stroke-width="3" fill="#F9DF31" stroke="#F9DF31"></rect>
+        </svg> - no grid, load shedding because of an <strong>event</strong></li>
+        <li><svg class="bullet" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect x="5" y="5" width="9" height="9" rx="2" ry="2" stroke-width="3" fill="#fff" stroke="#F9DF31"></rect>
+        </svg> - no grid, load shedding because of a <strong>schedule</strong></li>
+        <li><svg class="bullet" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect x="5" y="5" width="9" height="9" rx="2" ry="2" stroke-width="3" fill="#fff" stroke="#c00"></rect>
+        </svg> - ran out of API calls</li>
+    </ul>
+</div>
+
 <h1 id="documentation">Documentation</h1>
 
 <p>The GitHub site for the node can be found <a href="https://github.com/dirkjanfaber/node-red-contrib-eskomsepush">here</a>, while the documentation for the API can be found <a href="https://documenter.getpostman.com/view/1296288/UzQuNk3E">here</a>.
@@ -238,4 +256,21 @@ select#areaDropdown {
 #list-areas li {
   cursor: pointer;
 }
+
+#legend ul {
+    list-style: none;
+    padding: 0;
+}
+#legend li {
+    margin-bottom: 10px;
+    position: relative;
+    padding-left: 25px;
+}
+.bullet {
+    position: absolute;
+    top: 2px;
+    left: 0;
+    width: 35px;
+    height: 35px;
+}
 </style>

package/src/nodes/eskomsepush.js

@@ -2,50 +2,46 @@ module.exports = function (RED) {
   'use strict'
 
   const axios = require('axios')
-  let EskomSePushAPI = null
-  let Stage = null
-  let Schedule = null
-  let LoadShedding = null
-  let lastStatusUpdate = new Date()
-  let lastStageUpdate = new Date()
-  let lastScheduleUpdate = new Date()
-
-  function updateStatus (node) {
-    let fill = 'green'
-    let shape = 'ring'
-    let statusText = ''
-    if (Stage && Stage.status && Stage.status[node.config.statusselect].stage) {
-      statusText += 'Stage ' + Stage.status[node.config.statusselect].stage
-    }
-    if (LoadShedding && LoadShedding.active && LoadShedding.next && LoadShedding.next.end) {
-      statusText += ' - ' + new Date(LoadShedding.next.end).toLocaleTimeString()
-      fill = 'red'
-      if (LoadShedding.type === 'event') {
-        shape = 'dot'
-      }
-    } else {
-      if (LoadShedding && LoadShedding.next && LoadShedding.next.start) {
-        statusText += ' - ' + new Date(LoadShedding.next.start).toLocaleTimeString()
-      }
-    }
-    if (EskomSePushAPI) {
-      statusText += ` (API: ${EskomSePushAPI.allowance.count}/${EskomSePushAPI.allowance.limit})`
-      if (EskomSePushAPI.allowance.count >= EskomSePushAPI.allowance.limit) {
-        fill = 'red'
-      }
-    }
-    node.status({
-      fill, shape, text: statusText
-    })
+  const EskomSePushInfo = {
+    api: {
+      lastUpdate: null,
+      info: {}
+    },
+    status: {
+      lastUpdate: null,
+      info: {}
+    },
+    area: {
+      lastUpdate: null,
+      info: {}
+    },
+    calc: {}
+  }
+
+  function getMinutesLeftInDay () {
+    const currentDate = new Date()
+    const tomorrow = new Date(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDate() + 1)
+    const timeDiff = tomorrow.getTime() - currentDate.getTime()
+    const minutesLeft = Math.floor(timeDiff / (1000 * 60))
+
+    return minutesLeft
   }
 
   function checkAllowance (node) {
     const options = {}
     const headers = { token: node.config.licensekey }
+
+    if (node.config.verbose === true) {
+      node.warn('Running function checkAllowance')
+    }
     axios.get('https://developer.sepush.co.za/business/2.0/api_allowance',
       { params: options, headers }).then(function (response) {
-      EskomSePushAPI = response.data
-      updateStatus(node)
+      EskomSePushInfo.api.info = response.data
+      if (EskomSePushInfo.api.lastUpdate === null) {
+        EskomSePushInfo.api.lastUpdate = new Date()
+        updateSheddingStatus(node)
+      }
+      EskomSePushInfo.api.lastUpdate = new Date()
     })
       .catch(error => {
         node.warn({ error: error.message })
@@ -55,9 +51,21 @@ module.exports = function (RED) {
   function checkStage (node) {
     const options = {}
     const headers = { token: node.config.licensekey }
+
+    if (node.config.verbose === true) {
+      let warnstring = 'Running function checkStage'
+      if (EskomSePushInfo.status.lastUpdate === null) {
+        warnstring += ' - initial run'
+      } else {
+        warnstring += ' after ' + ((new Date() - EskomSePushInfo.status.lastUpdate) / 60000).toFixed(0) + ' minutes'
+      }
+      node.warn(warnstring)
+    }
     axios.get('https://developer.sepush.co.za/business/2.0/status',
       { params: options, headers }).then(function (response) {
-      Stage = response.data
+      EskomSePushInfo.status.info = response.data
+      EskomSePushInfo.status.lastUpdate = new Date()
+      // Call updateSheddingStatus again now we have new data
       updateSheddingStatus(node)
     })
       .catch(error => {
@@ -65,17 +73,28 @@ module.exports = function (RED) {
       })
   }
 
-  function checkSchedule (node) {
+  function checkArea (node) {
     const options = { id: node.config.area }
     const headers = { token: node.config.licensekey }
     const url = 'https://developer.sepush.co.za/business/2.0/area'
+
+    if (node.config.verbose === true) {
+      let warnstring = 'Running function checkArea'
+      if (EskomSePushInfo.area.lastUpdate === null) {
+        warnstring += ' - initial run'
+      } else {
+        warnstring += ' after ' + ((new Date() - EskomSePushInfo.area.lastUpdate) / 60000).toFixed(0) + ' minutes'
+      }
+      node.warn(warnstring)
+    }
     if (node.config.test) {
       options.test = 'current'
     }
     axios.get(url,
       { params: options, headers }).then(function (response) {
-      Schedule = response.data
-      Schedule.info.area = node.config.area
+      EskomSePushInfo.area.info = response.data
+      EskomSePushInfo.area.lastUpdate = new Date()
+      // Call updateSheddingStatus again now we have new data
       updateSheddingStatus(node)
     })
       .catch(error => {
@@ -86,138 +105,158 @@ module.exports = function (RED) {
   function updateSheddingStatus (node) {
     const now = new Date()
 
-    if (EskomSePushAPI === null || (now.getTime() - lastStatusUpdate.getTime()) > 600000) {
+    // Check allowance every ten minutes
+    if (EskomSePushInfo.api.lastUpdate === null || (now.getTime() - EskomSePushInfo.api.lastUpdate.getTime()) > 600000) {
       checkAllowance(node)
-      lastStatusUpdate = now
     }
 
-    if (Schedule && Schedule.info.area !== node.config.area) {
-      Schedule = null
+    // If we don't have API info, we just return
+    if (Object.entries(EskomSePushInfo.api.info).length === 0) {
+      node.warn('No API info (yet), refusing to continue')
+      return
     }
 
-    if (EskomSePushAPI && EskomSePushAPI.allowance.count >= EskomSePushAPI.allowance.limit) {
-      updateStatus(node)
+    // The same is true if we have no API calls left
+    if (EskomSePushInfo.api.info.allowance.count >= EskomSePushInfo.api.info.allowance.limit) {
+      node.warn('No API calls left, not checking status/schedule')
       return
     }
 
-    if (Stage === null || (now.getTime() - lastStageUpdate.getTime()) > 3600000) {
+    // 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
+    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)
+    } else {
+      EskomSePushInfo.calc.sleeptime = 30
+    }
+
+    if (EskomSePushInfo.status.lastUpdate === null || (now.getTime() - EskomSePushInfo.status.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
       checkStage(node)
-      lastStageUpdate = now
     }
 
-    if (Schedule === null || (now.getTime() - lastScheduleUpdate.getTime()) > 3600000) {
-      checkSchedule(node)
-      lastScheduleUpdate = now
+    if (EskomSePushInfo.area.lastUpdate === null || (now.getTime() - EskomSePushInfo.area.lastUpdate) > (EskomSePushInfo.calc.sleeptime * 60000)) {
+      checkArea(node)
     }
 
-    if (Stage && Schedule && EskomSePushAPI) {
-      const stage = Stage.status[node.config.statusselect].stage
-      const nowtime = now.toLocaleTimeString('en-US', { hour12: false, hour: '2-digit', minute: '2-digit' })
-      LoadShedding = {
-        schedule: {
-          next: {},
-          active: false
-        },
-        event: {
-          next: {},
-          active: false
-        },
-        checked: nowtime
-      }
-      for (const schedule of Schedule.schedule.days[0].stages[stage - 1]) {
-        if (nowtime >= schedule.split('-')[0] && nowtime <= schedule.split('-')[1]) {
-          LoadShedding.schedule = {
-            active: true
-          }
-          if (schedule.split('-')[0] < schedule.split('-')[1]) {
-            LoadShedding.schedule.next = {
-              start: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[0]),
-              end: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[1])
-            }
-          } else {
-            LoadShedding.schedule.next = {
-              start: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[0]),
-              end: Date.parse(Schedule.schedule.days[1].date + ' ' + schedule.split('-')[1])
-            }
-          }
+    // Now we have all info to continue. Just making sure that all update values are non null.
+    if (EskomSePushInfo.api.lastUpdate === null ||
+        EskomSePushInfo.status.lastUpdate === null ||
+        EskomSePushInfo.area.lastUpdate === null) {
+      (node.config.verbose === true) && node.warn('Not enough info to continue.')
+      return
+    }
+
+    // Determine the current stage
+    EskomSePushInfo.calc.stage = EskomSePushInfo.status.info.status[node.config.statusselect].stage
+
+    if (node.config.verbose === true) {
+      node.warn('API call status: ' + EskomSePushInfo.api.info.allowance.count + '/' + EskomSePushInfo.api.info.allowance.limit)
+      node.warn(EskomSePushInfo)
+    }
+
+    // Default to false, overrule of loadshedding is active
+    EskomSePushInfo.calc.active = false
+
+    // 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.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]
         }
-        if (nowtime < schedule.split('-')[0]) {
-          if (schedule.split('-')[0] < schedule.split('-')[1]) {
-            LoadShedding.schedule.next = {
-              start: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[0]),
-              end: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[1])
-            }
+      } else {
+        EskomSePushInfo.calc.next = {
+          type: 'event',
+          start: EventStart,
+          end: EventEnd,
+          stage: EskomSePushInfo.area.info.events[0].note.match(/Stage (\d+)/i)[1]
+        }
+      }
+    }
+
+    // Scheduled downtime has the thing that the time is in locatime
+    // 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]) {
+        const ScheduleStart = Date.parse(dates.date + ' ' + schedule.split('-')[0])
+        const ScheduleEnd = Date.parse(dates.date + ' ' + schedule.split('-')[1])
+        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 {
-            LoadShedding.schedule.next = {
-              start: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[0]),
-              end: Date.parse(Schedule.schedule.days[1].date + ' ' + schedule.split('-')[1])
+            EskomSePushInfo.calc.next = {
+              type: 'schedule',
+              start: ScheduleStart,
+              end: ScheduleEnd
             }
           }
         }
+        if (BreakLoop) { break }
       }
-      if (!LoadShedding.schedule.active && Object.keys(LoadShedding.schedule.next).length === 0) {
-        const s = Schedule.schedule.days[1].stages[stage - 1][0]
-        LoadShedding.schedule.next = {
-          start: Date.parse(Schedule.schedule.days[1].date + ' ' + s.split('-')[0]),
-          end: Date.parse(Schedule.schedule.days[1].date + ' ' + s.split('-')[1])
-        }
-      }
-      LoadShedding.event.next = {
-        start: Date.parse(Schedule.events[0].start),
-        end: Date.parse(Schedule.events[0].end)
-      }
-      if (now >= LoadShedding.event.next.start && now < LoadShedding.event.next.end) {
-        LoadShedding.event.active = true
-      }
+      if (BreakLoop) { break }
+    }
 
-      if (!LoadShedding.schedule | !LoadShedding.schedule.next ||
-         !LoadShedding.event || !LoadShedding.event.next ||
-         !LoadShedding.schedule.next.start || !LoadShedding.event.next.start) {
-        node.warn('Unable to find next scheduled event and/or schedule')
-        node.warn(LoadShedding)
-        return
-      }
-      if (LoadShedding.schedule.next.start <= LoadShedding.event.next.start) {
-        LoadShedding.next = LoadShedding.schedule.next
-        LoadShedding.next.type = 'schedule'
-      } else {
-        LoadShedding.next = LoadShedding.event.next
-        LoadShedding.next.type = 'event'
-      }
+    if (EskomSePushInfo.calc.next) {
+      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)
+    }
 
-      LoadShedding.next.duration = (LoadShedding.next.end - LoadShedding.next.start) / 1000
-      LoadShedding.next.islong = LoadShedding.next.duration >= (4 * 3600)
+    if (EskomSePushInfo.calc.active) {
+      EskomSePushInfo.calc.duration = (EskomSePushInfo.calc.end - EskomSePushInfo.calc.start) / 1000
+      EskomSePushInfo.calc.islong = EskomSePushInfo.calc.duration >= (4 * 3600)
+      EskomSePushInfo.calc.secondstostatechange = parseInt((EskomSePushInfo.calc.end - now) / 1000)
+    }
 
-      LoadShedding.active = (LoadShedding.schedule.active || LoadShedding.event.active)
-      if (LoadShedding.schedule.active) {
-        LoadShedding.type = 'schedule'
-        LoadShedding.start = LoadShedding.schedule.next.start
-        LoadShedding.end = LoadShedding.schedule.next.end
-      }
-      if (LoadShedding.event.active) {
-        LoadShedding.type = 'event'
-        LoadShedding.start = LoadShedding.event.next.start
-        LoadShedding.end = LoadShedding.event.next.end
-      }
+    if (node.config.verbose === true) {
+      node.warn(EskomSePushInfo.calc)
+    }
 
-      node.send([{
-        payload: LoadShedding.active,
-        LoadShedding,
-        stage,
-        statusselect: node.config.statusselect,
-        api: {
-          count: EskomSePushAPI.allowance.count,
-          limit: EskomSePushAPI.allowance.limit,
-          lastStatusUpdate: lastStatusUpdate.toString(),
-          lastScheduleUpdate: lastScheduleUpdate.toString()
-        }
-      }, {
-        stage: Stage,
-        schedule: Schedule
-      }])
+    // Send output
+    node.send([{
+      payload: EskomSePushInfo.calc.active,
+      stage: EskomSePushInfo.calc.stage,
+      statusselect: node.config.statusselect,
+      api: {
+        count: EskomSePushInfo.api.info.allowance.count,
+        limit: EskomSePushInfo.api.info.allowance.limit
+      },
+      calc: EskomSePushInfo.calc
+    }, {
+      stage: EskomSePushInfo.status,
+      schedule: EskomSePushInfo.area
+    }])
+
+    // And update the status
+    let fill = 'green'
+    let shape = 'ring'
+    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()
+    } else {
+      statusText += ' - ' + new Date(EskomSePushInfo.calc.next.start).toLocaleTimeString()
+      statusText += ' - ' + new Date(EskomSePushInfo.calc.next.end).toLocaleTimeString()
     }
 
-    updateStatus(node)
+    statusText += ' (API: ' + EskomSePushInfo.api.info.allowance.count + '/' + EskomSePushInfo.api.info.allowance.limit + ')'
+    node.status({
+      fill, shape, text: statusText
+    })
   }
 
   function EskomSePush (config) {