FruxePi OPEN-PROTOTYPE v0.3-BETA
A browser-based dashboard to monitor and automate indoor agriculture using the Raspberry Pi.
PLEASE NOTE: This version of the FruxePi is still under development and in prototype. Our goal is to make this application effortless to deploy and run on your Raspberry Pi. However, until we get all the bugs worked out, this project may require the knowledge of an advanced Pi user. Nonetheless, if you are keen on this project and are having issues deploying FruxePi, please create an issue explaining your problem or contact email@example.com.
The FruxePi is a web application running on a LAMP stack (Linux, Apache, MySQL, PHP) which can be accessed from the browser on your local network. The application collects grow data from a variety of sensors and controls various operations such as lighting, ventilation and watering, using relay modules.
Using the browser-based dashboard, users can easily monitor the status of their growing environment and automate certain tasks.
The basic functionalies of the FruxePi include:
- Monitor your growing climate (temperature and humidity).
- Chart visualizations for historical temperature and humidity data.
- Manage crops by tracking progress and time to harvest.
- Monitor soil moisture.
- Camera monitoring with periodic and manual photo capture.
- Manual and scheduled lighting control.
- Fan control both manually and exception based (temperature or humidity thresholds).
- Watering pump control and daily automation.
- User authentication and management.
- Track daily activity using blog-like journal.
What parts will I need?
The FruxePi runs on the RaspberryPi using several sensors and relays:
Please see the full list of requirements and further information regarding each component.
Quickly deploy the FruxePi application using Docker and the installation script.
Step 1: Clone Project
Clone the FruxePi repository to your Raspberry Pi or download the ZIP file.
git clone https://github.com/fruxefarms/FruxePi.git cd FruxePi
Step 2: Run Installation Script
sudo bash install.sh to quickly install the application as well as Docker, Docker Compose and some other installation dependencies.
Besides the Docker installation, the FruxePi can also be manually installed and configured by following these instructions. Good luck!
Step 3: Launch App
Launch the application from your browser and login!
After successful deployment, visit
http://<your-raspi-ip-address>:80/ in your browser to launch the FruxePi dashboard and login with the default credentials below:
This project was built with the assistance of the following libraries and tools:
- Adafruit DHT Sensor Library - Python library to read the DHT series of humidity and temperature sensors on the Raspberry Pi.
- Wiring Pi - GPIO Interface library for the Raspberry Pi.
- Pillow - The friendly Python Imaging Library fork.
- PyMySQL - A pure-Python MySQL client library.
- Codeigniter - PHP web framework.
- Ion Auth - Ion Auth is a simple and lightweight authentication library for the CodeIgniter framework.
- Docker - Containerized LAMP stack.
- Balena - Raspberry Pi compatible Docker base images.
- Docsify - A magical documentation site generator.
- Bootstrap - The world's most popular HTML, CSS, and JS front-end component library.
- Bootstrap Datepicker - A flexible datepicker widget in the Bootstrap style.
- Font Awesome - The world's most popular and easiest to use icon set.
This project is released under GPL 3.0.
You are free to use, copy, distribute and transmit this software for non-commercial purposes.
Read the LICENSE for details in full.
- Teamwork makes the dream work. Big shout out to all the FruxePi contributors. It's really great working on this together!
- The seed of thought. Thanks to the RaspiViv Project for the inspiration and early confidence in making this project work.
- Big thanks to all the master growers for sharing their earthly wisdom.
- Finally, a humble bow to the Raspberry Pi community. We owe a huge thank you to anyone who tinkered, tweaked or destroyed their Pi and were kind enough to share their story.
We are a collective of programmers and master growers. Our goal is to develop open-source software and low-cost hardware to automate indoor agriculture.