#include <splash.h> // Used To Display The Adafruit Logo In The Beginning
#include <Adafruit_GFX.h> // Used For For Drawing Lines, Rectangles, Circles, Text, And Images, As Well As Functions For Changing The Color And Size Of Drawn Shapes.
#include <Adafruit_SSD1306.h> // Used For Controlling The Display And Drawing Graphics On It.
#include <WiFi.h> // Used For Connecting To A Wi-Fi Network And For Communicating With Other Devices Over The Network. It Allows The Board To Act As A Client Or Server On A Wi-Fi Network
#include <WebServer.h> // Used To Receive Http Requests From Clients, Such As Web Browsers Or Mobile Apps, And To Send Responses Back To Those Clients.
#include <WebSocketsServer.h> // Used To Establish A Two-way Communication Channel With A Client, Such As A Web Browser Or Mobile App, Over A Single Tcp Connection.
#include "webpage.h" // Use For The Webpage
#define OLED_RESET 4 // Pin For OLED Reseting (For Updating Its Content)
#define TRIGGER_PIN 27 // Pin For The Ultra Sonic's Sensor Trigger
#define ECHO_PIN 26 // Pin For The Ultra Sonic's Sensor Echo
#define RELAY 32 // Pin For The Relay
#define TH 380 // Write Here The Maximum Height Of The Liquid Inside The Tank In cm (Total Capacity In cm) Note:The Maximum sensor distance is rated at 400-500cm)
#define IGH 20 // Witre Here The Ignored Height Above The Water Tank In cm (Distance Between The Sensor And The 100% Of Water Level)
#define TC 1600 // Write Here The Total Capacity Of The Water Tank In Liters
#define SCREEN_WIDTH 128 // OLED display width, in pixels
#define SCREEN_HEIGHT 64 // OLED display height, in pixels
Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET); // Used To Updates The Display With The Latest Content (Reseting The Display In This Case).
WebServer server(80); // Used To Creates A Web Server Object That Listens For Incoming Http Requests On The Specified Port (80 In This Case).
WebSocketsServer webSocket = WebSocketsServer(81); // Used To Creates A Websocket Server Object That Listens For Incoming Websocket Connections On The Specified Port (81 In This Case).
String JSONtxt; // Used To Declare A String Value To JSONtxt
boolean RELAYonoff = false; // Boolean Value For The Relay State
const char* ssid = "Wokwi-GUEST"; // Write your SSID here
const char* password = ""; // Write your PASSWORD here
long duration, distance; // Used To Declare Duration And Distance
int WH, P, C; // Used To Declare WH,P,C
//=================================================================================================================================================================================================================================================================================================
void setup() { // Used To Put Code Here To Be Ran Once
Serial.begin(115200); // Used To Initializes The Serial Communication With A Baud Rate Of 9600 Bits Per Second.
pinMode(RELAY, OUTPUT); // Used To Specifie That The Pin Will Be Used As An Output Pin.
pinMode(TRIGGER_PIN, OUTPUT); // Used To Specifie That The Pin Will Be Used As An Output Pin.
pinMode(ECHO_PIN, INPUT); // Used To Specifie That The Pin Will Be Used As An Input Pin.
//=================================================================================================================================================================================================================================================================================================
WiFi.begin(ssid, password); // Used To Connects The Board To The Specified Wi-fi Network Using The Provided Ssid (Network Name) And Password.
while (WiFi.status() != WL_CONNECTED) // Used To Returns The Current Status Of The Wi-fi Connection, Such As "Connected", "Disconnected", Or "Connecting".
{
Serial.print("."); delay(500); // Used For Showing Text In The Serial Monitor
}
WiFi.mode(WIFI_STA); // Used To Set The WIFI To A WiFi Station mode.
Serial.print(" Local IP: "); // Used For Showing Text In The Serial Monitor
Serial.println(WiFi.localIP()); // Used To Returns The Local Ip Address Of The Board On The Wi-fi Network.
//=================================================================================================================================================================================================================================================================================================
server.on("/", handleRoot); // Used To Sets Up A Handler Function For A Specific Url Path On The Web Server. When A Client Makes An Http Request To That Path, The Handler Function Is Called And Can Generate A Response To Send Back To The Client.
server.begin(); // Used To Starts The Websocket Server And Begins Listening For Incoming Connections.
webSocket.begin(); // Used To Initializes The WebSocket Server
webSocket.onEvent(webSocketEvent); // Used To Registers An Event Handler Function For Websocket Events On The Websocket Server,The Websocket.Onevent() Function Can Be Called Multiple Times In An Arduino Sketch To Register Multiple Event Handlers For Different Websocket Events.
//=================================================================================================================================================================================================================================================================================================
display.begin(SSD1306_SWITCHCAPVCC, 0x3C); // Used To Initialize With The I2C Address 0X3C (For The 128X32 OLED Display)
display.display(); // Used To Clear The Display.
delay(1000); // Used To Set A 1 Second Delay.
display.clearDisplay(); // Used To Clear The Display (Clear The Buffer).
}
//=================================================================================================================================================================================================================================================================================================
// The sensor is triggered by a HIGH pulse of 10 or more microseconds.
// Give a short LOW pulse beforehand to ensure a clean HIGH pulse:
void loop() { // Used To Put Code Here To Be Ran Repeatedly
digitalWrite(TRIGGER_PIN, LOW); // Used To sets the digital output pin TRIGGER_PIN to a low voltage level, which corresponds to a logical value of 0.
delayMicroseconds(5); // Used To Set A 5 Micro-Second Delay
digitalWrite(TRIGGER_PIN, HIGH); // Used To sets the digital output pin TRIGGER_PIN to a high voltage level, which corresponds to a logical value of 1.
delayMicroseconds(10); // Used To Set A 10 Micro-Second Delay
digitalWrite(TRIGGER_PIN, LOW); // Used To sets the digital output pin TRIGGER_PIN to a low voltage level, which corresponds to a logical value of 0.
// Read the signal from the sensor: a HIGH pulse whose
// duration is the time (in microseconds) from the sending
// of the ping to the reception of its echo off of an object.
duration = pulseIn(ECHO_PIN, HIGH); // Used To Measures The Duration Of A Pulse On A Digital Input Pin Echo_Pin.
distance = (duration / 2) / 29.1; // Used To convert the time into a distance
WH = (TH + IGH) - distance; // WH Is The Water Height In cm
P = (WH * 100) / TH; // P Is The Water Percentage
C = (P * TC) / 100; // C Is The Real Time Capacity Of The Water Tank
//=================================================================================================================================================================================================================================================================================================
if (P > 100 || P < 0) { // Used To Set An If Condition In Case The Water Rises More That 100%
Serial.print("The Water Is Leaking\n"); // Used For Showing Text In The Serial Monitor
}
else { // Used For The Resting Condition
Serial.print("Capacity: " + String(C) + " Liters\n"); // Used For Showing Text In The Serial Monitor
Serial.print("Percentage: " + String(P) + " %\n"); // Used For Showing Text In The Serial Monitor
Serial.print("Percentage: " + String(WH) + " cm\n"); // Used For Showing Text In The Serial Monitor
}
//=================================================================================================================================================================================================================================================================================================
if (P > 100 || P < 0) { // Used To Set An If Condition In Case The Water Rises More That 100%
display.clearDisplay(); // Used To Clear The Display
display.setTextSize(1); // Used To Set The Text's Size
display.setTextColor(WHITE); // Used To Set The Font's Color
display.setCursor(0, 0); // Used To Sets The Cursor Position For Text On The Display.
display.print("---------------------\n"); // Used For Showing Text On The Display
display.print(" W A R N I N G ! \n"); // Used For Showing Text On The Display
display.print(" Water Level > 100 % \n"); // Used For Showing Text On The Display
display.print("---------------------\n"); // Used For Showing Text On The Display
}
else { // Used For The Resting Condition
display.clearDisplay(); // Used To Clear The Display
display.setTextSize(2); // Used To Set The Text's Size
display.setTextColor(WHITE); // Used To Set The Font's Color
display.setCursor(0, 0); // Used To Sets The Cursor Position For Text On The Display.
display.println(" " + String(C) + " Ltr "); // Used For Showing Text On The Display
display.println(" " + String(WH) + " cm "); // Used For Showing Text On The Display
display.println(" " + String(P) + " % "); // Used For Showing Text On The Display
}
display.display(); // Used To Clear The Display
//=================================================================================================================================================================================================================================================================================================
webSocket.loop(); // Used to repeatedly processe incoming WebSocket messages and events on the WebSocket server.
server.handleClient(); // Used To processe incoming client requests on the HTTP server.
//=================================================================================================================================================================================================================================================================================================
static unsigned long l = 0; // Used To Track time intervals and retain their values across multiple iterations of the loop.
unsigned long t = millis(); // Used to track the starting time of an operation and calculate elapsed time using the millis() function.
if ((t - l) > 1000) // Used To Set An If Condition In Case The (t-l) > 1000
{
if (RELAYonoff == false) digitalWrite(RELAY, LOW); // Used to turn the Relay Off if the condition is off
else digitalWrite(RELAY, HIGH); // Used to turn the Relay On if the condition is on
String RELAYstatus = "OFF"; // Status of the Relay
if (RELAYonoff == true) RELAYstatus = "ON"; // sed to turn the Relay On if the condition is on
//=================================================================================================================================================================================================================================================================================================
String capacityvalString = String(C); // Used to give a value to a string
String percentagevalString = String(P); // Used to give a value to a string
//=================================================================================================================================================================================================================================================================================================
JSONtxt = "{\"capacity\":\"" + capacityvalString + "\","; // Used For generating a JSON-formatted string with a single key-value pair,
JSONtxt += "\"percentage\":\"" + percentagevalString + "\","; // where the value is the contents of a variable.This is a common way to transmit data between different
JSONtxt += "\"RELAYonoff\":\"" + RELAYstatus + "\"}"; // systems or components using a lightweight and widely supported data format.
webSocket.broadcastTXT(JSONtxt); // sends the JSON-formatted string as a text message to all connected clients.
} // This allows the clients to receive and process the message in a way
} // that is appropriate for their specific use case.
void handleRoot() //handle function: send webpage to client
{
server.send(200, "text/html", webpageCont); // Used To Sends An Http Response Back To The Client With The Specified Status Code, Content Type, And Content.
}
//=========================================================================================================================================================================
//function process event: new data received from client (its a callback function that is called by the WebSocketsServer library when a WebSocket event occurs.)
//"num" is an identifier for the WebSocket client that triggered the event
//"type" is the type of the event (e.g. WStype_TEXT for a text message)
//"payload" is a pointer to the message data
//"welength" is the length of the message data in bytes.
//=========================================================================================================================================================================
void webSocketEvent(uint8_t num, WStype_t type, uint8_t *payload, size_t welength)
{
String payloadString = (const char *)payload; // Used To converts a byte array (i.e., payload) into a String object (i.e., payloadString).
//=========================================================================================================================================================================
if (type == WStype_TEXT) // Used To checks whether the WebSocket event type is a text message (WStype_TEXT). If it is, then the code within the curly braces is executed.
{
byte separator = payloadString.indexOf('='); // Used To finds the index of the equals sign (=) in the payloadString. The equals sign is used as a separator between the key and value in the key-value pairs.
String var = payloadString.substring(0, separator); // Used To extracts the substring of the payloadString from the beginning of the string to the index of the separator. This substring represents the key in the key-value pair.
String val = payloadString.substring(separator + 1); // Used To extracts the substring of the payloadString from the index of the separator plus one to the end of the string. This substring represents the value in the key-value pair.
//=========================================================================================================================================================================
if (var == "RELAYonoff") // Used To check whether the key extracted from the payload is equal to the string. If it is, then the code within the curly braces is executed.
{
RELAYonoff = false; // Used To set the relay off variable to false by default. This variable is used to track whether the relay is turned on or off.
if (val == "ON") RELAYonoff = true; // Used To check whether the value extracted from the payload is equal to the string "ON". If it is, then the relay variable is set to true, indicating that the relay should be turned on.
}
}
}