Difference between revisions of "SecuriDoor"

From ESE205 Wiki
Jump to navigation Jump to search
m (Protected "SecuriDoor" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(48 intermediate revisions by 2 users not shown)
Line 11: Line 11:
 
* Nathan Schmetter (TA)
 
* Nathan Schmetter (TA)
  
== Objective ==
+
== Objectives ==
  
 
We will achieve success with this project if we are able to effectively lock and unlock a door using a locking mechanism on the Raspberry Pi via a website. Specifically, the communication between the site and the locking mechanism is the focus of this success and must execute without error for success to be achieved. We must also transmit an image taken from a webcam on the Pi and display it on the website. Additionally, our project has the potential to include more features, such as motion sensors and alarms for further home security.
 
We will achieve success with this project if we are able to effectively lock and unlock a door using a locking mechanism on the Raspberry Pi via a website. Specifically, the communication between the site and the locking mechanism is the focus of this success and must execute without error for success to be achieved. We must also transmit an image taken from a webcam on the Pi and display it on the website. Additionally, our project has the potential to include more features, such as motion sensors and alarms for further home security.
Line 32: Line 32:
 
* [http://www.microcenter.com/product/461230/Raspberry_Pi_3_Model_B_Board_and_Case_Kit MCM Electronics Raspberry Pi 3 Model B Board and Case Kit]-$42.99
 
* [http://www.microcenter.com/product/461230/Raspberry_Pi_3_Model_B_Board_and_Case_Kit MCM Electronics Raspberry Pi 3 Model B Board and Case Kit]-$42.99
 
* [http://www.homedepot.com/p/Global-Door-Controls-Single-Cylinder-Bright-Brass-Residential-Deadbolt-GLS660-605/203574784 Single Cylinder Bright Brass Residential Deadbolt]-$10.48
 
* [http://www.homedepot.com/p/Global-Door-Controls-Single-Cylinder-Bright-Brass-Residential-Deadbolt-GLS660-605/203574784 Single Cylinder Bright Brass Residential Deadbolt]-$10.48
* [http://www.homedepot.com/p/WeatherShield-2-in-x-4-in-x-8-ft-2-Prime-Cedar-Tone-Ground-Contact-Pressure-Treated-Lumber-253928/206967765 2 in. x 4 in. x 8 ft. #2 Prime Cedar-Tone Ground Contact Pressure-Treated Lumber]-$4.98
+
* [https://www.amazon.com/abcGoodefg-Battery-Holder-Plastic-Storage/dp/B071YD9F7X/ref=sr_1_4?ie=UTF8&qid=1512951361&sr=8-4&keywords=3+AA+battery+pack]-$7.99
 
* [https://www.web.com/website-hosting Website Hosting and Domain (Essential Plan)]-$5.95/month for total of $17.85
 
* [https://www.web.com/website-hosting Website Hosting and Domain (Essential Plan)]-$5.95/month for total of $17.85
 
* 3D Printing Materials (Free -- Provided)
 
* 3D Printing Materials (Free -- Provided)
 
* Breadboard and Resistors (Free -- Provided)
 
* Breadboard and Resistors (Free -- Provided)
  
Total Budget: $88.29
+
Total Budget: $91.30
  
 
== Design and Solutions ==
 
== Design and Solutions ==
 +
'''View our code [https://github.com/sjrush/SavannahRush here.]'''
 +
=== Design Components ===
 +
The central physical element of the SecuriDoor system is the locking mechanism. This locking system is, in essence, a servo motor connected to a deadbolt on the inside of a door that can be controlled by a Raspberry Pi 3. We initially considered a housing mechanism for the servo that would be placed overtop of the deadbolt and would directly turn the lock; however, this design would not work as the connection would not allow for easy access to manually turn the deadbolt. Instead, we pursued an offset connection between the servo and the lock utilizing a wide bar attachment to the servo and two strong wires or strings that latch onto either side of the deadbolt. This final design can be seen in the graphic below.
 +
[[File:Locking.png|200px|thumb|left|Locking Mechanism]]
 +
Another design element we were interested in was a 3D printed case for the Raspberry Pi that would attach to the door for ease of use. We were able to design such a case with two connecting parts that has the necessary openings for wiring and other device connections to attach. Unfortunately, the case was not printed due to time constraints; however, the model for the case can be seen below.
  
=== Design Components ===
+
[[File:Case.png|200px|thumb|left|3D Printed Case]]
Clayton: talk about the locking mechanism, case, etc
+
 
=== User Interface ===
+
=== Server and Hosting ===
 +
We used Web.com for our cloud server and site hosting. Through their platform, we purchased a domain name (thesecuridoor.com) and had a site accessible via nearly any network. To send files to be displayed on the site I used an FTP software called Filezilla. For more information on Filezilla and its use, please see our tutorial [[Using_FTP_With_Filezilla|here]].
 +
 
 +
To make our homepage visually appealing, I used Web.com's site builder to design the components. To achieve our objectives, I created the PHP and HTML scripts for all of the other pages on the site. These scripts are found on the repository linked above. The main feature of the site is the 'checker.php' file, which contains a form where a user submits their desired lock setting. Using GET methods, this data is sent to another file on the site, 'doorstatus.txt', which is downloaded by the Pi. This communication is discussed further in the next section.
 +
 
 +
=== Coding Solutions ===
 +
Throughout the semester we worked on independent Python scripts for testing purposes. One script controlled the servo, one downloaded and read a file on the website, and the final script took an image using a webcam connected to the Pi and sent it to be displayed on the server. Near the end of the semester, we combined each of these scripts into one, with specific methods performing each of the functions. This script is shown in the GitHub repository (linked above) and is titled 'getFile.py'.
  
 +
For each of the aforementioned functions, we utilized different Python packages and functionalities. To control the servo, we used the GPIO package. To download and send files from/to the website, we employed an FTP connection. To determine the user's desired lock setting and control the servo, the getFile() method downloads a file on the site and writes its contents to a file on the Pi every 5 seconds. The script continually checks the string contained in the file on the Pi, which is either "lock" or "unlock". Depending on the string value, the servo changes position according to the desired setting. To send the image, the sendPic() method is employed, which takes an image on the Pi webcam every 5 seconds and sends it to a file (again using FTP) on the server, which is immediately displayed on the site.
  
=== Server ===
+
On the website side, we utilized HTML and PHP scripts. For the main functionality, we used GET methods to transmit variables. These are the variables that are downloaded by the Pi which help to determine the user's desired preferences.
  
 
== Security ==
 
== Security ==
 +
Security is a major concern with our project. As our project currently stands, anyone could log on to the website and control the user's door. Obviously this would need to change if our system were brought to market. If we were to continue on this project, we would need to add layers of security to the website.
 +
 +
First and foremost, robust password protection needs to be instituted. To mimic a real-world product, each of our locking mechanisms would be given their own unique password, only known to the purchaser of the product. I would code these unique passwords into the .htaccess file that already exists in our file system, which would ensure that only the purchaser of the locking mechanism would be able to remotely control their lock and move past the site homepage.
 +
 +
However, password protection is not the only security concern. Since we are using FTP to send data from the Pi to the server, a hacker can easily gain anonymous access to the FTP server and view the data that is displayed on the site. A hacker could see if a user had recently locked or unlocked their door and could reasonably infer the current status of the lock, as well as view the picture taken in front of the door. Because this image is updated constantly, at all times a hacker could spy on a user's door and have continuous access to the image.
 +
 +
There are many potential solutions to help mitigate these security concerns. Many of these solutions are outside the scope of this project and certainly beyond the understanding of two non-computer science students. However, there exists one promising solution that could have been chosen for this project, had we had access to a different Wifi network and router, other than the WashU Wifi. Instead of FTP protocol to send data to the server, we would have instead utilized port forwarding. Port forwarding is a more secure option, as there are many defense features available to prevent hacking. Port forwarding would be a fine choice for a home router and network, but due to WashU IT, we were unable to institute this option.
  
 
== Results ==
 
== Results ==
 
=== Final Locking Mechanism ===
 
=== Final Locking Mechanism ===
CLAYTON
+
 
 +
[[File:IMG 2070.MOV.mov|Our locking mechanism in action during our Demo Session]]
 +
 
 +
Our final product can be seen below. We were successfully able to connect the web server to the Pi and, on the school's wifi network, send the "lock" or "unlock" signal to the Pi and lock or unlock the door. We also found that we were able to connect to the server via mobile phone, which we were not expecting to accomplish. Overall, we were satisfied with the execution of our final product and believe our demo is an impressive display of systems engineering.
  
 
=== Final Website===
 
=== Final Website===
 +
 +
[[File:SavFlow.jpg|800px|How to navigate the site to control the lock and view the image]]
 +
 
=== Demo Poster ===
 
=== Demo Poster ===
CLAYTON
+
[[File:Sav_poster.jpg|800 px]]
 +
 
  
 
=== Comparison to Objectives ===
 
=== Comparison to Objectives ===
 +
Our project achieves both of the major goals we set at the beginning of the semester: to successfully control a lock via a website and to display an image on the website that is  taken on the Pi. However, some of the ancillary objectives were not met. Ideally, our Raspberry Pi/servo mechanism would have been encapsulated in a 3-D printed case which we designed. Unfortunately we did not achieve this in time for the demo. We also desired for our scripts on the Pi to run immediately upon reboot. However, even after an hour with Prof. Feher, we were unable to complete this. We hypothesize that this was an issue with the Pi having trouble connecting to the wifi. When the script ran upon startup, the wifi was not yet connected, which resulted in the script terminating.
 +
 
=== Critical Decisions ===
 
=== Critical Decisions ===
 +
There were very few limiting factor in our project, and thus we were able to achieve almost all of the goals we set out for ourselves. The two that are relevant, though, are not getting our case printed and having to use a monitor during the demo of our product.
 +
The case was ready to print about halfway through the semester, but the difficulties with the 3D printers as well as design changes made it so that we did not actually print the case. Instead, we changed the design of the physical system to have the Raspberry Pi more accessible to modifications (out of a case) and the servo motor inserted into a hole created in our door.
 +
The other critical decision we made was to boot up the Pi script using a monitor instead of having it run continuously without being plugged into any external devices (e.g. mouse, keyboard, screen). This change was made due to troubles we faced while attempting to stay connected to the wifi which we would not have been able to successfully demonstrate without.
  
 
== Potential Project Extensions ==
 
== Potential Project Extensions ==
CLAYTON
+
If we were to continue developing the SecuriDoor, there are a few changes to the online server as well as the physical locking mechanism that we would make.
 +
First, we initially hoped to have a more secure website that would require a distinct username and password to connect to the door, but were unable to make it work within the time constraints. With more time, we would look into implementing HTTPS and port forwarding to maximize the online security.
 +
On the physical side, the next step in improving the SecuriDoor would be to include a function to the website that would tell the user whether the door is currently locked or unlocked before opting to change its status. This would simply require a motion sensor connected to either the servo or the deadbolt and a connection to the website.
 +
 
 +
== Tutorial ==
 +
Find our tutorial [[Using_FTP_With_Filezilla|here]].
 +
 
 +
== References ==
 +
https://www.w3schools.com/php/php_forms.asp
 +
<br />
 +
 
 +
http://www.instructables.com/id/Simple-and-intuitive-web-interface-for-your-Raspbe/
 +
 
 
[[Category:Projects]]
 
[[Category:Projects]]
 
[[Category:Fall 2017 Projects]]
 
[[Category:Fall 2017 Projects]]

Latest revision as of 12:49, 12 December 2017

Overview

Have you ever left the house and, hours later, fretted over whether you locked your door? It's a familiar feeling--and one that can be avoided. Our project can be used to solve this all-too-common problem. Through our website interface, a user can remotely lock their door and eliminate the worry associated with common forgetfulness. Using the website, a user will be able to command the physical aspects of our design to activate a servo which pushes the door's lock into place.

Find our weekly log here

Group Members

  • Clayton Keating
  • Savannah Rush
  • Nathan Schmetter (TA)

Objectives

We will achieve success with this project if we are able to effectively lock and unlock a door using a locking mechanism on the Raspberry Pi via a website. Specifically, the communication between the site and the locking mechanism is the focus of this success and must execute without error for success to be achieved. We must also transmit an image taken from a webcam on the Pi and display it on the website. Additionally, our project has the potential to include more features, such as motion sensors and alarms for further home security.

Our final project demonstration will consist of short and long range tests of the system to show off the site's realistic use.

Challenges

  • Familiarization with Raspberry Pi
  • Building a housing mechanism such that it can be attached to a door
  • Ensuring that the app cannot lock you out of your own home
  • Maximizing range of communication between locking mechanism and web application
  • Ensuring security of the website


Gantt Chart

Savannahgantt.jpg

Budget

Total Budget: $91.30

Design and Solutions

View our code here.

Design Components

The central physical element of the SecuriDoor system is the locking mechanism. This locking system is, in essence, a servo motor connected to a deadbolt on the inside of a door that can be controlled by a Raspberry Pi 3. We initially considered a housing mechanism for the servo that would be placed overtop of the deadbolt and would directly turn the lock; however, this design would not work as the connection would not allow for easy access to manually turn the deadbolt. Instead, we pursued an offset connection between the servo and the lock utilizing a wide bar attachment to the servo and two strong wires or strings that latch onto either side of the deadbolt. This final design can be seen in the graphic below.

Locking Mechanism

Another design element we were interested in was a 3D printed case for the Raspberry Pi that would attach to the door for ease of use. We were able to design such a case with two connecting parts that has the necessary openings for wiring and other device connections to attach. Unfortunately, the case was not printed due to time constraints; however, the model for the case can be seen below.

3D Printed Case

Server and Hosting

We used Web.com for our cloud server and site hosting. Through their platform, we purchased a domain name (thesecuridoor.com) and had a site accessible via nearly any network. To send files to be displayed on the site I used an FTP software called Filezilla. For more information on Filezilla and its use, please see our tutorial here.

To make our homepage visually appealing, I used Web.com's site builder to design the components. To achieve our objectives, I created the PHP and HTML scripts for all of the other pages on the site. These scripts are found on the repository linked above. The main feature of the site is the 'checker.php' file, which contains a form where a user submits their desired lock setting. Using GET methods, this data is sent to another file on the site, 'doorstatus.txt', which is downloaded by the Pi. This communication is discussed further in the next section.

Coding Solutions

Throughout the semester we worked on independent Python scripts for testing purposes. One script controlled the servo, one downloaded and read a file on the website, and the final script took an image using a webcam connected to the Pi and sent it to be displayed on the server. Near the end of the semester, we combined each of these scripts into one, with specific methods performing each of the functions. This script is shown in the GitHub repository (linked above) and is titled 'getFile.py'.

For each of the aforementioned functions, we utilized different Python packages and functionalities. To control the servo, we used the GPIO package. To download and send files from/to the website, we employed an FTP connection. To determine the user's desired lock setting and control the servo, the getFile() method downloads a file on the site and writes its contents to a file on the Pi every 5 seconds. The script continually checks the string contained in the file on the Pi, which is either "lock" or "unlock". Depending on the string value, the servo changes position according to the desired setting. To send the image, the sendPic() method is employed, which takes an image on the Pi webcam every 5 seconds and sends it to a file (again using FTP) on the server, which is immediately displayed on the site.

On the website side, we utilized HTML and PHP scripts. For the main functionality, we used GET methods to transmit variables. These are the variables that are downloaded by the Pi which help to determine the user's desired preferences.

Security

Security is a major concern with our project. As our project currently stands, anyone could log on to the website and control the user's door. Obviously this would need to change if our system were brought to market. If we were to continue on this project, we would need to add layers of security to the website.

First and foremost, robust password protection needs to be instituted. To mimic a real-world product, each of our locking mechanisms would be given their own unique password, only known to the purchaser of the product. I would code these unique passwords into the .htaccess file that already exists in our file system, which would ensure that only the purchaser of the locking mechanism would be able to remotely control their lock and move past the site homepage.

However, password protection is not the only security concern. Since we are using FTP to send data from the Pi to the server, a hacker can easily gain anonymous access to the FTP server and view the data that is displayed on the site. A hacker could see if a user had recently locked or unlocked their door and could reasonably infer the current status of the lock, as well as view the picture taken in front of the door. Because this image is updated constantly, at all times a hacker could spy on a user's door and have continuous access to the image.

There are many potential solutions to help mitigate these security concerns. Many of these solutions are outside the scope of this project and certainly beyond the understanding of two non-computer science students. However, there exists one promising solution that could have been chosen for this project, had we had access to a different Wifi network and router, other than the WashU Wifi. Instead of FTP protocol to send data to the server, we would have instead utilized port forwarding. Port forwarding is a more secure option, as there are many defense features available to prevent hacking. Port forwarding would be a fine choice for a home router and network, but due to WashU IT, we were unable to institute this option.

Results

Final Locking Mechanism

Our final product can be seen below. We were successfully able to connect the web server to the Pi and, on the school's wifi network, send the "lock" or "unlock" signal to the Pi and lock or unlock the door. We also found that we were able to connect to the server via mobile phone, which we were not expecting to accomplish. Overall, we were satisfied with the execution of our final product and believe our demo is an impressive display of systems engineering.

Final Website

How to navigate the site to control the lock and view the image

Demo Poster

Sav poster.jpg


Comparison to Objectives

Our project achieves both of the major goals we set at the beginning of the semester: to successfully control a lock via a website and to display an image on the website that is taken on the Pi. However, some of the ancillary objectives were not met. Ideally, our Raspberry Pi/servo mechanism would have been encapsulated in a 3-D printed case which we designed. Unfortunately we did not achieve this in time for the demo. We also desired for our scripts on the Pi to run immediately upon reboot. However, even after an hour with Prof. Feher, we were unable to complete this. We hypothesize that this was an issue with the Pi having trouble connecting to the wifi. When the script ran upon startup, the wifi was not yet connected, which resulted in the script terminating.

Critical Decisions

There were very few limiting factor in our project, and thus we were able to achieve almost all of the goals we set out for ourselves. The two that are relevant, though, are not getting our case printed and having to use a monitor during the demo of our product. The case was ready to print about halfway through the semester, but the difficulties with the 3D printers as well as design changes made it so that we did not actually print the case. Instead, we changed the design of the physical system to have the Raspberry Pi more accessible to modifications (out of a case) and the servo motor inserted into a hole created in our door. The other critical decision we made was to boot up the Pi script using a monitor instead of having it run continuously without being plugged into any external devices (e.g. mouse, keyboard, screen). This change was made due to troubles we faced while attempting to stay connected to the wifi which we would not have been able to successfully demonstrate without.

Potential Project Extensions

If we were to continue developing the SecuriDoor, there are a few changes to the online server as well as the physical locking mechanism that we would make. First, we initially hoped to have a more secure website that would require a distinct username and password to connect to the door, but were unable to make it work within the time constraints. With more time, we would look into implementing HTTPS and port forwarding to maximize the online security. On the physical side, the next step in improving the SecuriDoor would be to include a function to the website that would tell the user whether the door is currently locked or unlocked before opting to change its status. This would simply require a motion sensor connected to either the servo or the deadbolt and a connection to the website.

Tutorial

Find our tutorial here.

References

https://www.w3schools.com/php/php_forms.asp

http://www.instructables.com/id/Simple-and-intuitive-web-interface-for-your-Raspbe/