🏠 SmartSense Home

A modern, scalable IoT platform for monitoring and controlling ESP32-based devices through a beautiful web dashboard.

---

📖 Overview

SmartSense Home is a complete, production-ready IoT platform that enables users to:

• 📊 Monitor real-time sensor data from ESP32 devices
• 🎛️ Control IoT devices remotely via intuitive web interface
• 👥 Manage multiple devices from a single dashboard
• 🔐 Secure multi-user authentication system
• 📡 Communicate via REST API (no MQTT broker required)

Perfect for home automation, environmental monitoring, smart sensors, and IoT prototyping!

---

✨ Features

Backend

• ⚡ Fast PHP 8+ REST API
• 🔒 Secure authentication (bcrypt password hashing)
• 🗄️ MySQL database with optimized schema
• 🛡️ SQL injection protection (prepared statements)
• 📝 Input validation and sanitization
• 🔑 Token-based device authentication

Frontend

• 🎨 Clean, modern UI/UX
• 📱 Fully responsive design
• ⚡ Real-time data updates
• 📊 Data visualization (tables + graphs)
• 🎛️ Device control interface
• 🌙 No frameworks - pure vanilla JavaScript

ESP32

• 📡 WiFi connectivity
• 🔄 Automatic reconnection
• 📤 Batch data transmission
• 📥 Command polling & execution
• 💡 Built-in LED control example
• 🌡️ DHT22 sensor support (optional)

---

🚀 Quick Start

Prerequisites

• XAMPP (Apache + PHP 8.0+ + MySQL)
• Arduino IDE with ESP32 support
• ESP32-C3 Super Mini (or compatible board)

Installation

1. Clone the repository

   git clone https://github.com/scrozza2007/smartsense-home.git
   cd smartsense-home

2. Setup database

   • Copy project to xampp/htdocs/
   • Open phpMyAdmin: http://localhost/phpmyadmin
   • Create database: smartsense_home
   • Import: database/schema.sql

3. Configure backend

   • Verify settings in backend/config/database.php
   • Default: root user, no password (XAMPP default)

4. Access web app

   • Open: http://localhost/smartsense-home/frontend/
   • Create account and login
   • Add your first device

5. Setup ESP32

   • Install libraries: ArduinoJson
   • Configure WiFi in esp32/smartsense_device/smartsense_device.ino
   • Set server IP and device token
   • Upload to ESP32

📖 Detailed guide: docs/INSTALLATION.md

---

📁 Project Structure

smartsense-home/
├── backend/                 # PHP backend
│   ├── api/
│   │   ├── auth/           # Authentication endpoints
│   │   ├── devices/        # Device management
│   │   └── device/         # ESP32 communication
│   ├── config/             # Database configuration
│   └── includes/           # Utility functions
├── frontend/               # Web dashboard
│   ├── assets/
│   │   ├── css/           # Stylesheets
│   │   └── js/            # JavaScript modules
│   ├── index.html         # Login page
│   ├── register.html      # Registration page
│   └── dashboard.html     # Main dashboard
├── esp32/                  # Arduino sketches
│   └── smartsense_device/ # ESP32-C3 firmware
├── database/               # SQL schema
│   └── schema.sql
├── docs/                   # Documentation
│   ├── API.md             # API reference
│   ├── ESP32_SETUP.md     # ESP32 guide
│   └── INSTALLATION.md    # Setup instructions
├── .gitignore
└── README.md

---

🎯 Usage

Web Dashboard

1. Register/Login

   • Create account with username, email, password
   • Login to access dashboard

2. Add Device

   • Click "Add Device"
   • Enter device name (e.g., "Living Room Sensor")
   • Save the device token! (needed for ESP32)

3. View Data

   • Click on device card to view sensor data
   • Latest values shown at top
   • Historical data in table below
   • Auto-refreshes every 10 seconds

4. Send Commands

   • Select command type (LED, RELAY, etc.)
   • Enter value (ON, OFF, TOGGLE)
   • Click "Send"
   • ESP32 executes command within seconds

ESP32 Device

Configuration:

const char* WIFI_SSID = "YourWiFiName";
const char* WIFI_PASSWORD = "YourPassword";
const char* API_BASE_URL = "http://192.168.1.100/smartsense-home/backend/api";
const char* DEVICE_TOKEN = "your_device_token_from_dashboard";

Features:

• Sends sensor data every 30 seconds (configurable)
• Polls for commands every 5 seconds (configurable)
• Built-in LED control on GPIO8
• Automatic WiFi reconnection
• Detailed serial output for debugging

---

🔌 API Endpoints

Authentication

• POST /api/auth/register - Create account
• POST /api/auth/login - Login
• POST /api/auth/logout - Logout

Device Management

• GET /api/devices/list - List user devices
• POST /api/devices/create - Add new device
• GET /api/devices/data - Get device data
• POST /api/devices/command - Send command

ESP32 Communication

• POST /api/device/send_data - Submit sensor data
• GET /api/device/get_commands - Poll for commands
• POST /api/device/update_command - Update command status

📖 Full API documentation: docs/API.md

---

🛠 Technology Stack

Component	Technology
Backend	PHP 8+, PDO, MySQL
Frontend	HTML5, CSS3, JavaScript (ES6+)
Database	MySQL 5.7+ / MariaDB 10.3+
Hardware	ESP32-C3 Super Mini
Firmware	Arduino (C++), ArduinoJson
Server	Apache 2.4+ (XAMPP)

---

📊 Database Schema

users
├── id
├── username
├── email
├── password_hash
└── created_at

devices
├── id
├── user_id (FK → users)
├── device_name
├── device_token (unique)
├── is_online
└── last_seen

sensor_data
├── id
├── device_id (FK → devices)
├── sensor_type
├── sensor_value
├── unit
└── timestamp

commands
├── id
├── device_id (FK → devices)
├── command_type
├── command_value
├── status (pending/executed/failed)
└── created_at

---

🔐 Security Features

✅ Password Security

• Bcrypt hashing (cost factor 10)
• Salted hashes

✅ Database Security

• Prepared statements (SQL injection protection)
• Input validation and sanitization
• Foreign key constraints

✅ API Security

• Session-based authentication
• Device token authentication
• Access control (users only see their devices)

✅ Best Practices

• HTTPS ready (configure SSL certificate)
• CORS headers configured
• XSS protection via htmlspecialchars()

---

🎨 Screenshots

Login Page

Clean authentication interface with registration option.

Dashboard

Device cards, real-time data, command controls

Device Data View

Latest values, historical data table, command interface

---

🧪 Testing

Manual API Testing

# Register user
curl -X POST http://localhost/smartsense-home/backend/api/auth/register.php \
  -H "Content-Type: application/json" \
  -d '{"username":"test","email":"test@example.com","password":"test123"}'

# Login
curl -X POST http://localhost/smartsense-home/backend/api/auth/login.php \
  -H "Content-Type: application/json" \
  -d '{"username":"test","password":"test123"}' \
  -c cookies.txt

# List devices
curl -X GET http://localhost/smartsense-home/backend/api/devices/list.php \
  -b cookies.txt

ESP32 Testing

1. Upload code to ESP32
2. Open Serial Monitor (115200 baud)
3. Verify:
   • WiFi connection ✓
   • Data sending (HTTP 201) ✓
   • Command polling ✓
   • LED control ✓

---

📚 Documentation

• 📘 Installation Guide - Complete setup instructions
• 📗 API Reference - REST API documentation
• 📙 ESP32 Setup - Hardware configuration

---

🔧 Customization

Add Custom Sensor

// In ESP32 code
JsonObject custom = readings.createNestedObject();
custom["sensor_type"] = "soil_moisture";
custom["sensor_value"] = String(analogRead(A0));
custom["unit"] = "%";

Add New Command Type

// In executeCommand()
} else if (type == "RELAY") {
    digitalWrite(RELAY_PIN, value == "ON" ? HIGH : LOW);
    Serial.println("✓ Relay controlled");
}

Change Update Intervals

const unsigned long DATA_SEND_INTERVAL = 60000;  // 1 minute
const unsigned long COMMAND_CHECK_INTERVAL = 10000;  // 10 seconds

---

🐛 Troubleshooting

Issue	Solution
Database connection failed	Check MySQL is running, verify credentials
API returns 404	Ensure files in correct htdocs location
ESP32 won't connect	Verify WiFi credentials, use 2.4GHz network
Device token invalid	Copy token exactly from dashboard
Data not appearing	Check Serial Monitor for HTTP response codes

📖 More help: docs/INSTALLATION.md#troubleshooting

---

🛣️ Roadmap

• Data export (CSV, JSON)
• Email/SMS alerts on sensor thresholds
• Device groups and automation rules
• Mobile app (React Native)
• MQTT support (optional alternative)
• WebSocket for real-time updates
• Charts and data visualization
• Device firmware OTA updates

---

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

---

📄 License

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

---

👨‍💻 Author

scrozza2007

• GitHub: @scrozza2007

---

🙏 Acknowledgments

• Inspired by platforms like Blynk and ThingsBoard
• ESP32 community for amazing support
• ArduinoJson library by Benoit Blanchon
• All contributors and testers

---

⭐ Star History

If you find this project useful, please consider giving it a star! ⭐

---

📞 Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

---

Made with ❤️ for the IoT community

Report Bug · Request Feature · Documentation