diff --git a/README.md b/README.md index 173db56..1642b07 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # New-Pi-Garage-Door-Opener -A rewrite of the Raspberry Pi Garage Door Opener using Flask +A rewrite of the Raspberry Pi Garage Door Opener using Flask. + +This repo contains a python script (garage_door_script.py), which runs a Flask web server that allows you to control and monitor your Raspberry Pi Garage Door Opener. This script assumes you have the same hardware configuration as described in this video: https://youtu.be/An7KQbmUnhs. + +## Differences between this and the old python garage door control script (https://github.com/Rav4s/Pi-Garage-Door-Opener) +Unlike the old script, this one allows you to view the status of your garage door and control it from one webpage. Also, once you sign in, it sets a cookie which allows you to stay signed in after closing and re-opening the page. Improvements have also been made for mobile usability and overall look and feel (see the screenshots below). + +## What's in each folder? +The static folder contains the Bootstrap CSS framework, along with the main CSS file and the favicon. +The templates folder contains the index.html and login.html templates, which the python file uses to serve the webpages. +The main python script is called garage_door_script.py. + +## Dependencies +This python script requires python 3.x, Flask, and RPi.GPIO. + +## How to run the script +To run the python script, first clone the repository using `git clone https://github.com/Rav4s/New-Pi-Garage-Door-Opener`. Then enter the directory using `cd New-Pi-Garage-Door-Opener`. Then finally run the script using `python3 garage_door_script.py`. Your web server will be accessible at http://serverip:1235/. + +## Screenshots +![Screenshot of main page](Screenshot%202020-12-26%20170542.png) diff --git a/Screenshot 2020-12-26 170542.png b/Screenshot 2020-12-26 170542.png new file mode 100644 index 0000000..647300b Binary files /dev/null and b/Screenshot 2020-12-26 170542.png differ