# ravirajsinh45/face-recognition-home-door-lock-system architecture

> Architecture diagram of the GitHub repository ravirajsinh45/face-recognition-home-door-lock-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ravirajsinh45/face-recognition-home-door-lock-system
- Repository: https://github.com/ravirajsinh45/face-recognition-home-door-lock-system

## Overview

##### Project type and purpose
- This is an embedded IoT application running on a Raspberry Pi that implements a face‐recognition door‐lock system.
- Its purpose is to continuously monitor distance via an ultrasonic sensor, capture images when a person approaches, perform face recognition against a local dataset, and, if the person is authorized, actuate a solenoid lock via a relay.

##### File structure
Top-level files and directories:
- distance_measurement.py – measures distance over GPIO
- lock_control.py – provides unlock()/lock() wrappers around the relay GPIO
- generating_encoding.py – scans `dataset/` images and produces `face_encodings.pickle`
- final.py – the main control loop that ties sensors, camera, recognition, and lock actuation
- face_encodings.pickle – serialized face embeddings database
- dataset/ – subfolders per authorized person, each containing sample images
- assets/ – documentation images for wiring, installation, etc.

Architectural hints:
– Modular Python scripts separate concerns (sensing, encoding, control, orchestration)
– Local storage of training data (`dataset/`) and embeddings (`.pickle`)
– Extensive use of Raspberry Pi GPIO for sensor input and actuator output
– Use of external libraries (face_recognition, OpenCV, imutils)

##### README for additional insights
– System overview describes an event‐driven loop: ultrasonic distance sensor → camera → face recognition → lock control.
– Software stack: Python 3, OpenCV 4, face_recognition, imutils, pypickle.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Hardware components
    subgraph "Hardware" 
        direction TB
        Ultrasonic["Ultrasonic Distance Sensor<br/>(SIG→GPIO15)"]:::hardware
        PiCamera["Pi Camera Module"]:::hardware
        Relay["Relay Module<br/>(IN→GPIO26)"]:::hardware
        Solenoid["12V Solenoid Lock"]:::hardware
    end

    %% Raspberry Pi as central hub
    subgraph "Raspberry Pi 4" 
        direction TB
        subgraph "Software Modules"
            direction TB
            DM["DistanceMeasurement Service"]:::software
            EG["EncodingGenerator Service"]:::software
            FR["FaceRecognition Engine"]:::software
            LC["LockControl Service"]:::software
            ORC["Orchestrator<br/>(final.py)"]:::software
        end
        subgraph "External Libraries"
            direction TB
            Lib1["face_recognition"]:::library
            Lib2["OpenCV"]:::library
            Lib3["imutils / pickle"]:::library
        end
        subgraph "Local Storage"
            direction TB
            Dataset["Dataset Storage"]:::storage
            Embeddings["Face Embeddings<br/>(face_encodings.pickle)"]:::storage
        end
    end

    %% Data and control flows
    Ultrasonic -->|"measures distance"| DM
    DM -->|"distance ≤150cm"| ORC
    ORC -->|"capture frame"| PiCamera
    PiCamera --> FR
    FR -->|"load encodings"| Embeddings
    FR -->|"recognition result"| ORC
    ORC -->|"unlock()"| LC
    LC --> Relay
    Relay --> Solenoid
    ORC -->|"lock() after 10s"| LC

    %% Encoding generation flow
    EG -->|"scan dataset"| Dataset
    EG -->|"generate pickle"| Embeddings

    %% Library dependencies
    FR --> Lib1
    FR --> Lib2
    ORC --> Lib3
    EG --> Lib3
    DM --> Lib3
    LC --> Lib3

    %% Click Events
    click DM "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/distance_measurement.py"
    click LC "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/lock_control.py"
    click EG "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/generating_encoding.py"
    click ORC "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/final.py"
    click Dataset "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/tree/master/dataset/"
    click Embeddings "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/face_encodings.pickle"
    click README "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/blob/master/README.md"
    click assets "https://github.com/ravirajsinh45/face-recognition-home-door-lock-system/tree/master/assets/"

    %% Styles
    classDef hardware fill:#8FBC8F,stroke:#333,stroke-width:1px
    classDef software fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef storage fill:#FFA500,stroke:#333,stroke-width:1px
    classDef library fill:#D3D3D3,stroke:#333,stroke-width:1px
```
