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

https://github.com/nna301023/seagrow

FINAL PROJECT ELEKTRO 2021
https://github.com/nna301023/seagrow

iot machine-learning microcontroller time-series

Last synced: 6 months ago
JSON representation

FINAL PROJECT ELEKTRO 2021

Awesome Lists containing this project

README

          

# 🌊 Aquaculture Monitoring System

## Overview

A cutting-edge, real-time monitoring and control system designed to revolutionize aquaculture management. This comprehensive solution leverages modern web technologies to provide seamless, intelligent monitoring of aquatic environments.

![System Architecture](https://img.shields.io/badge/Architecture-Microservices-blue)
![Python Version](https://img.shields.io/badge/Python-3.8+-green)
![Docker](https://img.shields.io/badge/Containerization-Docker-blue)
![License](https://img.shields.io/badge/License-MIT-yellow)

## 🚀 Key Features

### Real-Time Environmental Monitoring
- **Comprehensive Sensor Tracking**
- Water temperature monitoring
- Salinity level detection
- Acidity (pH) measurement
- Instant alerts for parameter deviations

### Advanced Control Capabilities
- Interactive web-based control panel
- Precision parameter adjustments
- Automated scheduling for aquaculture cycles

### Data Management
- Robust historical data logging
- Comprehensive data visualization
- WebSocket-powered real-time updates

## 🛠 Tech Stack

| Category | Technologies |
|----------|--------------|
| Backend | ![Flask](https://img.shields.io/badge/Flask-Framework-red) ![SocketIO](https://img.shields.io/badge/SocketIO-Realtime-green) |
| Message Broker | ![Redis](https://img.shields.io/badge/Redis-MessageQueue-red) |
| Frontend | ![HTML5](https://img.shields.io/badge/HTML5-Markup-orange) ![JavaScript](https://img.shields.io/badge/JavaScript-ES6-yellow) |
| Containerization | ![Docker](https://img.shields.io/badge/Docker-Containers-blue) |

## 🔧 Prerequisites

Before you begin, ensure you have the following installed:
- 🐳 Docker & Docker Compose
- 🐍 Python 3.8 or higher
- 📦 Redis server

## 💻 Installation & Setup

### Quick Start with Docker

```bash
# Clone the repository
git clone https://github.com/yourusername/aquaculture-monitoring.git
cd aquaculture-monitoring

# Build and launch containers
docker-compose up -d
```

### Local Development Setup

```bash
# Install dependencies
pip install -r requirements.txt

# Run the application
python app.py
```

## 📂 Project Structure

```
aquaculture-monitoring/

├── app.py # Main application entry point
├── data_generator.py # Simulated sensor data generation
├── docker-compose.yml # Docker service configurations
├── requirements.txt # Python package dependencies

└── src/
└── templates/ # Web interface templates
├── monitoring.html
├── control.html
└── input_schedule.html
```

## 🌐 API Endpoints

| Endpoint | Method | Description |
|----------|--------|-------------|
| `/api/parameters` | GET | Retrieve current sensor parameters |
| `/api/parameters` | POST | Update sensor parameters |
| `/api/schedules` | GET | Fetch all aquaculture schedules |
| `/api/schedules` | POST | Create a new schedule |
| `/api/schedules` | DELETE | Reset all schedules |
| `/api/sensor_history` | GET | Access historical sensor data |

## 🔌 WebSocket Events

- `connect`: Establishes client connection
- `sensor_data`: Streams real-time sensor updates
- `disconnect`: Handles client disconnection

## 🌍 Configuration

### Environment Variables
No additional configuration required. Default Redis connection: `localhost:6379`

## 🤝 Contributing

We welcome contributions! Please follow these steps:

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

## 📄 License

Distributed under the MIT License. See `LICENSE` for more information.

## 🙏 Acknowledgments

- Flask & Flask-SocketIO Communities
- Redis Open Source Project
- Passionate Aquaculture Innovators

---

**Built with ❤️ for the Future of Sustainable Aquaculture**