Guía de Integración para Sensores e IoT (Improvemeter)

Bienvenido a la documentación oficial para la integración de dispositivos IoT, sensores de planta y PLCs con la plataforma de control industrial Improvemeter OEE.

Esta guía está diseñada exclusivamente para desarrolladores e integradores externos que requieren conectar hardware o controladores a la plataforma para el envío de señales de producción y recepción del estado operativo.

---

🎯 Objetivo de la Integración

El objetivo del sensor/dispositivo es:

1. Transmitir impulsos de producción (Conteo de Piezas) en tiempo real.
2. Notificar el estado de la máquina (Marcha / Detenida) para el registro automático de paradas.
3. Recibir la información de la orden de producción activa para mostrarla en pantallas de planta o dispositivos locales.

sequenceDiagram
    autonumber
    actor Sensor as Dispositivo Sensor / IoT / PLC
    participant Gateway as API Gateway (Improvemeter)

    Sensor->>Gateway: POST /auth/login-for-socket (Obtener Token)
    Gateway-->>Sensor: Token de Socket (JWT)
    
    Sensor->>Gateway: Conexión WebSocket (Namespace /oee)
    Gateway-->>Sensor: Conexión Establecida

    Sensor->>Gateway: emit 'subscribeLiveOee' { machineIds, isSensor: true }
    Gateway-->>Sensor: Eventos de estado de producción

    loop Durante la Operación
        Sensor->>Gateway: emit 'sendSensorSignal' { sensorId, signalValue, signalType }
        Gateway-->>Sensor: emit 'sensorSignalResponse'
    end

---

📋 Pasos para la Integración

1. Autenticación: Obtener el token de acceso para la sesión del socket.
2. Conexión: Establecer el canal WebSocket mediante Socket.io.
3. Suscripción del Sensor: Suscribir el dispositivo a la máquina asignada.
4. Envío de Señales: Transmitir señales de conteo (data) y estado (status).
5. Eventos Recibidos: Manejar las respuestas y el estado de la producción en tiempo real.