Skip to content
Indoor farming software using the Raspberry Pi
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app UI tweaks May 16, 2019
db File versioning and checks Apr 28, 2019
docker
docs Documentation edits May 16, 2019
.gitignore Edited docs to terminate MYSQL session Mar 5, 2019
LICENSE.md Added docs for github pages Mar 18, 2019
README.md File versioning and checks Apr 28, 2019
install.sh PiZero install testing May 17, 2019
update.sh Tweaks to update script Apr 13, 2019

README.md

FruxePi OPEN-PROTOTYPE v0.3-BETA

A browser-based dashboard to monitor and automate indoor agriculture using the Raspberry Pi.

FruxePi Dashboard

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 hello@fruxe.co.

Quick Links


FruxePi Overview

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.

Dashboard Demo

URL: https://demo.fruxe.co/
User: demo@fruxe.co
Pass: password

Features

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:

Part Description
Raspberry Pi Raspberry Pi
The FruxePi has been tested and runs well on the following models running Raspian:
- Raspberry Pi 3 Model B
- Raspberry Pi Model Zero W
Climate Sensor Climate Sensor
The DHT22 is a basic digital temperature and humidity sensor. It uses a capacitive humidity sensor and a thermistor to measure the surrounding air, and spits out a digital signal on the data pin, no analog input pins needed.
Moisture Probe Moisture Probe
The TE215 moisture probe is sensitive to ambient humidity and is used to detect the moisture content of the soil or growing medium. The module outputs a HIGH or LOW value when the the soil humidity exceeds a set threshold value.
Relay Module 5V Relay Modules
5V Relay Modules are a great way to control high current and high voltage devices directly from the Raspberry Pi.
Camera Raspberry Pi Camera
The Raspberry Pi Camera Module is the official camera product from the Raspberry Pi Foundation. The FruxePi has been tested using the 8MP Camera Module v2 (2016).

Please see the full list of requirements and further information regarding each component.


Easy Install

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

Run sudo bash install.sh to quickly install the application as well as Docker, Docker Compose and some other installation dependencies.

FruxePi Install

Manual Installation

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!

Launch FruxePi

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:

Default Login

User: hello@fruxe.co
Pass: password


Built With

This project was built with the assistance of the following libraries and tools:

Raspberry Pi

  • 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.

Back-End

  • 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.

Front-End

  • Bootstrap - The world's most popular HTML, CSS, and JS front-end component library.
  • Bootstrap Datepicker - A flexible datepicker widget in the Bootstrap style.
  • jQuery Timepicker - A lightweight, customizable javascript timepicker plugin.
  • Chart.js - Simple yet flexible JavaScript charting for designers & developers.
  • Font Awesome - The world's most popular and easiest to use icon set.

Version

frx-pi-v0.3-BETA

We use SemVer for versioning. For the versions available, see the tags on this repository.


License

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.


Acknowledgments

  • 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.

About Fruxe

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.

fruxe.co/about

You can’t perform that action at this time.