Smart Irrigation System 🌱💧

A modular, extensible smart irrigation controller in Python
Decides intelligently when to water plants by combining soil moisture levels with rain probability forecasts — ideal for Raspberry Pi, ESP32, simulators, or any IoT setup.

✨ Features

• Configurable moisture & rain probability thresholds
• Simulated sensors (easy to replace with real hardware like capacitive soil sensors, DHT22, etc.)
• Dry-run / simulation mode (no hardware needed for development & testing)
• Structured logging + basic CLI interface
• Clean architecture ready for extensions:
  • Real weather APIs (OpenWeatherMap, WeatherAPI, etc.)
  • MQTT publishing/subscribing
  • GPIO control (RPi.GPIO, adafruit libraries)
  • Database storage (SQLite, InfluxDB)
  • Web dashboard (future)

📋 Table of Contents

• Features
• Project Structure
• Prerequisites
• Installation
• Quick Start
• Usage Examples
• Configuration
• Testing
• Contributing
• License

Project Structure

smart-irrigation-platform/ │ ├── src/ # Main source code │ ├── init.py │ ├── main.py # Entry point │ ├── core/ │ │ ├── init.py │ │ └── irrigation_system.py # Core business logic │ ├── sensors/ │ │ ├── init.py │ │ └── soil_moisture.py # Sensor abstractions │ ├── weather/ │ │ ├── init.py │ │ └── weather_service.py # Weather data (simulated or API) │ └── utils/ │ ├── init.py │ └── logger.py # Centralized logging │ ├── tests/ # Unit & integration tests │ ├── init.py │ └── test_irrigation_system.py │ ├── config/ │ └── config.py # Configuration (thresholds, etc.) │ ├── .env # Environment variables (not in git) ├── .env.example # Template for .env ├── .gitignore ├── README.md ├── requirements.txt ├── setup.py # Optional: for packaging └── LICENSE

🛠 Prerequisites

• Python 3.8+
• Git
• (Optional) Virtual environment tool: venv, uv, poetry, etc.

🚀 Installation

1. Clone the repository:

   git clone https://github.com/bundlab/smart_irrigation_sys.git
   cd smart_irrigation_sys
   

⚡ Quick Start

Run the simulation python -m smart_irrigation

[INFO] Soil moisture: 42% | Rain probability: 15% [INFO] Decision: NO irrigation needed

▶️ Usage Examples

1. Simulate custom conditions python -m smart_irrigation --simulate --moisture=25 --rain-prob=60

2. Run once (good for scheduled tasks) python -m smart_irrigation --once

3. Verbose mode python -m smart_irrigation --verbose

⚙️ Configuration

cp src/smart_irrigation/config.example.yaml config.yaml Example config.yml thresholds: moisture_critical: 30 # below → must water moisture_warning: 45 rain_skip_probability: 40 # above → skip

🧪 Testing

pytest # run tests pytest --cov # with coverage black . # format ruff check --fix # lint & fix

🤝 Contributing

• Fork the repo
• Create your branch (git checkout -b feature/cool-feature)
• Commit (git commit -m 'Add cool feature')
• Push (git push origin feature/cool-feature)
• Open a Pull Request Follow black formatting & add tests where possible.

📄 License

• MIT License — see LICENSE for details.