An open API service indexing awesome lists of open source software.

https://github.com/desiFish/Smart-Aquarium-V2.0

Using NodeMCU ESP8266 for controlling switches (Relay). Uses RTC (Real Time Clock - DS3231) and NTP (Network Time Protocol) for maintaining time. OLED Display (128x64) for instant updates. A webserver for Manual Controls. Vast application including Aquariums and IOT related.
https://github.com/desiFish/Smart-Aquarium-V2.0

aquarium-automation aquarium-controller arduino diy ds3231-arduino ds3231-rtc iot nodemcu-arduino nodemcu-arduino-ide nodemcu-esp8266 nodemcu-httpserver nodemcu-lua ntp oled oled-display-ssd1306 ota-update relay-switch webserver

Last synced: about 2 months ago
JSON representation

Using NodeMCU ESP8266 for controlling switches (Relay). Uses RTC (Real Time Clock - DS3231) and NTP (Network Time Protocol) for maintaining time. OLED Display (128x64) for instant updates. A webserver for Manual Controls. Vast application including Aquariums and IOT related.

Awesome Lists containing this project

README

        

🌊 Smart Aquarium V2.0 🐠

![GitHub last commit](https://img.shields.io/github/last-commit/desifish/Smart-Aquarium-V2.0?style=for-the-badge&color=green)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)
![Project Status: Closed](https://img.shields.io/badge/Project%20Status-Closed-red?style=for-the-badge)

🎛️ IoT-Based Aquarium Automation System


Control your aquarium using a web interface!


> ⚠️ **CAUTION**: This project involves working with electrical components and may require handling of high voltage connections. Always prioritize safety, use proper insulation, and consult with a qualified electrician if you're unsure about any aspect of the installation or operation.

> 📢 **NOTE**: This project (V2.0) is now closed. For the latest updates and improvements, please check out [Smart Aquarium V3.0](https://github.com/desiFish/Smart-Aquarium-V3.0).

## ✨ Features

- 🌐 Web-based control interface
- ⏰ Automated timing controls
- 🌡️ Real-time temperature monitoring
- 💡 Smart lighting control
- 🔄 Power-saving modes
- 📱 Mobile-responsive design
- 🔄 OTA (Over-The-Air) updates
- ⚡ Low latency control

## 🛠️ Hardware Required

Component
Image
Purpose

NodeMCU ESP8266

Main controller with WiFi capabilities

DS3231 RTC Module

Accurate time keeping

OLED Display

Status display

4-Channel Relay

Control aquarium equipment

## 📥 Installation

```bash
# Clone this repository
git clone https://github.com/desifish/Smart-Aquarium-V2.0.git

# Navigate to the directory
cd Smart-Aquarium-V2.0

# Open in Arduino IDE
# Update WiFi credentials in aqua_NODEMCU.ino
# Flash to NodeMCU
```

> **Important**: The favicon image inside the `data` folder needs to be copied into the flash storage of the NodeMCU. This ensures the web interface can properly display the favicon. For instructions on how to upload files to the ESP8266 filesystem using LittleFS, please refer to [this updated guide](https://randomnerdtutorials.com/install-esp8266-nodemcu-littlefs-arduino/).

## 📝 Documentation

📌 Version History

- v1.12 - Added Power Saver Mode
- v1.11 - Updated UI with customizable timers
- v1.10 - Added auto-start relay feature
- v1.9 - Added web-based time updates
- v1.8 - Added Auto/Manual Control

🔌 Wiring Diagram

```
NodeMCU ESP8266 -> OLED Display
D1 -> SCL
D2 -> SDA
3.3V -> VCC
GND -> GND

NodeMCU ESP8266 -> DS3231
D1 -> SCL
D2 -> SDA
3.3V -> VCC
GND -> GND

NodeMCU ESP8266 -> 4 Channel Relay
D0 -> IN1
D6 -> IN2
D7 -> IN3
D5 -> IN4
5V -> VCC
GND -> GND
```

## 📱 Web Interface

The system provides an intuitive web interface accessible from any device on your network:

- 💻 Desktop View
- 📱 Mobile-Responsive
- 🎛️ Real-time Controls
- 📊 Status Monitoring

### Web Interface
Web Interface

## 🔒 License

This project is licensed under GPL-3.0 License - see the [LICENSE](LICENSE) file for details.

### GNU General Public License v3.0

License Details

Permissions:
- ✅ Commercial use
- ✅ Modification
- ✅ Distribution
- ✅ Patent use
- ✅ Private use

Conditions:
- 📝 License and copyright notice
- 📄 State changes
- 📦 Disclose source
- 📜 Same license

Limitations:
- ❌ Liability
- ❌ Warranty

---

Made with ❤️ for the IoT Community

[![Follow on GitHub](https://img.shields.io/github/followers/desifish?style=social)](https://github.com/desifish)