nodejs-poolcontroller 7.6.1 → 8.0.0

package/web/bindings/rulesManager.json

@@ -1,55 +1,55 @@
-{
-  "context": {
-    "name":  "Rules Manager",
-    "vars": {},
-    "options": {
-      "method": "PUT",
-      "headers": {
-        "CONTENT-TYPE": "application/json"
-      }
-    }
-  },
-  "events": [
-    {
-      "name": "controller",
-      "description": "Turn on needsCleaning flag for filter.  Evaluate on a controller socket emit.  True when the pool is on, pump is not priming, and filter psi > 15",
-      "enabled": true,
-      "filter": "@bind=data.id;===1 && @bind=state.filters.getItemById(1).psi;>15 && @bind=data.status.name;!=='priming'",
-      "options": {
-        "path": "/config/filter"
-      },
-      "body": {"needsCleaning":true}
-    },
-    {
-      "name": "controller",
-      "description": "Turn on needsCleaning flag for filter.  Evaluate on a controller/time socket emit.  Eval on the first day of every 3rd month when psi is >15 at any point",
-      "enabled": true,
-      "filter": "@bind=(new Date(data.time)).getMonth()%3;===0 && @bind=(new Date(data.time)).getDate();===1 && @bind=state.filters.getItemById(1).psi;>15",
-      "options": {
-        "path": "/config/filter"
-      },
-      "body": {"needsCleaning":true}
-    },
-    {
-      "name": "chemController",
-      "description": "Sets chlorinator to 50% if ORP is low",
-      "enabled": true,
-      "filter": "@bind=data.orpLevel; < @bind=sys.chemControllers.getItemById(1).orpSetpoint;",
-      "options": {
-        "path": "/config/chlorinator"
-      },
-      "body": {"id":1, "poolSetpoint":50}
-    },
-    {
-      "name": "chemController",
-      "description": "Sets chlorinator to 5% if ORP is in range",
-      "enabled": true,
-      "filter": "@bind=data.orpLevel; > @bind=sys.chemControllers.getItemById(1).orpSetpoint;",
-      "options": {
-        "path": "/config/chlorinator"
-      },
-      "body": {"id":1, "poolSetpoint":5}
-    }
-  
-  ]
+{
+  "context": {
+    "name":  "Rules Manager",
+    "vars": {},
+    "options": {
+      "method": "PUT",
+      "headers": {
+        "CONTENT-TYPE": "application/json"
+      }
+    }
+  },
+  "events": [
+    {
+      "name": "controller",
+      "description": "Turn on needsCleaning flag for filter.  Evaluate on a controller socket emit.  True when the pool is on, pump is not priming, and filter psi > 15",
+      "enabled": true,
+      "filter": "@bind=data.id;===1 && @bind=state.filters.getItemById(1).psi;>15 && @bind=data.status.name;!=='priming'",
+      "options": {
+        "path": "/config/filter"
+      },
+      "body": {"needsCleaning":true}
+    },
+    {
+      "name": "controller",
+      "description": "Turn on needsCleaning flag for filter.  Evaluate on a controller/time socket emit.  Eval on the first day of every 3rd month when psi is >15 at any point",
+      "enabled": true,
+      "filter": "@bind=(new Date(data.time)).getMonth()%3;===0 && @bind=(new Date(data.time)).getDate();===1 && @bind=state.filters.getItemById(1).psi;>15",
+      "options": {
+        "path": "/config/filter"
+      },
+      "body": {"needsCleaning":true}
+    },
+    {
+      "name": "chemController",
+      "description": "Sets chlorinator to 50% if ORP is low",
+      "enabled": true,
+      "filter": "@bind=data.orpLevel; < @bind=sys.chemControllers.getItemById(1).orpSetpoint;",
+      "options": {
+        "path": "/config/chlorinator"
+      },
+      "body": {"id":1, "poolSetpoint":50}
+    },
+    {
+      "name": "chemController",
+      "description": "Sets chlorinator to 5% if ORP is in range",
+      "enabled": true,
+      "filter": "@bind=data.orpLevel; > @bind=sys.chemControllers.getItemById(1).orpSetpoint;",
+      "options": {
+        "path": "/config/chlorinator"
+      },
+      "body": {"id":1, "poolSetpoint":5}
+    }
+  
+  ]
 }

package/web/bindings/smartThings-Hubitat.json

@@ -1,32 +1,32 @@
-{
-  "context": {
-    "name":  "SmartThings",
-    "vars": {},
-    "options": {
-      "method": "NOTIFY",
-      "path": "/notify",
-      "headers": {
-        "CONTENT-TYPE": "application/json",
-        "X-EVENT-TYPE": "@bind=eventName;"
-      }
-    }
-  },
-  "events": [
-    {
-      "name": "justAnExample",
-      "description":  "Shows how the binding can be used to send variable data to SmartThings.  This can be any combination of data.",
-      "body": "{\"air\":\"@bind=data.air;@bind=data.units.name.substring(0, 1);\", \"total\":@bind=data.solar + data.waterSensor1;, \"status\":\"@bind=state.equipment.model;\"}",
-      "options": {
-        "headers": {
-          "X-EVENT2": ""
-        }
-      }
-    },
-    {
-        "name": "config",
-        "description": "Not used for updates",
-        "enabled": false
-    },
-    { "name": "*", "description": "All events that are not trapped by other event names.  Sends the entire emitted response.", "body": "@bind=data;" }
-  ]
+{
+  "context": {
+    "name":  "SmartThings",
+    "vars": {},
+    "options": {
+      "method": "NOTIFY",
+      "path": "/notify",
+      "headers": {
+        "CONTENT-TYPE": "application/json",
+        "X-EVENT-TYPE": "@bind=eventName;"
+      }
+    }
+  },
+  "events": [
+    {
+      "name": "justAnExample",
+      "description":  "Shows how the binding can be used to send variable data to SmartThings.  This can be any combination of data.",
+      "body": "{\"air\":\"@bind=data.air;@bind=data.units.name.substring(0, 1);\", \"total\":@bind=data.solar + data.waterSensor1;, \"status\":\"@bind=state.equipment.model;\"}",
+      "options": {
+        "headers": {
+          "X-EVENT2": ""
+        }
+      }
+    },
+    {
+        "name": "config",
+        "description": "Not used for updates",
+        "enabled": false
+    },
+    { "name": "*", "description": "All events that are not trapped by other event names.  Sends the entire emitted response.", "body": "@bind=data;" }
+  ]
 }

package/web/bindings/valveRelays.json

@@ -1,20 +1,20 @@
-{
-  "context": {
-    "name": "valveRelay",
-    "options": {
-      "method": "GET",
-      "path": "/@bind=data.pinId;/@bind=data.isDiverted ? 'on' : 'off';",
-      "headers": {
-        "CONTENT-TYPE": "application/json"
-      }
-    },
-    "vars": {} 
-  },
-  "events": [
-    {
-      "name": "valve",
-      "filter": "@bind=data.isVirtual;",
-      "description": "Send commands to turn on or off the valve relay based upon the valve emit."       
-    }
-  ]
-}
+{
+  "context": {
+    "name": "valveRelay",
+    "options": {
+      "method": "GET",
+      "path": "/@bind=data.pinId;/@bind=data.isDiverted ? 'on' : 'off';",
+      "headers": {
+        "CONTENT-TYPE": "application/json"
+      }
+    },
+    "vars": {} 
+  },
+  "events": [
+    {
+      "name": "valve",
+      "filter": "@bind=data.isVirtual;",
+      "description": "Send commands to turn on or off the valve relay based upon the valve emit."       
+    }
+  ]
+}

package/web/bindings/vera.json

@@ -1,25 +1,25 @@
-{
-  "context": {
-    "name": "Vera",
-    "options": {
-      "method": "POST",
-      "path": "/data_request?id=action&DeviceNum=@bind=vars.deviceId;&serviceId=urn:rstrouse-com:serviceId:PoolController1&action=SetEventData&targetData=@bind=eventName;",
-      "headers": {
-        "CONTENT-TYPE": "application/json"
-      }
-    },
-    "vars": {} 
-  },
-  "events": [
-    {
-      "name": "config",
-      "description": "Vera doesn't use this payload.",
-      "enabled": false
-    },
-    {
-      "name": "*",
-      "description": "This will be the UPnP version when I get the services built in Vera and the only binding required.  Sends the entire emitted response.",
-      "body": "@bind=data;"
-    }
-  ]
-}
+{
+  "context": {
+    "name": "Vera",
+    "options": {
+      "method": "POST",
+      "path": "/data_request?id=action&DeviceNum=@bind=vars.deviceId;&serviceId=urn:rstrouse-com:serviceId:PoolController1&action=SetEventData&targetData=@bind=eventName;",
+      "headers": {
+        "CONTENT-TYPE": "application/json"
+      }
+    },
+    "vars": {} 
+  },
+  "events": [
+    {
+      "name": "config",
+      "description": "Vera doesn't use this payload.",
+      "enabled": false
+    },
+    {
+      "name": "*",
+      "description": "This will be the UPnP version when I get the services built in Vera and the only binding required.  Sends the entire emitted response.",
+      "body": "@bind=data;"
+    }
+  ]
+}

package/web/interfaces/baseInterface.ts

@@ -1,136 +1,188 @@
-import extend = require("extend");
-import { logger } from "../../logger/Logger";
-import { sys as sysAlias } from "../../controller/Equipment";
-import { state as stateAlias} from "../../controller/State";
-import { webApp as webAppAlias } from '../Server';
-import { utils, Timestamp } from "../../controller/Constants";
-
-export class BaseInterfaceBindings {
-    constructor(cfg) {
-        this.cfg = cfg;
-    }
-    public context: InterfaceContext;
-    public cfg;
-    public events: InterfaceEvent[];
-    public bindEvent(evt: string, ...data: any) { };
-    protected bindVarTokens(e: InterfaceEvent, evt: string, ...data: any) {
-        let v = {};
-        let toks = {};
-        let vars = extend(true, {}, this.cfg.vars, this.context.vars, typeof e !== 'undefined' && e.vars ? e.vars : {});
-        for (var s in vars) {
-            let ovalue = vars[s];
-            if (typeof ovalue === 'string') {
-                if (ovalue.includes('@bind')) {
-                    this.matchTokens(ovalue, evt, toks, e, data[0], vars);
-                    v[s] = toks;
-                    ovalue = this.evalTokens(ovalue, toks);
-                }
-            }
-            v[s] = ovalue;
-        }
-        //console.log(...data);
-        //console.log(v);
-        return v;
-    }
-    protected matchTokens(input: string, eventName: string, toks: any, e: InterfaceEvent, data, vars): any {
-        toks = toks || [];
-        let s = input;
-        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
-        let match;
-        let sys = sysAlias;
-        let state = stateAlias;
-        let webApp = webAppAlias;
-        while (match = regx.exec(s)) {
-            let bind = match[0];
-            if (typeof toks[bind] !== 'undefined') continue;
-            let tok: any = {};
-            toks[bind] = tok;
-            try {
-                // we may error out if data can't be found (eg during init)
-                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
-                tok.value = eval(bind);
-            }
-            catch (err) {
-                // leave value undefined so it isn't sent to bindings
-                toks[bind] = null;
-            }
-        }
-        return toks;
-
-    }
-    protected buildTokens(input: string, eventName: string, toks: any, e: InterfaceEvent, data): any {
-        toks = toks || [];
-        let s = input;
-        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
-        let match;
-        let vars = this.bindVarTokens(e, eventName, data);
-        let sys = sysAlias;
-        let state = stateAlias;
-        let webApp = webAppAlias;
-        // Map all the returns to the token list.  We are being very basic
-        // here an the object graph is simply based upon the first object occurrence.
-        // We simply want to eval against that object reference.
-
-        while (match = regx.exec(s)) {
-            let bind = match[0];
-            if (typeof toks[bind] !== 'undefined') continue;
-            let tok: any = {};
-            toks[bind] = tok;
-            try {
-                // we may error out if data can't be found (eg during init)
-                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
-                tok.value = eval(bind);
-            }
-            catch (err) {
-                // leave value undefined so it isn't sent to bindings
-                toks[bind] = null;
-            }
-        }
-        return toks;
-    }
-    protected escapeRegex(reg: string) { return reg.replace(/[-[\]{}()*+?.|,\\^$]/g, '\\$&'); }
-    protected replaceTokens(input: string, toks: any) {
-        let s = input;
-        for (let exp in toks) {
-            let tok = toks[exp];
-            if (!tok || typeof tok.reg === 'undefined') continue;
-            tok.reg.lastIndex = 0; // Start over if we used this before.
-            if (typeof tok.value === 'string') s = s.replace(tok.reg, tok.value);
-            else if (typeof tok.value === 'undefined') s = s.replace(tok.reg, 'null');
-            else s = s.replace(tok.reg, JSON.stringify(tok.value));
-        }
-        return s;
-    }
-    protected evalTokens(input: string, toks: any) {
-        let s = input;
-        for (let exp in toks) {
-            let tok = toks[exp];
-            if (!tok || typeof tok.reg === 'undefined') continue;
-            tok.reg.lastIndex = 0; // Start over if we used this before.
-            if (typeof tok.value === 'string') s = s.replace(tok.reg, tok.value);
-            else if (typeof tok.value === 'undefined') s = s.replace(tok.reg, 'null');
-            else return tok.value;
-        }
-    }
-    protected tokensReplacer(input: string, eventName: string, toks: any, e: InterfaceEvent, data): any{
-        this.buildTokens(input, eventName, toks, e, data);
-        return this.replaceTokens(input, toks);
-    }
-    public async stopAsync() { }
-}
-
-export class InterfaceEvent {
-    public name: string;
-    public enabled: boolean = true;
-    public filter: string;
-    public options: any = {};
-    public body: any = {};
-    public vars: any = {};
-}
-export class InterfaceContext {
-    public name: string;
-    public mdnsDiscovery: any;
-    public upnpDevice: any;
-    public options: any = {};
-    public vars: any = {};
-}
+import * as fs from "fs";
+import * as path from "path";
+import extend = require("extend");
+import { logger } from "../../logger/Logger";
+import { sys as sysAlias } from "../../controller/Equipment";
+import { state as stateAlias} from "../../controller/State";
+import { webApp as webAppAlias } from '../Server';
+import { config } from "../../config/Config";
+export class BindingsFile {
+    public static async fromBuffer(filename: string, buff: Buffer) {
+        try {
+            let bf = new BindingsFile();
+            bf.filename = filename;
+            bf.filePath = path.join(process.cwd(), 'web/bindings/custom', bf.filename);
+            bf.options = await bf.extractBindingOptions(buff);
+            return typeof bf.options !== 'undefined' ? bf : undefined;
+        } catch (err) { logger.error(`Error creating buffered backup file: ${filename}`); }
+    }
+    public static async fromFile(pathName: string, fileName: string) {
+        try {
+            let bf = new BindingsFile();
+            bf.filePath = path.posix.join(pathName, fileName);
+            bf.filename = fileName;
+            bf.options = await bf.extractBindingOptions(bf.filePath);
+            return typeof bf.options !== 'undefined' ? bf : undefined;
+        } catch (err) { logger.error(`Error creating bindings file from file ${pathName}${fileName}`); }
+    }
+    public filename: string;
+    public filePath: string;
+    public options: any;
+    protected async extractBindingOptions(file: string | Buffer) {
+        try {
+            let buff = Buffer.isBuffer(file) ? file.toString() : fs.readFileSync(file, 'utf8');
+            let bindings = JSON.parse(buff);
+            let interfaces = config.getSection('web.interfaces');
+            let ass = [];
+            for (let ifname in interfaces) {
+                let iface = interfaces[ifname]
+                if (typeof iface !== 'undefined' && typeof iface.fileName !== 'undefined')
+                    if (iface.fileName.endsWith(`custom/${this.filename}`)) ass.push(ifname);
+            }
+            if (typeof bindings.context !== 'undefined')
+                return {
+                    filename: this.filename, filepath: this.filePath, name: bindings.context.name || name, type: bindings.context.type || undefined, assoc: ass
+                };
+            return this.options;
+        } catch (err) { logger.error(`Error extracting binding options from ${Buffer.isBuffer(file) ? 'Buffer' : file}: ${err.message}`); }
+    }
+}
+
+export class BaseInterfaceBindings {
+    constructor(cfg) {
+        this.cfg = cfg;
+    }
+    public context: InterfaceContext;
+    public cfg;
+    public events: InterfaceEvent[];
+    public bindEvent(evt: string, ...data: any) { };
+    public bindVarTokens(e: IInterfaceEvent, evt: string, ...data: any) {
+        let v = {};
+        let toks = {};
+        let vars = extend(true, {}, this.context.vars, typeof e !== 'undefined' && e.vars ? e.vars : {}, this.cfg.vars || {});
+        for (var s in vars) {
+            let ovalue = vars[s];
+            if (typeof ovalue === 'string') {
+                if (ovalue.includes('@bind')) {
+                    this.matchTokens(ovalue, evt, toks, e, data[0], vars);
+                    v[s] = toks;
+                    ovalue = this.evalTokens(ovalue, toks);
+                }
+            }
+            v[s] = ovalue;
+        }
+        //console.log(...data);
+        //console.log(v);
+        return v;
+    }
+    protected matchTokens(input: string, eventName: string, toks: any, e: IInterfaceEvent, data, vars): any {
+        toks = toks || [];
+        let s = input;
+        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
+        let match;
+        let sys = sysAlias;
+        let state = stateAlias;
+        let webApp = webAppAlias;
+        while (match = regx.exec(s)) {
+            let bind = match[0];
+            if (typeof toks[bind] !== 'undefined') continue;
+            let tok: any = {};
+            toks[bind] = tok;
+            try {
+                // we may error out if data can't be found (eg during init)
+                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
+                tok.value = eval(bind);
+            }
+            catch (err) {
+                // leave value undefined so it isn't sent to bindings
+                toks[bind] = null;
+            }
+        }
+        return toks;
+
+    }
+    protected buildTokens(input: string, eventName: string, toks: any, e: IInterfaceEvent, data): any {
+        toks = toks || [];
+        let s = input;
+        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
+        let match;
+        let vars = this.bindVarTokens(e, eventName, data);
+        let sys = sysAlias;
+        let state = stateAlias;
+        let webApp = webAppAlias;
+        // Map all the returns to the token list.  We are being very basic
+        // here an the object graph is simply based upon the first object occurrence.
+        // We simply want to eval against that object reference.
+
+        while (match = regx.exec(s)) {
+            let bind = match[0];
+            if (typeof toks[bind] !== 'undefined') continue;
+            let tok: any = {};
+            toks[bind] = tok;
+            try {
+                // we may error out if data can't be found (eg during init)
+                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
+                tok.value = eval(bind);
+            }
+            catch (err) {
+                // leave value undefined so it isn't sent to bindings
+                toks[bind] = null;
+            }
+        }
+        return toks;
+    }
+    protected escapeRegex(reg: string) { return reg.replace(/[-[\]{}()*+?.|,\\^$]/g, '\\$&'); }
+    protected replaceTokens(input: string, toks: any) {
+        let s = input;
+        for (let exp in toks) {
+            let tok = toks[exp];
+            if (!tok || typeof tok.reg === 'undefined') continue;
+            tok.reg.lastIndex = 0; // Start over if we used this before.
+            if (typeof tok.value === 'string') s = s.replace(tok.reg, tok.value);
+            else if (typeof tok.value === 'undefined') s = s.replace(tok.reg, 'null');
+            else s = s.replace(tok.reg, JSON.stringify(tok.value));
+        }
+        return s;
+    }
+    protected evalTokens(input: string, toks: any) {
+        let s = input;
+        for (let exp in toks) {
+            let tok = toks[exp];
+            if (!tok || typeof tok.reg === 'undefined') continue;
+            tok.reg.lastIndex = 0; // Start over if we used this before.
+            if (typeof tok.value === 'string') s = s.replace(tok.reg, tok.value);
+            else if (typeof tok.value === 'undefined') s = s.replace(tok.reg, 'null');
+            else return tok.value;
+        }
+        return s;
+    }
+    protected tokensReplacer(input: string, eventName: string, toks: any, e: InterfaceEvent, data): any{
+        this.buildTokens(input, eventName, toks, e, data);
+        return this.replaceTokens(input, toks);
+    }
+    public async stopAsync() { }
+}
+export interface IInterfaceEvent {
+    enabled: boolean;
+    filter?: string;
+    options?: any;
+    body?: any;
+    vars?: any;
+    processor?: string[]
+}
+export class InterfaceEvent implements IInterfaceEvent {
+    public name: string;
+    public enabled: boolean = true;
+    public filter: string;
+    public options: any = {};
+    public body: any = {};
+    public vars: any = {};
+    public processor?: string[]
+}
+export class InterfaceContext {
+    public name: string;
+    public mdnsDiscovery: any;
+    public upnpDevice: any;
+    public options: any = {};
+    public vars: any = {};
+}