node-red-contrib-eskomsepush 0.0.8 → 0.0.9

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Using node  '...'
+2. Click on '....'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Flow**
+If applicable, add a flow to help explain your problem.
+
+**Software (please complete the following information):**
+ - node-red-contrib-eskomsepush version:
+
+**Additional context**
+Add any other context about the problem here.
+

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for the EskomSePush node
+title: "[Feature]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+

package/README.md

@@ -20,7 +20,9 @@ The node has been made to work well together with the [@victronenergy/node-red-c
 
 You can find the example flow for this via importing the [victron-minsoc-stage-based.json](examples/victron-minsoc-stage-based.json) file.
 
-### Configuration
+### Installation & Configuration
+
+Install the node from within Node-RED from the menu: Manage pallete -> Install (tab) -> Search for "eskom" and click "install".
 
 First you will need a _licence key_. You can get one from [here](https://eskomsepush.gumroad.com/l/api), by subscribing to the Free model. Note that this is for personal use only.
 
@@ -106,6 +108,10 @@ 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 load schedding is because of an _event_. When it is a ring, it is caused by
+a matching _schedule_.
+
 ### Documentation
 
 Documentation for the API can be found [here](https://documenter.getpostman.com/view/1296288/UzQuNk3E)

package/package.json

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

package/src/nodes/eskomsepush.html

@@ -1,4 +1,33 @@
 <script type="text/javascript">
+    function checkForValidLicense() {
+        var licensekey = $('#node-input-licensekey').val();
+
+        var regexValidator = RED.validators.regex(/^[0-9A-F\-]{35}$/)
+        var isValid = regexValidator(licensekey)
+
+        if (isValid) {
+            document.getElementById("searchAreaText").disabled = false
+            $.ajax({
+                url: '/eskomsepush/api',
+                method: 'GET',
+                data: {
+                    token: licensekey,
+                },
+                success: function(response) {
+                    $('#api_info').text(response.allowance.count + '/' + response.allowance.limit)
+                    if (response.allowance.count >= response.allowance.limit) {
+                        document.getElementById("searchAreaText").disabled = true
+                    }
+                },
+                error: function(error) {
+                    node.warn(error)
+                }
+            })
+        } else {
+            document.getElementById("searchAreaText").disabled = true
+        }
+    }
+
     RED.nodes.registerType('eskomsepush',{
         category: 'network',
         color: '#ffffff',
@@ -16,53 +45,48 @@
             return this.name||"EskomSePush API";
         },
         oneditprepare: function oneditprepare() {
-
-        }
-    });
-
-    function searchArea() {
-        var input = document.getElementById("node-input-area");
-        var dropdown = document.getElementById("areaDropdown");
-        var licensekey = document.getElementById("node-input-licensekey");
-
-        if (!RED.validators.regex(licensekey.value, /^[0-9A-F\-]{35}$/)) {
-            return
-        }
-
-        if (input.value.length >= 5) {
-            dropdown.innerHTML = "";
-
-            $.ajax({
-                url: '/eskomsepush/search',
-                method: 'GET',
-                data: {
-                    token: licensekey.value,
-                    search: input.value
-                },
-                success: function(response) {
-                    for (var i = 0; i < response.areas.length; i++) {
-                        var option = document.createElement("option");
-                        option.text = response.areas[i].name;
-                        option.value = response.areas[i].id;
-                        dropdown.add(option);
-                    }
-                },
-                error: function(error) {
-                    node.warn(error)
+            checkForValidLicense()
+
+            $("button#searchAreaId").on("click", function() {
+                var licensekey = $("#node-input-licensekey").val()
+                var regexValidator = RED.validators.regex(/^[0-9A-F\-]{35}$/)
+                var isValid = regexValidator(licensekey)
+                var search = $("input#searchAreaText").val()
+                var arealist = ''
+
+                if (isValid && search != '') {
+                    $.ajax({
+                        url: '/eskomsepush/search',
+                        method: 'GET',
+                        data: {
+                            token: licensekey,
+                            search
+                        },
+                        success: function(response) {
+                            for (var i = 0; i < response.areas.length; i++) {
+                                arealist += '<li id="' + response.areas[i].id + '">' + response.areas[i].name +
+                                    ', '+ response.areas[i].region + '</li>'
+                            }
+                            $('#list-areas').html(arealist)
+                            $('#list-areas li').on('click', function() {
+                                $('#node-input-area').val($(this).attr("id"))
+                                $('#node-input-name').val($(this).text().split(',')[0])
+                            })
+                            checkForValidLicense()
+                        },
+                        error: function(error) {
+                            node.warn(error)
+                        }
+                    })
                 }
             })
-            dropdown.style.display = "block";
-            dropdown.addEventListener("change", function() {
-                input.value = dropdown.value;
-                dropdown.style.display = "none";
+
+            $("#node-input-licensekey").on("input", function() {
+                checkForValidLicense()
             });
-            input.addEventListener("focusout", function() {
-                dropdown.style.display = "none"
-            })
-        } else {
-            dropdown.style.display = "none";
         }
-    }
+    });
+
 </script>
 
 <script type="text/html" data-template-name="eskomsepush">
@@ -75,13 +99,8 @@
         <input type="password" id="node-input-licensekey" placeholder="License key" required>
     </div>
     <div class="form-row">
-        <label for="node-input-area"><i class="fa fa-tag"></i> Area</label>
-        <input type="text" id="node-input-area" placeholder="Area" onkeyup="searchArea()">
-        <select id="areaDropdown" style="display: none;"></select>
-    </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">
+        <label for="node-input-area"><i class="fa fa-tag"></i> Area id</label>
+        <input type="text" id="node-input-area" placeholder="Area id">
     </div>
     <div class="form-row">
         <label for="node-input-statusselect"><i class="fa fa-location-arrow"></i> Status select</label>
@@ -90,6 +109,27 @@
             <option value="capetown">Cape Town</option>
         </select>
     </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">
+    </div>
+    <div class="form-tips">
+        <p>In order to fill out the properties, you will need to add the correct license key, which can be
+        obtained <a href="https://eskomsepush.gumroad.com/l/api">here</a>. Apart from that, the
+        <em>Aread id</em> needs to be filled out. The search form below can help you to obtain that.<br />
+        Once you have a valid licence key filled out in the form, a query willl be done, checking
+            how many credits you have left. If you have credits left, the form 
+            can be used to search for the needed area id. <strong>Each search will cost you 5 credits.</strong>
+        </p>
+
+        <ul id="list-areas"></ul>
+
+        <p>
+            Queries left: <span id="api_info">unknown/unknown</span><br />
+        <input type="text" id="searchAreaText" placeholder="Area" disabled />
+        <button id="searchAreaId">Search</button><br />
+    </p>
+    </div>
 </script>
 
 <script type="text/html" data-help-name="eskomsepush">
@@ -111,8 +151,7 @@ see how many queries you have left.</p>
 <h3 id="configuration">Configuration</h3>
 
 <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 you entered 5 characters (and a valid license is used), the API will be used for searching the correct area. 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 first and then the license
-key.</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>
 
@@ -122,47 +161,53 @@ key.</p>
 
 <pre>
 {
-  "payload":false,
-  "LoadShedding":{
-    "schedule":{
-       "next":{
-         "start":1683561600000,
-         "end":1683570600000,
-         "type":"schedule"
-       },
-       "active":false
-    },
-    "event":{
-      "next":{
-        "start":1683561600000,
-        "end":1683570600000
-      },
-      "active":false
+    "payload": false,
+    "LoadShedding": {
+        "schedule": {
+        "next": {
+            "start": 1684267200000,
+            "end": 1684276200000,
+            "type": "schedule",
+            "duration": 9000,
+            "islong": false
+        },
+        "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
     },
-    "checked":"13:35",
-    "next":{
-      "start":1683561600000,
-      "end":1683570600000,
-      "type":"schedule"
+    "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)"
     },
-    "active":false
-  },
-  "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)"
-  },
-  "_msgid":"6e77b593b7f9eda4"
-}
+    "_msgid": "dfa429a93a16472d"
+    }
 </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).</p>
+<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
+    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 writing your own functions and logic.</p>
+This output is mainly useful when debugging or writing your own functions and logic.</p>
 
 <h3 id="status">Status</h3>
 
@@ -170,9 +215,16 @@ This output is mainly useful when writing your own functions and logic.</p>
     It also shows the count of API calls that have been done and
 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 load schedding is because of an <em>event</em>. When it is a ring, it is caused by
+a matching <em>schedule</em>.
+</p>
+
 <h1 id="documentation">Documentation</h1>
-<p>Documentation for the API can be found <a href="https://documenter.getpostman.com/view/1296288/UzQuNk3E">here</a></p>
 
+<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>.
+For issues and/or suggestions for improving the node, please use the <a href="https://github.com/dirkjanfaber/node-red-contrib-eskomsepush/issues">issue tracker</a>.</p>
 </script>
 
 <style>
@@ -183,4 +235,7 @@ select#areaDropdown {
   position: absolute;
   left: 120px;
 }
+#list-areas li {
+  cursor: pointer;
+}
 </style>

package/src/nodes/eskomsepush.js

@@ -10,13 +10,12 @@ module.exports = function (RED) {
   let lastStageUpdate = new Date()
   let lastScheduleUpdate = new Date()
 
-
-  function updateStatus(node) {
+  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
+      statusText += 'Stage ' + Stage.status[node.config.statusselect].stage
     }
     if (LoadShedding && LoadShedding.active && LoadShedding.next && LoadShedding.next.end) {
       statusText += ' - ' + new Date(LoadShedding.next.end).toLocaleTimeString()
@@ -32,7 +31,7 @@ module.exports = function (RED) {
     if (EskomSePushAPI) {
       statusText += ` (API: ${EskomSePushAPI.allowance.count}/${EskomSePushAPI.allowance.limit})`
       if (EskomSePushAPI.allowance.count >= EskomSePushAPI.allowance.limit) {
-        fill = 'red'    
+        fill = 'red'
       }
     }
     node.status({
@@ -130,15 +129,29 @@ module.exports = function (RED) {
           LoadShedding.schedule = {
             active: true
           }
-          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])
+          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])
+            }
           }
         }
         if (nowtime < schedule.split('-')[0]) {
-          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])
+          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])
+            }
           }
         }
       }
@@ -172,6 +185,9 @@ module.exports = function (RED) {
         LoadShedding.next.type = 'event'
       }
 
+      LoadShedding.next.duration = (LoadShedding.next.end - LoadShedding.next.start) / 1000
+      LoadShedding.next.islong = LoadShedding.next.duration >= (4 * 3600)
+
       LoadShedding.active = (LoadShedding.schedule.active || LoadShedding.event.active)
       if (LoadShedding.schedule.active) {
         LoadShedding.type = 'schedule'
@@ -243,4 +259,23 @@ module.exports = function (RED) {
         return res.send({ error: error.message })
       })
   })
+  RED.httpNode.get('/eskomsepush/api', (req, res) => {
+    if (!req.query.token) {
+      res.setHeader('Content-Type', 'application/json')
+      return res.send('invalid')
+    }
+    const headers = {
+      token: req.query.token
+    }
+    const options = {}
+
+    res.setHeader('Content-Type', 'application/json')
+    axios.get('https://developer.sepush.co.za/business/2.0/api_allowance',
+      { params: options, headers }).then(function (response) {
+      return res.send(response.data)
+    })
+      .catch(error => {
+        return res.send({ error: error.message })
+      })
+  })
 }