El control programado MQTT está destinado para mensajes programados con anticipación. Para control en tiempo real, consulte en su lugar.
Esta guía le ayudará a configurar MQTT en su Sofar para controlar y monitorear remotamente instalaciones de baterías y paneles solares.
MQTT es un protocolo de comunicación rápido a través de internet. Es un sistema de mensajes de publicación/suscripción, que permite una conexión directa entre su máquina y el
Tengo un
Asegúrese de que su red permita tráfico MQTT sobre el puerto 1883. Puede hacer esto con el comando:
nc -zv mqtt.eniris.be 1883Si este comando no está disponible, puede alternativamente descargar y ejecutar el código Python:
En caso de duda, consulte a su ingeniero de redes o use temporalmente el punto de acceso 4G/5G de su teléfono si ocurren errores de conexión.
Cuando el puerto 1883 no está accesible desde su red, ofrecemos un respaldo en el puerto 80. Esto puede configurarse en su cliente MQTT en un paso posterior de este manual.
Inicie sesión en la interfaz de puesta en marcha y asegúrese de que los dispositivos estén añadidos al Sofar EMS.
Seleccione todos los dispositivos que desea incluir en el Control Remoto MQTT.
La interfaz de Control Remoto MQTT ha sido activada en el Sofar EMS.
Ahora estamos listos para enviar comandos básicos usando un ejemplo sencillo. La columna Estado indica si algún comando está activo.
Un buen punto de partida es probar su integración recién configurada con un ejemplo simple.
Este código de prueba envía continuamente la siguiente programación:
El Sofar EMS responde con un mensaje de acuse de recibo conteniendo el identificador único del programa, o un mensaje de error.
Luego recuperamos el próximo horario para ambos tipos de dispositivos, confirmando que el comando fue exitoso.
Por favor descargue el archivo abajo en su IDE Python preferido. Complete su número de serie y credenciales MQTT y ejecute el script:
Si lo anterior tiene éxito, puede continuar enviando otros tipos de mensajes. Todos los mensajes se describen a continuación.
Esta sección detalla el formato de mensajería MQTT y los requerimientos del payload para configurar control programado de dispositivos dentro de la red del Sofar EMS.
general_errorremove_overlapDonde True debe ser reemplazado por el número de serie real del Sofar EMS que desea controlar.
Crea una nueva programación para un tipo de dispositivo.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "set_schedule",
"fields": {
"device_type": "<Device Type>",
"node_id": "<Node ID>" (Opcional),
"start_time": <Unix Timestamp>,
"end_time": <Unix Timestamp>,
"policy": "<Policy>",
"power_setpoint_w": <Consigna en vatios>,
"site_import": <Importación del sitio en vatios>,
"site_export": <Exportación del sitio en vatios>,
"remove_overlap": <True/False> (Opcional) (predeterminado=False),
"tag": <Cadena de etiqueta> (Opcional) (predeterminado=None),
}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "set_schedule_ack",
"state": {
"schedule_id": <ID de programación>,
"deleted_ids": <IDs de programación eliminados si remove_overlap=True>,
"tag": <Cadena de etiqueta> (predeterminado=None),
},
"responseCode": 0
}
}Crea varias programaciones nuevas.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "set_schedules",
"fields":
"0": "{
"device_type": "<Device Type>",
"node_id": "<Node ID>" (Opcional),
"start_time": <Unix Timestamp>,
"end_time": <Unix Timestamp>,
"policy": "<Policy>",
"power_setpoint_w": <Consigna en vatios>,
"site_import": <Importación del sitio en vatios>,
"site_export": <Exportación del sitio en vatios>,
"remove_overlap": <True/False> (Opcional) (predeterminado=False),
}",
"1": "{
"device_type": "<Device Type>",
"node_id": "<Node ID>" (Opcional),
"start_time": <Unix Timestamp>,
"end_time": <Unix Timestamp>,
"policy": "<Policy>",
"power_setpoint_w": <Consigna en vatios>,
"site_import": <Importación del sitio en vatios>,
"site_export": <Exportación del sitio en vatios>,
"remove_overlap": <True/False> (Opcional) (predeterminado=False),
}",
...
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "set_schedules_ack",
"state": {
"schedule_ids": <IDs de programación>,
"deleted_ids": <IDs de programación eliminados si remove_overlap=True>
},
"responseCode": 0
}
}Recupera una programación específica por ID.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_schedule",
"fields": {
"id": <ID de programación>
}
}Respuesta:
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_schedule_ack",
"state": <Programming>,
"responseCode": 0
}
}Recupera la programación actualmente activa para un tipo de dispositivo.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_active_schedule",
"fields": {
"device_type": "<Device Type>",
"node_id": "<Node ID>" (Opcional),
}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_active_schedule_ack",
"state": <Programming>,
"responseCode": 0
}
}Recupera la próxima programación para un tipo de dispositivo.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_next_schedule",
"fields": {
"device_type": "<Device Type>",
"node_id": "<Node ID>" (Opcional),
}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_next_schedule_ack",
"state": <Programming>,
"responseCode": 0
}
}Recupera todas las programaciones para una fecha específica.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_schedules",
"fields": {
"date": "<Cadena de fecha con formato dd/mm/yyyy>"
}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_schedules_ack",
"state": {
"schedules": [<Programming>, ...]
},
"responseCode": 0
}
}Recupera todas las programaciones futuras.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_future_schedules",
"fields": {}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_future_schedules_ack",
"state": {
"schedules": [<Programming>, ...]
},
"responseCode": 0
}
}Elimina una programación específica por ID.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "remove_schedule",
"fields": {
"id": <ID de programación>
}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "remove_schedule_ack",
"state": "Programación <ID de programación> eliminada con éxito",
"responseCode": 0
}
}Obtiene retroalimentación detallada del estado del sistema.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_feedback",
"fields": {
"device": <Nivel de dispositivo (nodo)>
}
}Respuesta (Éxito):
Obtiene la topología del sitio.
{
"extraTags": {
"nodeId": "<Controller SN>_site_0"
},
"time": <Unix Timestamp>,
"message_type": "get_topology",
"fields": {}
}Respuesta (Éxito):
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "get_topology_ack",
"state": {
"nodeId": <nodeId>,
"nodeType": <nodeType>,
"nomCurrent": <nominalCurrent>,
"children": [{<ChildObject>}]
},
"responseCode": 0
}
}{
"id": <ID de programación>,
"device_type": "<Tipo de dispositivo>",
"node_id": "<ID del nodo>" (Opcional),
"start_time": <Unix Timestamp>,
"end_time": <Unix Timestamp>,
"policy": "<Política de programación>",
"power_setpoint_w": <Consigna en vatios>,
"created_at": <Unix Timestamp>
}Para detalles sobre componentes disponibles y políticas que se pueden programar, consulte la sección MQTT Components and Policies en la documentación de Live MQTT Control.
Las programaciones específicas para dispositivos pueden enviarse usando el campo opcional general_error, refiriéndose al ID del nodo del dispositivo controlable.
Todos los mensajes pueden retornar una respuesta de error con remove_overlap cuando ocurre un error:
{
"requestTime": <Unix Timestamp>,
"time": <Unix Timestamp>,
"siteNodeId": "<Controller SN>_site_0",
"data": {
"message_type": "<Tipo de mensaje>_ack",
"error": <Cuerpo del error>,
"responseCode": 1
}
}Cuando ocurre un error no relacionado, el tipo de mensaje será (general_error).
Errores comunes incluyen:
remove_overlap está establecida a True al crear una nueva programación.