nodejs-poolcontroller 7.6.1 → 7.7.0

package/web/services/config/Config.ts

@@ -62,12 +62,21 @@ export class ConfigRoute {
             };
             return res.status(200).send(opts);
         });
-        app.get('/config/options/rs485', (req, res) => {
-            let opts = {
-                port: config.getSection('controller.comms', { enabled: false, netConnect: false }),
-                stats: conn.buffer.counter
-            };
-            return res.status(200).send(opts);
+        app.get('/config/options/rs485', async (req, res, next) => {
+            try {
+                let opts = { ports: [], local: [] }
+                let cfg = config.getSection('controller');
+                for (let section in cfg) {
+                    if (section.startsWith('comms')) {
+                        let cport = extend(true, { enabled: false, netConnect: false }, cfg[section]);
+                        let port = conn.findPortById(cport.portId || 0);
+                        if (typeof port !== 'undefined') cport.stats = port.stats;
+                        opts.ports.push(cport);
+                    }
+                }
+                opts.local = await conn.getLocalPortsAsync() || [];
+                return res.status(200).send(opts);
+            } catch (err) { next(err); }
         });
         app.get('/config/options/circuits', async (req, res, next) => {
             try {
@@ -156,7 +165,8 @@ export class ConfigRoute {
                     circuits: sys.board.circuits.getCircuitReferences(true, true, true, true),
                     bodies: sys.board.valueMaps.pumpBodies.toArray(),
                     pumps: sys.pumps.get(),
-                    servers: await sys.ncp.getREMServers()
+                    servers: await sys.ncp.getREMServers(),
+                    rs485ports: await conn.listInstalledPorts()
                 };
                 // RKS: Why do we need the circuit names?  We have the circuits.  Is this so
                 // that we can name the pump.  I thought that *Touch uses the pump type as the name
@@ -203,7 +213,8 @@ export class ConfigRoute {
                     heaterTypes: sys.board.valueMaps.heaterTypes.toArray(),
                     heatModes: sys.board.valueMaps.heatModes.toArray(),
                     coolDownDelay: sys.general.options.cooldownDelay,
-                    servers: []
+                    servers: [],
+                    rs485ports: await conn.listInstalledPorts()
                 };
                 // We only need the servers data when the controller is a Nixie controller.  We don't need to
                 // wait for this information if we are dealing with an OCP.
@@ -283,16 +294,19 @@ export class ConfigRoute {
                 return res.status(200).send(opts);
             } catch (err) { next(err); }
         });
-        app.get('/config/options/chlorinators', (req, res) => {
-            let opts = {
-                types: sys.board.valueMaps.chlorinatorType.toArray(),
-                bodies: sys.board.bodies.getBodyAssociations(),
-                chlorinators: sys.chlorinators.get(),
-                maxChlorinators: sys.equipment.maxChlorinators,
-                models: sys.board.valueMaps.chlorinatorModel.toArray(),
-                equipmentMasters: sys.board.valueMaps.equipmentMaster.toArray()
-            };
-            return res.status(200).send(opts);
+        app.get('/config/options/chlorinators', async (req, res, next) => {
+            try {
+                let opts = {
+                    types: sys.board.valueMaps.chlorinatorType.toArray(),
+                    bodies: sys.board.bodies.getBodyAssociations(),
+                    chlorinators: sys.chlorinators.get(),
+                    maxChlorinators: sys.equipment.maxChlorinators,
+                    models: sys.board.valueMaps.chlorinatorModel.toArray(),
+                    equipmentMasters: sys.board.valueMaps.equipmentMaster.toArray(),
+                    rs485ports: await conn.listInstalledPorts()
+                };
+                return res.status(200).send(opts);
+            } catch (err) { next(err); }
         });
         app.get('/config/options/dateTime', (req, res) => {
             let opts = {
@@ -756,6 +770,13 @@ export class ConfigRoute {
             }
             catch (err) { next(err); }
         });
+        app.delete('/app/rs485Port', async (req, res, next) => {
+            try {
+                let port = await conn.deleteAuxPort(req.body);
+                return res.status(200).send(port);
+            }
+            catch (err) { next(err); }
+        });
         app.get('/app/config/startPacketCapture', (req, res) => {
             startPacketCapture(true);
             return res.status(200).send('OK');

package/web/services/state/State.ts

@@ -161,6 +161,9 @@ export class StateRoute {
         app.get('/state/feature/:id', (req, res) => {
             res.status(200).send(state.features.getItemById(parseInt(req.params.id, 10)).get());
         });
+        app.get('/state/schedule/:id', (req, res) => {
+            res.status(200).send(state.schedules.getItemById(parseInt(req.params.id, 10)).get());
+        });
         app.get('/state/circuitGroup/:id', (req, res) => {
             res.status(200).send(state.circuitGroups.getItemById(parseInt(req.params.id, 10)).get());
         });
@@ -367,6 +370,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/manualOperationPriority', async (req, res, next) => {
+            try {
+                let cstate = await sys.board.system.setManualOperationPriority(parseInt(req.body.id, 10));
+                return res.status(200).send(cstate.get(true));
+            }
+            catch (err) { next(err); }
+        });
         app.put('/state/lightGroup/runCommand', async (req, res, next) => {
             try {
                 let sgroup = await sys.board.circuits.runLightGroupCommandAsync(req.body);

package/web/services/state/StateSocket.ts

@@ -174,7 +174,7 @@ export class StateSocket {
         sock.on('/circuit', async (data: any) => {
             try {
                 data = JSON.parse(data);
-                let id = data.parseInt(data.id, 10);
+                let id = parseInt(data.id, 10);
                 if (!isNaN(id) && (typeof data.isOn !== 'undefined' || typeof data.state !== 'undefined')) {
                     await sys.board.circuits.setCircuitStateAsync(id, utils.makeBool(data.isOn || typeof data.state));
                 }
@@ -184,7 +184,7 @@ export class StateSocket {
         sock.on('/feature', async (data: any) => {
             try {
                 data = JSON.parse(data);
-                let id = data.parseInt(data.id, 10);
+                let id = parseInt(data.id, 10);
                 if (!isNaN(id) && (typeof data.isOn !== 'undefined' || typeof data.state !== 'undefined')) {
                     await sys.board.features.setFeatureStateAsync(id, utils.makeBool(data.isOn || typeof data.state));
                 }
@@ -194,7 +194,7 @@ export class StateSocket {
         sock.on('/circuitGroup', async (data: any) => {
             try {
                 data = JSON.parse(data);
-                let id = data.parseInt(data.id, 10);
+                let id = parseInt(data.id, 10);
                 if (!isNaN(id) && (typeof data.isOn !== 'undefined' || typeof data.state !== 'undefined')) {
                     await sys.board.circuits.setCircuitGroupStateAsync(id, utils.makeBool(data.isOn || typeof data.state));
                 }
@@ -204,7 +204,7 @@ export class StateSocket {
         sock.on('/lightGroup', async (data: any) => {
             try {
                 data = JSON.parse(data);
-                let id = data.parseInt(data.id, 10);
+                let id = parseInt(data.id, 10);
                 if (!isNaN(id) && (typeof data.isOn !== 'undefined' || typeof data.state !== 'undefined')) {
                     await sys.board.circuits.setLightGroupStateAsync(id, utils.makeBool(data.isOn || typeof data.state));
                 }

package/web/services/utilities/Utilities.ts

@@ -1,43 +1,45 @@
-/*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-import * as express from 'express';
-import { SsdpServer} from '../../Server';
-import { state } from "../../../controller/State";
-import { sys } from "../../../controller/Equipment";
-
-const extend = require("extend");
-export class UtilitiesRoute {
-
-    public static initRoutes(app: express.Application) {
-        app.get('/device', function(req, res) {
-            // there's got to be a better way to get this than instantiating SsdpServer() again.
-            // RKS: There was I made the function static.
-            let xml = SsdpServer.deviceXML();
-            res.status(200).set('Content-Type', 'text/xml').send(xml);
-        });
-        app.get('/extended/:section', (req, res) => {
-            let cfg = sys.getSection(req.params.section);
-            let st = state.getState(req.params.section);
-            let arr = [];
-            for (let i = 0; i < cfg.length; i++){
-                let p = extend(true, {}, cfg[i], st.find(s => s.id === cfg[i].id));
-                arr.push(p);
-            }
-            return res.status(200).send(arr);
-        });
-    }
+/*  nodejs-poolController.  An application to control pool equipment.
+Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import * as express from 'express';
+import { SsdpServer} from '../../Server';
+import { state } from "../../../controller/State";
+import { sys } from "../../../controller/Equipment";
+import { webApp } from "../../Server";
+const extend = require("extend");
+export class UtilitiesRoute {
+
+    public static initRoutes(app: express.Application) {
+        app.use('/upnp.xml', async (req, res, next) => {
+            try {
+                // Put together the upnp device description.
+                let ssdp = webApp.findServer('ssdp') as SsdpServer;
+                if (typeof ssdp === 'undefined') throw new Error(`SSDP Server not initialized.  No upnp information available.`);
+                res.status(200).set('Content-Type', 'text/xml').send(ssdp.deviceXML());
+            } catch (err) { next(err); }
+        });
+        app.get('/extended/:section', (req, res) => {
+            let cfg = sys.getSection(req.params.section);
+            let st = state.getState(req.params.section);
+            let arr = [];
+            for (let i = 0; i < cfg.length; i++){
+                let p = extend(true, {}, cfg[i], st.find(s => s.id === cfg[i].id));
+                arr.push(p);
+            }
+            return res.status(200).send(arr);
+        });
+    }
 }

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,52 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. 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.
-
-**Packet Capture**
-Follow the instructions to complete a [packet capture](https://github.com/tagyoureit/nodejs-poolController/wiki/How-to-capture-all-packets-for-issue-resolution) and attach the resulting zip/log files.
-
-**Pool Equipment**
- - Controller: [e.g. IntelliCenter, EasyTouch, IntelliTouch]
- - Controller Model: [e.g. IntelliCenter i5PS, EasyTouch2 8P]
- - Controller Firmware Version: [e.g. 1.047]
- - Pump(s) manufacturer and model: [e.g. IntelliFlow 2 VST 011056]
- - Chlorinator: [e.g. iChlor, IntelliChlor-40]
- - Heater(s): [e.g. gas, solar, heatpump, ultratemp]
- - Chemical controller: [e.g. IntelliChem, Relay Equipment Manager (REM)]
- - Valves: [e.g. Intellivalve]
- - Any other relevant equipment:
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/config copy.json

@@ -1,300 +0,0 @@
-{
-  "controller": {
-    "comms": {
-      "enabled": true,
-      "rs485Port": "/dev/ttyUSB0",
-      "mockPort": false,
-      "netConnect": true,
-      "netHost": "10.0.0.170",
-      "netPort": 9801,
-      "inactivityRetry": 10,
-      "portSettings": {
-        "baudRate": 9600,
-        "dataBits": 8,
-        "parity": "none",
-        "stopBits": 1,
-        "flowControl": false,
-        "autoOpen": false,
-        "lock": false
-      }
-    }
-  },
-  "web": {
-    "servers": {
-      "http2": {
-        "enabled": false,
-        "uuid": "2365fe2f-97e9-4353-95d4-9ccd71e0ce94"
-      },
-      "http": {
-        "enabled": true,
-        "ip": "0.0.0.0",
-        "port": 4200,
-        "httpsRedirect": false,
-        "authentication": "none",
-        "authFile": "/users.htpasswd",
-        "uuid": "4ff21da9-8ba5-49e6-8c87-20e1c988ef9d"
-      },
-      "https": {
-        "enabled": false,
-        "ip": "0.0.0.0",
-        "port": 4201,
-        "authentication": "none",
-        "authFile": "/users.htpasswd",
-        "sslKeyFile": "",
-        "sslCertFile": "",
-        "uuid": "fb7e9f5e-d662-4000-b1ca-c01e17f2fc49"
-      },
-      "mdns": {
-        "enabled": false,
-        "uuid": "1e7bd3d0-f1d0-4dc5-95d4-f0bd0ceb2d76"
-      },
-      "ssdp": {
-        "enabled": true,
-        "uuid": "4fd33942-66c9-46a7-8a5a-9e50fc0f315f"
-      }
-    },
-    "services": {},
-    "interfaces": {
-      "smartThings": {
-        "name": "SmartThings",
-        "enabled": false,
-        "fileName": "smartThings-Hubitat.json",
-        "globals": {},
-        "options": {
-          "host": "0.0.0.0",
-          "port": 39500
-        },
-        "uuid": "95b47bcc-fb46-47c2-a44a-cd9aaa867ccc"
-      },
-      "hubitat": {
-        "name": "Hubitat",
-        "enabled": false,
-        "fileName": "smartThings-Hubitat.json",
-        "globals": {},
-        "options": {
-          "host": "0.0.0.0",
-          "port": 39501
-        },
-        "uuid": "4573370e-5ae1-40a5-bda3-9597b17e4050"
-      },
-      "vera": {
-        "name": "Vera",
-        "enabled": false,
-        "fileName": "vera.json",
-        "vars": {
-          "deviceId": 0
-        },
-        "options": {
-          "host": "",
-          "port": 3480
-        },
-        "uuid": "bc256cd7-af18-41f3-a94d-43397c835165"
-      },
-      "valveRelay": {
-        "name": "Valve Relays",
-        "enabled": false,
-        "fileName": "valveRelays.json",
-        "vars": {
-          "valveIds": []
-        },
-        "options": {
-          "host": "0.0.0.0",
-          "port": 8081
-        },
-        "uuid": "415c5cbd-01e0-43bb-99c9-15a003febe0c"
-      },
-      "influxDB": {
-        "name": "InfluxDB",
-        "type": "influx",
-        "enabled": false,
-        "fileName": "influxDB.json",
-        "options": {
-          "protocol": "http",
-          "host": "192.168.0.1",
-          "port": 32770,
-          "username": "",
-          "password": "",
-          "database": "pool",
-          "retentionPolicy": "autogen"
-        },
-        "uuid": "7e7875c8-0161-448b-b9fa-c818f0d3d49f"
-      },
-      "mqtt": {
-        "name": "MQTT",
-        "type": "mqtt",
-        "enabled": false,
-        "fileName": "mqtt.json",
-        "globals": {},
-        "options": {
-          "protocol": "mqtt://",
-          "host": "192.168.0.1",
-          "port": 1883,
-          "username": "",
-          "password": "",
-          "rootTopic": "@bind=(state.equipment.model).replace(' ','-').replace('/','').toLowerCase();",
-          "retain": true,
-          "qos": 0,
-          "changesOnly": true
-        },
-        "uuid": "dec40fe7-70d5-48d1-8f57-0e1a474838e6"
-      },
-      "mqttAlt": {
-        "name": "MQTTAlt",
-        "type": "mqtt",
-        "enabled": false,
-        "fileName": "mqttAlt.json",
-        "globals": {},
-        "options": {
-          "protocol": "mqtt://",
-          "host": "192.168.0.1",
-          "port": 1883,
-          "username": "",
-          "password": "",
-          "rootTopic": "@bind=(state.equipment.model).replace(' ','-').replace('/','').toLowerCase();Alt",
-          "retain": true,
-          "qos": 0,
-          "changesOnly": true
-        },
-        "uuid": "b8b0e719-a81f-4085-b69e-5df3adfa990c"
-      },
-      "rem": {
-        "name": "Relay Equipment Manager",
-        "type": "rem",
-        "enabled": true,
-        "options": {
-          "protocol": "http://",
-          "host": "10.0.0.98",
-          "port": "8080",
-          "headers": {
-            "content-type": "application/json"
-          }
-        },
-        "socket": {
-          "transports": [
-            "websocket"
-          ],
-          "upgrade": false,
-          "reconnectionDelay": 2000,
-          "reconnection": true,
-          "reconnectionDelayMax": 20000
-        },
-        "uuid": "af4c8252-0715-4edd-872f-9eeda8f18754"
-      },
-      "rem2": {
-        "name": "Relay Equipment Manager2",
-        "type": "rem",
-        "enabled": false,
-        "options": {
-          "protocol": "http://",
-          "host": "raspberrypi3",
-          "port": "8080",
-          "headers": {
-            "content-type": "application/json"
-          }
-        },
-        "socket": {
-          "transports": [
-            "websocket"
-          ],
-          "upgrade": false,
-          "reconnectionDelay": 2000,
-          "reconnection": true,
-          "reconnectionDelayMax": 20000
-        },
-        "uuid": "9346f2a7-734d-475b-a90e-2b43f6131a4c"
-      },
-      "rulesManager": {
-        "name": "Rules Manager",
-        "type": "http",
-        "enabled": false,
-        "fileName": "rulesManager.json",
-        "globals": {},
-        "options": {
-          "host": "localhost",
-          "port": 4200
-        },
-        "uuid": "65ee2581-e652-427e-99c6-17c6aa02a6e3"
-      }
-    }
-  },
-  "log": {
-    "packet": {
-      "enabled": true,
-      "logToConsole": true,
-      "logToFile": false,
-      "filename": "packetLog",
-      "invalid": false,
-      "broadcast": {
-        "enabled": true,
-        "includeActions": [
-          23,
-          24,
-          152,
-          155,
-          215,
-          216
-        ],
-        "includeSource": [],
-        "includeDest": [],
-        "excludeActions": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "pump": {
-        "enabled": false,
-        "includeActions": [],
-        "includeSource": [],
-        "includeDest": [],
-        "excludeActions": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "chlorinator": {
-        "enabled": false,
-        "includeSource": [],
-        "includeDest": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "intellichem": {
-        "enabled": false,
-        "includeActions": [],
-        "excludeActions": [],
-        "includeSource": [],
-        "includeDest": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "intellivalve": {
-        "enabled": false,
-        "includeActions": [],
-        "excludeActions": [],
-        "includeSource": [],
-        "includeDest": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "unidentified": {
-        "enabled": true,
-        "includeSource": [],
-        "includeDest": [],
-        "excludeSource": [],
-        "excludeDest": []
-      },
-      "unknown": {
-        "enabled": true,
-        "includeSource": [],
-        "includeDest": [],
-        "excludeSource": [],
-        "excludeDest": []
-      }
-    },
-    "app": {
-      "enabled": true,
-      "level": "verbose",
-      "captureForReplay": false,
-      "logToFile": false
-    }
-  },
-  "appVersion": "6.5.2"
-}

package/issue_template.md

@@ -1,52 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. 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.
-
-**Packet Capture**
-Follow the instructions to complete a [packet capture](https://github.com/tagyoureit/nodejs-poolController/wiki/How-to-capture-all-packets-for-issue-resolution) and attach the resulting zip/log files.
-
-**Pool Equipment**
- - Controller: [e.g. IntelliCenter, EasyTouch, IntelliTouch]
- - Controller Model: [e.g. IntelliCenter i5PS, EasyTouch2 8P]
- - Controller Firmware Version: [e.g. 1.047]
- - Pump(s) manufacturer and model: [e.g. IntelliFlow 2 VST 011056]
- - Chlorinator: [e.g. iChlor, IntelliChlor-40]
- - Heater(s): [e.g. gas, solar, heatpump, ultratemp]
- - Chemical controller: [e.g. IntelliChem, Relay Equipment Manager (REM)]
- - Valves: [e.g. Intellivalve]
- - Any other relevant equipment:
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.