nodejs-poolcontroller 7.7.0 → 8.0.1

package/.eslintrc.json

@@ -1,45 +1,36 @@
 {
-    /* See all the pre-defined configs here: https://www.npmjs.com/package/eslint-config-defaults */
+    "env": {
+        "es2021": true,
+        "node": true
+    },
     "extends": [
-        "eslint:recommended"
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
     ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 6,
-        "ecmaFeatures": {
-            "jsx": true
-        },
+        "ecmaVersion": "latest",
         "sourceType": "module"
     },
-    "env": {
-        "amd": true,
-        "browser": true,
-        "jquery": true,
-        "node": true,
-        "es6": true,
-        "worker": true
-    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
     "rules": {
-        "eqeqeq": 2,
-        "comma-dangle": 1,
-        "no-console": 0,
-        "no-debugger": 1,
-        "no-extra-semi": 1,
-        "no-extra-parens": 0,
-        "no-irregular-whitespace": 0,
-        "no-undef": 0,
-        "no-unused-vars": 0,
-        "no-case-declaration": 0,
-        "no-prototype-builtins": 0,
-        "semi": 1,
-        "semi-spacing": 1,
-        "valid-jsdoc": [
-            2,
-            {
-                "requireReturn": false
-            }
+        "indent": [
+            "error",
+            "tab"
+        ],
+        "linebreak-style": [
+            "error",
+            "windows"
+        ],
+        "quotes": [
+            "error",
+            "single"
         ],
-        "space-infix-ops": 2,
-        "keyword-spacing": ["error",{"before": true, "after": true}]
+        "semi": [
+            "error",
+            "always"
+        ]
     }
-}
+}

package/Changelog

@@ -1,5 +1,27 @@
 # Changelog
 
+## 8.0.0
+1. Refactor comms code to Async
+2. Update dependencies and Node >16
+3. EasyTouch v1 support
+4. Screenlogic support
+5. Anslq25 (Mock controller)
+
+## 7.7.0
+1. Aqualink-D MQTT Interface
+2. Manual Priority for Schedules
+3. Add multiple RS-485 ports
+4. Support for Hayward Pumps
+5. Display remote chlorinators
+6. Updates for ETi hybrid
+7. Stop temp deltas for Nixie
+8. Batch write influx points
+9. MQTT & Influx updates
+10. Ability to hide bodies in dashPanel
+11. Florida Sunseeker Pooltone lighting
+12. Proper uPNP formatting
+
+
 ## 7.6.1
 1. Many bugfixes: Intellichem, Touch body capacities, Ultratemp heaters, Nixie, more...
 2. Add env variables for Docker setup: POOL_RS485_PORT, POOL_NET_CONNECT, POOL_NET_HOST, POOL_NET_PORT, SOURCE_COMMIT, SOURCE_BRANCH

package/README.md

@@ -1,4 +1,4 @@
-# nodejs-poolController - Version 7.6
+# nodejs-poolController - Version 8.0
 
 ## What is nodejs-poolController
 
@@ -11,8 +11,8 @@ nodejs-poolController is an application to communicate and control your Pentair
  * Want to control your pumps or chlorinator without a pool controller?
 
 Equipment supported
-1. Controllers:  IntelliCenter, Intellitouch, EasyTouch, No controller (standalone equimpent) 
-1. Pumps: Intelliflow VS/VSF/VF, older models
+1. Controllers:  IntelliCenter, Intellitouch, EasyTouch, Nixie (standalone equimpent), Aqualink
+1. Pumps: Intelliflow VS/VSF/VF, older models, relay controlled pumps, Whisperflo
 1. Chlorinators: Intellichlor, Aqua-Rite and OEM brands
 1. Heaters: Gas, solar, heatpump
 1. Intellichem and Relay Equipment Manager (REM) chemical controllers
@@ -23,6 +23,10 @@ Equipment supported
 ## Latest Changes
 See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
 
+## What's new in 8.0?
+
+Screenlogic can now be used as a direct connection point.  If you feel that integrating an RS-485 adapter is a bit too much, then this is an option for you.  The preferred method is still RS-485 as it is more fully featured.
+
 ## What's new in 7.0?
 
 The current version includes very tight intergation with [relayEquipmentManager](https://github.com/rstrouse/relayEquipmentManager) which allows for hardware control over your ancillary pool equipment (chemical probes, pumps, tanks, heaters, pumps, etc).  

package/anslq25/MessagesMock.ts

@@ -0,0 +1,218 @@
+import { Inbound, Message, Outbound, Protocol } from "../controller/comms/messages/Messages";
+import { ControllerType } from "../controller/Constants";
+import { sys } from "../controller/Equipment";
+import { logger } from "../logger/Logger";
+import { MockSystemBoard } from "./boards/MockSystemBoard";
+import { mockChlor } from "./chemistry/MockChlorinator";
+import { mockPump, MockPump } from "./pumps/MockPump";
+
+
+export class MessagesMock {
+    constructor() { }
+
+    public static process(msg: Inbound) {
+        switch (msg. protocol) {
+            case Protocol.Broadcast: {
+                switch (sys.controllerType) {
+                    case ControllerType.IntelliCenter:
+                        switch (msg.action) {
+                            /* case xyz:
+                                */
+                            default:
+                                logger.info(`An unprocessed message was received ${msg.toPacket()}`)
+                                break;
+
+                        }
+                    default:
+                        {
+
+                            switch (msg.action) {
+                                /*  SET COMMANDS  */
+                                case 133: // set date/time
+                                case 134: // set circuit
+                                case 136: // set heat/temperature
+                                case 138: // set custom names
+                                case 139: // set circuit names/functions
+                                case 144: // set heat pump status
+                                case 145: // set schedule
+                                case 146: // set intellichem
+                                case 147: // set intellichem
+                                case 150: // set intellflo spa side controllers
+                                case 152: // set pump config
+                                case 155: // set pump config extended
+                                case 153: // set intellichlor
+                                case 157: // set valve
+                                case 158: // set high speed circuits
+                                case 160: // set is4/is10 high speed circuits
+                                case 161: // set quicktouch remote
+                                case 162: // set solar/heat pump config
+                                case 131: // set delay
+                                case 163: // set delay
+                                case 167: // set light group
+                                case 168: // set settings
+                                    sys.anslq25Board.system.sendAck(msg);
+                                    break;
+                                /*  GET COMMANDS  */
+                                case 194: // get controller status
+                                    break;
+                                case 197: // get date time
+                                    sys.anslq25Board.system.processDateTimeAsync(msg);
+                                    break;
+                                case 198: // get circuit state
+                                    break;
+                                case 200: // get heat/status
+                                    sys.anslq25Board.heaters.processHeatModesAsync(msg);
+                                    break;
+                                case 202: // get custom names
+                                    sys.anslq25Board.system.processCustomNameAsync(msg);
+                                    break;
+                                case 203: //get circuit functions
+                                    sys.anslq25Board.circuits.processCircuitAsync(msg);
+                                    break;
+                                case 208: // get heat pump status
+                                    break;
+                                case 209: // get schedule
+                                    sys.anslq25Board.schedules.processScheduleAsync(msg);
+                                    break;
+
+                                case 210: // get intellichem
+                                case 211: // get intellichem
+                                    logger.error(`mock packet ${msg.action} not programmed yet.`)
+                                    break;
+                                case 214: // get intelliflo spa side
+                                    sys.anslq25Board.remotes.processSpaCommandRemoteAsync(msg);
+                                    break;
+                                case 215: // get pump status
+                                    break;
+                                case 216: // get pump config
+                                    sys.anslq25Board.pumps.processPumpConfigAsync(msg);
+                                    break
+                                case 217: // get intellichlor
+                                case 219: // get pump config
+                                    logger.error(`mock packet ${msg.action} not programmed yet.`)
+                                    break;
+                                case 221: // get valve
+                                    sys.anslq25Board.valves.processValveAssignmentsAsync(msg);
+                                    break;
+                                case 222: // get high speed circuits
+                                    sys.anslq25Board.pumps.processHighSpeedCircuitsAsync(msg);
+                                    break;
+                                case 224: // get is4/is10
+                                    sys.anslq25Board.remotes.processIS4IS10RemoteAsync(msg);
+                                    break;
+                                case 225: //get quicktouch
+                                    sys.anslq25Board.remotes.processQuickTouchRemoteAsync(msg);
+                                    break;
+                                case 226: // get solar/heat pump
+                                    sys.anslq25Board.heaters.processHeaterConfigAsync(msg);
+                                    break;
+                                case 227: // get delays
+                                    sys.anslq25Board.valves.processValveOptionsAsync(msg);
+                                    break;
+                                case 231: // get light groups
+                                    sys.anslq25Board.circuits.processLightGroupAsync(msg);
+                                    break;
+                                case 239: // get unknown
+                                    break;
+                                case 232: // get settings
+                                    sys.anslq25Board.system.processSettingsAsync(msg);
+                                    break;
+                                case 253: // get sw version
+                                    logger.info(`Mock EasyTouch OCP - Packet ${msg.toShortPacket()} request not programmed yet.`)
+                                    break;
+                                case 1: // Ack
+                                case 2:  // Shared IntelliCenter/IntelliTouch
+                                case 5:
+                                case 8:
+                                case 96: // EquipmentStateMessage.process(this);
+                                case 10: // CustomNameMessage.process(this);
+                                case 11: // CircuitMessage.processTouch(this);
+                                case 25: // ChlorinatorMessage.processTouch(this);
+                                case 153: // ExternalMessage.processTouchChlorinator(this);
+                                case 17:
+                                case 145: // ScheduleMessage.process(this);
+                                case 18:  // IntellichemMessage.process(this);
+                                    break;
+                                case 24:
+                                case 27:
+
+                                    break;
+                                case 152:
+                                case 155: // PumpMessage.process(this);
+                                case 30:
+                                // switch (sys.controllerType) {
+                                //     case ControllerType.Unknown:
+                                //         break;
+                                //     case ControllerType.SunTouch:
+                                //         ScheduleMessage.processSunTouch(this);
+                                //         break;
+                                //     default:
+                                //         OptionsMessage.process(this);
+                                //         break;
+                                // }
+                                case 22:
+                                case 32:
+                                case 33: // RemoteMessage.process(this);
+                                case 29:
+                                case 35: // ValveMessage.process(this);
+                                case 39:
+                                case 167: // CircuitMessage.processTouch(this);
+                                case 40:
+                                case 168: // OptionsMessage.process(this);
+                                case 41:  // CircuitGroupMessage.process(this);
+                                case 197: // EquipmentStateMessage.process(this);    // Date/Time request
+                                case 252: // EquipmentMessage.process(this);
+                                case 9:
+                                case 16:
+                                case 34:
+                                case 137:
+                                case 144:
+                                case 162: // HeaterMessage.process(this);
+                                case 114:
+                                case 115: // HeaterStateMessage.process(this);
+                                case 147: // IntellichemMessage.process(this);
+                                    logger.info(`Mock EasyTouch OCP - Packet ${msg.toShortPacket()} should be coming to the OCP, not from it.`);
+                                    break;
+                                default:
+                                    logger.info(`No mock EasyTouch response for ${msg.toShortPacket()} `);
+                            }
+                        }
+                }
+                break;
+            }
+            /*
+            case Protocol.IntelliValve:
+            IntelliValveStateMessage.process(outboundMsg);
+            break;
+            case Protocol.IntelliChem:
+            IntelliChemStateMessage.process(outboundMsg);
+            break; */
+            // case Protocol.Pump:
+            // if ((msg.source >= 96 && msg.source <= 111) || (msg.dest >= 96 && msg.dest <= 111))
+            // mockPump.process(msg);
+            // else
+            // MockSystemBoard.convertOutbound(msg);
+            /* case Protocol.Heater:
+            HeaterStateMessage.process(outboundMsg);
+            break;*/
+            case Protocol.Chlorinator:
+                mockChlor.process(msg);
+            /*
+            case Protocol.Hayward:
+                PumpStateMessage.processHayward(msg);
+                break; */
+            default:
+                logger.debug(`Unprocessed Message ${msg.toPacket()}`)
+                // return new Outbound(Protocol.Broadcast, 0, 0, 0, []);
+        }
+    }
+
+    // public static processOutbound(outboundMsg: Outbound) {
+    //     // outbound mock messages will be sent here instead of to the comms port
+    //     let inbound = Message.convertOutboundToInbound(outboundMsg);
+    //     let newOut = MessagesMock.processInbound(inbound);
+    //     return newOut;
+
+    // }
+}
+export var messagesMock = new MessagesMock();

package/anslq25/boards/MockBoardFactory.ts

@@ -0,0 +1,50 @@
+/*  nodejs-poolController.  An application to control pool equipment.
+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
+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 { MockIntelliCenterBoard } from './MockIntelliCenterBoard';
+// import { MockIntelliTouchBoard } from './MockIntelliTouchBoard';
+// import { MockIntelliComBoard } from './MockIntelliComBoard';
+import { MockEasyTouch } from './MockEasyTouchBoard';
+import { MockSystemBoard } from './MockSystemBoard';
+import { ControllerType } from '../../controller/Constants';
+import { PoolSystem } from 'controller/Equipment';
+// import { MockAquaLinkBoard } from './MockAquaLinkBoard';
+// import { MockSunTouchBoard } from "./MockSunTouchBoard";
+
+
+export class MockBoardFactory {
+    // Factory create the system board from the controller type.  Resist storing
+    // the pool system as this can cause a leak.  The PoolSystem object already has a reference to this.
+    public static fromControllerType(ct: ControllerType, system: PoolSystem) {
+        switch (ct) {
+            // case ControllerType.IntelliCenter:
+            //     return new MockIntelliCenterBoard(system);
+            // case ControllerType.IntelliTouch:
+            //     return new MockIntelliTouchBoard(system);
+            // case ControllerType.IntelliCom:
+            //     return new MockIntelliComBoard(system);
+            case ControllerType.EasyTouch:
+                return new MockEasyTouch(system);
+            // case ControllerType.AquaLink:
+            //     return new MockAquaLinkBoard(system);
+            // case ControllerType.SunTouch:
+            //     return new MockSunTouchBoard(system);
+        }
+        return new MockSystemBoard(system);
+    }
+
+}