nodejs-poolcontroller 7.3.1 → 7.6.1

package/README.md

@@ -1,186 +1,191 @@
-# nodejs-poolController - Version 7.3.0
-
-## What is nodejs-poolController
-
-nodejs-poolController is an application to communicate and control your Pentair compatible pool equipment.
-
- * Want to include a low cost controller for your pool?
- * Want a web interface for your system?
- * Want to turn your pumps on remotely?
- * Want to have your home automation system talk to your pool?
- * 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. Chlorinators: Intellichlor, Aqua-Rite and OEM brands
-1. Heaters: Gas, solar, heatpump
-1. Intellichem and homegrown chemical controllers
-1. Intellivalve (coming soon)
-1. Home Automation:  SmartThings, Hubitat, ISY, Vera, Siri, Echo
-1. Chemical probes (pH, ORP, flow sensors, EC, etc.)
-
-## Latest Changes
-See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
-
-## 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).  
-
-Starting with this version, all code will immediately be pushed to `master` branch.  The version of a `next` branch for feature development will disappear.
- 
-
- <a name="module_nodejs-poolController--install"></a>
-
-Dashpanel Client Screenshot
-
-<img src="https://tagyoureit.github.io/nodejs-poolController/images/v6/clients/dashPanel.png?raw=true" height="300">
-
-## Installation Instructions
-
-This code requires a physical [RS485](https://github.com/tagyoureit/nodejs-poolController/wiki/RS-485-Adapter-Details) adapter to work.
-
-This is only the server code.  See [clients](#module_nodejs-poolController--clients) below for web or other ways to read/control the pool equipment. 
-
-### Prerequisites
-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).
-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.
-1. Running `npm start` will also create a `config.json` file for your installation.  If you need to modify any properties (e.g. the path to your serialport adapter, enabling socat, etc) then stop the app, edit the `config.json` per the [instructions](module_nodejs-poolController--config.json) below, and start the app again.
-1. Verify your pool equipment is correctly identified by inspecting the `/data/*.json` files.  
-1. Install a [webclient](module_nodejs-poolController--clients) for a browser experience and/or a [binding](module_nodejs-poolController--bindings) to have two way control with Home Automation systems.
-
-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.
-
-### Docker instructions
-
-See the [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/Docker). Thanks @wurmr @andylippitt @emes.
-
-### Automate startup of app
-See the [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/Automatically-start-at-boot---PM2-&-Systemd).
-
-# Clients & Bindings
-To do anything with this app, you need a client to connect to it.  A client can be a web application or Home Automation system.
-
-<a name="module_nodejs-poolController--clients"></a>
-
-## REM (Relay Equipment Manager)
-[Relay Equipment Manager](https://github.com/rstrouse/relayEquipmentManager) is a companion app developed by @rstrouse that integrates standalone hardware control.  Controls GPIO, i2c, and SPI devices including:
-* Atlas Scientific pH, orp, ec, hum, prs, pmp, rtd
-* ADS1x15 a/d converters
-* Pressure Tranducers
-* Flow sensors
-* Temperature sensors (10k, NTC)
-
-## Web Clients
-1. [nodejs-poolController-dashPanel](https://github.com/rstrouse/nodejs-poolController-dashPanel).  Full compatibility with IntelliCenter, *Touch, REM (RelayEquipmentManager).
-1. Deprecated - ~~[nodejs-poolController-webClient](http://github.com/tagyoureit/nodejs-poolController-webClient).  Built primarily around EasyTouch/IntelliTouch but will work with other systems.~~
-
-* This app has the default to only listen to clients from localhost (127.0.0.1).  If you need to have clients connect from other machines you will need to change the [ip](#module_nodejs-poolController--config.json) in `config.json`.
-
-<a name="module_nodejs-poolController--bindings"></a>
-
-## Home Automation Bindings (previously Integrations)
-**NOTE: Existing integrations built of 5.3 or earlier WILL NOT WORK.  They need to be upgraded to leverage 6.0.  **
-
-Available for 6.x:
-* [Vera Home Automation Hub](https://github.com/rstrouse/nodejs-poolController-veraPlugin) - A plugin that integrates with nodejs-poolController.  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#vera)
-* [Hubitat](https://github.com/bsileo/hubitat_poolcontroller) by @bsileo (prev help from @johnny2678, @donkarnag, @arrmo).  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#smartthingshubitat)
-* [Homebridge/Siri/EVE](https://github.com/gadget-monk/homebridge-poolcontroller) by @gadget-monk, adopted from @leftyflip
-* InfluxDB - [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#influx)
-* [MQTT](https://github.com/crsherman/nodejs-poolController-mqtt) original release by @crsherman, re-write by @kkzonie, testing by @baudfather and others.  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#mqtt)
-   * [Homeseer](https://github.com/tagyoureit/nodejs-poolController/wiki/Homeseer-Setup-Instructions) - Integration directions by @miamijerry to integrate Homeseer through MQTT
-
-Need to be updated:
-* [Another SmartThings Controller](https://github.com/dhop90/pentair-pool-controller/blob/master/README.md) by @dhop90
-* [ISY](src/integrations/socketISY.js).  Original credit to @blueman2, enhancements by @mayermd
-* [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. 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),
-
-### Virtual Controller
-v6 adds all new configuration and support for virtual pumps, chlorinators (and soon, Intellichem)
-
-* [Virtual Pump Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Virtual-Pump-Controller---v6)
-* [Virtual Chlorinator Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Virtual-Chlorinator-Controller-v6)
-* Virtual Chem Controller
-
-# Changes
-See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
-
-
-<a name="module_nodejs-poolController--config.json"></a>
-# Config.json changes
-
-## Controller section - changes to the communications for the app
-* `rs485Port` - set to the name of you rs485 controller.  See [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/RS-485-Adapter-Details) for details and testing.
-* `portSettings` - should not need to be changed for RS485
-* `mockPort` - opens a "fake" port for this app to communicate on.  Can be used with [packet captures/replays](https://github.com/tagyoureit/nodejs-poolController/wiki/How-to-capture-all-packets-for-issue-resolution).
-* `netConnect` - used to connect via [Socat](https://github.com/tagyoureit/nodejs-poolController/wiki/Socat)
-  * `netHost` and `netPort` - host and port for Socat connection.
-* `inactivityRetry` - # of seconds the app should wait before trying to reopen the port after no communications.  If your equipment isn't on all the time or you are running a virtual controller you may want to dramatically increase the timeout so you don't get console warnings.
-
-## Web section - controls various aspects of external communications
-* `servers` - setting for different servers/services
- * `http2` - not used currently
- * `http` - primary server used for api connections without secure communications
-    * `enabled` - self-explanatory
-    * `ip` - The ip of the network address to listen on.  Default of `127.0.0.1` will only listen on the local loopback (localhost) adapter.  `0.0.0.0` will listen on all network interfaces.  Any other address will listen exclusively on that interface.
-    * `port` - Port to listen on.  Default is `4200`.
-    * `httpsRedirect` - Redirect http traffic to https
-    * `authentication` - Enable basic username/password authentication.  (Not implemented yet.)
-    * `authFile` - Location of the encrypted password file.  By default, `/users.htpasswd`. If you have `authentication=1` then create the file users.htpasswd in the root of the application.  Use a tool such as http://www.htaccesstools.com/htpasswd-generator/ and paste your user(s) into this file.  You will now be prompted for authentication.
- * `https` - See http options above.
-    * `sslKeyFile` - Location of key file
-    * `sslCertFile` - Location of certificate file
- * `mdns` - Not currently used.
- * `ssdp` - Enable for automatic configuration by the webClient and other platforms.
-
-
-## Log - Different aspects of logging to the application
- * `app` - Application wide settings
-    * `enabled` - Enable/disable logging for the entire application
-    * `level` - Different levels of logging from least to most: 'error', 'warn', 'info', 'verbose', 'debug', 'silly'
-* `packet` - Configuration for the 
-
-
-# Credit
-
-1.  @Rstrouse for helping make the 6.0 rewrite and Intellicenter possible, continuing to make monumental changes, and driving this project forward in numerous ways.  My knowledge of coding in general has benefitted greatly from working with him.
-1.  [Jason Young](http://www.sdyoung.com/home/decoding-the-pentair-easytouch-rs-485-protocol) (Read both posts, they are a great baseline for knowledge)
-1.  Michael Russe [ceesco](https://github.com/ceesco53/pentair_examples) [CocoonTech](http://cocoontech.com/forums/topic/13548-intelliflow-pump-rs485-protocol/?p=159671) - Registration required for CocoonTech.  Jason Young used this material for his understanding in the protocol as well.  There is a very detailed .txt file with great information ~~that I won't post unless I get permission~~. Looks like it was publicly posted to [Pastebin](http://pastebin.com/uiAmvNjG).
-1.  [Michael Usner](https://github.com/michaelusner/Home-Device-Controller) for taking the work of both of the above and turning it into Javascript code.
-1.  [rflemming](https://github.com/rflemming) for being the first to contribute some changes to the code.
-1.  Awesome help from @arrmo and @blueman2 on Gitter
-
-# License
-
-nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017.  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/>
+# nodejs-poolController - Version 7.6
+
+## What is nodejs-poolController
+
+nodejs-poolController is an application to communicate and control your Pentair compatible pool equipment.
+
+ * Want to include a low cost controller for your pool?
+ * Want a web interface for your system?
+ * Want to turn your pumps on remotely?
+ * Want to have your home automation system talk to your pool?
+ * 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. Chlorinators: Intellichlor, Aqua-Rite and OEM brands
+1. Heaters: Gas, solar, heatpump
+1. Intellichem and Relay Equipment Manager (REM) chemical controllers
+1. Intellivalve (coming soon)
+1. Home Automation:  SmartThings, Hubitat, ISY, Vera, Siri, Echo
+1. Chemical probes (pH, ORP, flow sensors, EC, etc.)
+
+## Latest Changes
+See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
+
+## 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).  
+
+Starting with this version, all code will immediately be pushed to `master` branch.  The version of a `next` branch for feature development will disappear.
+ 
+
+ <a name="module_nodejs-poolController--install"></a>
+
+Dashpanel Client Screenshot
+
+<img src="https://tagyoureit.github.io/nodejs-poolController/images/v6/clients/dashPanel.png?raw=true" height="300">
+
+## Installation Instructions
+
+This code requires a physical [RS485](https://github.com/tagyoureit/nodejs-poolController/wiki/RS-485-Adapter-Details) adapter to work.
+
+This is only the server code.  See [clients](#module_nodejs-poolController--clients) below for web or other ways to read/control the pool equipment. 
+
+### Prerequisites
+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
+   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.
+1. Running `npm start` will also create a `config.json` file for your installation.  If you need to modify any properties (e.g. the path to your serialport adapter, enabling socat, etc) then stop the app, edit the `config.json` per the [instructions](module_nodejs-poolController--config.json) below, and start the app again.
+1. Verify your pool equipment is correctly identified by inspecting the `/data/*.json` files.  
+1. Install a [webclient](module_nodejs-poolController--clients) for a browser experience and/or a [binding](module_nodejs-poolController--bindings) to have two way control with Home Automation systems.
+
+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.
+
+### Automate startup of app
+See the [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/Automatically-start-at-boot---PM2-&-Systemd).
+
+# Clients & Bindings
+To do anything with this app, you need a client to connect to it.  A client can be a web application or Home Automation system.
+
+<a name="module_nodejs-poolController--clients"></a>
+
+## REM (Relay Equipment Manager)
+[Relay Equipment Manager](https://github.com/rstrouse/relayEquipmentManager) is a companion app developed by @rstrouse that integrates standalone hardware control.  Controls GPIO, i2c, and SPI devices including:
+* Atlas Scientific pH, orp, ec, hum, prs, pmp, rtd
+* ADS1x15 a/d converters
+* Pressure Tranducers
+* Flow sensors
+* Temperature sensors (10k, NTC)
+
+## Web Clients
+1. [nodejs-poolController-dashPanel](https://github.com/rstrouse/nodejs-poolController-dashPanel).  Full compatibility with IntelliCenter, *Touch, REM (RelayEquipmentManager).
+1. Deprecated - ~~[nodejs-poolController-webClient](http://github.com/tagyoureit/nodejs-poolController-webClient).  Built primarily around EasyTouch/IntelliTouch but will work with other systems.~~
+
+* This app has the default to only listen to clients from localhost (127.0.0.1).  If you need to have clients connect from other machines you will need to change the [ip](#module_nodejs-poolController--config.json) in `config.json`.
+
+<a name="module_nodejs-poolController--bindings"></a>
+
+## Home Automation Bindings (previously Integrations)
+**NOTE: Existing integrations built of 5.3 or earlier WILL NOT WORK.  They need to be upgraded to leverage 6.0.  **
+
+Available for 6.x:
+* [Vera Home Automation Hub](https://github.com/rstrouse/nodejs-poolController-veraPlugin) - A plugin that integrates with nodejs-poolController.  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#vera)
+* [Hubitat](https://github.com/bsileo/hubitat_poolcontroller) by @bsileo (prev help from @johnny2678, @donkarnag, @arrmo).  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#smartthingshubitat)
+* [Homebridge/Siri/EVE](https://github.com/gadget-monk/homebridge-poolcontroller) by @gadget-monk, adopted from @leftyflip
+* InfluxDB - [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#influx)
+* [MQTT](https://github.com/crsherman/nodejs-poolController-mqtt) original release by @crsherman, re-write by @kkzonie, testing by @baudfather and others.  [Bindings Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Bindings-Integrations-in-2.0#mqtt)
+   * [Homeseer](https://github.com/tagyoureit/nodejs-poolController/wiki/Homeseer-Setup-Instructions) - Integration directions by @miamijerry to integrate Homeseer through MQTT
+
+Need to be updated:
+* [Another SmartThings Controller](https://github.com/dhop90/pentair-pool-controller/blob/master/README.md) by @dhop90
+* [ISY](src/integrations/socketISY.js).  Original credit to @blueman2, enhancements by @mayermd
+* [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. 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),
+
+### Virtual Controller
+v6 adds all new configuration and support for virtual pumps, chlorinators (and soon, Intellichem)
+
+* [Virtual Pump Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Virtual-Pump-Controller---v6)
+* [Virtual Chlorinator Directions](https://github.com/tagyoureit/nodejs-poolController/wiki/Virtual-Chlorinator-Controller-v6)
+* Virtual Chem Controller
+
+# Changes
+See [Changelog](https://github.com/tagyoureit/nodejs-poolController/blob/master/Changelog)
+
+
+<a name="module_nodejs-poolController--config.json"></a>
+# Config.json changes
+
+## Controller section - changes to the communications for the app
+* `rs485Port` - set to the name of you rs485 controller.  See [wiki](https://github.com/tagyoureit/nodejs-poolController/wiki/RS-485-Adapter-Details) for details and testing.
+* `portSettings` - should not need to be changed for RS485
+* `mockPort` - opens a "fake" port for this app to communicate on.  Can be used with [packet captures/replays](https://github.com/tagyoureit/nodejs-poolController/wiki/How-to-capture-all-packets-for-issue-resolution).
+* `netConnect` - used to connect via [Socat](https://github.com/tagyoureit/nodejs-poolController/wiki/Socat)
+  * `netHost` and `netPort` - host and port for Socat connection.
+* `inactivityRetry` - # of seconds the app should wait before trying to reopen the port after no communications.  If your equipment isn't on all the time or you are running a virtual controller you may want to dramatically increase the timeout so you don't get console warnings.
+
+## Web section - controls various aspects of external communications
+* `servers` - setting for different servers/services
+ * `http2` - not used currently
+ * `http` - primary server used for api connections without secure communications
+    * `enabled` - self-explanatory
+    * `ip` - The ip of the network address to listen on.  Default of `127.0.0.1` will only listen on the local loopback (localhost) adapter.  `0.0.0.0` will listen on all network interfaces.  Any other address will listen exclusively on that interface.
+    * `port` - Port to listen on.  Default is `4200`.
+    * `httpsRedirect` - Redirect http traffic to https
+    * `authentication` - Enable basic username/password authentication.  (Not implemented yet.)
+    * `authFile` - Location of the encrypted password file.  By default, `/users.htpasswd`. If you have `authentication=1` then create the file users.htpasswd in the root of the application.  Use a tool such as http://www.htaccesstools.com/htpasswd-generator/ and paste your user(s) into this file.  You will now be prompted for authentication.
+ * `https` - See http options above.
+    * `sslKeyFile` - Location of key file
+    * `sslCertFile` - Location of certificate file
+ * `mdns` - Not currently used.
+ * `ssdp` - Enable for automatic configuration by the webClient and other platforms.
+
+
+## Log - Different aspects of logging to the application
+ * `app` - Application wide settings
+    * `enabled` - Enable/disable logging for the entire application
+    * `level` - Different levels of logging from least to most: 'error', 'warn', 'info', 'verbose', 'debug', 'silly'
+* `packet` - Configuration for the 
+
+
+# Credit
+
+1.  @Rstrouse for helping make the 6.0 rewrite and Intellicenter possible, continuing to make monumental changes, and driving this project forward in numerous ways.  My knowledge of coding in general has benefitted greatly from working with him.
+1.  [Jason Young](http://www.sdyoung.com/home/decoding-the-pentair-easytouch-rs-485-protocol) (Read both posts, they are a great baseline for knowledge)
+1.  Michael Russe [ceesco](https://github.com/ceesco53/pentair_examples) [CocoonTech](http://cocoontech.com/forums/topic/13548-intelliflow-pump-rs485-protocol/?p=159671) - Registration required for CocoonTech.  Jason Young used this material for his understanding in the protocol as well.  There is a very detailed .txt file with great information ~~that I won't post unless I get permission~~. Looks like it was publicly posted to [Pastebin](http://pastebin.com/uiAmvNjG).
+1.  [Michael Usner](https://github.com/michaelusner/Home-Device-Controller) for taking the work of both of the above and turning it into Javascript code.
+1.  [rflemming](https://github.com/rflemming) for being the first to contribute some changes to the code.
+1.  Awesome help from @arrmo and @blueman2 on Gitter
+
+# License
+
+nodejs-poolController.  An application to control pool equipment.
+Copyright (C) 2016, 2017.  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/>

package/app.ts

@@ -35,6 +35,7 @@ export async function initAsync() {
         await state.init();
         await webApp.init();
         await sys.start();
+        await webApp.initAutoBackup();
     } catch (err) { console.log(`Error Initializing nodejs-PoolController ${err.message}`);  }
     //return Promise.resolve()
     //    .then(function () { config.init(); })
@@ -70,6 +71,7 @@ export async function stopAsync(): Promise<void> {
     try {
         console.log('Shutting down open processes');
         // await sys.board.virtualPumpControllers.stopAsync();
+        await webApp.stopAutoBackup();
         await sys.stopAsync();
         await state.stopAsync();
         await conn.stopAsync();

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.
@@ -100,6 +100,8 @@ class Config {
         c[section] = val;
         this.update();
     }
+    // RKS: 09-21-21 - We are counting on the return from this being immutable.  A copy of the data
+    // should always be returned here.
     public getSection(section?: string, opts?: any): any {
         if (typeof section === 'undefined') return this._cfg;
         let c: any = this._cfg;
@@ -118,6 +120,7 @@ class Config {
         let baseDir = process.cwd();
         this.ensurePath(baseDir + '/logs/');
         this.ensurePath(baseDir + '/data/');
+        this.ensurePath(baseDir + '/backups/');
         // this.ensurePath(baseDir + '/replay/');
         //setTimeout(() => { config.update(); }, 100);
     }
@@ -148,5 +151,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,26 +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');
-            let out = res.toString().trim();
+            let out: string;
+            if (typeof env.SOURCE_BRANCH !== 'undefined') 
+            {
+                out = `${env.SOURCE_BRANCH} - From environment variable`; // 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) {
-            logger.error(`Unable to retrieve local git branch.  ${err}`);
+            state.appVersion.gitLocalBranch = '--';
+            logger.warn(`Unable to retrieve local git branch.  ${err}`);
         }
         try {
-            let res = execSync('git rev-parse HEAD');
-            let out = res.toString().trim();
+            let out: string;
+            if (typeof env.SOURCE_COMMIT !== 'undefined') 
+            {
+                out = `${env.SOURCE_COMMIT} - From environment variable`; // 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':
@@ -69,7 +85,10 @@ class VersionCheck {
                     state.appVersion.gitLocalCommit = out;
             }
         }
-        catch (err) { logger.error(`Unable to retrieve local git commit.  ${err}`); }
+        catch (err) { 
+            state.appVersion.gitLocalCommit = '--';
+            logger.warn(`Unable to retrieve local git commit.  ${err}`); 
+        }
     }
     private checkAll() {
         try {
@@ -83,7 +102,7 @@ class VersionCheck {
             });
         }
         catch (err) {
-            logger.error(err);
+            logger.error(`Error checking latest release: ${err.message}`);
         }
     }