Saltar al contenido principal

API para el módulo ModulatorManager

El módulo ModulatorManager se ocupa de modular y/o balancear el consumo de la instalación actuando sobre los procesos de carga.

< Volver a la página principal.

Table of Contents

Operations

RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/processes/modulator Operation

  • Operation ID: StatProcModulatorOp

Indica el estado actual de los procesos abiertos

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringIdentificador de la red "mesh" a la que pertenece el cargador. Usualmente consiste en un 0 seguido de los últimos cinco dígitos del número de serie en formato hexadecimal.examples ("0F75B7")-required
deviceIdstringNúmero de serie del dispositivo.examples ("EVVC3454F75B7", "EVVC4AC4F415C")-required

Message StatProcModulatorMsg

Estado actual de los procesos abiertos

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobjectCabecera común para el payload de cada mensaje--additional properties are allowed
header.timestampintegerFecha y hora en formato UNIX Time Stamp--required
header.heapFreeintegerCantidad de memoria libre en la sección Heap---
dataobject---additional properties are allowed
data.uidintegerIdentificador del móduloconst (22)--
data.maxPowerintegerPotencia máxima del cargador (W)---
data.limitPowerintegerPotencia contratada (W)---
data.limitPowerByPhasearray<integer>Potencia contratada por fase (W)-3 items-
data.limitPowerByPhase (single item)integer----
data.totalPowerintegerPotencia total consumida en la instalación (W)---
data.totalPowerByPhasearray<integer>Potencia consumida en la instalación discriminada por fase (W)-3 items-
data.totalPowerByPhase (single item)integer----
data.midLEnabledbooleanContador MID de la izquierda habilitado---
data.midREnabledbooleanContador MID de la derecha habilitado---
data.totalEnerynumberEnergía total medida en la instalación (Wh)---
data.totalEnergyByPhasearray<number>Energía medida por fase en la instalación (Wh)-3 items-
data.totalEnergyByPhase (single item)number----
data.homeEnergynumberEnergía estimada consumida en la vivienda (Wh)---
data.homeEnergyByPhasearray<number>Energía estimada consumida en la vivienda por fase (Wh)-3 items-
data.homeEnergyByPhase (single item)number----
data.homePowerintegerPotencia medida en la vivienda, es decir, sin contar el cargador (W)---
data.evsePowerintegerPotencia medida en el cargador (W)---
data.totalCurrentarray<number>Corriente total medida en la instalación (mA), en cada fase-3 items-
data.totalCurrent (single item)number----
data.splModeintegerModo de funcionamiento SPL: - 0: deshabilitado - 1: SPL en modo Master - 2: SPL en modo Slave---
data.splSlaveFailPowerintegerCorrriente de carga máxima ante pérdida de comunicaciones SPL (mA)---
data.statusintegerEstado interno---
data.splMeterintegerTipo de medidor usado en la red SPL: - 0: CONTAX-D-0643 - 1: TMC100---
data.relOverloadnumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica---
data.relOverloadByPhasenumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica en cada fase---
data.mbusDetectedbooleanMedidor secundario detectado---
data.splDetectedbooleanSistema SPL habilitado---
data.ctxDetectedbooleanMedidor principal detectado---
data.elementsarray<object>--[ 1 .. 2 ] items-
data.elements.connectorIdintegerIdentificador numérico del conector---
data.elements.connectorTypeintegerTipo de conector: - 0: Schuko - 1: manguera Tipo 2 - 2: base Tipo 2---
data.elements.connectorNamestringNombre del conector: - mennekes - schuko - mennekes1 - mennekes2---
data.elements.stateintegerEstado del conector---
data.elements.nowobject---additional properties are allowed
data.elements.now.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.activeintegerPotencia activa instantánea (W)---
data.elements.now.reactiveintegerPotencia reactiva instantánea (VAr)---
data.elements.now.asignmentintegerCorriente asignada al conector (mA)---
data.elements.now.currentarray<integer>Corriente instantánea por fase (mA)-3 items-
data.elements.now.current (single item)integer----
data.elements.now.pfactorarray<number>Factor de potencia por fase-3 items-
data.elements.now.pfactor (single item)number----
data.elements.now.aPowarray<integer>Potencia activa por fase (W)-3 items-
data.elements.now.aPow (single item)integer----
data.elements.now.rPowarray<integer>Potencia reactiva por fase (Var)-3 items-
data.elements.now.rPow (single item)integer----
data.elements.now.chargeProcessobject---additional properties are allowed
data.elements.now.chargeProcess.idintegerIdentificador del proceso de carga---
data.elements.now.chargeProcess.phaseintegerFase activa---
data.elements.now.chargeProcess.pwmintegerValor actual de la corriente señalada al VE (mA)---
data.elements.now.chargeProcess.minPwmintegerValor mínimo a señalar al VE (mA)---
data.elements.now.chargeProcess.startobjectInformación en el momento de iniciar el proceso de carga--additional properties are allowed
data.elements.now.chargeProcess.start.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.chargeProcess.start.sourcestringAgente que inició el proceso de carga---
data.elements.now.chargeProcess.start.activeintegerEnergía activa (Wh)---
data.elements.now.chargeProcess.start.reactiveintegerEnergía reactiva (VArh)---
data.elements.now.chargeProcess.lastobjectInformación instantánea o al final del proceso de carga.--additional properties are allowed
data.elements.now.chargeProcess.last.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.chargeProcess.last.sourcestringAgente que inició el proceso---
data.elements.now.chargeProcess.last.activeintegerEnergía activa (Wh)---
data.elements.now.chargeProcess.last.reactiveintegerEnergía reactiva (VArh)---
data.splElementsarray<object>--[ 1 .. 256 ] items-
data.splElements.macstringIdentificador MAC del cargador.---
data.splElements.disconnectedbooleanIndica si está o no desconectado de la red SPL---
data.splElements.isMasterbooleanIndica si es o no Máster de la red SPL---
data.splElements.indexnumberÍndice del equipo esclavo---
data.splElements.connectorIdnumberIdentificador del conector---
data.splElements.flagsnumberFlags de estado---
data.splElements.pwmarray<number>Corriente señalada en cada fase-3 items-
data.splElements.pwm (single item)number----
data.splElements.currentarray<number>Corriente intantánea en cada fase (mA).-3 items-
data.splElements.current (single item)number----
data.splElements.powerarray<number>Potencia activa intantánea en cada fase (W).-3 items-
data.splElements.power (single item)number----
data.splElements.phasearray<boolean>Indica la presencia de cada fase-3 items-
data.splElements.phase (single item)boolean----
data.splElements.phaseCountintegerNúmero de fases empleadas en la carga---
data.splElements.chargeEnergyintegerEnergía activa acumulada en la carga actual (Wh).---
data.splElements.totalEnergyintegerEnergía activa total (Wh).---

Examples of payload (generated)

{
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 22,
"maxPower": 0,
"limitPower": 0,
"limitPowerByPhase": [
0,
0,
0
],
"totalPower": 0,
"totalPowerByPhase": [
0,
0,
0
],
"midLEnabled": true,
"midREnabled": true,
"totalEnery": 0,
"totalEnergyByPhase": [
0,
0,
0
],
"homeEnergy": 0,
"homeEnergyByPhase": [
0,
0,
0
],
"homePower": 0,
"evsePower": 0,
"totalCurrent": [
0,
0,
0
],
"splMode": 0,
"splSlaveFailPower": 0,
"status": 0,
"splMeter": 0,
"relOverload": 0,
"relOverloadByPhase": 0,
"mbusDetected": true,
"splDetected": true,
"ctxDetected": true,
"elements": [
{
"connectorId": 0,
"connectorType": 0,
"connectorName": "string",
"state": 0,
"now": {
"timestamp": 0,
"active": 0,
"reactive": 0,
"asignment": 0,
"current": [
0,
0,
0
],
"pfactor": [
0,
0,
0
],
"aPow": [
0,
0,
0
],
"rPow": [
0,
0,
0
],
"chargeProcess": {
"id": 0,
"phase": 0,
"pwm": 0,
"minPwm": 0,
"start": {
"timestamp": 0,
"source": "string",
"active": 0,
"reactive": 0
},
"last": {
"timestamp": 0,
"source": "string",
"active": 0,
"reactive": 0
}
}
}
}
],
"splElements": [
{
"mac": "string",
"disconnected": true,
"isMaster": true,
"index": 0,
"connectorId": 0,
"flags": 0,
"pwm": [
0,
0,
0
],
"current": [
0,
0,
0
],
"power": [
0,
0,
0
],
"phase": [
true,
true,
true
],
"phaseCount": 0,
"chargeEnergy": 0,
"totalEnergy": 0
}
]
}
}

RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/historic/modulator Operation

  • Operation ID: StatHistModulatorOp

Resumen del proceso de carga una vez finalizada esta

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringIdentificador de la red "mesh" a la que pertenece el cargador. Usualmente consiste en un 0 seguido de los últimos cinco dígitos del número de serie en formato hexadecimal.examples ("0F75B7")-required
deviceIdstringNúmero de serie del dispositivo.examples ("EVVC3454F75B7", "EVVC4AC4F415C")-required

Message StatHistModulatorMsg

Estao actual de los procesos abiertos

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobjectCabecera común para el payload de cada mensaje--additional properties are allowed
header.timestampintegerFecha y hora en formato UNIX Time Stamp--required
header.heapFreeintegerCantidad de memoria libre en la sección Heap---
dataobjectResumen de un proceso de carga tras su finalización--additional properties are allowed
data.uidintegerIdentificador de objetoconst (22)--
data.idintegerIdentificador del proceso de carga---
data.connectorIdintegerIdentificador numérico del conector---
data.connectorTypeintegerTipo de conector: - 0: Schuko - 1: manguera Tipo 2 - 2: base Tipo 2---
data.connectorNamestringNombre del conector: - mennekes - schuko - mennekes1 - mennekes2---
data.phaseintegerFases activas durante el proceso---
data.minPwmintegerValor mínimo del PWM (mA)---
data.startobject---additional properties are allowed
data.start.timestampintegerMarca de tiempo en formato UNIX---
data.start.userstringUsuario que inició la carga---
data.start.sourcestringAgente que inició el proceso de carga---
data.start.activeintegerEnergía activa (Wh)---
data.lastobject---additional properties are allowed
data.last.timestampintegerFecha y hora en el momento de finalizar la carga en formato UNIX---
data.last.userstringUsuario que finalizó la carga---
data.last.sourcestringAgente que finalizó el proceso de carga---
data.last.activeintegerEnergía activa (Wh)---
data.activearray<integer>Parcial de la Energía Activa entregada en la carga (total y por periodos tarifarios - Wh)-4 items-
data.active (single item)integer----

Examples of payload (generated)

{
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 22,
"id": 0,
"connectorId": 0,
"connectorType": 0,
"connectorName": "string",
"phase": 0,
"minPwm": 0,
"start": {
"timestamp": 0,
"user": "string",
"source": "string",
"active": 0
},
"last": {
"timestamp": 0,
"user": "string",
"source": "string",
"active": 0
},
"active": [
0,
0,
0,
0
]
}
}

SEND XEO/VIARIS/{meshId}/set/0/{deviceId}/rt/modulator Operation

  • Operation ID: SetRtModulatorOp

Mensaje para activar el envío de la trama RT en una frecuencia establecida. La trama RT se usa para poder ver el estado de los procesos de carga activos

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringIdentificador de la red "mesh" a la que pertenece el cargador. Usualmente consiste en un 0 seguido de los últimos cinco dígitos del número de serie en formato hexadecimal.examples ("0F75B7")-required
deviceIdstringNúmero de serie del dispositivo.examples ("EVVC3454F75B7", "EVVC4AC4F415C")-required

Message SetRtModulatorMsg

Activación del envío periodico de la "trama RT"

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idTransintegerIdentificador del mensaje---
dataobject---additional properties are allowed
data.periodintegerPeriocidad (en segundos) con la que se quiere enviar la "trama RT"->= 3-
data.timeoutintegerTiempo (en segundos) que estará activo el envío de la "trama RT"examples (120)--
data.statusbooleanIndica si debe activarse o anularse el envío---

Examples of payload (generated)

{
"idTrans": 0,
"data": {
"period": 3,
"timeout": 120,
"status": true
}
}

RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/streamrt/modulator Operation

  • Operation ID: StreamRtModulatorOp

Presenta el estado de los procesos de carga activos en el dispositivo

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringIdentificador de la red "mesh" a la que pertenece el cargador. Usualmente consiste en un 0 seguido de los últimos cinco dígitos del número de serie en formato hexadecimal.examples ("0F75B7")-required
deviceIdstringNúmero de serie del dispositivo.examples ("EVVC3454F75B7", "EVVC4AC4F415C")-required

Message StreamRtMsg

Estado actual de los procesos abiertos

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobjectCabecera común para el payload de cada mensaje--additional properties are allowed
header.timestampintegerFecha y hora en formato UNIX Time Stamp--required
header.heapFreeintegerCantidad de memoria libre en la sección Heap---
dataobject---additional properties are allowed
data.uidintegerIdentificador del móduloconst (22)--
data.maxPowerintegerPotencia máxima del cargador (W)---
data.limitPowerintegerPotencia contratada (W)---
data.limitPowerByPhasearray<integer>Potencia contratada por fase (W)-3 items-
data.limitPowerByPhase (single item)integer----
data.totalPowerintegerPotencia total consumida en la instalación (W)---
data.totalPowerByPhasearray<integer>Potencia consumida en la instalación discriminada por fase (W)-3 items-
data.totalPowerByPhase (single item)integer----
data.midLEnabledbooleanContador MID de la izquierda habilitado---
data.midREnabledbooleanContador MID de la derecha habilitado---
data.totalEnerynumberEnergía total medida en la instalación (Wh)---
data.totalEnergyByPhasearray<number>Energía medida por fase en la instalación (Wh)-3 items-
data.totalEnergyByPhase (single item)number----
data.homeEnergynumberEnergía estimada consumida en la vivienda (Wh)---
data.homeEnergyByPhasearray<number>Energía estimada consumida en la vivienda por fase (Wh)-3 items-
data.homeEnergyByPhase (single item)number----
data.homePowerintegerPotencia medida en la vivienda, es decir, sin contar el cargador (W)---
data.evsePowerintegerPotencia medida en el cargador (W)---
data.totalCurrentarray<number>Corriente total medida en la instalación (mA), en cada fase-3 items-
data.totalCurrent (single item)number----
data.splModeintegerModo de funcionamiento SPL: - 0: deshabilitado - 1: SPL en modo Master - 2: SPL en modo Slave---
data.splSlaveFailPowerintegerCorrriente de carga máxima ante pérdida de comunicaciones SPL (mA)---
data.statusintegerEstado interno---
data.splMeterintegerTipo de medidor usado en la red SPL: - 0: CONTAX-D-0643 - 1: TMC100---
data.relOverloadnumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica---
data.relOverloadByPhasenumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica en cada fase---
data.mbusDetectedbooleanMedidor secundario detectado---
data.splDetectedbooleanSistema SPL habilitado---
data.ctxDetectedbooleanMedidor principal detectado---
data.elementsarray<object>--[ 1 .. 2 ] items-
data.elements.connectorIdintegerIdentificador numérico del conector---
data.elements.connectorTypeintegerTipo de conector: - 0: Schuko - 1: manguera Tipo 2 - 2: base Tipo 2---
data.elements.connectorNamestringNombre del conector: - mennekes - schuko - mennekes1 - mennekes2---
data.elements.stateintegerEstado del conector---
data.elements.nowobject---additional properties are allowed
data.elements.now.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.activeintegerPotencia activa instantánea (W)---
data.elements.now.reactiveintegerPotencia reactiva instantánea (VAr)---
data.elements.now.asignmentintegerCorriente asignada al conector (mA)---
data.elements.now.currentarray<integer>Corriente instantánea por fase (mA)-3 items-
data.elements.now.current (single item)integer----
data.elements.now.pfactorarray<number>Factor de potencia por fase-3 items-
data.elements.now.pfactor (single item)number----
data.elements.now.aPowarray<integer>Potencia activa por fase (W)-3 items-
data.elements.now.aPow (single item)integer----
data.elements.now.rPowarray<integer>Potencia reactiva por fase (Var)-3 items-
data.elements.now.rPow (single item)integer----
data.elements.now.chargeProcessobject---additional properties are allowed
data.elements.now.chargeProcess.idintegerIdentificador del proceso de carga---
data.elements.now.chargeProcess.phaseintegerFase activa---
data.elements.now.chargeProcess.pwmintegerValor actual de la corriente señalada al VE (mA)---
data.elements.now.chargeProcess.minPwmintegerValor mínimo a señalar al VE (mA)---
data.elements.now.chargeProcess.startobjectInformación en el momento de iniciar el proceso de carga--additional properties are allowed
data.elements.now.chargeProcess.start.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.chargeProcess.start.sourcestringAgente que inició el proceso de carga---
data.elements.now.chargeProcess.start.activeintegerEnergía activa (Wh)---
data.elements.now.chargeProcess.start.reactiveintegerEnergía reactiva (VArh)---
data.elements.now.chargeProcess.lastobjectInformación instantánea o al final del proceso de carga.--additional properties are allowed
data.elements.now.chargeProcess.last.timestampintegerMarca de tiempo en formato UNIX---
data.elements.now.chargeProcess.last.sourcestringAgente que inició el proceso---
data.elements.now.chargeProcess.last.activeintegerEnergía activa (Wh)---
data.elements.now.chargeProcess.last.reactiveintegerEnergía reactiva (VArh)---
data.splElementsarray<object>--[ 1 .. 256 ] items-
data.splElements.macstringIdentificador MAC del cargador.---
data.splElements.disconnectedbooleanIndica si está o no desconectado de la red SPL---
data.splElements.isMasterbooleanIndica si es o no Máster de la red SPL---
data.splElements.indexnumberÍndice del equipo esclavo---
data.splElements.connectorIdnumberIdentificador del conector---
data.splElements.flagsnumberFlags de estado---
data.splElements.pwmarray<number>Corriente señalada en cada fase-3 items-
data.splElements.pwm (single item)number----
data.splElements.currentarray<number>Corriente intantánea en cada fase (mA).-3 items-
data.splElements.current (single item)number----
data.splElements.powerarray<number>Potencia activa intantánea en cada fase (W).-3 items-
data.splElements.power (single item)number----
data.splElements.phasearray<boolean>Indica la presencia de cada fase-3 items-
data.splElements.phase (single item)boolean----
data.splElements.phaseCountintegerNúmero de fases empleadas en la carga---
data.splElements.chargeEnergyintegerEnergía activa acumulada en la carga actual (Wh).---
data.splElements.totalEnergyintegerEnergía activa total (Wh).---

Examples of payload (generated)

{
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 22,
"maxPower": 0,
"limitPower": 0,
"limitPowerByPhase": [
0,
0,
0
],
"totalPower": 0,
"totalPowerByPhase": [
0,
0,
0
],
"midLEnabled": true,
"midREnabled": true,
"totalEnery": 0,
"totalEnergyByPhase": [
0,
0,
0
],
"homeEnergy": 0,
"homeEnergyByPhase": [
0,
0,
0
],
"homePower": 0,
"evsePower": 0,
"totalCurrent": [
0,
0,
0
],
"splMode": 0,
"splSlaveFailPower": 0,
"status": 0,
"splMeter": 0,
"relOverload": 0,
"relOverloadByPhase": 0,
"mbusDetected": true,
"splDetected": true,
"ctxDetected": true,
"elements": [
{
"connectorId": 0,
"connectorType": 0,
"connectorName": "string",
"state": 0,
"now": {
"timestamp": 0,
"active": 0,
"reactive": 0,
"asignment": 0,
"current": [
0,
0,
0
],
"pfactor": [
0,
0,
0
],
"aPow": [
0,
0,
0
],
"rPow": [
0,
0,
0
],
"chargeProcess": {
"id": 0,
"phase": 0,
"pwm": 0,
"minPwm": 0,
"start": {
"timestamp": 0,
"source": "string",
"active": 0,
"reactive": 0
},
"last": {
"timestamp": 0,
"source": "string",
"active": 0,
"reactive": 0
}
}
}
}
],
"splElements": [
{
"mac": "string",
"disconnected": true,
"isMaster": true,
"index": 0,
"connectorId": 0,
"flags": 0,
"pwm": [
0,
0,
0
],
"current": [
0,
0,
0
],
"power": [
0,
0,
0
],
"phase": [
true,
true,
true
],
"phaseCount": 0,
"chargeEnergy": 0,
"totalEnergy": 0
}
]
}
}