Code Monkey home page Code Monkey logo

opengardener's Introduction

logo

openGardener

A project for automatically taking care of plants in your house.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

This project is designed to be run on a Raspberry Pi and uses Raspberry Pi specific modules like RPi.GPIO and picamera. As such, it may not run correctly on other systems.

All Python requirements can be found in requirements.txt, but do not have to be preinstalled.

Currently Supported Components

  • Moisture Sensor
  • Water Pump
  • Camera (plugged in via ribbon cable)

Installing

Container

The container can be pulled directly from docker hub or you can build it yourself using the supplied dockerfile.

Recommended docker use:

docker run \
-p 8080:8080 \
-v host/path/to/database.sqlite3:/opt/openGardener/opengardener.db \
-v host/path/to/picture_folder:/opt/openGardener/static/img/plant \
-d \
bmswens/opengardener

Direct Install

Installation is designed to be easy, but does require root access.

Before running anything as root, I recommend familiarizing yourself with the commands to be run.

Steps

openGardener can be installed anywhere, but /opt is a very good place for it.

cd /opt
git clone https://github.com/bmswens/openGardener.git
cd openGardener

Modify the HOST setting in webapp.py to match the IP and port that you wish to host on, or set the HOST and PORT environment variables. You may keep it as localhost if you only plan to access it locally, or are going to enable port forwarding.

bash system/install.sh

After it finishes installing you will need to set up your configuration at http://ip:port/settings before the system finishes setting up the cronjobs.

Built With

  • Python - Primary language
  • Flask - The web framework used

Authors

  • Brandon Swenson- Initial work - bmswens

License

This project is licensed under the GNU GPLv3 - see the LICENSE.md file for details

Acknowledgments

  • My friend, for forcing me to take care of her plants while she's away.

opengardener's People

Contributors

bmswens avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

ksjpswaroop

opengardener's Issues

Update Logging Method

Update logging method from saving JSON objects into a text file to using a SQLite database.
Also refactor installation scripts and webapp to allow for this.

Containerization

Create a dockerfile to containerize the entirety of the project.
Create and example docker-compose.yml with proper mounting and privileges to store data, and properly use GPIO from within the container.

Uninstall File

Create an uninstall.sh file to remove all traces of the software from the system.

Add About Documentation

  • Add an about page to the project
  • Add a link to Amazon list of items used to footer
  • Link the Github logo to this repository
  • Remove Trello logo (using Github projects instead)

Photo Sizing

Make it so that photos scale correctly based on window size, rather than always being actual size.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.