Gixy31/ESP32-PoolMaster

ESP32 PoolMaster

Brief description

This project is a software port to an ESP32 platform of the PoolMaster project from Loic74650 (https://github.com/Loic74650/PoolMaster)
Compared to the initial project, the main differences are:

ESP32 MCU with WiFi (multiple access points)
ESP32-Arduino framework, PlatformIO IDE
async MQTT client
JSON upgrade to version 6
lots of code modifications, keeping the general behaviour
add a fourth pump (cleaning robot)
manage only 2 relays (+ the four pumps)
analog measurements done by external ADC I2C module (ADS1115), in async mode
and more...

The project isn't a fork of the original one due to the different structure of source files with PlatformIO ((.cpp, .h). A dedicated board has been designed to host all components. There are 8 LEDs at the bottom to display status, warnings and alarms.

In version ESP-3.0, the display function has been very simplified (twice less code), using Nextion variables only to deport the logic into the Nextion and updating the display only when it is ON.

A new version of the board allows the connection of the pH_Orp board from Loïc (https://github.com/Loic74650/pH_Orp_Board/tree/main) on an additional I2C connector. The sofware is modified accordingly. The configuration is defined in the config.h file. CAD_files 2 Gerber 3 files are provided.

The version V6, (aka ESP-2.0) implement direct usage of FreeRTOS functions for managing tasks and queues. There are 10 tasks sharing the app_CPU : - The Arduino loopTask, with only the setup() function. When the setup is finished, the task deletes itself to recover memory; - PoolMaster, running every 500ms, which mainly supervises the overall timing of the system; - AnalogPoll, running every 125ms, to acquire analog measurements of pH, ORP and Pressure with an ADS115 sensor on an I2C bus; - GetTemp, running every 1000ms, to acquire water and air temperatures with DS18B20 sensors on two 1Wire busses; - ORPRegulation, running every 1000ms, to manage Chlorine pump; - pHRegulation, running every 1000ms, to manage Acid/Soda pump; - ProcessCommand, running every 500ms, to process commands received on /Home/Pool6/API MQTT Topic; - SettingsPublish, running when notified only (e.g with external command), to publish settings on the MQTT topic; - MeasuresPublish, running every 30s and when notified, to publish actual measures and status; - StatusLights, running every 3000ms, to display a row of 8 status LEDs on the mother board, through a PCF8574A on the I2C bus.

Board

PoolMaster 5.0.0

Arduino Mega2560 (or Controllino-Maxi) Ph/Orp (Chlorine) regulation system for home pools

Overview

Dashboard

Nextion 3.5

Brief description

Four main metrics are measured and periodically reported over MQTT and a 3.5" Nextion touch screen: water temperature and pressure, pH and ORP values.
Pumps states, tank-levels estimates and other parameters are also periodically reported
Two PID regulation loops are running in parallel: one for PH, one for ORP
An additional simple (on/off) regulation loop is handling the water temperature (it starts/stops the house-heating system circulator which brings heat to a heat exchanger mounted on the pool water pipes)
pH is regulated by injecting Acid from a tank into the pool water (a relay starts/stops the Acid peristaltic pump)
ORP is regulated by injecting Chlorine from a tank into the pool water (a relay starts/stops the Chlorine peristaltic pump)
Defined time-slots and water temperature are used to start/stop the filtration pump for a daily given amount of time (a relay starts/stops the filtration pump)
Tank-levels are estimated based on the running-time and flow-rate of each pump.
Ethernet connectivity parameters can be set through a webpage accessible from the LAN at http://PoolMaster.local.
If an ethernet connection is available, the internal clock (RTC) is synchronized with a time-server every day at midnight.
An API function enables telling the system what the outside air temperature is. In case it is below -2.0°C, filtration is started until it rises back above +2.0°C
Communication with the system is performed using the MQTT protocol over an Ethernet connection to the local network/MQTT broker.

Every 30 seconds (by default), the system will publish on the "PoolTopicMeas1" and "PoolTopicMeas2"(see in code below) the following payloads in Json format:
{"Tmp":818,"pH":321,"PSI":56,"Orp":583,"FilUpT":8995,"PhUpT":0,"ChlUpT":0}
{"AcidF":100,"ChlF":100,"IO":11,"IO2":0}
Tmp: measured Water temperature value in °C x100 (8.18°C in the above example payload)
pH: measured pH value x100 (3.21 in the above example payload)
Orp: measured Orp (aka Redox) value in mV (583mV in the above example payload)
PSI: measured Water pressure value in bar x100 (0.56bar in the above example payload)
FiltUpT: current running time of Filtration pump in seconds (reset every 24h. 8995secs in the above example payload)
PhUpT: current running time of Ph pump in seconds (reset every 24h. 0secs in the above example payload)
ChlUpT: current running time of Chl pump in seconds (reset every 24h. 0secs in the above example payload)
AcidF: percentage fill estimate of acid tank ("pHTank" command must have been called when a new acid tank was set in place in order to have accurate value)
ChlF: percentage fill estimate of Chlorine tank ("ChlTank" command must have been called when a new Chlorine tank was set in place in order to have accurate value)
IO: a variable of type BYTE where each individual bit is the state of a digital input on the Arduino. These are :

FiltPump: current state of Filtration Pump (0=on, 1=off)
PhPump: current state of Ph Pump (0=on, 1=off)
ChlPump: current state of Chl Pump (0=on, 1=off)
PhlLevel: current state of Acid tank level (0=empty, 1=ok)
ChlLevel: current state of Chl tank level (0=empty, 1=ok)
PSIError: over-pressure error
pHErr: pH pump overtime error flag
ChlErr: Chl pump overtime error flag

IO2: a variable of type BYTE where each individual bit is the state of a digital input on the Arduino. These are :

pHPID: current state of pH PID regulation loop (1=on, 0=off)
OrpPID: current state of Orp PID regulation loop (1=on, 0=off)
Mode: state of pH and Orp regulation mode (0=manual, 1=auto)
Heat: state of water heat command (0=off, 1=on)
R1: state of Relay1 (0=off, 1=on)
R2: state of Relay2 (0=off, 1=on)
R6: state of Relay6 (0=off, 1=on)
R7: state of Relay7 (0=off, 1=on)

How to compile

- this code was developped for two main hardware configurations (see list in the hardware section below):

Controllino-Maxi or
Arduino Mega 2560 + Ethernet shield + relay shield + RTC module

- select the target board type in the Arduino IDE (either "Arduino Mega 2560" or "Controllino Maxi") code should compile for both types

Compatibility

For this sketch to work on your setup you must change the following in the code (in the "Config.h" file):
- possibly the pinout definitions depending on your wiring
- the unique address of the DS18b20 water temperature sensor
- MAC and IP address of the Ethernet shield
- MQTT broker IP address and login credentials
- possibly the topic names on the MQTT broker to subscribe and publish to
- the Kp,Ki,Kd parameters for both PID loops in case your peristaltic pumps have a different throughput than 1.5Liters/hour for the pH pump and 3.0Liters/hour for the Chlorine pump. Also the default Kp values were adjusted for a 50m3 pool volume. You might have to adjust the Kp values in case of a different pool volume and/or peristaltic pumps throughput (start by adjusting it proportionally). In any case these parameters are likely to require adjustments for every pool

Tips

Before attempting to regulate your pool water with this automated system, it is essential that you start with:
1- testing your water quality (using liquid kits and/or test strips for instance) and balancing it properly (pH, Chlorine, Alkalinity, Hardness). Proper water balancing will greatly ease the pH stability and regulation
2- calibrating the pH probe using calibrated buffer solutions (pay attention to the water temperature which plays a big role in pH readings)
3- adjusting pH to 7.4
4- once above steps 1 to 3 are ok, you can start regulating ORP

Notes:
a/ the ORP sensor should theoretically not be calibrated nore temperature compensated (by nature its 0mV pivot point cannot shift)
b/ the ORP reading is strongly affected by the pH value and the water temperature. Make sure pH is adjusted at 7.4
c/ prefer platinium ORP probes for setpoints >500mV (ie. Pools and spas)
e/ the response time of ORP sensors can be fast in reference buffer solutions (10 secs) and yet very slow in pool water (minutes or more) as it depends on the water composition

Overview

MQTT API

Below are the

{"Mode":1} or {"Mode":0}
{"Heat":1} or {"Heat":0}
{"FiltPump":1}
{"ChlPump":1} or {"ChlPump":0}
{"PhPump":1} or {"PhPump":0}
{"PhPID":1} or {"PhPID":0}
{"OrpPID":1} or {"OrpPID":0}
{"PhCalib":[4.02,3.8,9.0,9.11]}
{"OrpCalib":[450,465,750,784]}
{"PhSetPoint":7.4}
{"OrpSetPoint":750.0}
{"WSetPoint":27.0}
{"WTempLow":10.0}
{"OrpPIDParams":[2857,0,0]}
{"PhPIDParams":[1330000,0,0.0]}
{"OrpPIDWSize":3600000}
{"PhPIDWSize":1200000}
{"Date":[1,1,1,18,13,32,0]}
{"FiltT0":9}
{"FiltT1":20}
{"PubPeriod":30}
{"PumpsMaxUp":1800}
{"Clear":1}
{"DelayPID":30}
{"TempExt":4.2}
{"PSIHigh":1.0}
{"pHTank":[20,100]}
{"ChlTank":[20,100]}
{"Relay":[1,1]}
{"Reboot":1}
{"pHPumpFR":1.5}
{"ChlPumpFR":3}
{"RstpHCal":1}
{"RstOrpCal":1}
{"RstPSICal":1}

Payloads/commands to publish on the "PoolTopicAPI" topic (see hardcoded in code) in Json format in order to launch actions on the Arduino:
-> set "Mode" to manual (0) or Auto (1). In Auto, filtration starts/stops at set times of the day and pH and Orp are regulated -> start/stop the regulation of the pool water temperature or {"FiltPump":0} -> manually start/stop the filtration pump -> manually start/stop the Chl pump to add more Chlorine -> manually start/stop the Acid pump to lower the Ph -> start/stop the Ph PID regulation loop -> start/stop the Orp PID regulation loop -> multi-point linear regression calibration (minimum 1 point-couple, 6 max.) in the form [ProbeReading_0, BufferRating_0, xx, xx, ProbeReading_n, BufferRating_n] -> multi-point linear regression calibration (minimum 1 point-couple, 6 max.) in the form [ProbeReading_0, BufferRating_0, xx, xx, ProbeReading_n, BufferRating_n] -> set the Ph setpoint, 7.4 in this example -> set the Orp setpoint, 750mV in this example -> set the water temperature setpoint, 27.0deg in this example -> set the water low-temperature threshold below which there is no need to regulate Orp and Ph (ie. in winter) -> respectively set Kp,Ki,Kd parameters of the Orp PID loop. In this example they are set to 2857, 0 and 0 -> respectively set Kp,Ki,Kd parameters of the Ph PID loop. In this example they are set to 1330000, 0 and 0 -> set the window size of the Orp PID loop in msec, 60mins in this example -> set the window size of the Ph PID loop in msec, 20mins in this example -> set date/time of RTC module in the following format: (Day of the month, Day of the week, Month, Year, Hour, Minute, Seconds), in this example: Monday 1st January 2018 - 13h32mn00secs -> set the earliest hour (9:00 in this example) to run filtration pump. Filtration pump will not run beofre that hour -> set the latest hour (20:00 in this example) to run filtration pump. Filtration pump will not run after that hour -> set the periodicity (in seconds) at which the system info (pumps states, tank levels states, measured values, etc) will be published to the MQTT broker -> set the Max Uptime (in secs) for the Ph and Chl pumps over a 24h period. If over, PID regulation is stopped and a warning flag is raised -> reset the pH and Orp pumps overtime error flags in order to let the regulation loops continue. "Mode" also needs to be switched back to Auto (1) after an error flag was raised -> Delay (in mins) after FiltT0 before the PID regulation loops will start. This is to let the Orp and pH readings stabilize first. 30mins in this example. Should not be > 59mins -> Provide the system with the external temperature. Should be updated regularly and will be used to start filtration when temperature is less than 2°C. 4.2deg in this example -> set the water high-pressure threshold (1.0bar in this example). When water pressure is over that threshold, an error flag is set -> call this function when the Acid tank is replaced or refilled. First parameter is the tank volume in Liters, second parameter is its percentage fill (100% when full) -> call this function when the Chlorine tank is replaced or refilled. First parameter is the tank volume in Liters, second parameter is its percentage fill (100% when full) -> call this generic command to actuate spare relays. Parameter 1 is the relay number (R1 in this example), parameter 2 is the relay state (ON in this example). This command is useful to use spare relays for additional features (lighting, etc). Available relay numbers are 1,2,6,7,8,9 -> call this command to reboot the controller (after 8 seconds from calling this command) -> call this command to set pH pump flow rate un L/s. In this example 1.5L/s -> call this command to set Chl pump flow rate un L/s. In this example 3L/s -> call this command to reset the calibration coefficients of the pH probe -> call this command to reset the calibration coefficients of the Orp probe -> call this command to reset the calibration coefficients of the pressure sensor