# drstone438/mk-bot-online architecture

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

- Interactive diagram: https://gitdiagram.com/drstone438/mk-bot-online
- Repository: https://github.com/drstone438/mk-bot-online

## Overview

Para dibujar un diagrama de arquitectura preciso para este proyecto "MK-BOT", sigue estos pasos:

##### Identificar tipo de proyecto y propósito
- Es una solución IoT / Full-Stack de control remoto de un robot.
- Consta de tres subsistemas principales:
a. Firmware en un microcontrolador ESP32/ESP8266 (edge device)
b. Servidor WebSocket en Node.js (back-end)
c. Interfaz Web en HTML/CSS/Bootstrap/JavaScript (front-end)

##### Analizar la estructura de ficheros
- Carpeta “ESP 8266”: codigo fuente del firmware, PlatformIO (platformio.ini), `include/` (headers), `lib/` (librerías), `src/main.cpp`, tests.
- Carpeta “Servidor Externo”: Node.js con `server.js`, `package.json`, `node_modules/`, `public/` (interfaz web), y un HTML sin Bootstrap para pruebas.
- Raíz: `README.md` (documentación global), `LICENSE`.

##### Extraer insights del README
- El firmware se conecta a WiFi y abre un cliente WebSocket.
- El servidor Node.js expone un endpoint WS y sirve la página web.
- La página web envía comandos (adelante, atrás, izquierda, derecha, stop) y recibe estados posiblemente.

##### Componentes a incluir en el diagrama
- **Edge Device (ESP32/ESP8266)**
- Módulo WiFi + WebSocketsClient
- Control de puente H y motores
- **Servidor WebSocket**
- Node.js + Express + ws + cors
- Gestión de conexiones WS de múltiples clientes web y del ESP
- **Cliente Web**
- HTML/CSS/Bootstrap + JS (WebSocket en navegador)
- UI de botones y selección de robot
- **Red WiFi / Internet**
- Punto de acceso o router
- Tráfico WS

##### Relaciones e interacciones
- Flechas bidireccionales WebSocket:
a. Entre navegador web y servidor Node.js (Puerto 3000)
b. Entre servidor Node.js y microcontrolador ESP (misma URL o IP)
- Flujo de comando:
Usuario → UI web → WS → Servidor → WS → ESP → Motores
- Flujo de estado o ACKs (opcional) vuelve en sentido inverso.

##### Patrones y principios arquitecturales
- Comunicación en tiempo real basada en Pub/Sub via WebSockets.
- Separación de capas: edge, back-end y front-end.
- Modulación de firmware usando PlatformIO y librerías ArduinoJson, WiFi.h, WebSocketsClient.h.

##### Tecnologías y frameworks clave
- Firmware: PlatformIO (platformio.ini), C++/Arduino
- Servidor: Node.js, Express, ws, cors
- Web UI: HTML5, CSS, Bootstrap, JavaScript WebSocket API

##### Guía para dibujar el diagrama
a. Usa rectángulos o “nubes” para cada componente:
- Circle/rectangle azul para el ESP
- Rectángulo verde para el servidor
- Rectángulo naranja para la UI web
- Icono de WiFi o nube para la red
- (Opcional) Caja de hardware motor/power
b. Dibuja flechas con sentido para mostrar:
- Conexión WebSocket entre Web UI ↔ Servidor
- Conexión WebSocket entre Servidor ↔ ESP
- Señala puertos (por ej. 3000) y protocolos (ws://)
- Azul = Edge Device
- Verde = Back-end
- Naranja = Front-end
- Gris = Infraestructura de red
d. Etiqueta cada flecha (“comando”, “ack”, “payload JSON”)

##### Detalles a capturar
- Ficheros de configuración (platformio.ini, package.json) como anotaciones.
- Librerías críticas (ArduinoJson, ws) junto al componente correspondiente.
- Estructura de carpetas principales mencionada como “sub-sistemas lógicos”.

Con estos lineamientos, el diagrama reflejará fielmente la arquitectura de MK-BOT, mostrando clara separación de responsabilidades, flujos de datos y tecnologías involucradas.
No es necesario sobre-diseñar; basta con separar cada capa/componentes y conectar con flechas etiquetadas.
Asegúrate de incluir leyenda de colores, labels claros y notas de configuración para máximo detalle.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Edge Device Layer
    subgraph "Edge Device (ESP32/ESP8266)" 
        direction TB
        PINI["platformio.ini"]:::edge
        MAIN["src/main.cpp"]:::edge
        INCL["include/"]:::edge
        LIBS["lib/"]:::edge
        FWLIB["ArduinoJson, WiFi.h, WebSocketsClient.h"]:::edge
    end

    %% Back-end Layer
    subgraph "Back-end (WebSocket Server)" 
        direction TB
        SJ["server.js"]:::backend
        PKG["package.json"]:::backend
        NM["node_modules/"]:::backend
    end

    %% Front-end Layer
    subgraph "Front-end (Web UI)" 
        direction TB
        INDEX["public/index.html"]:::frontend
        PUB["public/"]:::frontend
        TEST["indexSinBoostrap.html"]:::frontend
    end

    %% Network Infrastructure
    subgraph "Network (WiFi/Internet)" 
        direction TB
        WIFI["WiFi Router / Access Point\nws://"]:::infra
    end

    %% Hardware Components
    subgraph "Hardware" 
        direction TB
        MOTORS["H-Bridge & Motors"]:::edge
    end

    %% Documentation
    subgraph "Project Documentation" 
        direction TB
        RD["README.md"]:::docs
        LIC["LICENSE"]:::docs
    end

    %% Connections
    WIFI -.->|“transports ws://”| INDEX
    WIFI -.->|“transports ws://”| TEST
    WIFI -.->|“transports ws://”| SJ
    WIFI -.->|“transports ws://”| PINI

    INDEX -->|"WS cmd/ack\nPort 3000"| SJ
    TEST -->|"WS cmd/ack\nPort 3000"| SJ
    SJ -->|"WS cmd/ack\nws://ESP_IP"| PINI
    PINI -->|"executes control"| MOTORS

    %% Click Events
    click PINI "https://github.com/drstone438/mk-bot-online/blob/main/ESP 8266/platformio.ini"
    click MAIN "https://github.com/drstone438/mk-bot-online/blob/main/ESP 8266/src/main.cpp"
    click INCL "https://github.com/drstone438/mk-bot-online/tree/main/ESP 8266/include/"
    click LIBS "https://github.com/drstone438/mk-bot-online/tree/main/ESP 8266/lib/"
    click SJ "https://github.com/drstone438/mk-bot-online/blob/main/Servidor Externo/server.js"
    click PKG "https://github.com/drstone438/mk-bot-online/blob/main/Servidor Externo/package.json"
    click NM "https://github.com/drstone438/mk-bot-online/tree/main/Servidor Externo/node_modules/"
    click INDEX "https://github.com/drstone438/mk-bot-online/blob/main/Servidor Externo/public/index.html"
    click PUB "https://github.com/drstone438/mk-bot-online/tree/main/Servidor Externo/public/"
    click TEST "https://github.com/drstone438/mk-bot-online/blob/main/Servidor Externo/indexSinBoostrap.html"
    click RD "https://github.com/drstone438/mk-bot-online/blob/main/README.md"
    click LIC "https://github.com/drstone438/mk-bot-online/tree/main/LICENSE"

    %% Styles
    classDef edge fill:#cce5ff,stroke:#333,stroke-width:2px
    classDef backend fill:#d4edda,stroke:#333,stroke-width:2px
    classDef frontend fill:#ffe5b4,stroke:#333,stroke-width:2px
    classDef infra fill:#e2e3e5,stroke:#333,stroke-width:2px
    classDef docs fill:#f8f9fa,stroke:#333,stroke-width:2px
```
