seaverd/nodejs-poolcontroller repository overview

⁠Important note-downgrade from the latest version of node to use dependencies in this project. A new version of this app is currently under development.

⁠nodejs-poolController - Version 5.3.3

Full Changelog⁠

⁠5.3.3

1. #134

⁠5.3.1

1. #132

⁠5.3.0

1. Fix for #106
2. Fix for "Error 60" messages
3. Improved caching of files on browsers. Thanks @arrmo! Now files will be loaded once in the browser and kept in cache instead of reloaded each time.
4. Improved handling of sessions and graceful closing of the HTTP(s) servers.

⁠License

nodejs-poolController. An application to control pool equipment. Copyright (C) 2016, 2017. Russell Goldin, tagyoureit. [email protected]⁠

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/⁠.

⁠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?

Controllers: Intellitouch, EasyTouch, Intermatic, SunTouch, IntellicomII Pumps: Intelliflow, older models Chlorinator: Intellichlor, Aqua-Rite and OEM brands Home Automation: ISY. (Soon to include Siri, Echo, more?)

⁠Plug-ins / Extensions / Contributions

Extend nodejs-Poolcontroller with these additional integration points

• outputSocketToConsoleExample⁠ A sample included with the code to demonstrate correct usage.
• Homebridge/Siri⁠ by @leftyfl1p
• SmartThings⁠ by @bsileo, @johnny2678, @donkarnag, @arrmo
• Another SmartThings Controller⁠ by @dhop90
• ISY⁠ included with this app. Original credit to @blueman2, enhancements by @mayermd
• ISY Polyglot NodeServer⁠ created by @brianmtreese
• MQTT⁠ created by @crsherman.
• Hubitat⁠ by @bsileo

⁠Installation Instructions

This code requires a physical RS485⁠ adapter to work.

If you don't know anything about NodeJS, these directions might be helpful.

1. Install Nodejs. (https://nodejs.org/en/download/⁠)
2. Update NPM (https://docs.npmjs.com/getting-started/installing-node⁠).
3. Download the latest code release⁠ OR clone with git clone [email protected]:tagyoureit/nodejs-poolController.git
4. Unzip into nodejs-poolController.
5. Run 'npm install' in the new folder (where package.json exists). This will automatically install all the dependencies (serial-port, express, sockets.io, etc).
6. Run the app by calling 'npm start'* (again, in the root directory). It should now run properly.
   • to run with a specific configuration, run node index.js arg where arg is the name of your current config file. eg npm start configCustomized.json. By default, the app will load config.json.

⁠Upgrade instructions

Universal notes

1. For precaution, make a backup copy of your config.json or customized configuration file. New in the 5.0.0 release is that the app will automatically upgrade this file.

Git clone method - Harder way, but you can create PR's and help with development

1. git clone [email protected]:tagyoureit/nodejs-poolController.git (clone the repo if you are starting fresh) 1. git checkout 5.0.0 (switch to 5.0.0 branch - Development branch only) Will update when there is a new Dev branch.
2. git pull (anytime you want to grab the latest code)
3. npm update (update dependencies)

Download method - Easier way

1. Download the latest release from the release page or branch page big Clone or download v button
2. Unzip and overwrite your existing directory*. See note above about config.json file.

⁠Support

For support you can open a github issue⁠, for discussions, designs, and clarifications, we recommend you join our Gitter Chat room⁠.

⁠Web Interfaces

• A slick Bootstrap⁠ interface by @arrmo⁠. Set variable: "expressDir": "/bootstrap"⁠
• A boring, basic, functional interface. Set variable: "expressDir": "/public"⁠ To choose, set the expressDir variable in the 'config.json'. Load both interfaces from http://localhost:3000/index.html

⁠Useful URL's included with the boring, basic, functional interface

• Control standalone pumps: http://_your_machine_name_:3000/pump.html See #150.
• Listen for specific messages: http://_your_machine_name_:3000/debug.html
• Send a message on the serial bus: http://<server>:3000/public/send_packet.html

⁠Technical notes:

The web UI will dynamically load as the information is received from the app. Yes, Socket.io, we love you! Full loading may take 20-30 seconds depending on your equipment setup.

⁠REST Interface & Socket.IO

You can also call REST URI's like:

• Get circuit status: /circuit/# to get the status of circuit '#'
• Toggle circuit status: /circuit/#/toggle to get the toggle circuit '#'
• Get system status: /status Depricated.
• Get schedules: /schedule
• Get pump status: /pump
• Get all equipment as one JSON: /all
• Set spa heat setpoint: /spaheat/setpoint/#
• Set spa heat mode: /spaheat/mode/# (0=off, 1=heater, 2=solar pref, 3=solar only)
• Set pool heat setpoint: /poolheat/setpoint/#
• Set pool heat mode: /poolheat/mode/# (0=off, 1=heater, 2=solar pref, 3=solar only)
• Run pumps in stand-alone mode
• Cancel delay: /cancelDelay

⁠APIs

You can use Sockets.IO (see the "basic UI" example). Valid sockets:

⁠General

⁠Circuits

⁠Temperatures and Heat

⁠Chlorinator and Intellichem

(Note: As of 5.3 the Chlorinator API's will route the commands either through the Intellitouch/Intellicom or directly to the chlorinator depending upon your setup)

⁠Pumps

⁠Standalone pump controllers or Easytouch (Not Intellitouch)

⁠Schedules

⁠Config.JSON

The poolController app runs on a configuration file. As noted in the Install Instructions⁠, you can launch from a custom file or use the default name of config.json.

New as of 4.1.33, the app will not come with config.json. This makes upgrading easy because the app will not overwrite your existing settings if you use the default name.

⁠First launch

When you first launch the app, or launch the app specifying a configuration file that does not exist, it will be created from a template. The template is sysDefault.json and this file should NOT be modified directly.

⁠Subsequent launches and upgrades

Every time the app runs, or the code is upgraded, the app will check the specified configuration file against the sysDefaults.json file and add any new keys.

Summary

• Any edits are retained (eg you change logConfigMessages=1, but it is logConfigMessages=0 in the template, the value will not be changed in the configuration file). The only exception is the version key which will be updated to the latest value.
• New keys are automatically added with default values.
• Old keys will output a warning, but will not be deleted*.

⁠Example Messages

In the logs, you will see

Keys that can be deleted:

20:49:15.181 INFO Potential expired/deprecated keys in
	file: config_local.json
	key: Hi I am an extra key:0

Keys that are automatically added:

20:50:55.718 INFO New keys copied
	from: sysDefault.json
	  to: config.json
	key: poolController.log.logApi:0

⁠Only output changes in config.json

If you want to only see what would be changed, or if you want the app to also delete keys, you can run an npm script.

• npm run configTester %config.json% [overwriteFile or outputToScreen]

where %config.json% is the path to your configuration file. Defaults to config.json and [overwriteFile or outputToScreen], if present, will write the entire changed file to the file (with deletes) or output the contents to the screen.

See below for descriptions

{
    "equipment": {
        "controller": {
            "intellicom": {
                "installed": 0,
                "friendlyName": ""
            },
            "intellitouch": {
                "installed": 1,
                "friendlyName": "",
                "numberOfCircuits": 20,
                "numberOfPumps": 2,
                "numberOfCustomNames": 10
            },
            "virtual": {
                "pumpController": "default",
                "chlorinatorController": "default"
            },
            "id": {
                "productName": "",
                "productNumber": "",
                "manufacturer": "",
                "description": ""
            },
            "circuitFriendlyNames": {
                "1": "",
                "2": "",
                "3": "",
                "4": "",
                "5": "",
                "6": "",
                "7": "",
                "8": "",
                "9": "",
                "10": "",
                "11": "",
                "12": "",
                "13": "",
                "14": "",
                "15": "",
                "16": "",
                "17": "",
                "18": "",
                "19": "",
                "20": ""
            }
        },
        "chlorinator": {
            "installed": 1,
            "desiredOutput": {
                "pool": -1,
                "spa": -1
            },
            "friendlyName": "",
            "id": {
                "productName": "",
                "productNumber": "",
                "manufacturer": "",
                "description": ""
            }
        },
        "pump": {
            "1": {
                "type": "VS",
                "externalProgram": {
                    "1": -1,
                    "2": -1,
                    "3": -1,
                    "4": -1
                },
                "friendlyName": ""
            },
            "2": {
                "type": "VS",
                "externalProgram": {
                    "1": -1,
                    "2": -1,
                    "3": -1,
                    "4": -1
                },
                "friendlyName": ""
            }
        }
    },
    "poolController": {
        "appAddress": 33,
        "http": {
            "enabled": 1,
            "expressPort": 3000,
            "redirectToHttps": 0,
            "expressAuth": 0,
            "expressAuthFile": "/users.htpasswd"
        },
        "https": {
            "enabled": 1,
            "expressPort": 3001,
            "expressAuth": 0,
            "expressAuthFile": "/users.htpasswd",
            "expressKeyFile": "/data/server.key",
            "expressCertFile": "/data/server.crt"
        },
        "network": {
            "rs485Port": "/dev/ttyUSB0",
            "netConnect": 0,
            "netHost": "raspberrypi",
            "netPort": 9801,
            "inactivityRetry": 10
        },
        "notifications": {
            "version": {
                "remote": {
                    "version": "4.0.0",
                    "tag_name": "v4.0.0",
                    "dismissUntilNextRemoteVersionBump": false
                }
            }
        },
        "log": {
            "logLevel": "info",
            "socketLogLevel": "info",
            "fileLog": {
                "enable": 0,
                "fileLogLevel": "silly",
                "fileName": "output.log"
            },
            "logPumpMessages": 0,
            "logDuplicateMessages": 0,
            "logConsoleNotDecoded": 0,
            "logConfigMessages": 0,
            "logMessageDecoding": 0,
            "logChlorinator": 0,
            "logIntellichem": 0,
            "logPacketWrites": 0,
            "logPumpTimers": 0,
            "logReload": 0,
            "logApi": 0
        },
        "database": {
            "influx": {
                "enabled": 0,
                "host": "localhost",
                "port": 8086,
                "database": "pool"
            }
        }
    },
    "integrations": {
        "socketISY": 0,
        "outputSocketToConsoleExample": 0
    },
 "socketISY": {
        "username": "blank",
        "password": "blank",
        "ipaddr": "127.0.0.1",
        "port": 12345,
        "Variables": {
            "chlorinator": {
                "saltPPM": 16
            },
            "pump": {
                "1": {
                    "watts": 25,
                    "rpm": 24,
                    "currentprogram": 13,
                    "program1rpm": 10,
                    "program2rpm": 11,
                    "program3rpm": 12,
                    "program4rpm": 13,
                    "power": 14,
                    "timer": 15
                }
            },
            "circuit": {
                "1": {
                    "status": 8
                },
                "2": {
                    "status": 3
                },
                "3": {
                    "status": 2
                }
            },
            "temperatures": {
                "poolTemp": 17,
                "spaTemp": 18,
                "airTemp": 19,
                "spaSetPoint": 20
            }