🌟 ESP32-S3 Sensor Monitor

A powerful, feature-rich ESP32-S3 sensor monitoring system with real-time web interface, OTA updates, and RGB status indicators.

🚀 Quick Start • 📖 Documentation • 🎯 Features • 🤝 Contributing • 💬 Support

---

🎯 Features

🌐 Web Interface Clean, responsive dashboard Real-time sensor data visualization Mobile-friendly design RESTful API endpoints 📊 Sensor Management Multi-client sensor support Real-time data collection JSON-based data format Automatic client detection

🔧 System Management Over-the-air (OTA) firmware updates SPIFFS file system management Upload/download/delete files Static IP configuration 💡 Visual Feedback RGB LED status indicators Connection state visualization Sensor value representation Custom color control

---

🚀 Quick Start

⚡ One-Line Setup

git clone https://github.com/OmarTemsah99/ESP_WebSocket && cd ESP_WebSocket && pio run -t upload

📋 Prerequisites

• Hardware: ESP32-S3 Development Board
• LED: WS2812B RGB LED (NeoPixel)
• Software: PlatformIO IDE or CLI
• Network: WiFi connection

---

🛠️ Hardware Setup

📌 Pin Configuration

┌─────────────────┐
│    ESP32-S3     │
│                 │
│  GPIO 48 ──────┼──── WS2812B RGB LED
│                 │      (Data In)
│                 │
│  GND     ──────┼──── LED GND
│  3V3     ──────┼──── LED VCC
└─────────────────┘

🔌 Wiring Diagram

Component	ESP32-S3 Pin	Notes
WS2812B Data	GPIO 48	Digital signal
WS2812B VCC	3.3V	Power supply
WS2812B GND	GND	Ground connection

⚠️ Important: Ensure stable 3.3V power supply for reliable operation.

---

💻 Software Installation

1️⃣ Environment Setup

# Install PlatformIO CLI
pip install platformio

# Clone repository
git clone https://github.com/OmarTemsah99/ESP_WebSocket
cd ESP_WebSocket

2️⃣ Configuration

Create src/config.cpp:

#include "config.h"

// 📶 WiFi Settings
const char *WIFI_SSID = "YourWiFiNetwork";
const char *WIFI_PASSWORD = "YourWiFiPassword";

// 🌐 Network Configuration
const IPAddress STATIC_IP(192, 168, 1, 200);    // Device IP
const IPAddress GATEWAY(192, 168, 1, 1);        // Router IP
const IPAddress SUBNET(255, 255, 255, 0);       // Subnet mask
const IPAddress DNS_SERVER(8, 8, 8, 8);         // DNS server

3️⃣ Build & Upload

# 🔨 Build project
pio run

# 📤 Upload firmware (USB)
pio run -t upload -e esp32-s3-usb

# 💾 Upload web files
pio run -t uploadfs -e esp32-s3-usb

# 📡 Monitor serial output
pio device monitor

4️⃣ OTA Updates (After initial setup)

# Update IP in platformio.ini, then:
pio run -t upload -e esp32-s3-ota

---

🌐 Web Interface

📊 Dashboard (http://192.168.1.200/)

• Real-time Metrics: Live sensor data updates
• Client Management: View all connected sensors
• Status Monitoring: System health indicators
• LED Control: RGB color management

📈 Sensor Data Viewer (http://192.168.1.200/sensor_data)

• Live Refresh: Automatically updates every 200ms
• Detailed Display:
• IP Address
• Client ID
• Sensor Value
• Error Handling: Displays fallback message on failure
• Clean UI: Styled via shared /styles.css
• Navigation: Includes back button to main dashboard

📁 File Manager (http://192.168.1.200/upload)

• Upload Files: Drag & drop interface
• File Browser: View SPIFFS contents
• Download: Retrieve stored files
• Delete: Remove unwanted files

🔄 Firmware Update (http://192.168.1.200/firmware)

• OTA Updates: Upload new firmware
• Progress Tracking: Real-time update status
• Rollback Support: Automatic recovery
• Verification: Checksum validation

---

🚨 LED Status Guide

LED Color	Status	Description
🔴 Red	Disconnected	No WiFi connection
🔵 Blue (Blinking)	Connecting	Attempting WiFi connection
🟢 Green	Connected	Ready and operational
🔵 Blue (Solid)	Sensor Active	Sensor value = 1
🔴 Red (Solid)	Sensor Inactive	Sensor value = 0

---

🔗 API Reference

📤 Send Sensor Data

POST /sensor
Content-Type: application/x-www-form-urlencoded

clientId=sensor1&value=1

Response: 200 OK

📥 Get Sensor Data

GET /sensorData

Response:

{
  "192.168.1.100": {
    "clientId": "sensor1",
    "value": 1,
    "timestamp": "2025-06-23T10:30:00Z"
  }
}

🎨 Control LED

GET /color?r=255&g=128&b=0

Parameters:

• r: Red value (0-255)
• g: Green value (0-255)
• b: Blue value (0-255)

📂 File Operations

GET /list                    # List all files
POST /delete?file=config.txt # Delete specific file
POST /upload                 # Upload file (multipart/form-data)

---

🏗️ Project Structure

ESP_WebSocket/
├── 📁 data/                    # Web interface files
│   ├── 🌐 index.html          # Main dashboard
│   ├── 📁 file_manager.html   # File management
│   ├── 🔄 firmware_update.html # OTA interface
│   └── 🎨 styles.css          # Styling
├── 📁 include/                # Header files
│   ├── ⚙️ config.h           # Configuration
│   ├── 💡 led_controller.h   # LED management
│   ├── 📊 sensor_manager.h   # Sensor handling
│   ├── 🌐 web_handlers.h     # Web routes
│   ├── 📶 wifi_manager.h     # Network management
│   └── 💾 filesystem_utils.h # File operations
├── 📁 src/                   # Source code
│   ├── 🚀 main.cpp          # Main application
│   ├── 💡 led_controller.cpp
│   ├── 📊 sensor_manager.cpp
│   ├── 🌐 web_handlers.cpp
│   ├── 📶 wifi_manager.cpp
│   └── 💾 filesystem_utils.cpp
└── ⚙️ platformio.ini        # Build configuration

---

⚙️ Configuration Options

🔧 Hardware Customization

// config.h
#define RGB_LED_PIN 48        // GPIO pin for RGB LED
#define NUM_PIXELS 1          // Number of LEDs
#define LED_BRIGHTNESS 100    // Brightness (0-255)

⏱️ Timing Settings

#define RECONNECT_INTERVAL 10000    // WiFi reconnect delay (ms)
#define SENSOR_UPDATE_INTERVAL 50   // Sensor refresh rate (ms)
#define WEB_SERVER_TIMEOUT 5000     // HTTP timeout (ms)

🌐 Network Configuration

#define WEB_SERVER_PORT 80          // HTTP server port
#define OTA_PORT 3232              // OTA update port
#define MAX_CLIENTS 10             // Maximum concurrent clients

---

🎯 Use Cases

🏠 Home Automation

• Temperature monitoring
• Motion detection
• Light control
• Security systems

🏭 Industrial IoT

• Equipment monitoring
• Environmental sensing
• Predictive maintenance
• Data logging

🌱 Agriculture

• Soil moisture monitoring
• Weather station
• Greenhouse automation
• Irrigation control

🔬 Research & Education

• Sensor data collection
• IoT prototyping
• Remote monitoring
• Educational projects

---

🚀 Advanced Features

📈 Performance Optimization

• Memory Management: Efficient SPIFFS usage
• Power Efficiency: Deep sleep support ready
• Network Optimization: Keep-alive connections
• Real-time Updates: WebSocket ready architecture

🔒 Security Features

• OTA Security: Password-protected updates
• Access Control: IP-based restrictions ready
• Data Validation: Input sanitization
• Secure Headers: CORS and security headers

🔧 Extensibility

• Modular Design: Easy feature addition
• Plugin Architecture: Sensor plugin support
• Custom Protocols: Multiple communication options
• Database Integration: Ready for external databases

---

🐛 Troubleshooting

🔍 WiFi Connection Issues

Problem: Device not connecting to WiFi

Solutions:

1. ✅ Verify credentials in config.cpp
2. ✅ Check signal strength (LED should blink blue)
3. ✅ Confirm 2.4GHz network (ESP32 doesn't support 5GHz)
4. ✅ Reset network settings: Hold reset during power-on

Debug Commands:

Serial.println("WiFi Status: " + String(WiFi.status()));
Serial.println("RSSI: " + String(WiFi.RSSI()));

💾 SPIFFS Mount Failed

Problem: Web interface not loading

Solutions:

1. ✅ Upload filesystem: pio run -t uploadfs
2. ✅ Format SPIFFS via serial monitor
3. ✅ Check partition table in platformio.ini
4. ✅ Verify file sizes don't exceed partition

Recovery:

# Force filesystem upload
pio run -t uploadfs --force

🔄 OTA Update Failed

Problem: Firmware update not working

Solutions:

1. ✅ Ensure stable power supply (use USB power)
2. ✅ Check IP address in platformio.ini
3. ✅ Verify .bin file integrity
4. ✅ Close other applications using the network

Prevention:

// Add to main.cpp for better OTA reliability
ArduinoOTA.setRebootOnSuccess(true);
ArduinoOTA.setTimeout(30000);

💡 LED Not Working

Problem: RGB LED not responding

Solutions:

1. ✅ Check wiring (GPIO 48, VCC, GND)
2. ✅ Verify power supply (3.3V stable)
3. ✅ Test with different LED
4. ✅ Check pin configuration in config.h

Test Code:

// Add to setup() for LED testing
pixels.setPixelColor(0, pixels.Color(255, 0, 0)); // Red
pixels.show();

---

📊 Performance Metrics

Metric	Value	Notes
Boot Time	~3-5 seconds	Including WiFi connection
Memory Usage	~180KB RAM	With web server active
Flash Usage	~1.2MB	Including SPIFFS data
Power Consumption	~150mA	At 3.3V with LED
WiFi Range	~50m indoor	Depends on environment
Update Rate	20Hz	Sensor data refresh
Concurrent Clients	10+	Web interface users
File Upload Size	1MB max	SPIFFS limitation

---

🔮 Roadmap

🎯 Version 2.0 (Planned)

• WebSocket Support: Real-time bidirectional communication
• Database Integration: SQLite for data persistence
• Multi-sensor Support: I2C/SPI sensor integration
• Advanced Visualization: Charts and graphs
• Mobile App: Companion mobile application

🚀 Version 3.0 (Future)

• Machine Learning: On-device sensor prediction
• Mesh Networking: ESP-NOW multi-device support
• Cloud Integration: AWS/Azure IoT connectivity
• Voice Control: Alexa/Google Assistant integration

---

🤝 Contributing

We welcome contributions! Here's how you can help:

🐛 Bug Reports

Found a bug? Open an issue with:

• Detailed description
• Steps to reproduce
• Expected vs actual behavior
• Serial monitor output
• Hardware configuration

💡 Feature Requests

Have an idea? Create a feature request with:

• Clear description of the feature
• Use cases and benefits
• Implementation suggestions
• Mockups or examples (if applicable)

🔧 Code Contributions

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 Documentation

• Improve README sections
• Add code comments
• Create tutorials
• Fix typos and grammar

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License - Free for personal and commercial use

---

🌟 Showcase

✨ Official Project Overview

Get a comprehensive look at the ESP32-S3 Sensor Monitor's features and operation:

https://drive.google.com/drive/folders/1sLqX2KvURR44xT6yc-h5InCnI4ER0E39?usp=sharing
*Click to watch the Project Overview Demo*

🏆 Featured Projects

Using ESP32-S3 Sensor Monitor

• Smart Garden Monitor - Automated plant care system
• Home Security Hub - Multi-sensor security monitoring
• Weather Station - Environmental data collection
• Industrial Monitor - Equipment health tracking

Want your project featured? Submit your implementation!

---

💬 Support

🆘 Get Help

• 📖 Documentation: Check this README first
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📧 Direct Contact: Open an issue for project-specific questions

🌐 Community

• 👥 Contributors: See Contributors
• ⭐ Star this repository if it helped you!
• 🍴 Fork to create your own version
• 📢 Share with the community

---

🎉 Thank you for using ESP32-S3 Sensor Monitor!

Made with ❤️ by OmarTemsah99

⬆️ Back to Top