nodejs-poolcontroller 7.7.0 → 8.0.0

package/web/services/config/Config.ts

@@ -1,5 +1,6 @@
 /*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.  
+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
@@ -15,11 +16,11 @@ 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 fs from "fs";
+import * as path from "path";
 import * as express from "express";
 import * as extend from 'extend';
 import * as multer from 'multer';
-import * as path from "path";
-import { sys, LightGroup, ControllerType, Pump, Valve, Body, General, Circuit, ICircuit, Feature, CircuitGroup, CustomNameCollection, Schedule, Chlorinator, Heater } from "../../../controller/Equipment";
+import { sys, LightGroup, ControllerType, Pump, Valve, Body, General, Circuit, ICircuit, Feature, CircuitGroup, CustomNameCollection, Schedule, Chlorinator, Heater, Screenlogic } from "../../../controller/Equipment";
 import { config } from "../../../config/Config";
 import { logger } from "../../../logger/Logger";
 import { utils } from "../../../controller/Constants";
@@ -29,6 +30,8 @@ import { stopPacketCaptureAsync, startPacketCapture } from '../../../app';
 import { conn } from "../../../controller/comms/Comms";
 import { webApp, BackupFile, RestoreFile } from "../../Server";
 import { release } from "os";
+import { ScreenLogicComms, sl } from "../../../controller/comms/ScreenLogic";
+import { screenlogic } from "node-screenlogic";
 
 export class ConfigRoute {
     public static initRoutes(app: express.Application) {
@@ -64,20 +67,48 @@ export class ConfigRoute {
         });
         app.get('/config/options/rs485', async (req, res, next) => {
             try {
-                let opts = { ports: [], local: [] }
+                let opts = { ports: [], local: [], screenlogic: {} }
                 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 cport = extend(true, { enabled: false, netConnect: false, mock: false }, cfg[section]);
                         let port = conn.findPortById(cport.portId || 0);
+                        if (typeof cport.type === 'undefined'){
+                            cport.type = cport.netConnect ? 'netConnect' : cport.mockPort || cport.mock ? 'mock' : 'local'
+                        }
                         if (typeof port !== 'undefined') cport.stats = port.stats;
+                        if (port.portId === 0 && port.type === 'screenlogic') {
+                            cport.screenlogic.stats = sl.stats;
+                        }
                         opts.ports.push(cport);
                     }
+                    // if (section.startsWith('screenlogic')){
+                    //     let screenlogic = cfg[section];
+                    //     screenlogic.types =  [{ val: 'local', name: 'Local', desc: 'Local Screenlogic' }, { val: 'remote', name: 'Remote', desc: 'Remote Screenlogic' }];
+                    //     screenlogic.stats = sl.stats;
+                    //     opts.screenlogic = screenlogic;
+                    // }
                 }
                 opts.local = await conn.getLocalPortsAsync() || [];
                 return res.status(200).send(opts);
             } catch (err) { next(err); }
         });
+        // app.get('/config/options/screenlogic', async (req, res, next) => {
+        //     try {
+        //         let cfg = config.getSection('controller.screenlogic');
+        //         let data = {
+        //             cfg,
+        //             types: [{ val: 'local', name: 'Local', desc: 'Local Screenlogic' }, { val: 'remote', name: 'Remote', desc: 'Remote Screenlogic' }]
+        //         }
+        //         return res.status(200).send(data);
+        //     } catch (err) { next(err); }
+        // });
+        app.get('/config/options/screenlogic/search', async (req, res, next) => {
+            try {
+                let localUnits = await ScreenLogicComms.searchAsync();
+                return res.status(200).send(localUnits);
+            } catch (err) { next(err); }
+        });
         app.get('/config/options/circuits', async (req, res, next) => {
             try {
                 let opts = {
@@ -269,12 +300,34 @@ export class ConfigRoute {
                     warnings,
                     // waterFlow: sys.board.valueMaps.chemControllerWaterFlow.toArray(), // remove
                     controllers: sys.chemControllers.get(),
-                    maxChemControllers: sys.equipment.maxChemControllers
+                    maxChemControllers: sys.equipment.maxChemControllers,
+                    doserTypes: sys.board.valueMaps.chemDoserTypes.toArray()
                 };
                 return res.status(200).send(opts);
             }
             catch (err) { next(err); }
         });
+        app.get('/config/options/chemDosers', async (req, res, next) => {
+            try {
+                let remServers = await sys.ncp.getREMServers();
+                let opts = {
+                    bodies: sys.board.bodies.getBodyAssociations(),
+                    tempUnits: sys.board.valueMaps.tempUnits.toArray(),
+                    status: sys.board.valueMaps.chemDoserStatus.toArray(),
+                    pumpTypes: sys.board.valueMaps.chemPumpTypes.toArray(),
+                    volumeUnits: sys.board.valueMaps.volumeUnits.toArray(),
+                    flowSensorTypes: sys.board.valueMaps.flowSensorTypes.toArray(),
+                    remServers,
+                    dosingStatus: sys.board.valueMaps.chemDoserDosingStatus.toArray(),
+                    dosers: sys.chemDosers.get(),
+                    doserTypes: sys.board.valueMaps.chemDoserTypes.toArray(),
+                    maxChemDosers: sys.equipment.maxChemDosers
+                };
+                return res.status(200).send(opts);
+            }
+            catch (err) { next(err); }
+        });
+
         app.get('/config/options/rem', async (req, res, next) => {
             try {
                 let opts = {
@@ -294,6 +347,19 @@ export class ConfigRoute {
                 return res.status(200).send(opts);
             } catch (err) { next(err); }
         });
+        app.get('/config/options/anslq25ControllerType', async (req, res, next) => {
+            try {
+                let opts = {
+                    // controllerType: typeof sys.anslq25.controllerType === 'undefined' ? '' : sys.anslq25.controllerType,
+                    // model: typeof sys.anslq25.model === 'undefined' ? '' : sys.anslq25.model,
+                    // equipment: sys.equipment.get(),
+                    ...sys.anslq25.get(true),
+                    controllerTypes: sys.getAvailableControllerTypes(['easytouch', 'intellitouch', 'intellicenter']),
+                    rs485ports: await conn.listInstalledPorts()
+                }
+                return res.status(200).send(opts);
+            } catch (err) { next(err); }
+        });
         app.get('/config/options/chlorinators', async (req, res, next) => {
             try {
                 let opts = {
@@ -324,25 +390,6 @@ export class ConfigRoute {
             let opts = config.getSection();
             return res.status(200).send(opts);
         });
-        app.get('/app/options/interfaces', (req, res) => {
-            // todo: move bytevaluemaps out to a proper location; add additional definitions
-            let opts = {
-                interfaces: config.getSection('web.interfaces'),
-                types: [
-                    { name: 'rest', desc: 'Rest' },
-                    { name: 'http', desc: 'Http' },
-                    { name: 'rem', desc: 'Relay Equipment Manager' },
-                    { name: 'mqtt', desc: 'MQTT' },
-                    { name: 'influx', desc: 'InfluxDB' }
-                ],
-                protocols: [
-                    { val: 0, name: 'http://', desc: 'http://' },
-                    { val: 1, name: 'https://', desc: 'https://' },
-                    { val: 2, name: 'mqtt://', desc: 'mqtt://' }
-                ]
-            }
-            return res.status(200).send(opts);
-        });
         app.get('/config/options/tempSensors', (req, res) => {
             let opts = {
                 tempUnits: sys.board.valueMaps.tempUnits.toArray(),
@@ -400,6 +447,13 @@ export class ConfigRoute {
                 return res.status(200).send(controller.get(true));
             } catch (err) { next(err); }
         });
+        app.put('/config/anslq25ControllerType', async (req, res, next) => {
+            try {
+                // sys.anslq25ControllerType
+                await sys.anslq25Board.setAnslq25Async(req.body);
+                return res.status(200).send(sys.anslq25.get(true));
+            } catch (err) { next(err); }
+        });
         app.delete('/config/filter', async (req, res, next) => {
             try {
                 let sfilter = await sys.board.filters.deleteFilterAsync(req.body);
@@ -521,6 +575,18 @@ export class ConfigRoute {
             }
             catch (err) { next(err); }
         });
+        // RKS: 05-20-22 This is a remnant of the old web ui.  It is not called and the setType method needed to go away.
+        //app.delete('/config/pump/:pumpId', async (req, res, next) => {
+        //    try {
+        //        let pump = sys.pumps.getItemById(parseInt(req.params.pumpId, 10));
+        //        await sys.board.pumps.deletePumpAsync()
+        //        if (pump.type === 0) {
+        //            return res.status(500).send(`Pump ${pump.id} not active`);
+        //        }
+        //        pump.setType(0);
+        //        return res.status(200).send('OK');
+        //    } catch (err) { next(err); }
+        //});
         app.delete('/config/pump', async (req, res, next) => {
             try {
                 let pump = await sys.board.pumps.deletePumpAsync(req.body);
@@ -638,14 +704,6 @@ export class ConfigRoute {
                 next(err);
             }
         });
-        app.delete('/config/pump/:pumpId', (req, res) => {
-            let pump = sys.pumps.getItemById(parseInt(req.params.pumpId, 10));
-            if (pump.type === 0) {
-                return res.status(500).send(`Pump ${pump.id} not active`);
-            }
-            pump.setType(0);
-            return res.status(200).send('OK');
-        });
         app.put('/config/dateTime', async (req, res, next) => {
             try {
                 let time = await sys.updateControllerDateTimeAsync(req.body);
@@ -706,6 +764,28 @@ export class ConfigRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/config/chemDoser', async (req, res, next) => {
+            try {
+                let doser = await sys.board.chemDosers.setChemDoserAsync(req.body);
+                return res.status(200).send(doser.get());
+            }
+            catch (err) { next(err); }
+
+        });
+        app.put('/config/chemController/calibrateDose', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemControllers.calibrateDoseAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
+        app.put('/config/chemDoser/calibrateDose', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.calibrateDoseAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
         app.put('/config/chemController/feed', async (req, res, next) => {
             try {
                 let chem = await sys.board.chemControllers.setChemControllerAsync(req.body);
@@ -719,8 +799,16 @@ export class ConfigRoute {
                 return res.status(200).send(chem.get());
             }
             catch (err) { next(err); }
+        });
+        app.delete('/config/chemDoser', async (req, res, next) => {
+            try {
+                let doser = await sys.board.chemDosers.deleteChemDoserAsync(req.body);
+                return res.status(200).send(doser.get());
+            }
+            catch (err) { next(err); }
 
         });
+
         /*         app.get('/config/intellibrite', (req, res) => {
                     return res.status(200).send(sys.intellibrite.getExtended());
                 });
@@ -770,6 +858,13 @@ export class ConfigRoute {
             }
             catch (err) { next(err); }
         });
+        // app.put('/app/screenlogic', async (req, res, next) => {
+        //     try {
+        //         let screenlogic = await sl.setScreenlogicAsync(req.body);
+        //         return res.status(200).send(screenlogic);
+        //     }
+        //     catch (err) { next(err); }
+        // });
         app.delete('/app/rs485Port', async (req, res, next) => {
             try {
                 let port = await conn.deleteAuxPort(req.body);
@@ -909,5 +1004,17 @@ export class ConfigRoute {
                 return res.status(200).send(results);
             } catch (err) { next(err); }
         });
+        app.put('/app/anslq25', async(req, res, next) => {
+            try {
+                await sys.anslq25Board.setAnslq25Async(req.body);
+                return res.status(200).send(sys.anslq25.get(true));
+            } catch (err) { next(err); }
+        });
+        app.delete('/app/anslq25', async(req, res, next) => {
+            try {
+                await sys.anslq25Board.deleteAnslq25Async(req.body);
+                return res.status(200).send(sys.anslq25.get(true));
+            } catch (err) { next(err); }
+        });
     }
 }

package/web/services/config/ConfigSocket.ts

@@ -1,5 +1,6 @@
 /*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.  
+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

package/web/services/state/State.ts

@@ -1,5 +1,6 @@
 /*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017, 2018, 2019, 2020.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022.  
+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
@@ -22,14 +23,64 @@ import { sys } from "../../../controller/Equipment";
 import { utils } from '../../../controller/Constants';
 import { logger } from "../../../logger/Logger";
 import { DataLogger } from "../../../logger/DataLogger";
+import { conn } from "../../../controller/comms/Comms";
+import { config } from "../../../config/Config";
 
 import { ServiceParameterError } from "../../../controller/Errors";
 
 export class StateRoute {
     public static initRoutes(app: express.Application) {
+        app.get('/state/rs485Port/:id', async (req, res, next) => {
+            try {
+                let portId = parseInt(req.params.id, 10);
+                if (isNaN(portId)) throw new ServiceParameterError(`RS485 port id not supplied`, '/state/rs485Port/:id', 'portId', req.params.id);
+                let cfg = config.getSection(portId === 0 ? 'controller.comms' : `controller.comms${portId}`);
+                if (typeof cfg === 'undefined') throw new ServiceParameterError(`RS485 port id not found`, '/state/rs485Port/:id', 'portId', req.params.id);
+                let port = conn.findPortById(portId);
+                let sport: any = {
+                    portId: portId,
+                    enabled: cfg.enabled || false,
+                    netConnect: cfg.netConnect,
+                    reconnects: 0,
+                    inactivityRetry: cfg.inactivityRetry,
+                    isOpen: false,
+                    mock: cfg.mock || false
+                }
+                if (cfg.netConnect) sport.netConnect = { host: cfg.netHost, port: cfg.netPort }
+                else if (typeof cfg.type !== 'undefined' && cfg.type === 'screenlogic'){
+                    sport.screenlogic = cfg.screenlogic;
+                }
+                else sport.settings = extend(true, { name: cfg.rs485Port }, cfg.portSettings);
+                if (typeof port !== 'undefined' && port.type !== 'screenlogic') {
+                    let stats = port.stats;
+                    sport.reconnects = port.reconnects;
+                    sport.isOpen = port.isOpen;
+                    sport.received = {
+                        bytes: stats.bytesReceived,
+                        success: stats.recSuccess,
+                        failed: stats.recFailed,
+                        collisions: stats.recCollisions,
+                        rewinds: stats.recFRewinds,
+                        failureRate: stats.recFailureRate
+                    };
+                    sport.sent = {
+                        bytes: stats.bytesSent,
+                        success: stats.sndSuccess,
+                        aborted: stats.sndAborted,
+                        retries: stats.sndRetries,
+                        failureRate: stats.sndFailureRate
+                    }
+                }
+                res.status(200).send(sport);
+            }
+            catch (err) { next(err); }
+        });
         app.get('/state/chemController/:id', (req, res) => {
             res.status(200).send(state.chemControllers.getItemById(parseInt(req.params.id, 10)).getExtended());
         });
+        app.get('/state/chemDoser/:id', (req, res) => {
+            res.status(200).send(state.chemDosers.getItemById(parseInt(req.params.id, 10)).getExtended());
+        });
         app.put('/state/chemController', async (req, res, next) => {
             try {
                 let schem = await sys.board.chemControllers.setChemControllerStateAsync(req.body);
@@ -37,6 +88,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.setChemDoserStateAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
         app.put('/state/chemController/manualDose', async (req, res, next) => {
             try {
                 let schem = await sys.board.chemControllers.manualDoseAsync(req.body);
@@ -44,6 +102,14 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser/manualDose', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.manualDoseAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
+
         app.put('/state/chemController/manualMix', async (req, res, next) => {
             try {
                 logger.debug(`Starting manual mix`);
@@ -53,6 +119,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser/manualMix', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.manualMixAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
         app.get('/state/chemController/:id/doseHistory', (req, res) => {
             let schem = state.chemControllers.getItemById(parseInt(req.params.id));
             let hist = { ph: [], orp: [] };
@@ -62,6 +135,11 @@ export class StateRoute {
                 hist.orp.push(schem.orp.doseHistory[i]);
             return res.status(200).send(hist);
         });
+        app.get('/state/chemDoser/:id/doseHistory', (req, res) => {
+            let schem = state.chemDosers.getItemById(parseInt(req.params.id));
+            return res.status(200).send(schem.doseHistory);
+        });
+
         app.put('/state/chemController/:id/doseHistory/orp/clear', async (req, res, next) => {
             try {
                 let schem = state.chemControllers.getItemById(parseInt(req.params.id));
@@ -71,6 +149,16 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser/:id/doseHistory/clear', async (req, res, next) => {
+            try {
+                let schem = state.chemDosers.getItemById(parseInt(req.params.id));
+                schem.doseHistory = [];
+                schem.calcDoseHistory();
+                return res.status(200).send(schem.doseHistory);
+            }
+            catch (err) { next(err); }
+        });
+
         app.put('/state/chemController/:id/doseHistory/ph/clear', async (req, res, next) => {
             try {
                 let schem = state.chemControllers.getItemById(parseInt(req.params.id));
@@ -95,6 +183,21 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.get('/state/chemDoser/:id/doseLog', async (req, res, next) => {
+            try {
+                let schem = state.chemDosers.getItemById(parseInt(req.params.id));
+                let filter = req.body || {};
+                let dh = await DataLogger.readFromEndAsync(`chemDosage_Peristalic.log`, ChemicalDoseState, (lineNumber: number, entry: ChemicalDoseState, arr: ChemicalDoseState[]): boolean => {
+                    if (entry.id !== schem.id) return false;
+                    if (typeof filter.lines !== 'undefined' && filter.lines <= arr.length) return false;
+                    if (typeof filter.date !== 'undefined' && entry.end < filter.date) return false;
+                    return true;
+                });
+                return res.status(200).send(dh);
+            }
+            catch (err) { next(err); }
+        });
+
         app.search('/state/chemController/:id/doseLog/ph', async (req, res, next) => {
             try {
                 let schem = state.chemControllers.getItemById(parseInt(req.params.id));
@@ -144,6 +247,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser/cancelDosing', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.cancelDosingAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
         app.put('/state/chemController/cancelMixing', async (req, res, next) => {
             try {
                 let schem = await sys.board.chemControllers.cancelMixingAsync(req.body);
@@ -151,6 +261,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/chemDoser/cancelMixing', async (req, res, next) => {
+            try {
+                let schem = await sys.board.chemDosers.cancelMixingAsync(req.body);
+                return res.status(200).send(schem.getExtended());
+            }
+            catch (err) { next(err); }
+        });
 
         app.get('/state/chlorinator/:id', (req, res) => {
             res.status(200).send(state.chlorinators.getItemById(parseInt(req.params.id, 10), false).getExtended());
@@ -233,6 +350,13 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
+        app.put('/state/light/:id/colorSync', async (req, res, next) => {
+            try {
+                let slight = await sys.board.circuits.runLightCommandAsync({ id: parseInt(req.params.id, 10), command: 'colorsync' });
+                return res.status(200).send(slight.get(true));
+            }
+            catch (err) { next(err); }
+        });
         app.put('/state/light/:id/colorHold', async (req, res, next) => {
             try {
                 let slight = await sys.board.circuits.runLightCommandAsync({ id: parseInt(req.params.id, 10), command: 'colorhold' });
@@ -306,6 +430,7 @@ export class StateRoute {
             // RKS: 06-24-20 -- Changed this so that users can send in the body id, circuit id, or the name.
             // RKS: 05-14-21 -- Added cooling setpoints for the body.
             try {
+                
                 let body = sys.bodies.findByObject(req.body);
                 if (typeof body === 'undefined') return next(new ServiceParameterError(`Cannot set body setPoint.  You must supply a valid id, circuit, name, or type for the body`, 'body', 'id', req.body.id));
                 if (typeof req.body.coolSetpoint !== 'undefined' && !isNaN(parseInt(req.body.coolSetpoint, 10)))
@@ -426,8 +551,24 @@ export class StateRoute {
             }
             catch (err) { next(err); }
         });
-
-
+        app.put('/state/panelMode', async (req, res, next) => {
+            try {
+                await sys.board.system.setPanelModeAsync(req.body);
+                return res.status(200).send(state.controllerState);
+            } catch (err) { next(err); }
+        });
+        app.put('/state/toggleServiceMode', async (req, res, next) => {
+            try {
+                let data = extend({}, req.body);
+                if (state.mode === 0) {
+                    if (typeof data.timeout !== 'undefined' && !isNaN(data.timeout)) data.mode = 'timeout';
+                    else data.mode = 'service';
+                    await sys.board.system.setPanelModeAsync(req.body);
+                }
+                else sys.board.system.setPanelModeAsync({ mode: 'auto' });
+                return res.status(200).send(state.controllerState);
+            } catch (err) { next(err); }
+        });
         app.get('/state/emitAll', (req, res) => {
             res.status(200).send(state.emitAllEquipmentChanges());
         });