nodejs-poolcontroller 7.5.1 → 7.7.0

package/.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -0,0 +1,84 @@
+name: "\U0001F41B Bug report"
+description: Create a report to help us improve
+title: '[BUG] '
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue.  Most issues can be more readily resolved by attaching a 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.
+
+        If you require more general support please file an start a discussion on our discussion board https://github.com/tagyoureit/nodejs-poolController/discussions
+
+        Having trouble installing? Be sure to check out the wiki! https://github.com/tagyoureit/nodejs-poolController/wiki
+
+        Please fill in as much of the form below as you're able.
+  - type: input
+    attributes:
+      label: nodejs-poolController Version/commit
+      description: can be viewed under dashPanel.  Hamburger menu => System.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: nodejs-poolController-dashPanel Version/commit
+      description: if applicable
+  - type: input
+    attributes:
+      label: relayEquipmentManager Version/commit 
+      description: if applicable
+  - type: input
+    attributes:
+      label: Node Version
+      description: Output of `node -v`
+  - type: input
+    attributes:
+      label: Platform
+      description: |
+        UNIX: output of `uname -a`
+        Windows: output of `"$([Environment]::OSVersion | ForEach-Object VersionString) $(if ([Environment]::Is64BitOperatingSystem) { "x64" } else { "x86" })"` in PowerShell console
+  - type: input
+    attributes:
+      label: RS485 Adapter
+      description: Elfin? JBTek?
+  - type: checkboxes
+    attributes:
+      label: Are you using Docker?
+      options:
+        - label: Yes.
+  - type: input
+    attributes:
+      label: OCP
+      description: Outdoor Control Panel.  Eg EasyTouch2 8P, Intellicenter i5PS, none.
+      placeholder: None / Nixie (standalone setup)
+  - type: input
+    attributes:
+      label: Pump(s)
+      description: Please list all pumps.  EG Intelliflo 2 VST, Intelliflo VS
+      placeholder: Intelliflo VS
+  - type: input
+    attributes:
+      label: Chlorinator(s)
+      description: Please list all chlorinators.  EG Intellichlor IC-40, Aquarite, None
+      placeholder: None
+  - type: textarea
+    attributes:
+      label: What steps will reproduce the bug?
+      description: Enter details about your bug, preferably a simple code snippet that can be run using `node` directly without installing third-party dependencies.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What happens?
+      description: If possible please provide textual output instead of screenshots.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What should have happened?
+      description: If possible please provide textual output instead of screenshots.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: Tell us anything else you think we should know.

package/.github/ISSUE_TEMPLATE/2-docs.md

@@ -0,0 +1,12 @@
+---
+name: 📚 Documentation
+about: Report an issue related to documentation
+---
+
+## 📚 Documentation
+
+(A clear and concise description of how the docs could be better, with links if possible)
+
+### Have you read the [Contributing Guidelines on docs](https://github.com/serialport/node-serialport/blob/master/CONTRIBUTING.md#writing-documentation)?
+
+(Write your answer here.)

package/.github/ISSUE_TEMPLATE/3-proposal.md

@@ -0,0 +1,28 @@
+---
+name: 💥 Proposal / Feature
+about: Propose a non-trivial change or new feature for SerialPort
+---
+
+## 💥 Proposal
+
+### What feature you'd like to see
+
+(A clear and concise description of what the proposal is.)
+
+## Motivation
+
+(Please outline the motivation for the proposal. It's interesting knowing what people are working on and also could help community members make suggestions for work-arounds until the feature is built)
+
+## Pitch
+
+(Please explain why this feature should be implemented and how it would be used.)
+
+<!--
+  What happens if you skip this step?
+
+  Someone will read your feature proposal and maybe will be able to help you,
+  but it’s unlikely that it will get much attention from the team. Eventually,
+  the issue will likely get closed in favor of issues that have better explanations
+
+  Thanks for helping us help you!
+-->

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ⁉️ Need help with nodejs-poolController?
+    url: https://github.com/tagyoureit/nodejs-poolController/discussions
+    about: Please start a discussion before opening a bug.
+  - name: Gitter
+    url: https://gitter.im/nodejs-poolController/Lobby
+    about: Legacy Gitter discussion forums

package/Changelog

@@ -1,5 +1,24 @@
 # Changelog
 
+## 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
+3. Update dependencies
+## 7.6
+1. MasterTemp RS485 support for Nixie and IntelliCenter
+2. Nixie Valve Rotation delay
+3. Nixie Heater Cooldown delay
+4. Nixie Cleaner Start delay
+5. Nixie Cleaner Shutdown on Solar
+6. Nixie Delay Cancel
+
+## 7.5.1
+1. Backup/restore fixes
+2. Egg timer expiration
+3. Bug Fixes
+4. dashPanel/messageManager Filter
+5. RS485 refactor
+
 ## 7.5
 1. Backup/restore
 2. Intellitouch add expansion modules

package/Dockerfile

@@ -1,5 +1,5 @@
-FROM node:lts-alpine AS build
-RUN apk add --no-cache make gcc g++ python linux-headers udev tzdata
+FROM node:lts-alpine3.12 AS build
+RUN apk add --no-cache make gcc g++ python3 linux-headers udev tzdata
 WORKDIR /app
 COPY package*.json ./
 RUN npm ci
@@ -7,7 +7,7 @@ COPY . .
 RUN npm run build
 RUN npm ci --production
 
-FROM node:lts-alpine as prod
+FROM node:lts-alpine3.12 as prod
 RUN apk add git
 RUN mkdir /app && chown node:node /app
 WORKDIR /app

package/README.md

@@ -1,4 +1,4 @@
-# nodejs-poolController - Version 7.5
+# nodejs-poolController - Version 7.6
 
 ## What is nodejs-poolController
 
@@ -48,12 +48,10 @@ If you don't know anything about NodeJS, these directions might be helpful.
 1. Install Nodejs (v12 recommended). (https://nodejs.org/en/download/)
 1. Update NPM (https://docs.npmjs.com/getting-started/installing-node).
 1. It is recommended to clone the source code as updates are frequently pushed while releases are infrequent
-   
-   Download the latest [code release](https://github.com/tagyoureit/nodejs-poolController/releases)
-   OR
-   clone with `git clone git@github.com:tagyoureit/nodejs-poolController.git`
-1. Unzip into nodejs-poolController.
-1. Run 'npm install' in the new folder (where package.json exists).  This will automatically install all the dependencies (serial-port, express, sockets.io, etc).
+   clone with `git clone https://github.com/tagyoureit/nodejs-poolController.git`
+   (Alternate - not recommended - Download the latest [code release](https://github.com/tagyoureit/nodejs-poolController/releases)
+1. Change directory into nodejs-poolController.
+1. Run `npm install` in the new folder (where package.json exists).  This will automatically install all the dependencies (serial-port, express, sockets.io, etc).
 1. Run the app with `npm start`.
    * `npm start` will compile the Typescript code.  You should use this every time you download/clone/pull the latest code.
    * `npm run start:cached` will run the app without compiling the code which can be much faster.
@@ -63,6 +61,13 @@ If you don't know anything about NodeJS, these directions might be helpful.
 
 For a very thorough walk-through, see [this](https://www.troublefreepool.com/threads/pentair-intellicenter-pool-control-dashboard-instructional-guide.218514/) great thread on Trouble Free Pool.  Thanks @MyAZPool.
 
+#### Upgrade Instructions
+Assuming you cloned the repo, the following are easy steps to get the latest version:
+1. Change directory to the njsPC app
+2. `git pull`
+3. `npm i` (not always necessary, but if dependencies are upgraded this will bring them up to date)
+4. Start application as normal, or if using `npm run start:cached` then run `npm run build` to compile the code.
+
 ### Docker instructions
 
 See the [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/Docker). Thanks @wurmr @andylippitt @emes.
@@ -108,7 +113,7 @@ Need to be updated:
 * [ISY Polyglot NodeServer](https://github.com/brianmtreese/nodejs-pool-controller-polyglotv2) created by @brianmtreese
 
 # Support
-1. For discussions, recommendations, designs, and clarifications, we recommend you join our [Gitter Chat room](https://gitter.im/pentair_pool/Lobby).
+1. For discussions, recommendations, designs, and clarifications, we recommend you join the [Github discussions](https://github.com/tagyoureit/nodejs-poolController/discussions or [Gitter Chat room](https://gitter.im/pentair_pool/Lobby).
 1. Check the [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki) for tips, tricks and additional documentation.
 1. For bug reports you can open a [github issue](https://github.com/tagyoureit/nodejs-poolController/issues/new),
 

package/app.ts

@@ -30,7 +30,7 @@ export async function initAsync() {
     try {
         await config.init();
         await logger.init();
-        await conn.init();
+        await conn.initAsync();
         await sys.init();
         await state.init();
         await webApp.init();

package/config/Config.ts

@@ -17,10 +17,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 import * as path from "path";
 import * as fs from "fs";
 import { EventEmitter } from 'events';
-
-//import { conn } from "../controller/comms/Comms";
 const extend = require("extend");
 import { logger } from "../logger/Logger";
+import { utils } from "../controller/Constants";
 class Config {
     private cfgPath: string;
     private _cfg: any;
@@ -59,6 +58,7 @@ class Config {
                 else throw err;
             });
             this._isLoading = false;
+            this.getEnvVariables();
         } catch (err) {
             console.log(`Error reading configuration information.  Aborting startup: ${ err }`);
             // Rethrow this error so we exit the app with the appropriate pause in the console.
@@ -86,6 +86,20 @@ class Config {
 
         }
     }
+    public removeSection(section: string) {
+        let c = this._cfg;
+        if (section.indexOf('.') !== -1) {
+            let arr = section.split('.');
+            for (let i = 0; i < arr.length - 1; i++) {
+                if (typeof c[arr[i]] === 'undefined')
+                    c[arr[i]] = {};
+                c = c[arr[i]];
+            }
+            section = arr[arr.length - 1];
+        }
+        if(typeof c[section] !== 'undefined') delete c[section];
+        this.update();
+    }
     public setSection(section: string, val) {
         let c = this._cfg;
         if (section.indexOf('.') !== -1) {
@@ -151,5 +165,27 @@ class Config {
             }
         }
     }
+    private getEnvVariables(){
+        // set docker env variables to config.json, if they are set
+        let env = process.env;
+        let bUpdate = false;
+        if (typeof env.POOL_RS485_PORT !== 'undefined' && env.POOL_RS485_PORT !== this._cfg.controller.comms.rs485Port) {
+            this._cfg.controller.comms.rs485Port = env.POOL_RS485_PORT;
+            bUpdate = true;
+        }
+        if (typeof env.POOL_NET_CONNECT !== 'undefined' && env.POOL_NET_CONNECT !== this._cfg.controller.comms.netConnect) {
+            this._cfg.controller.comms.netConnect = utils.makeBool(env.POOL_NET_CONNECT);
+            bUpdate = true;
+        }
+        if (typeof env.POOL_NET_HOST !== 'undefined' && env.POOL_NET_HOST !== this._cfg.controller.comms.netHost) {
+            this._cfg.controller.comms.netHost = env.POOL_NET_HOST;
+            bUpdate = true;
+        }
+        if (typeof env.POOL_NET_PORT !== 'undefined' && env.POOL_NET_PORT !== this._cfg.controller.comms.netPort) {
+            this._cfg.controller.comms.netPort = env.POOL_NET_PORT;
+            bUpdate = true;
+        }
+        if (bUpdate) this.update();
+    }
 }
 export const config: Config = new Config();

package/config/VersionCheck.ts

@@ -39,27 +39,42 @@ class VersionCheck {
         if (typeof state.appVersion.nextCheckTime === 'undefined' || new Date() > new Date(state.appVersion.nextCheckTime)) setTimeout(() => { this.checkAll(); }, 100);
     }
     public checkGitLocal() {
+        let env = process.env;
         // check local git version
         try {
-            let res = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' });
-            let out = res.toString().trim();
+            let out: string;
+            if (typeof env.SOURCE_BRANCH !== 'undefined') 
+            {
+                out = env.SOURCE_BRANCH // check for docker variable
+            }
+            else {
+                let res = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' });
+                out = res.toString().trim();
+            }
             logger.info(`The current git branch output is ${out}`);
             switch (out) {
-                case 'fatal':
-                case 'command':
-                    state.appVersion.gitLocalBranch = '--';
-                    break;
-                default:
-                    state.appVersion.gitLocalBranch = out;
-            }
+            case 'fatal':
+            case 'command':
+                state.appVersion.gitLocalBranch = '--';
+                break;
+            default:
+                state.appVersion.gitLocalBranch = out;
+        }
         }
         catch (err) {
             state.appVersion.gitLocalBranch = '--';
             logger.warn(`Unable to retrieve local git branch.  ${err}`);
         }
         try {
-            let res = execSync('git rev-parse HEAD', { stdio: 'pipe' });
-            let out = res.toString().trim();
+            let out: string;
+            if (typeof env.SOURCE_COMMIT !== 'undefined') 
+            {
+                out = env.SOURCE_COMMIT; // check for docker variable
+            }
+            else {
+                let res = execSync('git rev-parse HEAD', { stdio: 'pipe' });
+                out = res.toString().trim();
+            }
             logger.info(`The current git commit output is ${out}`);
             switch (out) {
                 case 'fatal':
@@ -87,7 +102,7 @@ class VersionCheck {
             });
         }
         catch (err) {
-            logger.error(err);
+            logger.error(`Error checking latest release: ${err.message}`);
         }
     }
 

package/controller/Constants.ts

@@ -301,7 +301,8 @@ export enum ControllerType {
     EasyTouch = 'easytouch',
     Unknown = 'unknown',
     Virtual = 'virtual',
-    Nixie = 'nixie'
+    Nixie = 'nixie',
+    AquaLink = 'aqualink'
 }
 // export enum VirtualDeviceType {
 //     Pump = 'pump',