HSEC

A security system made from scratch.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a security camera manager. It includes the firmware of the camera written in CPP (here), it has the web server for the actual camera viewer and client written in ReactTS (here), it also has the main server that communicates with the users and cameras (here). It also includes a script to view the camera's logs (here).

More information about the custom protocol itself (that is built ontop of TCP) can be found here.

(back to top)

Built With

Web client

Main Server

Camera

(back to top)

Features

1. Linking to multiple cameras
2. Secure communications
3. Camera sharing
4. Object detection in red zones set up by user
5. Camera playback - WIP
6. Emails and notifications for redzone detection
7. Renaming and unlinking cameras
8. And more!

Getting Started

Prerequisites

First, you'd need to buy the camera or a compatible product. I used this.

Installation - Camera

1. Clone the repo

   git clone https://github.com/K9Developer/HSEC.git

2. Connect the camera to the board
3. Connect the board to the computer
4. Connect an Ethernet cable to the board
5. Install platform IO
6. Compile and upload the code pio run --target upload
7. Hold the BOOT button for a few seconds to ensure a full reset

If also want to read the camera's logs you can:

1. run cd HSEC/camera_module/camera_interact
2. Install dependecies: pip install -r requirements.txt
3. Run using python camera_interact.py

Installation - Webserver

1. Clone the repo

   git clone https://github.com/K9Developer/HSEC.git

2. Install NodeJS
3. Install yarn
4. Run cd HSEC/hsec-client && yarn install to install dependecies
5. Launch the server with yarn run

Installation - Central/Main Server

1. Clone the repo

   git clone https://github.com/K9Developer/HSEC.git

2. run cd HSEC/central_server and pip install -r requirements.txt
3. then run python -m main

(back to top)

Roadmap

• Add redzones
• Add camera sharing
• Add forgot password
• Fix a few possible replay vulnerabilties
• Camera sharing
• Camera playback - view history (WIP)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the Unlicense License. See LICENSE for more information.

(back to top)

Contact

Ilai - [email protected]

(back to top)