🏯 Castle-Black 🏯

Hey there!! Welcome to project castle-black! Glad you stumbled upon this repository. This is MDG's wifi operated door lock.

Setup

Hardware

Requirements

• Rasberry Pi (Model 3B or higher) and power adapter
• MG 995 Servo Motor
• M-F Jumper Wires
• Custom 3D printed lock attachment

Circuit Diagram

Software

In the rasberry pi, follow these steps:

1. Cloning the repository

$ git clone https://github.com/Abhijna-Raghavendra/castle-black.git
$ cd castle-black

2. Creating and activating your virtual environment

$ python3 -m venv virtenv
$ source virtenv/bin/activate

3. Setting a secret key

(virtenv)$ openssl rand -base64 64

This will give you a randomly generated secret key. Now create a '.env' file at the root of your project based on '.env.example' and put in your secret key.

4. Install the required dependencies

(virtenv)$ pip install -r requirements.txt

5. Run the app

(virtenv)$ python app.py

Now, the flask server is hosted on {Rasberry Pi's IP}:5000 and all devices on this network should be able to view it.

To register new users, add in the usernames and password SHAs in the passwords sheet of sheet.xlsx. Till then, try using the credentials :
username = orange
password = creator
Don't forget to change this password before deploying the project

Features

• Devices on the same network can open the wifi operated door lock
• User authentication
• Maintains user log

If you like this project, do give the repo a star!! ⭐ Enjoy safeguarding your homes!!