{"id":28214652,"url":"https://github.com/opensensor/growmax","last_synced_at":"2025-10-12T13:06:25.884Z","repository":{"id":65002755,"uuid":"579775699","full_name":"opensensor/growmax","owner":"opensensor","description":"MicroPython firmware for the GrowMax automation board - a complete IoT solution for precision agriculture and greenhouse management. Features 8-channel moisture sensing, MOSFET-driven pump control, environmental monitoring (CO2, temperature, humidity, pH), and cloud integration with OpenSensor.io for real-time data visualization and remote control.","archived":false,"fork":false,"pushed_at":"2025-06-28T13:57:08.000Z","size":479,"stargazers_count":27,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-01T16:53:02.361Z","etag":null,"topics":["automation","plant-monitoring","plant-watering","plant-wateringsystem","raspberry-pi-pico","sensors"],"latest_commit_sha":null,"homepage":"https://www.OpenSensor.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensensor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-12-18T21:50:45.000Z","updated_at":"2025-09-25T14:32:45.000Z","dependencies_parsed_at":"2025-08-26T11:35:29.055Z","dependency_job_id":"b0c23e6d-a218-4e18-918e-b4779262ff1e","html_url":"https://github.com/opensensor/growmax","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/opensensor/growmax","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensensor%2Fgrowmax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensensor%2Fgrowmax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensensor%2Fgrowmax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensensor%2Fgrowmax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensensor","download_url":"https://codeload.github.com/opensensor/growmax/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensensor%2Fgrowmax/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279011469,"owners_count":26084947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","plant-monitoring","plant-watering","plant-wateringsystem","raspberry-pi-pico","sensors"],"created_at":"2025-05-17T21:08:10.521Z","updated_at":"2025-10-12T13:06:25.867Z","avatar_url":"https://github.com/opensensor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌱 GrowMax - Smart Plant Watering Automation\n\n**Micropython library for automated plant watering and environmental monitoring**\n\n[![GitHub Stars](https://img.shields.io/github/stars/opensensor/growmax?style=social)](https://github.com/opensensor/growmax)\n[![PyPI Version](https://img.shields.io/pypi/v/growmax)](https://pypi.org/project/growmax/)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\nTransform your plant care with intelligent automation! GrowMax provides everything you need to build a sophisticated plant monitoring and watering system using affordable microcontrollers.\n\n![GrowMax Board with Screen and CO2 Sensor](https://github.com/opensensor/growmax/blob/main/images/growmax_install_with_screen.jpg)\n\n## 🚀 Why Choose GrowMax?\n\n- **🎯 Plug \u0026 Play**: Get started in minutes with pre-configured settings\n- **🔧 Highly Configurable**: 20+ configuration options for any setup\n- **📊 Multi-Sensor Support**: Soil moisture, pH, CO2, water level monitoring\n- **💧 Smart Watering**: Automated pumping with safety features\n- **📱 Remote Monitoring**: WiFi connectivity with cloud data collection\n- **🖥️ Visual Feedback**: OLED display support with motion activation\n- **⚡ Power Efficient**: Designed for 24/7 operation\n- **🛡️ Safety First**: Built-in water level checks and pump protection\n\n## 🛒 Get Your Hardware\n\nPurchase GrowMax boards and complete kits at **[opensensor.io](https://opensensor.io)**\n\n## ⚡ Quick Start\n\n### 1. Install Firmware\nChoose your microcontroller:\n- **Raspberry Pi Pico**: [Download Firmware](https://micropython.org/download/rp2-pico/)\n- **Raspberry Pi Pico W**: [Download Firmware](https://micropython.org/download/rp2-pico-w/)\n- **ESP32S3 (BananaPi)**: [See ESP32S3 Setup Guide](docs/bpi_esp32s3.md)\n\n### 2. Install GrowMax Library\n1. Install [Thonny IDE](https://thonny.org/)\n2. Connect your device and launch Thonny\n3. Go to **Tools → Manage Packages**\n4. Search for `growmax` and install the latest version\n\n### 3. Create Your Main Program\nCreate `main.py` on your device:\n```python\nfrom growmax.routine import main\n\nmain()\n```\n\n### 4. Configure Your System\n1. Copy `/lib/growmax/config.py` to your device root as `config.py`\n2. Customize settings for your setup (see [Configuration Guide](docs/configuration-reference.md))\n3. Run `main.py` in Thonny to test\n\n### 5. Deploy\nConnect 5V USB power - your system is now autonomous! 🎉\n\n## 📖 Documentation\n\n| Guide | Description |\n|-------|-------------|\n| [🚀 Quick Start](docs/quick-start.md) | Get running in 10 minutes |\n| [⚙️ Configuration Reference](docs/configuration-reference.md) | Complete settings guide |\n| [🔧 Hardware Setup](docs/instructions.md) | Assembly and connections |\n| [💡 Examples](docs/examples/) | Real-world use cases |\n| [🔍 Troubleshooting](docs/troubleshooting.md) | Common issues \u0026 solutions |\n| [📚 API Reference](docs/api-reference.md) | Technical documentation |\n\n## 🌟 Key Features\n\n### 💧 Smart Watering System\n- **8-channel soil moisture monitoring** with individual thresholds\n- **Automated pump control** with configurable duration\n- **Water level safety checks** prevent dry pumping\n- **High-power pump support** via I2C relay boards\n\n### 📊 Environmental Monitoring\n- **CO2 monitoring** with Adafruit SCD4X sensors\n- **pH measurement** using Atlas Scientific probes\n- **Temperature and humidity** tracking\n- **Real-time data logging** to OpenSensor.io cloud\n\n### 🖥️ Display \u0026 Interface\n- **OLED display support** (SSD1327, SH1107)\n- **Motion-activated display** for power efficiency\n- **Real-time status updates** showing all sensor readings\n- **Visual pump and sensor status** indicators\n\n### 🌐 Connectivity \u0026 Remote Control\n- **WiFi connectivity** for remote monitoring\n- **Cloud data collection** with opensensor.io integration\n- **Remote pump control** (experimental feature)\n- **Device management** through web dashboard\n\n## 🔧 Basic Configuration\n\nHere are the most commonly used settings:\n\n```python\n# Soil moisture threshold (0-28, lower = wetter)\nSOIL_WET_THRESHOLD = 10\n\n# Enable water level safety check\nWATER_SENSOR_LOW_ENABLED = True\nWATER_SENSOR_LOW = 22  # GPIO pin\n\n# Pump settings\nPUMP_WHEN_DRY = False  # Safety: only pump when water detected\nPUMP_CYCLE_DURATION = 30  # seconds\n\n# WiFi for remote monitoring\nWIFI_ENABLED = True\nWIFI_SSID = \"YourNetwork\"\nWIFI_PASSWORD = \"YourPassword\"\n```\n\nSee the [complete configuration guide](docs/configuration-reference.md) for all 20+ options.\n\n## 🏗️ Example Setups\n\n### 🌿 Basic Single Plant\nPerfect for beginners - monitor and water one plant automatically.\n\n### 🏡 Home Garden (8 Plants)\nFull 8-channel setup with individual moisture thresholds per plant.\n\n### 🏭 Greenhouse Monitoring\nAdvanced setup with CO2, pH, temperature monitoring and cloud logging.\n\n### 💪 High-Power Irrigation\nUsing relay boards to control large pumps and irrigation systems.\n\n[View detailed examples →](docs/examples/)\n\n## ⚡ Power \u0026 Safety\n\n**Important Safety Information:**\n- **Pico Power Limit**: 300mA max current (shared 5V rail)\n- **Onboard Pumps**: Use 5V pumps drawing \u003c200mA each\n- **Higher Power Applications**: Require I2C relay boards (not direct connection)\n- **Water Sensors**: Designed for Optomax liquid sensors with 4V→3.3V conversion\n- **Always Enable Water Level Checks**: Prevents pump damage from dry running\n\n## 🆘 Need Help?\n\n- **📖 Documentation**: Check our [comprehensive guides](docs/)\n- **🐛 Issues**: Report bugs on [GitHub Issues](https://github.com/opensensor/growmax/issues)\n- **💬 Community**: Join discussions on [opensensor.io](https://opensensor.io)\n- **📧 Support**: Contact us through opensensor.io\n\n## 🤝 Contributing\n\nWe welcome contributions! Whether it's:\n- 🐛 Bug reports and fixes\n- 📖 Documentation improvements\n- ✨ New features and sensors\n- 💡 Example projects and use cases\n\n## 📄 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n---\n\n**Made with ❤️ by [OpenSensor.io](https://opensensor.io)**\n\n*Automate your garden, monitor your plants, grow smarter! 🌱*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensensor%2Fgrowmax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensensor%2Fgrowmax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensensor%2Fgrowmax/lists"}