How drstone438/mk-bot-online works
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.