node-red-contrib-eskomsepush 0.0.2 → 0.0.3

package/README.md

@@ -2,7 +2,7 @@
 
 ![EskomsePush API](img/eskomsepush-flow.png)
 
-A node for retrieving info from the EskomSePush API.
+A node for retrieving info from the [EskomSePush API](https://eskomsepush.gumroad.com/l/api).
 
 The EskomSePush-API node gives the tools to make working with the load shedding in South Africa as easy as possible.
 
@@ -12,10 +12,18 @@ Once deployed, the node will fetch the data from EskomSePush every hour. As ever
 
 Internally the node checks every minute if a schedule is currently active or not. It will also output a message on the first deployment.
 
+![EskomsePush Victron MinSOC](img/eskomsepush-victron-minsoc.png)
+
+The node has been made to work well together with the [@victronenergy/node-red-contrib-victron](https://flows.nodered.org/node/@victronenergy/node-red-contrib-victron) nodes. One of the main once being the
+ESS control node for setting the MinSoc, based on the currently active stage. You can find the
+example flow for this via importing the [victron-minsoc-stage-based.json](examples/victron-minsoc-stage-based.json) example.
+
 ### Configuration
 
 First you will need a _licence key_. You can get one from [here](https://eskomsepush.gumroad.com/l/api), by subsribing to the Free model. Note that this is for personal use only.
 
+![EskomsePush configuration](img/eskomsepush-configuration.png)
+
 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't want that and you already know the id of the area, fill out the area first and then the license key.
 
 Then you need to fill out which status to follow. This can be either _National_ (eskom) or _Capetown_.

package/examples/victron-minsoc-stage-based.json

@@ -0,0 +1,362 @@
+[
+    {
+        "id": "854cb9223eb1d95f",
+        "type": "eskomsepush",
+        "z": "614c1c00b0cf1810",
+        "name": "",
+        "licensekey": "",
+        "area": "capetown-3-helderbergvillage",
+        "statusselect": "capetown",
+        "test": false,
+        "x": 130,
+        "y": 660,
+        "wires": [
+            [
+                "685df7425884177e"
+            ],
+            []
+        ]
+    },
+    {
+        "id": "1304ce8952d56b0e",
+        "type": "debug",
+        "z": "614c1c00b0cf1810",
+        "name": "Scheduled charging",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 840,
+        "y": 540,
+        "wires": []
+    },
+    {
+        "id": "685df7425884177e",
+        "type": "switch",
+        "z": "614c1c00b0cf1810",
+        "name": "Stage",
+        "property": "stage",
+        "propertyType": "msg",
+        "rules": [
+            {
+                "t": "eq",
+                "v": "1",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "2",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "3",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "4",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "5",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "6",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "7",
+                "vt": "str"
+            },
+            {
+                "t": "eq",
+                "v": "8",
+                "vt": "str"
+            },
+            {
+                "t": "else"
+            }
+        ],
+        "checkall": "true",
+        "repair": false,
+        "outputs": 9,
+        "x": 310,
+        "y": 660,
+        "wires": [
+            [
+                "d52bbef6b535646e"
+            ],
+            [
+                "d52bbef6b535646e"
+            ],
+            [
+                "9a6d3dab537b880f"
+            ],
+            [
+                "f1c3df4e680f41a6"
+            ],
+            [
+                "02a4b5afeb44828f"
+            ],
+            [
+                "a4c5cec636c88ea4"
+            ],
+            [
+                "a5f3427bd40f7aa1"
+            ],
+            [
+                "a5f3427bd40f7aa1"
+            ],
+            [
+                "c80133f055cc326a"
+            ]
+        ],
+        "inputLabels": [
+            "EskomSePush API"
+        ],
+        "outputLabels": [
+            "stage 1",
+            "stage 2",
+            "stage 3",
+            "stage 4",
+            "stage 5",
+            "stage 6",
+            "stage 7",
+            "stage 8",
+            "otherwise"
+        ]
+    },
+    {
+        "id": "9a6d3dab537b880f",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "60%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "60",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 580,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "02a4b5afeb44828f",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "80%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "80",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 660,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "a5f3427bd40f7aa1",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "100%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "100",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 740,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "d811aee571fa6d6b",
+        "type": "victron-output-settings",
+        "z": "614c1c00b0cf1810",
+        "service": "com.victronenergy.settings",
+        "path": "/Settings/CGwacs/BatteryLife/MinimumSocLimit",
+        "serviceObj": {
+            "service": "com.victronenergy.settings",
+            "name": "Venus settings"
+        },
+        "pathObj": {
+            "path": "/Settings/CGwacs/BatteryLife/MinimumSocLimit",
+            "type": "float",
+            "name": "ESS Minimum SoC (unless grid fails) (%)",
+            "writable": true
+        },
+        "name": "",
+        "onlyChanges": false,
+        "x": 910,
+        "y": 640,
+        "wires": []
+    },
+    {
+        "id": "a4c5cec636c88ea4",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "90%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "90",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 700,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "f1c3df4e680f41a6",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "70%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "70",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 620,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "d52bbef6b535646e",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "50%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "50",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 540,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "c80133f055cc326a",
+        "type": "change",
+        "z": "614c1c00b0cf1810",
+        "name": "30%",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "30",
+                "tot": "num"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 490,
+        "y": 780,
+        "wires": [
+            [
+                "c7e0a8b8221196b2"
+            ]
+        ]
+    },
+    {
+        "id": "c7e0a8b8221196b2",
+        "type": "junction",
+        "z": "614c1c00b0cf1810",
+        "x": 640,
+        "y": 640,
+        "wires": [
+            [
+                "1304ce8952d56b0e",
+                "d811aee571fa6d6b"
+            ]
+        ]
+    }
+]

package/package.json

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

package/src/nodes/eskomsepush.html

@@ -166,7 +166,8 @@ This output is mainly useful when writing your own functions and logic.</p>
 
 <h3 id="status">Status</h3>
 
-<p>The status will show the situation regarding the API calls. It will show the count of API calls that have been done and
+<p>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.</p>
 
 <h1 id="documentation">Documentation</h1>

package/src/nodes/eskomsepush.js

@@ -8,16 +8,15 @@ module.exports = function (RED) {
   let lastStatusUpdate = new Date()
   let lastStageUpdate = new Date()
   let lastScheduleUpdate = new Date()
-  let LoadShedding = false
   let fill = 'green'
   let shape = 'ring'
-  
+
   function checkAllowance (node) {
     const options = {}
     const headers = { token: node.config.licensekey }
     axios.get('https://developer.sepush.co.za/business/2.0/api_allowance',
       { params: options, headers }).then(function (response) {
-        EskomSePushAPI = response.data
+      EskomSePushAPI = response.data
     })
       .catch(error => {
         node.warn({ error: error.message })
@@ -29,7 +28,7 @@ module.exports = function (RED) {
     const headers = { token: node.config.licensekey }
     axios.get('https://developer.sepush.co.za/business/2.0/status',
       { params: options, headers }).then(function (response) {
-        Stage = response.data
+      Stage = response.data
     })
       .catch(error => {
         node.warn({ error: error.message })
@@ -39,22 +38,22 @@ module.exports = function (RED) {
   function checkSchedule (node) {
     const options = { id: node.config.area }
     const headers = { token: node.config.licensekey }
-    let url = 'https://developer.sepush.co.za/business/2.0/area'
+    const url = 'https://developer.sepush.co.za/business/2.0/area'
     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
+      Schedule = response.data
+      Schedule.info.area = node.config.area
     })
       .catch(error => {
         node.warn({ error: error.message })
       })
   }
 
-  function updateStatus(node) {
-    const now = new Date();
+  function updateStatus (node) {
+    const now = new Date()
     let statusText = ''
 
     if (EskomSePushAPI === null || (now.getTime() - lastStatusUpdate.getTime()) > 600000) {
@@ -70,25 +69,24 @@ module.exports = function (RED) {
       statusText += 'API quota reached'
       fill = 'red'
       shape = 'dot'
-
     } else {
-      if (Stage === null || (now.getTime() - lastStatusUpdate.getTime()) > 3600000) {
-        node.status({fill: 'yellow', shape, text: 'Fetching status'})
+      if (Stage === null || (now.getTime() - lastStageUpdate.getTime()) > 3600000) {
+        node.status({ fill: 'yellow', shape, text: 'Fetching stage' })
         checkStage(node)
         lastStageUpdate = now
       }
 
       if (Schedule === null || (now.getTime() - lastScheduleUpdate.getTime()) > 3600000) {
-        node.status({fill: 'yellow', shape, text: 'Fetching schedule'})
+        node.status({ fill: 'yellow', shape, text: 'Fetching schedule' })
         checkSchedule(node)
         lastScheduleUpdate = now
       }
-    }  
+    }
 
     if (Stage && Schedule && EskomSePushAPI) {
-      let stage = Stage.status[node.config.statusselect].stage
-      let nowtime = now.toLocaleTimeString('en-US', { hour12: false, hour: '2-digit', minute: '2-digit'})
-      let LoadShedding = {
+      const stage = Stage.status[node.config.statusselect].stage
+      const nowtime = now.toLocaleTimeString('en-US', { hour12: false, hour: '2-digit', minute: '2-digit' })
+      const LoadShedding = {
         schedule: {
           next: {},
           active: false
@@ -100,15 +98,15 @@ module.exports = function (RED) {
         checked: nowtime
       }
       fill = 'green'
-      for (let schedule of Schedule.schedule.days[0].stages[stage-1]) {
-        if ( nowtime >= schedule.split('-')[0] && nowtime <= schedule.split('-')[1] ) {
+      for (const schedule of Schedule.schedule.days[0].stages[stage - 1]) {
+        if (nowtime >= schedule.split('-')[0] && nowtime <= schedule.split('-')[1]) {
           LoadShedding.schedule = {
             active: true,
             start: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[0]),
             end: Date.parse(Schedule.schedule.days[0].date + ' ' + schedule.split('-')[1])
           }
         }
-        if ( Object.keys(LoadShedding.schedule.next).length === 0 && nowtime < schedule.split('-')[0] ) {
+        if (Object.keys(LoadShedding.schedule.next).length === 0 && 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])
@@ -116,7 +114,7 @@ module.exports = function (RED) {
         }
       }
       if (Object.keys(LoadShedding.schedule.next).length === 0) {
-        let s = Schedule.schedule.days[1].stages[stage-1][0]
+        const s = Schedule.schedule.days[1].stages[stage - 1][0]
         LoadShedding.schedule.next = {
           start: Date.parse(Schedule.sschedule.days[1].date + s.split('-')[0]),
           end: Date.parse(Schedule.sschedule.days[1].date + s.split('-')[1])
@@ -126,14 +124,14 @@ module.exports = function (RED) {
         start: Date.parse(Schedule.events[0].start),
         end: Date.parse(Schedule.events[0].end)
       }
-      if ( nowtime >= LoadShedding.event.start && nowtime < LoadShedding.event.end ) {
+      if (nowtime >= LoadShedding.event.start && nowtime < LoadShedding.event.end) {
         LoadShedding.event.active = true
         LoadShedding.start = LoadShedding.event.start
         LoadShedding.end = LoadShedding.event.end
       }
 
       if (!LoadShedding.schedule.next.start || !LoadShedding.event.next.start) {
-        node.warn("Unable to find next scheduled event and/or schedule")
+        node.warn('Unable to find next scheduled event and/or schedule')
         return
       }
       if (LoadShedding.schedule.next.start <= LoadShedding.event.next.start) {
@@ -144,14 +142,15 @@ module.exports = function (RED) {
         LoadShedding.next.type = 'event'
       }
 
+      statusText += 'Stage '+stage
       LoadShedding.active = (LoadShedding.schedule.active || LoadShedding.event.active)
       if (LoadShedding.active) {
-        statusText += 'Until: '+ new Date(LoadShedding.end).toLocaleTimeString()
+        statusText += ' - ' + new Date(LoadShedding.end).toLocaleTimeString()
         fill = 'red'
       } else {
-        statusText += 'Next: ' + new Date(LoadShedding.next.start).toLocaleTimeString()
+        statusText += ' - ' + new Date(LoadShedding.next.start).toLocaleTimeString()
       }
-      node.send([{ 
+      node.send([{
         payload: LoadShedding.active,
         LoadShedding,
         stage,
@@ -164,7 +163,8 @@ module.exports = function (RED) {
         }
       }, {
         stage: Stage,
-        schedule: Schedule }])
+        schedule: Schedule
+      }])
     }
 
     if (EskomSePushAPI) {
@@ -172,7 +172,7 @@ module.exports = function (RED) {
     }
 
     node.status({
-      fill, shape, text: ( statusText || 'Ok' )
+      fill, shape, text: (statusText || 'Ok')
     })
   }