# oscik559/mini_project_repo architecture

> Architecture diagram of the GitHub repository oscik559/mini_project_repo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oscik559/mini_project_repo
- Repository: https://github.com/oscik559/mini_project_repo

## Overview

##### Project type and purpose
- From the README and file-tree this is a full-stack Python “mini_project” (a thesis prototype) that integrates computer vision, LLM-based reasoning/orchestration, voice & face authentication, and robotic control. It provides both a CLI entrypoint (`run.py` / `mini_project/__main__.py`) and a Flask web interface (`mini_project/web_interface`).

##### File structure
- Top-level:
- `mini_project/` – the core package
– `authentication/` – face & voice auth modules
– `camera/` – vision pipelines (SQLite, PostgreSQL, ROS variants)
– `database/` – DB connection, handler, schema, population
– `config/` – application constants and logging setup
– `modalities/` – multimodal orchestrator, voice processor, LLM chains (langraph, langchain), prompt utils, session and task managers
– `web_interface/` – Flask routes, templates, static assets
– `tests/` – pytest suites (database, voice CLI, etc.)
- `db/postgreSQL_test/` – standalone DB utility & tests
- `docs/` – design notes, approaches, thesis proposals
- `keep_awake.py`, `run.py`, `ngrok.exe` – utilities and entry scripts
- `requirements.txt`, `pyproject.toml` – dependencies

##### README for additional insights
- Confirms objective: “Integrating Vision, Language Models, and Robotic Control for Personalized Task Execution in Virtual Environments.”

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Input Layer"
        Camera["USB/IP Camera"]:::input
        Microphone["Microphone"]:::input
    end

    subgraph "Processing Layer"
        FaceAuth["FaceAuth Module"]:::processing
        VoiceAuth["VoiceAuth Module"]:::processing
        subgraph "Vision Processing"
            CamSQLite["CameraVision_SQLite"]:::processing
            CamPgSQL["CameraVision_PgSQL"]:::processing
            CamROS["CameraVision_ROSBridge"]:::processing
            Shapes["ShapesDetection_PgSQL"]:::processing
            Tray["TrayHolderDetection_PgSQL"]:::processing
        end
    end

    subgraph "Persistence Layer"
        DBConn["DB Connection"]:::persistence
        DBHandler["DB Handler"]:::persistence
        Schema["DB Schema"]:::persistence
        Populate["Populate DB"]:::persistence
        Assets["Assets/Backup & Cache"]:::persistence
    end

    subgraph "Orchestration Layer"
        Orchestrator["Orchestrator"]:::orchestration
        SessionMgr["SessionManager"]:::orchestration
        TaskMgr["TaskManager"]:::orchestration
        Sync["Synchronizer"]:::orchestration
        PromptUtils["PromptUtils"]:::orchestration
        VoiceProc["VoiceProcessor"]:::orchestration
        CmdProc["CommandProcessor"]:::orchestration
        GestureProc["GestureProcessor"]:::orchestration
        LLMMChain["LLM_MainChain"]:::orchestration
        Langraph["Langraph_MainGraph"]:::orchestration
        VoiceAssist["VoiceAssistant"]:::orchestration
    end

    subgraph "Presentation Layer"
        CLI["CLI Entry Point"]:::presentation
        WebMain["WebApp Main"]:::presentation
        Routes["Flask Routes"]:::presentation
        Templates["Templates"]:::presentation
        Static["Static Assets"]:::presentation
    end

    subgraph "External Services"
        Ngrok["ngrok"]:::external
        CloudLLM["Cloud LLM"]:::external
    end

    Camera --> CamSQLite
    Camera --> CamPgSQL
    Camera --> CamROS
    CamPgSQL --> Shapes
    CamPgSQL --> Tray
    CamSQLite --> DBHandler
    CamPgSQL --> DBHandler
    Shapes --> DBHandler
    Tray --> DBHandler
    CamROS --> DBHandler

    Microphone --> VoiceProc
    VoiceProc --> DBHandler

    DBHandler --> DBConn
    DBConn --> Schema
    DBConn --> Populate
    Assets --> Orchestrator
    DBHandler --> Orchestrator

    FaceAuth --> Orchestrator
    VoiceAuth --> Orchestrator

    Orchestrator --> TaskMgr
    Orchestrator --> SessionMgr
    Orchestrator --> Sync
    Orchestrator --> PromptUtils
    Orchestrator --> LLMMChain
    PromptUtils --> LLMMChain
    LLMMChain --> CloudLLM
    Langraph --> CloudLLM
    VoiceAssist --> Orchestrator

    CLI --> Orchestrator
    WebMain --> Routes
    Routes --> Orchestrator
    Ngrok --> Routes

    click CLI "https://github.com/oscik559/mini_project_repo/blob/main/run.py"
    click FaceAuth "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/authentication/_face_auth.py"
    click VoiceAuth "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/authentication/_voice_auth.py"
    click CamSQLite "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/camera/camera_vision_SQLite.py"
    click CamPgSQL "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/camera/camera_vision_pgSQL.py"
    click CamROS "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/camera/camera_vision_rs_ROS.py"
    click Shapes "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/camera/camera_vision_shapes_detection_pgSQL.py"
    click Tray "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/camera/camera_vision_tray_and_holder_detection_pgSQL.py"
    click DBConn "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/database/connection.py"
    click DBHandler "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/database/db_handler.py"
    click Schema "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/database/schema_sql.py"
    click Populate "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/database/populate_db.py"
    click Assets "https://github.com/oscik559/mini_project_repo/tree/main/mini_project/assets/"
    click Orchestrator "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/orchestrator.py"
    click SessionMgr "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/session_manager.py"
    click TaskMgr "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/task_manager.py"
    click Sync "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/synchronizer.py"
    click PromptUtils "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/prompt_utils.py"
    click VoiceProc "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/voice_processor.py"
    click CmdProc "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/command_processor.py"
    click GestureProc "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/gesture_processor.py"
    click LLMMChain "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/llm_main_chain.py"
    click Langraph "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/langraph_implementation/llm_main_graph.py"
    click VoiceAssist "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/modalities/voice_assistant.py"
    click WebMain "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/web_interface/main.py"
    click Routes "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/web_interface/routes.py"
    click Templates "https://github.com/oscik559/mini_project_repo/blob/main/mini_project/web_interface/templates/index.html"
    click Static "https://github.com/oscik559/mini_project_repo/tree/main/mini_project/web_interface/static/"
    click Ngrok "https://github.com/oscik559/mini_project_repo/blob/main/ngrok.exe"

    classDef input fill:#c6f5c6,stroke:#2d8f2d
    classDef processing fill:#c6e0ff,stroke:#0000b3
    classDef persistence fill:#ffe0b3,stroke:#b36b00
    classDef orchestration fill:#e0b3ff,stroke:#8000b3
    classDef presentation fill:#fff2b3,stroke:#b38f00
    classDef external fill:#d9d9d9,stroke:#666666
```
