Project Files of Raspberry Pi 5 Water Meter and Leak Detector - Proteus Simulation

===============================================================================================================
  Raspberry Pi 5 Smart Water Meter and Leak Detector - Proteus Simulation Project V1.0
  The Engineering Projects - www.TheEngineeringProjects.com
===============================================================================================================

IMPORTANT LINKS
  The project tutorial (circuit, code, simulation results):
    https://www.theengineeringprojects.com/2026/11/raspberry-pi-5-water-meter-leak-detector-proteus-simulation.html
  The libraries this project is built from (each post has its own full download and tutorial):
    Raspberry Pi 5 board:
      https://www.theengineeringprojects.com/2026/10/raspberry-pi-5-library-for-proteus.html
    YF-S201 water flow sensor:
      https://www.theengineeringprojects.com/2026/10/yf-s201-water-flow-sensor-library-for-proteus-v1-0.html
    Relay module:
      https://www.theengineeringprojects.com/2026/10/relay-module-library-for-proteus-v1-0.html
    12V solenoid water valve:
      https://www.theengineeringprojects.com/2026/11/12v-solenoid-water-valve-library-for-proteus-v1-0.html
    1N4007 diode:
      https://www.theengineeringprojects.com/2026/11/1n4007-diode-library-for-proteus.html
    I2C LCD 16x2:
      https://www.theengineeringprojects.com/2026/10/i2c-lcd-16x2-library-for-proteus-v1-0.html
    Active buzzer:
      https://www.theengineeringprojects.com/2026/11/active-buzzer-library-for-proteus.html
    BC547 transistor (Small Transistors):
      https://www.theengineeringprojects.com/2026/11/small-transistors-library-for-proteus.html
    Resistor:
      https://www.theengineeringprojects.com/2026/11/resistor-library-for-proteus.html
    Laptop WiFi Monitor:
      https://www.theengineeringprojects.com/2026/10/laptop-wifi-monitor-library-for-proteus.html
    Mobile WiFi Monitor:
      https://www.theengineeringprojects.com/2026/10/mobile-wifi-monitor-library-for-proteus.html
  Support our free work: https://www.theengineeringprojects.com/donate

FILE STRUCTURE
Pi-5-Water-Leak-Detector-TEP-v1.0/
|-- Proteus Library Files/
|   |-- TEP1N4007.LIB                                   9.7 KB   a part of the project -> LIBRARY folder
|   |-- TEPBJT.LIB                                     18.6 KB   a part of the project -> LIBRARY folder
|   |-- TEPBUZZER.LIB                                   9.9 KB   a part of the project -> LIBRARY folder
|   |-- TEPI2CLCD16X2.LIB                             181.4 KB   a part of the project -> LIBRARY folder
|   |-- TEPLAPTOP.LIB                                  39.5 KB   a part of the project -> LIBRARY folder
|   |-- TEPMOBILE.LIB                                  13.1 KB   a part of the project -> LIBRARY folder
|   |-- TEPRELAY.LIB                                  490.4 KB   a part of the project -> LIBRARY folder
|   |-- TEPRESISTOR.LIB                               306.9 KB   a part of the project -> LIBRARY folder
|   |-- TEPRPI5.LIB                                    60.5 KB   a part of the project -> LIBRARY folder
|   |-- TEPVALVE.LIB                                   18.4 KB   a part of the project -> LIBRARY folder
|   |-- TEPYFS201.LIB                                  65.9 KB   a part of the project -> LIBRARY folder
|-- Proteus Model Files/
|   |-- TEP1N4007.DLL                                 286.5 KB   a model -> MODELS folder
|   |-- TEPBJT.DLL                                    292.0 KB   a model -> MODELS folder
|   |-- TEPBUZZER.DLL                                 276.0 KB   a model -> MODELS folder
|   |-- TEPLCD.DLL                                    409.0 KB   a model -> MODELS folder
|   |-- TEPNET.DLL                                     2.89 MB   a model -> MODELS folder
|   |-- TEPRELAY.DLL                                  330.0 KB   a model -> MODELS folder
|   |-- TEPRESISTOR.DLL                               311.0 KB   a model -> MODELS folder
|   |-- TEPVALVE.DLL                                  281.0 KB   a model -> MODELS folder
|   |-- TEPYFS201.DLL                                 292.5 KB   a model -> MODELS folder
|   |-- TEPPi/python/                                 17.54 MB   Python 3.11 embeddable -> MODELS\TEPPi (33 files)
|   |-- TEPPi/runtime/                                 1.11 MB   TEP Pi runtime, gpiozero -> MODELS\TEPPi (87 files)
|-- Proteus Simulation/
|   |-- Pi-5-Water-Leak-Detector.pdsprj                41.9 KB   the project simulation
|   |-- TEP1N4007.DLL                                 286.5 KB   copy of the model
|   |-- TEPBJT.DLL                                    292.0 KB   copy of the model
|   |-- TEPBUZZER.DLL                                 276.0 KB   copy of the model
|   |-- TEPLCD.DLL                                    409.0 KB   copy of the model
|   |-- TEPNET.DLL                                     2.89 MB   copy of the model
|   |-- TEPRELAY.DLL                                  330.0 KB   copy of the model
|   |-- TEPRESISTOR.DLL                               311.0 KB   copy of the model
|   |-- TEPVALVE.DLL                                  281.0 KB   copy of the model
|   |-- TEPYFS201.DLL                                 292.5 KB   copy of the model
|   |-- water_meter.py                                 11.1 KB   the program PI1 runs
|-- Python Code/
|   |-- water_meter.py                                 11.1 KB   the program (the same file)
|-- README.txt                                        ~11.0 KB   this file
Total: 30.54 MB (unzipped). The C++ source code of the models is not included.

WHAT IS IT?
  A water meter that watches the pipe into a house, which you can run in Proteus: a Raspberry Pi 5 counts the pulses
  of a flow sensor, logs every use of water, keeps today's litres, and shuts a solenoid valve when the water behaves
  like a leak or a burst pipe. An LCD, a buzzer and a web page show what it sees.
    * YF-S201 water flow sensor (YFS201ADVTEP, U1): 5 V, OUT on GPIO17 with the Pi's pull-up; 450 pulses per litre,
      F = 7.5 x Q (Hz, L/min).
    * 1-channel relay module (RELAY1ADVTEP, RLY1): VCC on the 5 V rail, IN on GPIO27 (active LOW); COM on +12V, NO to
      the valve.
    * 12 V solenoid water valve, normally closed (WATERVALVETEP, SV1): powered = open; a 1N4007 (DIODE1N4007TEP, D1)
      across its coil takes the spike when the relay lets go.
    * I2C LCD 16x2 (I2CLCD16X2BLUEADVTEP, LCD1, PCF8574 at 0x27) on SDA GPIO2 / SCL GPIO3, 5 V.
    * Active buzzer (BUZZERACTIVETEP, BZ1) on the 5 V rail, switched by Q1 BC547 (BC547BTEP; base through R2 1k from
      GPIO23); R1 1k across the buzzer.
    * RASPBERRY PI 5 (PI1) runs water_meter.py on Ethernet at 192.168.1.51; the dashboard is on port 8000.
    * Laptop WiFi Monitor (PC1) and Mobile WiFi Monitor (MOB1) open http://192.168.1.51:8000/.
  The rules (at the top of water_meter.py):
    * once a second the Pi turns the pulses of that second into L/min (pulses / 7.5) and litres (pulses / 450);
    * a use runs from the first pulse to 2 s without water and is logged with its litres;
    * LEAK: water for 20 s without a break (a demo value - in a real house 30 to 60 minutes);
    * BURST: more than 20 L/min for 3 s;
    * AWAY LEAK: in AWAY mode, any water for 5 s;
    * an alarm shuts the valve and beeps until it is silenced; water 3 s after a shut-off means the valve leaks.
  Its pages:
    /            the dashboard: the flow, today's litres, the valve, the alarm, the last uses, the events
    /open        clear the alarm and open the valve
    /close       close the valve
    /away        AWAY mode on / off
    /silence     the buzzer off for the present alarm
    /data        everything as JSON

TEST STATUS
  Tested in Proteus 8 Professional on Windows 11, the run that made the tutorial's screenshots (the program's times):
    * Start: "valve OPEN (start-up)" at 0.0 s; the relay on, the valve open (0.45 A at 12 V).
    * TAP (6 L/min) for about 7 s, then OFF: "a use: 0.69 L in 6.9 s at 6.0 L/min" at 19.3 s.
    * LEAK (a running cistern, 1.5 L/min): "LEAK - water has run for 20 s without a break" at 42.8 s, the valve
      CLOSED, the buzzer; after VALVE on the sensor's pop-up: "a use: 0.54 L in 21.7 s at 1.5 L/min".
    * SILENCE from the phone at 48.4 s; LEAK fixed, VALVE open, OPEN from the laptop: the valve open at 52.5 s.
    * FULL (30 L/min): "BURST - 30.0 L/min for 3 s" at 57.9 s, the valve CLOSED; "a use: 2.17 L in 4.3 s".
    * OPEN from the phone at 65.1 s; AWAY from the laptop at 66.9 s; TAP: "AWAY LEAK" at 74.1 s, the valve CLOSED.
    * Today 4.03 L; the sensor counted 1,812 pulses = 4.03 L of water that really passed.
  An earlier run counted a use's duration in whole seconds and logged a 6 L/min tap as "0.56 L in 5 s (6.6 L/min
  on average)"; the program now takes the flow from the full seconds and the duration from the litres.
  85 s of simulation took about 7 minutes on our PC with all the captures.

INSTALLATION
  1. Close Proteus. Extract the WHOLE zip file, for example to your Desktop.
  2. Copy the files from "Proteus Library Files" into the LIBRARY folder of Proteus, for example
     C:\Program Files (x86)\Labcenter Electronics\Proteus 8 Professional\LIBRARY
  3. Copy everything in "Proteus Model Files" - the DLL files AND the TEPPi folder - into the MODELS folder
     (next to LIBRARY). TEPPi holds the Python 3.11 that the Raspberry Pi board runs and our TEP Pi runtime.
  4. Start Proteus. Press P in the schematic and search for RASPBERRY PI 5, YFS201ADVTEP or WATERVALVETEP to check
     that the parts are there.

RUN THE SIMULATION
  1. Open "Proteus Simulation\Pi-5-Water-Leak-Detector.pdsprj". Keep water_meter.py and the DLL files beside it.
  2. Press Play. The program opens the valve (the relay clicks on); the LCD shows the flow and today's litres.
  3. Open the Laptop WiFi Monitor (PC1) or the Mobile WiFi Monitor (MOB1) and press Go. Press Refresh to update it.
  4. In the YF-S201's pop-up (U1) pick TAP, then OFF: one use is logged. Press LEAK (a running cistern): after 20 s
     the valve shuts and the buzzer beeps. FULL (30 L/min) is a burst pipe.
  5. The sensor's model does not know about the valve: after a shut-off press VALVE on its pop-up to stop the
     water, as the shut valve would. Press VALVE again (and fix the LEAK) before OPEN on the page.
  Your own program: edit water_meter.py beside the project (the limits at the top) and press Play.

PROPERTIES USED IN THIS PROJECT
  PI1 RASPBERRY PI 5          PROGRAM=water_meter.py, ETHERNET=IN (192.168.1.51)
  U1 YFS201ADVTEP             (no changes: K 7.5, the tap OFF)
  LCD1 I2CLCD16X2BLUEADVTEP   (no changes: address 0x27)
  R1, R2 RESISTOR4BANDTEP     1k
  PC1, MOB1                   HOMEPAGE=http://192.168.1.51:8000/

TROUBLESHOOTING
  * The flow stays at 0.0 L/min: OUT is not on GPIO17, or the sensor has no 5 V.
  * The litres are wrong by a few per cent: your sensor's K is not 7.5 - measure a bucket and change K.
  * The valve never opens: the relay's COM has no +12V, or the valve is on NC instead of NO.
  * LEAK while a bath fills: CONT_S is too short for your house - raise it.
  * The terminal cannot start Python: the TEPPi folder is not in MODELS (step 3 of INSTALLATION), or an older one.

LICENCES
  * The project, the program, the parts (LIB files) and the models (DLL files) are made by The Engineering
    Projects and are free for learning and for your own projects. The models use only standard Windows libraries.
    The C++ source code of the models is not included; the source code is not included for any model.
  * TEPPi\python is the Python 3.11 Windows embeddable package (Python Software Foundation License); TEPPi\runtime
    holds our TEP Pi runtime with gpiozero and colorzero (BSD licences) - their licence files are inside the folders.
  * Proteus is a product of Labcenter Electronics and is not included. Raspberry Pi is a trademark of Raspberry Pi
    Ltd. This project is not made or endorsed by them. A hobby leak detector does not replace a plumber or the
    safety devices your water supplier or local rules ask for.

VERSION
  V1.0 - the first release of the project.
===============================================================================================================