# andersonvictor/telemetria architecture

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

- Interactive diagram: https://gitdiagram.com/andersonvictor/telemetria
- Repository: https://github.com/andersonvictor/telemetria

## Overview

##### Project Type and Purpose
- This is a full-stack web application for real-time telemetry and device monitoring.
- Backend in PHP with MySQL, frontend in HTML/CSS/JS using Bootstrap, Chart.js and DataTables.
- A Python script (pingEscala.py) performs periodic pings and logs or writes data to the database.

##### File Structure
- Top-level PHP scripts:
- login.php / logout.php – authentication endpoints
- index.php – main dashboard view
- datos.php – JSON API serving telemetry data
- export_excel.php & SimpleXLSXGen.php – Excel report generator
- verify_events.php, fix_existing_counters.php – administrative tools
- assets/ – static files
- js/script.js – custom frontend logic
- datatables config and images
- logs/ – output from ping_monitor (daily log files)
- pingEscala.py – external Python ping worker
- vendor/ & composer.* – third-party PHP dependencies

##### README for Insights
- Describes three tiers: presentation (HTML/CSS/JS), application logic (PHP scripts), data storage (MySQL).
- Mentions real-time monitoring, historical reports, Excel export, user roles.

##### Main Components and Their Interactions
a. User Browser (Clients)
- Interacts over HTTP/HTTPS with the web server.
b. Web Server & PHP Backend
- Serves static assets and dynamic pages (login, dashboard).
- datos.php exposes REST-style JSON for charts and tables.
- export_excel.php uses SimpleXLSXGen to stream .xlsx files.
- Authentication and session management for admin/regular users.
c. Database (MySQL)
- Stores device records, ping results, user credentials, historical data.
d. Ping Worker (pingEscala.py)
- Scheduled via cron or service.
- Performs ICMP pings to devices.
- Inserts results into MySQL and/or writes to logs/ping_monitor_YYYYMMDD.log.
e. Logging Subsystem
- PHP scripts log errors or audit events to logs/.
- Python script logs ping activity separately.

##### Architectural Patterns and Design Principles
- Three-Tier Architecture: Presentation / Application / Data layers.
- Separation of Concerns:
- Frontend (assets/, script.js, Chart.js, DataTables)
- Backend API (datos.php)
- Report Generator (export_excel.php + SimpleXLSXGen)
- Cron-based worker for asynchronous data collection.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients
    subgraph "Clients"
        direction TB
        Browser["User Browser"]:::client
    end

    %% Web Server
    subgraph "PHP Server (Apache + PHP 7.4)" 
        direction TB
        login["login.php"]:::php
        logout["logout.php"]:::php
        index["index.php (Dashboard)"]:::php
        datos["datos.php (API)"]:::api
        test_datos["test_datos.php (API Test)"]:::api
        export_excel["export_excel.php"]:::php
        SimpleXLSXGen["SimpleXLSXGen.php"]:::lib
        verify_events["verify_events.php"]:::php
        vendor["vendor/"]:::deps
        composer_json["composer.json"]:::deps
        composer_lock["composer.lock"]:::deps
    end

    %% Frontend Assets
    subgraph "Frontend Assets" 
        direction TB
        assets_js["assets/js/script.js"]:::frontend
        assets_datatables["assets/datatables"]:::frontend
        assets_img["assets/img"]:::frontend
    end

    %% Data Storage
    subgraph "Data Storage"
        direction TB
        DB["MySQL Database"]:::database
        Logs["logs/ (ping_monitor_*.log)"]:::logs
    end

    %% Python Worker
    subgraph "Cron & Python Worker"
        direction TB
        cron["Cron Scheduler"]:::cron
        pingEscala["pingEscala.py"]:::python
    end

    %% Documentation
    subgraph "Documentation"
        direction TB
        README["README.md"]:::docs
        git_instrucciones["git_instrucciones.md"]:::docs
    end

    %% Connections
    Browser -->|"GET /login.php"| login
    Browser -->|"POST /logout.php"| logout
    Browser -->|"GET /index.php"| index
    Browser -->|"AJAX GET /datos.php"| datos
    Browser -->|"AJAX GET /test_datos.php"| test_datos
    Browser -->|"GET /export_excel.php"| export_excel
    login -->|"SQL SELECT user"| DB
    logout -->|"SQL UPDATE session"| DB
    index -->|"SQL SELECT telemetry"| DB
    datos -->|"SQL SELECT telemetry"| DB
    test_datos -->|"SQL SELECT telemetry"| DB
    export_excel -->|"Uses SimpleXLSXGen"| SimpleXLSXGen
    export_excel -->|"SQL SELECT telemetry"| DB
    verify_events -->|"SQL SELECT/UPDATE events"| DB
    cron -->|"trigger"| pingEscala
    pingEscala -->|"INSERT ping results"| DB
    pingEscala -->|"write logs"| Logs
    vendor -->|"provides dependencies"| login
    vendor -->|"provides dependencies"| index
    vendor -->|"provides dependencies"| datos
    vendor -->|"provides dependencies"| export_excel
    assets_js -->|served by PHP Server| Browser
    assets_datatables -->|served by PHP Server| Browser
    assets_img -->|served by PHP Server| Browser

    %% Click Events
    click login "https://github.com/andersonvictor/telemetria/blob/master/login.php"
    click logout "https://github.com/andersonvictor/telemetria/blob/master/logout.php"
    click index "https://github.com/andersonvictor/telemetria/blob/master/index.php"
    click datos "https://github.com/andersonvictor/telemetria/blob/master/datos.php"
    click test_datos "https://github.com/andersonvictor/telemetria/blob/master/test_datos.php"
    click export_excel "https://github.com/andersonvictor/telemetria/blob/master/export_excel.php"
    click SimpleXLSXGen "https://github.com/andersonvictor/telemetria/blob/master/SimpleXLSXGen.php"
    click verify_events "https://github.com/andersonvictor/telemetria/blob/master/verify_events.php"
    click assets_js "https://github.com/andersonvictor/telemetria/blob/master/assets/js/script.js"
    click assets_datatables "https://github.com/andersonvictor/telemetria/tree/master/assets/datatables"
    click assets_img "https://github.com/andersonvictor/telemetria/tree/master/assets/img"
    click Logs "https://github.com/andersonvictor/telemetria/tree/master/logs/"
    click pingEscala "https://github.com/andersonvictor/telemetria/blob/master/pingEscala.py"
    click vendor "https://github.com/andersonvictor/telemetria/tree/master/vendor/"
    click composer_json "https://github.com/andersonvictor/telemetria/blob/master/composer.json"
    click composer_lock "https://github.com/andersonvictor/telemetria/blob/master/composer.lock"
    click README "https://github.com/andersonvictor/telemetria/blob/master/README.md"
    click git_instrucciones "https://github.com/andersonvictor/telemetria/blob/master/git_instrucciones.md"

    %% Styles
    classDef client fill:#cdf2cd,stroke:#2d7a2d,color:#000
    classDef php fill:#cce5ff,stroke:#004085,color:#000
    classDef api fill:#b8daff,stroke:#004085,color:#000
    classDef lib fill:#d6d8db,stroke:#383d41,color:#000
    classDef frontend fill:#f0e6ff,stroke:#5b3292,color:#000
    classDef database fill:#ffe5b4,stroke:#ff8c00,color:#000
    classDef logs fill:#f5e1da,stroke:#a94442,color:#000
    classDef python fill:#ececec,stroke:#3470a1,color:#000
    classDef cron fill:#e2f0d9,stroke:#2e7d32,color:#000
    classDef deps fill:#d1ecf1,stroke:#0c5460,color:#000
    classDef docs fill:#fff3cd,stroke:#856404,color:#000
```
