Flujo de incorporación de señal externa
Consejo
La guía de incorporación está destinada a nuevas integraciones que utilizan el Protocolo MQTT de Eniris.
Una desventaja del protocolo MQTT es que no hay notificación ni transferencia de datos cuando se añade una nueva instalación. Por lo tanto, se recomienda incluir los siguientes pasos antes de integrarse completamente con el Sofar EMS.
Configuración
Se requerirá lo siguiente para configurar un flujo de incorporación:
-
API externa
- Se requiere una API pública
-
Al menos dos endpoints
- Endpoint de incorporación El endpoint de incorporación puede ser usado por el Sofar EMS para enviar una señal indicando que la instalación está lista para ser controlada. Información adicional puede incluir números de contrato ingresados por los usuarios, dirección de la instalación, información del dispositivo
- Endpoint de desvinculación El endpoint de desvinculación puede ser usado para indicar que la señal de control externa ha sido removida del Sofar EMS, y que el control ya no es posible.
- Endpoint de estado/healthcheck El endpoint de healthcheck puede ser consultado regularmente por el Sofar EMS para proporcionar una actualización del estado de los dispositivos o del sistema en conjunto.
Ejemplo
-
Un nuevo usuario añade la señal externa en el Sofar EMS. Se llamará al endpoint de incorporación para indicar que el Sofar EMS está listo para recibir comandos.
-
El Sofar EMS ha perdido conexión con la batería. El endpoint de healthcheck contendrá un mensaje de error.
-
Se requiere un número de contrato para vincular un número de serie Sofar EMS a un cliente. Un número de contrato puede incluirse en el flujo de incorporación, reduciendo la comunicación de ida y vuelta entre señales externas y clientes finales.
