node-red-contrib-eskomsepush 0.0.9 → 0.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-eskomsepush",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "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

@@ -14,12 +14,16 @@ module.exports = function (RED) {
     let fill = 'green'
     let shape = 'ring'
     let statusText = ''
+
+    if (node.config.verbose === true) {
+      node.warn('Running function updateStatus')
+    }
     if (Stage && Stage.status && Stage.status[node.config.statusselect].stage) {
-      statusText += 'Stage ' + Stage.status[node.config.statusselect].stage
+      statusText += 'Stage ' + (Stage.active || Stage.status[node.config.statusselect].stage)
     }
     if (LoadShedding && LoadShedding.active && LoadShedding.next && LoadShedding.next.end) {
       statusText += ' - ' + new Date(LoadShedding.next.end).toLocaleTimeString()
-      fill = 'red'
+      fill = 'yellow'
       if (LoadShedding.type === 'event') {
         shape = 'dot'
       }
@@ -42,6 +46,10 @@ module.exports = function (RED) {
   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
@@ -55,6 +63,10 @@ module.exports = function (RED) {
   function checkStage (node) {
     const options = {}
     const headers = { token: node.config.licensekey }
+
+    if (node.config.verbose === true) {
+      node.warn('Running function checkStage')
+    }
     axios.get('https://developer.sepush.co.za/business/2.0/status',
       { params: options, headers }).then(function (response) {
       Stage = response.data
@@ -69,6 +81,10 @@ module.exports = function (RED) {
     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) {
+      node.warn('Running function checkSchedule')
+    }
     if (node.config.test) {
       options.test = 'current'
     }
@@ -86,6 +102,9 @@ module.exports = function (RED) {
   function updateSheddingStatus (node) {
     const now = new Date()
 
+    if (node.config.verbose === true) {
+      node.warn('Running function updateSheddingStatus')
+    }
     if (EskomSePushAPI === null || (now.getTime() - lastStatusUpdate.getTime()) > 600000) {
       checkAllowance(node)
       lastStatusUpdate = now
@@ -111,7 +130,7 @@ module.exports = function (RED) {
     }
 
     if (Stage && Schedule && EskomSePushAPI) {
-      const stage = Stage.status[node.config.statusselect].stage
+      let stage = Stage.status[node.config.statusselect].stage
       const nowtime = now.toLocaleTimeString('en-US', { hour12: false, hour: '2-digit', minute: '2-digit' })
       LoadShedding = {
         schedule: {
@@ -124,7 +143,13 @@ module.exports = function (RED) {
         },
         checked: nowtime
       }
-      for (const schedule of Schedule.schedule.days[0].stages[stage - 1]) {
+
+      if (!Array.isArray(Schedule.schedule.days[0].stages[stage])) {
+        node.warn(`No schedule defined for stage ${stage}`)
+        return
+      }
+
+      for (const schedule of Schedule.schedule.days[0].stages[stage]) {
         if (nowtime >= schedule.split('-')[0] && nowtime <= schedule.split('-')[1]) {
           LoadShedding.schedule = {
             active: true
@@ -168,6 +193,12 @@ module.exports = function (RED) {
       }
       if (now >= LoadShedding.event.next.start && now < LoadShedding.event.next.end) {
         LoadShedding.event.active = true
+        if (Schedule.events[0].note.match(/Stage (\d+)/i)) {
+          stage = Schedule.events[0].note.match(/Stage (\d+)/i)[1]
+          Stage.active = stage
+        }
+      } else {
+        Stage.active = stage
       }
 
       if (!LoadShedding.schedule | !LoadShedding.schedule.next ||