Descripción del protocolo Stomp
Para enviar datos a Scout, se recomienda usar Stomp con nuestras cabeceras y definiciones de payload personalizadas.
Protocolo Stomp
El protocolo Stomp es muy sencillo: es un protocolo basado en texto con pocos comandos y cabeceras. La semántica se implementa mediante la cabecera destination.
Conexión
Para conectarte a Scout debes usar los siguientes parámetros:
| Parámetro | Valor |
|---|---|
| URL | wss://scout.circutor.com/ws/stomp |
| Host | pro |
| Username | <claimID> |
| Password | <Token> |
<claimID>son identificadores únicos (8 caracteres, A-Za-z0-9) que se usan para identificar la pasarela que envía los datos.<Token>es el token que se usa para autenticar la pasarela.
Ambos valores los proporciona la plataforma al crear la pasarela. Se pueden crear desde fábrica y configurarse en el hardware.
Cabeceras
Estas son las cabeceras necesarias para enviar datos a Scout:
| Cabecera | Descripción | Ejemplo |
|---|---|---|
| myc-version | Versión del protocolo | 1.0 |
| myc-message-type | Tipo de mensaje | EVENT,METRIC,WAVEFORM,ATTRIBUTE |
| myc-fw-version | Versión de firmware (comunicaciones) | X.Y.Z |
| myc-hw-version | Versión de hardware | X.Y.Z |
| myc-gw-type | Tipo de pasarela | gatewayType |
| myc-fw-measure | Versión de firmware de medida (opcional) | X.Y.Z |
| myc-serial-number | Número de serie de la pasarela | 2145588744588 |
Formato de los datos
Para enviar datos (eventos, métricas, formas de onda o atributos) a Scout, debes usar los formatos que se describen a continuación.
Métricas
Las métricas son el tipo de dato más habitual que se envía a Scout. Se usan para representar un valor en un instante determinado.
destination: /exchange/metrics/gateways.<claimID>
{
"gateway_device_id": "MAIN",
"metrics": [
{
"ts": "2024-09-30T09:00:00.000Z",
"data": {
"P_CON_TOT_ENERGY": 756387.9,
"P_GEN_TOT_ENERGY": 6.7711396,
"Q_Q1_TOT_ENERGY": 120348.6,
"Q_Q2_TOT_ENERGY": 1.2876,
"Q_Q3_TOT_ENERGY": 0.0013434684,
"Q_Q4_TOT_ENERGY": 0.16768773,
"S_TOT_ENERGY": 770940.9
}
}
]
}
Ten en cuenta que el campo ts debe estar en formato ISO 8601 y que gateway_device_id es un identificador único del equipo dentro del ámbito de la pasarela.
Para los equipos que incluyen tanto la pasarela como el equipo (como ComputerC6 o QNA600), el gateway_device_id es siempre MAIN.
Para otras pasarelas que tienen varios esclavos (como Line EDS Cloud), el gateway_device_id es el identificador del esclavo (por ejemplo, la dirección modbus o el nombre del equipo).
Atributos
Los atributos se usan para enviar datos de configuración a Scout. Sirven para comunicar a la plataforma la configuración de la pasarela o del equipo.
destination: /exchange/attributes/gateways.<claimID>
{
"gateway_attributes": {
"SERIAL_NUMBER": "82621240052",
"FW_VERSION": "2.03.01",
"FW_MEASURE": "2.6.0",
"HW_MODEL": "EDSCLOUD",
"HW_VERSION": "1"
},
"device_attributes": {
"<slave_1>": {
"SERIAL_NUMBER": "12300012345678",
"FW_VERSION": "1.1.0",
"FW_MEASURE": "2.6.0",
"HW_MODEL": "CVM-D50-ITF",
"HW_VERSION": "1",
"CONNECTION_TYPE": "3PH4W"
},
"<slave_2>": {
"SERIAL_NUMBER": "12300012345679",
"FW_VERSION": "1.1.1",
"FW_MEASURE": "2.6.2",
"HW_MODEL": "CVM-D50-ITF",
"HW_VERSION": "1",
"CONNECTION_TYPE": "3PH4W"
}
}
}
Tanto gateway_attributes como device_attributes son opcionales. Si device_attributes está presente, debe contener un mapa identificador -> información del equipo. En el payload, estos identificadores de la pasarela aparecen como <slave_1> y <slave_2>. Como valor se puede usar la dirección modbus o el nombre del equipo, siempre que sea único.
Hay algunas claves de atributo que tienen un efecto especial en la plataforma. Todos los campos son opcionales.
| Atributo | Descripción | Comportamiento |
|---|---|---|
| SERIAL_NUMBER | Número de serie | Actualiza el número de serie (pasarela o equipo) |
| FW_VERSION | Versión de firmware | Ninguno, solo actualiza la información |
| FW_MEASURE | Versión de firmware de medida | Ninguno, solo actualiza la información |
| HW_VERSION | Versión de hardware | Ninguno, solo actualiza la información |
| HW_MODEL | Variante de hardware (itf, flex, ...) | Ninguno, solo actualiza la información |
Eventos
destination: /exchange/events/gateways.<claimID>
{
"gateway_device_id": "MAIN",
"events": [
{
"id": "e9adb178-3a7c-4e90-9ea8-d0a3fc5ddc34",
"type": "EXPORT_CONNECTED",
"ts": "2024-09-30T12:13:54.094+02:00",
"status": "INFO",
"index": "NONE",
"info": {}
}
]
}
Descripción de los campos:
id: identificador único del evento (opcional)type: tipo de evento (obligatorio); se recomienda seguir la lista de tipos de eventots: marca de tiempo del evento (obligatorio); debe estar en formato ISO 8601status: estado del evento (obligatorio); puede serINFO,ON,OFFindex: se usa para representar fases, nombres de atributos, etc. (por defecto debe serNONE)info: información adicional que pueda ser de interés (opcional)
Formas de onda
Las formas de onda se usan para enviar datos de alta frecuencia a la plataforma. Sirven para representar la forma de onda de una señal.
destination: /exchange/waveforms/gateways.<claimID>
{
"id": "2ec67a5a-7310-42ae-95ec-1203d8fc634b",
"gateway_device_id": "QNA600",
"start_at": "2024-05-16T09:26:27.976Z",
"first_event_ts": "2024-05-16T09:26:28.040Z",
"sample_rate": 12797.278,
"channels_analog": [
{
"name": "V_AN",
"sample_factor": 0.02519966,
"samples": [
[
0,
12436
],
[
78,
12313
]
]
},
{
"name": "V_BN",
"sample_factor": 0.02519966,
"samples": [
[
0,
12475
],
[
78,
12352
]
]
},
{
"name": "V_CN",
"sample_factor": 0.02519966,
"samples": [
[
0,
12456
],
[
78,
12345
]
]
},
{
"name": "I_AN",
"sample_factor": 0.00066365,
"samples": [
[
0,
12
],
[
78,
11
]
]
},
{
"name": "I_BN",
"sample_factor": 0.00066365,
"samples": [
[
0,
4
],
[
78,
13
]
]
},
{
"name": "I_CN",
"sample_factor": 0.00066365,
"samples": [
[
0,
17
],
[
78,
27
]
]
}
]
}