Skip to content

Métricas

Las métricas son los datos que la plataforma Scout recoge de las instalaciones eléctricas. Estos datos se usan para supervisar el estado de las instalaciones y detectar desviaciones respecto al funcionamiento normal. Una vez procesados, los datos se pueden visualizar y usar para generar alertas automáticas.

Estructura de las métricas

Parámetros

Cada métrica tiene asociado un código que sirve como identificador. La tabla siguiente contiene la lista de todos los códigos que admite la plataforma.

  • Nombre contiene una descripción de la métrica
  • Unidad contiene la unidad de la métrica (si la tiene)
  • Tipo de variable indica si la métrica es un gauge (valor instantáneo) o un counter (valor acumulado)
  • Tipo indica el tipo de dato de la métrica. Los 2 tipos admitidos son:
    • FLOAT: contiene un único valor de coma flotante, por ejemplo 230.1
    • JSON: contiene datos anidados, por ejemplo:
      {
        "HARM_V_AN": {
            "0": 230.1,
            "1": 0.1,
            "2": 0.05
        }
      }
      

Consulta

Las métricas se pueden obtener con sus valores en bruto, pero también es posible aplicar agregaciones a los datos, según el tipo de variable: valor instantáneo (gauge) o valor acumulado (counter).

Las agregaciones disponibles para las variables gauge son:

  • avg: valor medio de la métrica en el periodo seleccionado.
  • max: valor máximo de la métrica en el periodo seleccionado.
  • min: valor mínimo de la métrica en el periodo seleccionado.

Las agregaciones disponibles para las variables counter son:

  • delta: diferencia entre el último y el primer valor de la métrica en el periodo seleccionado.

Los periodos de agregación de las variables son hour, day, week, month.

Lista de métricas

Código Nombre Unidad Tipo de variable Tipo
V_AN Tensión L1 V gauge FLOAT
V_BN Tensión L2 V gauge FLOAT
V_CN Tensión L3 V gauge FLOAT
V_AB Tensión L1L2 V gauge FLOAT
V_BC Tensión L2L3 V gauge FLOAT
V_CA Tensión L3L1 V gauge FLOAT
V_PP Tensión de fase desconocida V gauge FLOAT
V_NG Tensión de neutro V gauge FLOAT
I_AN Corriente L1 A gauge FLOAT
I_BN Corriente L2 A gauge FLOAT
I_CN Corriente L3 A gauge FLOAT
I_TOT Corriente total A gauge FLOAT
I_LK Corriente de fuga A gauge FLOAT
I_NG Corriente de neutro A gauge FLOAT
FREQ Frecuencia Hz gauge FLOAT
CF_I_AN Factor de cresta de corriente L1 gauge FLOAT
CF_I_BN Factor de cresta de corriente L2 gauge FLOAT
CF_I_CN Factor de cresta de corriente L3 gauge FLOAT
CF_I_NG Factor de cresta de corriente de neutro gauge FLOAT
CF_V_AN Factor de cresta de tensión L1 gauge FLOAT
CF_V_BN Factor de cresta de tensión L2 gauge FLOAT
CF_V_CN Factor de cresta de tensión L3 gauge FLOAT
CF_V_NG Factor de cresta de tensión de neutro gauge FLOAT
DPF_AN Cosφ L1 gauge FLOAT
DPF_BN Cosφ L2 gauge FLOAT
DPF_CN Cosφ L3 gauge FLOAT
DPF_TOT Cosφ total gauge FLOAT
KF_AN Factor K L1 % gauge FLOAT
KF_BN Factor K L2 % gauge FLOAT
KF_CN Factor K L3 % gauge FLOAT
N_AN Potencia no activa L1 var gauge FLOAT
N_BN Potencia no activa L2 var gauge FLOAT
N_CN Potencia no activa L3 var gauge FLOAT
N_TOT Potencia no activa total var gauge FLOAT
OD_V_AN Desviación por exceso L1 % gauge FLOAT
OD_V_BN Desviación por exceso L2 % gauge FLOAT
OD_V_CN Desviación por exceso L3 % gauge FLOAT
OD_V_AB Desviación por exceso L1L2 % gauge FLOAT
OD_V_BC Desviación por exceso L2L3 % gauge FLOAT
OD_V_CA Desviación por exceso L3L1 % gauge FLOAT
UD_V_AN Desviación por defecto L1 % gauge FLOAT
UD_V_BN Desviación por defecto L2 % gauge FLOAT
UD_V_CN Desviación por defecto L3 % gauge FLOAT
VOD_V_AN Desviación de tensión por exceso L1 V gauge FLOAT
VOD_V_BN Desviación de tensión por exceso L2 V gauge FLOAT
VOD_V_CN Desviación de tensión por exceso L3 V gauge FLOAT
VOD_V_AB Desviación de tensión por exceso L1L2 V gauge FLOAT
VOD_V_BC Desviación de tensión por exceso L2L3 V gauge FLOAT
VOD_V_CA Desviación de tensión por exceso L3L1 V gauge FLOAT
VUD_V_AN Desviación de tensión por defecto L1 V gauge FLOAT
VUD_V_BN Desviación de tensión por defecto L2 V gauge FLOAT
VUD_V_CN Desviación de tensión por defecto L3 V gauge FLOAT
VUD_V_AB Desviación de tensión por defecto L1L2 V gauge FLOAT
VUD_V_BC Desviación de tensión por defecto L2L3 V gauge FLOAT
VUD_V_CA Desviación de tensión por defecto L3L1 V gauge FLOAT
P1_AN Potencia activa fundamental L1 W gauge FLOAT
P1_BN Potencia activa fundamental L2 W gauge FLOAT
P1_CN Potencia activa fundamental L3 W gauge FLOAT
P1_TOT Potencia activa fundamental III W gauge FLOAT
PF_AN Factor de potencia L1 gauge FLOAT
PF_BN Factor de potencia L2 gauge FLOAT
PF_CN Factor de potencia L3 gauge FLOAT
PF_TOT Factor de potencia total gauge FLOAT
PHI_AN Ángulo tensión - corriente L1 ° gauge FLOAT
PHI_BN Ángulo tensión - corriente L2 ° gauge FLOAT
PHI_CN Ángulo tensión - corriente L3 ° gauge FLOAT
PST_AN Flicker de corta duración L1 gauge FLOAT
PST_BN Flicker de corta duración L2 gauge FLOAT
PST_CN Flicker de corta duración L3 gauge FLOAT
PST_AB Flicker de corta duración L1L2 gauge FLOAT
PST_BC Flicker de corta duración L2L3 gauge FLOAT
PST_CA Flicker de corta duración L3L2 gauge FLOAT
PLT_AN Flicker de larga duración L1 gauge FLOAT
PLT_BN Flicker de larga duración L2 gauge FLOAT
PLT_CN Flicker de larga duración L3 gauge FLOAT
PLT_AB Flicker de larga duración L1L2 gauge FLOAT
PLT_BC Flicker de larga duración L2L3 gauge FLOAT
PLT_CA Flicker de larga duración L3L1 gauge FLOAT
P_AN Potencia activa L1 W gauge FLOAT
P_BN Potencia activa L2 W gauge FLOAT
P_CN Potencia activa L3 W gauge FLOAT
P_TOT Potencia activa III W gauge FLOAT
Q_AN Potencia reactiva L1 var gauge FLOAT
Q_BN Potencia reactiva L2 var gauge FLOAT
Q_CN Potencia reactiva L3 var gauge FLOAT
Q_TOT Potencia reactiva III var gauge FLOAT
S1_AN Potencia aparente fundamental L1 VA gauge FLOAT
S1_BN Potencia aparente fundamental L2 VA gauge FLOAT
S1_CN Potencia aparente fundamental L3 VA gauge FLOAT
S1_TOT Potencia aparente fundamental III VA gauge FLOAT
SEQ_NEG_I Desequilibrio de corriente (descompuesto) I gauge FLOAT
SEQ_NEG_V_PN Desequilibrio de tensión (descompuesto) V gauge FLOAT
SEQ_NEG_V_PP Desequilibrio de fase desconocida (descompuesto) V gauge FLOAT
SEQ_POS_I Corriente de secuencia positiva A gauge FLOAT
SEQ_POS_V_PN Tensión de secuencia positiva total V gauge FLOAT
SEQ_POS_V_PP Tensión de secuencia positiva V gauge FLOAT
SEQ_ZERO_I Corriente de secuencia cero A gauge FLOAT
SEQ_ZERO_V_PN Tensión de secuencia cero total V gauge FLOAT
SEQ_ZERO_V_PP Tensión de secuencia cero V gauge FLOAT
ASYM_I Asimetría de corriente % gauge FLOAT
UNBAL_I Desequilibrio de corriente A gauge FLOAT
UNBAL_V_PN Factor de desequilibrio de tensión % gauge FLOAT
ASYM_V_PN Factor de asimetría de tensión % gauge FLOAT
UNBAL_V_PP Desequilibrio de tensión % gauge FLOAT
ASYM_V_PP Asimetría de tensión % gauge FLOAT
SGA_V_AN Corriente de señalización L1 V gauge FLOAT
SGA_V_BN Corriente de señalización L2 V gauge FLOAT
SGA_V_CN Corriente de señalización L3 V gauge FLOAT
S_AN Potencia aparente L1 VA gauge FLOAT
S_BN Potencia aparente L2 VA gauge FLOAT
S_CN Potencia aparente L3 VA gauge FLOAT
S_TOT Potencia aparente total VA gauge FLOAT
TDD_AN Distorsión total de la demanda L1 % gauge FLOAT
TDD_BN Distorsión total de la demanda L2 % gauge FLOAT
TDD_CN Distorsión total de la demanda L3 % gauge FLOAT
TDD_NG Distorsión total de la demanda neutro % gauge FLOAT
THD_I Distorsión armónica total de corriente % gauge FLOAT
THD_I_AN Distorsión armónica total de corriente L1 % gauge FLOAT
THD_I_BN Distorsión armónica total de corriente L2 % gauge FLOAT
THD_I_CN Distorsión armónica total de corriente L3 % gauge FLOAT
THD_I_NG Distorsión armónica total de corriente neutro % gauge FLOAT
THD_V_AN Distorsión armónica total de tensión L1 % gauge FLOAT
THD_V_BN Distorsión armónica total de tensión L2 % gauge FLOAT
THD_V_CN Distorsión armónica total de tensión L3 % gauge FLOAT
THD_V_AB Distorsión armónica total de tensión L1L2 % gauge FLOAT
THD_V_BC Distorsión armónica total de tensión L2L3 % gauge FLOAT
THD_V_CA Distorsión armónica total de tensión L3L1 % gauge FLOAT
THD_V_NG Distorsión armónica total de tensión neutro % gauge FLOAT
THD_V_PP Distorsión armónica total de corriente fase desconocida % gauge FLOAT
THETA_AA Ángulo entre tensiones L1L1 ° gauge FLOAT
THETA_AB Ángulo entre tensiones L1L2 ° gauge FLOAT
THETA_AC Ángulo entre tensiones L1L3 ° gauge FLOAT
TEMPERATURE_INTERNAL Temperatura interna °C gauge FLOAT
TEMPERATURE_EXTERNAL Temperatura externa °C gauge FLOAT
OPERATING_HOURS Horas de funcionamiento h gauge FLOAT
REPAIR_HOURS Horas de reparación h gauge FLOAT
OP_COUNT_STEP Número de maniobras por escalón ops counter JSON
P_CON_TOT_ENERGY Energía activa total A+ Wh counter FLOAT
P_CON_AN_ENERGY Energía activa L1 Wh counter FLOAT
P_CON_BN_ENERGY Energía activa L2 Wh counter FLOAT
P_CON_CN_ENERGY Energía activa L3 Wh counter FLOAT
P_GEN_TOT_ENERGY Energía activa total A- Wh counter FLOAT
P_GEN_AN_ENERGY Energía activa L1 - Wh counter FLOAT
P_GEN_BN_ENERGY Energía activa L2 - Wh counter FLOAT
P_GEN_CN_ENERGY Energía activa L3 - Wh counter FLOAT
Q_Q1_TOT_ENERGY Energía reactiva total Q1 varh counter FLOAT
Q_Q1_AN_ENERGY Energía reactiva L1 Q1 varh counter FLOAT
Q_Q1_BN_ENERGY Energía reactiva L2 Q1 varh counter FLOAT
Q_Q1_CN_ENERGY Energía reactiva L3 Q1 varh counter FLOAT
Q_Q2_TOT_ENERGY Energía reactiva total Q2 varh counter FLOAT
Q_Q2_AN_ENERGY Energía reactiva L1 Q2 varh counter FLOAT
Q_Q2_BN_ENERGY Energía reactiva L2 Q2 varh counter FLOAT
Q_Q2_CN_ENERGY Energía reactiva L3 Q2 varh counter FLOAT
Q_Q3_TOT_ENERGY Energía reactiva total Q3 varh counter FLOAT
Q_Q3_AN_ENERGY Energía reactiva L1 Q3 varh counter FLOAT
Q_Q3_BN_ENERGY Energía reactiva L2 Q3 varh counter FLOAT
Q_Q3_CN_ENERGY Energía reactiva L3 Q3 varh counter FLOAT
Q_Q4_TOT_ENERGY Energía reactiva total Q4 varh counter FLOAT
Q_Q4_AN_ENERGY Energía reactiva L1 Q4 varh counter FLOAT
Q_Q4_BN_ENERGY Energía reactiva L2 Q4 varh counter FLOAT
Q_Q4_CN_ENERGY Energía reactiva L3 Q4 varh counter FLOAT
S_TOT_ENERGY Energía aparente total S+ VAh counter FLOAT
S_AN_ENERGY Energía aparente L1 S+ VAh counter FLOAT
S_BN_ENERGY Energía aparente L2 S+ VAh counter FLOAT
S_CN_ENERGY Energía aparente L3 S+ VAh counter FLOAT
HARM_I_AN Armónico de corriente {X} L1 % json JSON
HARM_I_BN Armónico de corriente {X} L2 % json JSON
HARM_I_CN Armónico de corriente {X} L3 % json JSON
HARM_I_NG Armónico de corriente {X} neutro % json JSON
HARM_V_AN Armónico de tensión {X} L1 % json JSON
HARM_V_BN Armónico de tensión {X} L2 % json JSON
HARM_V_CN Armónico de tensión {X} L3 % json JSON
HARM_V_AB Armónico de tensión {X} L1L2 % json JSON
HARM_V_BC Armónico de tensión {X} L2L3 % json JSON
HARM_V_CA Armónico de tensión {X} L3L1 % json JSON
HARM_V_NG Armónico de tensión {X} neutro % json JSON
IHARM_I_AN Interarmónico de corriente {X} L1 % json JSON
IHARM_I_BN Interarmónico de corriente {X} L2 % json JSON
IHARM_I_CN Interarmónico de corriente {X} L3 % json JSON
IHARM_I_NG Interarmónico de corriente {X} neutro % json JSON
IHARM_V_AN Interarmónico de tensión {X} L1 % json JSON
IHARM_V_BN Interarmónico de tensión {X} L2 % json JSON
IHARM_V_CN Interarmónico de tensión {X} L3 % json JSON
IHARM_V_AB Interarmónico de tensión {X} L1L2 % json JSON
IHARM_V_BC Interarmónico de tensión {X} L2L3 % json JSON
IHARM_V_CA Interarmónico de tensión {X} L3L1 % json JSON
IHARM_V_NG Interarmónico de tensión {X} neutro % json JSON

Uso de las métricas con la API

Inserción

Si quieres insertar una métrica en la llamada a la API, debes usar el código de la métrica que quieres insertar. Por ejemplo, si quieres insertar la tensión de la fase L1 (V_AN), al ser un gauge tienes disponibles las siguientes opciones:

  • V_AN: representa el dato instantáneo
  • V_AN_AVG: representa el valor medio
  • V_AN_MAX: representa el valor máximo
  • V_AN_MIN: representa el valor mínimo

Si quieres insertar un counter, debes usar el sufijo _ENERGY. Por ejemplo, si quieres insertar la energía activa de la fase L1 (P_CON_AN_ENERGY), debes usar el código P_CON_AN_ENERGY.

Ejemplo de llamada para insertar en la API la tensión de la fase L1 (V_AN) con avg, max y min a las 8:00:

endpoint: /api/v2/assets/{assetId}/metricsv3/raw/batch parámetros:

  • assetId: id del activo en el que se va a insertar la métrica
  • Cabecera de autenticación: Bearer JSON Web Token

body:

{
  "metrics": [
    {
      "data": {
        "V_AN": 231.5,
        "V_AN_AVG": 231.2,
        "V_AN_MAX": 232.3,
        "V_AN_MIN": 229.8
      },
      "ts": "2024-10-22T08:00:00"
    }
  ]
}

Consulta

Para obtener métricas tienes dos opciones: obtener los datos en bruto u obtener los datos agregados.

Para obtener los datos en bruto, debes llamar al endpoint /api/v2/assets/{assetId}/metricsv3/raw con la siguiente configuración:

  • assetID: id del activo del que se van a obtener las métricas
  • Cabecera de autenticación: Bearer JSON Web Token
  • parámetros de consulta:
    • vars: código de las métricas que quieres obtener (puedes obtener varios tipos de métrica)
    • from: fecha de inicio del periodo que quieres obtener
    • to: fecha de fin del periodo que quieres obtener

Ejemplo de respuesta al obtener de la API la tensión L1 (V_AN) de 8:00 a 9:00:

{
  "data": [
    {
      "data": {
        "V_AN": 230.4
      },
      "ts": "2024-10-05T08:05:00+00:00"
    },
    {
      "data": {
        "V_AN": 231.2
      },
      "ts": "2024-10-05T08:55:00+00:00"
    }
  ],
  "status": "OK"
}

Para obtener los datos agregados, debes llamar al endpoint /api/v2/assets/{assetId}/metricsv3/raw con la siguiente configuración:

  • assetID: id del activo del que se van a obtener las métricas
  • Cabecera de autenticación: Bearer JSON Web Token
  • parámetros de consulta:
    • vars: código de las métricas que quieres obtener (puedes obtener varios tipos de métrica)
    • from: fecha de inicio del periodo que quieres obtener
    • to: fecha de fin del periodo que quieres obtener
    • agg: tipo de agregación que quieres obtener (avg, max, min, delta); ten en cuenta que la agregación delta solo está disponible para variables counter
    • period: periodo de la agregación (hour, day, week, month)

Ejemplo de respuesta al obtener de la API la energía activa total A+ (P_CON_TOT_ENERGY) de 8:00 a 9:00:

{
  "data": [
    {
      "data": {
        "P_CON_TOT_ENERGY": 230.4
      },
      "ts": "2024-10-05T08:05:00+00:00"
    },
    {
      "data": {
        "P_CON_TOT_ENERGY": 231.2
      },
      "ts": "2024-10-05T08:55:00+00:00"
    }
  ],
  "status": "OK"
}