Saltar al contenido principal

ModulatorManager - API MQTT a nivel de usuario 0.1.1 documentation

Definición de la API MQTT a nivel de usuario para el módulo ModulatorManager.

Table of Contents

Operations

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

Mensaje cuarto-horario con el estado del proceso de carga.

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringCada dispositivo pertenece a una red "mesh". El formato es "0xxxxx" donde los caracteres 'x' se obtienen de los últimos 5 dígitos del identificador del dispositivo.--required
deviceIdstringIdentificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).--required

Message <anonymous-message-1>

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobject---additional properties are allowed
header.timestampintegerEtiqueta de tiempo, en formato UNIX, en el momento del envío del mensaje---
header.heapSizeintegerTamaño del heap de aplicación, en el momento del envío del mensaje.---
dataobject---additional properties are allowed
data.uidintegerIdentificador del módulo.---
data.maxPowerintegerPotencia máxima del cargador (W).---
data.limitPowerintegerPotencia contratada (W).---
data.limitPowerByPhasearrayPotencia contratada por fase (W).-format (uint32_t[3])-
data.limitPowerByPhase (single item)integer--format (uint32_t)-
data.totalPowerintegerPotencia total consumida en la instalación (W).---
data.totalPowerByPhasearrayPotencia consumida en la instalación discriminada por fase (W).-format (uint32_t[3])-
data.totalPowerByPhase (single item)integer--format (uint32_t)-
data.midLEnabledbooleanContador MID de la izquierda habilitado.---
data.midREnabledbooleanContador MID de la derecha habilitado.---
data.totalEnerynumberEnergía total medida en la instalación (Wh).-format (float)-
data.totalEnergyByPhasearrayEnergía medida por fase en la instalación (Wh).-format (float[3])-
data.totalEnergyByPhase (single item)number--format (float)-
data.homeEnergynumberEnergía estimada consumida en la vivienda (Wh).-format (float)-
data.homeEnergyByPhasearrayEnergía estimada consumida en la vivienda por fase (Wh).-format (float[3])-
data.homeEnergyByPhase (single item)number--format (float)-
data.homePowerintegerPotencia medida en la vivienda, es decir, sin contar el cargador (W).-format (uint32_t)-
data.evsePowerintegerPotencia medida en el cargador (W).-format (uint32_t)-
data.totalCurrentarrayCorriente total medida en la instalación.-format (uint32_t[3])-
data.totalCurrent (single item)integer--format (uint32_t)-
data.splModeintegerModo de funcionamiento SPL. - (0) SPL deshabilitado. - (1) SPL activo en modo Master. - (2) SPL activo en modo Esclavo.---
data.splSlaveFailPowerintegerCorrriente de carga máxima ante pérdida de comunicaciones SPL.---
data.statusintegerEstado intento---
data.splMeterintegerTipo de medidor usado en la red SPL: - (0) Contador CONTAX-D-0643-BU - (1) Medidor TMC100---
data.relOverloadnumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica.-format (double)-
data.relOverloadByPhasearrayRelación de sobrecarga en cada fase de la instalación eléctrica.-format (double[3])-
data.relOverloadByPhase (single item)number--format (double)-
data.mbusDetectedbooleanIndica si se ha detectado o no la presencia de dispositivos de medida TMC100.---
data.splDetectedbooleanIndica si el modo SPL está habilitado.---
data.ctxDetectedbooleanIndica si se ha detectado o no la presencia del dispositivo de medida CONTAX-D0643.---
data.elementsarray--[ 1 .. 2 ] items-
data.elements.connectorIdinteger--[ 1 .. 2 ]-
data.elements.connectorTypeintegerIndica el tipo de conector: - (0) Schuko - (1) Manguera Mennekes - (2) Base Mennekes---
data.elements.connectorNamestringNombre del conector: - "mennekes" - "schuko" En el caso de cargadores con 2 conectores Mennekes: - "mennekes1" - "mennekes2"---
data.elements.stateintegerEstado del conector.---
data.elements.nowobject---additional properties are allowed
data.elements.now.timestampintegerMarca de tiempo.---
data.elements.now.activeintegerPotencia activa instantánea (W).---
data.elements.now.reactiveintegerPotencia reactiva instantánea (VAr).---
data.elements.now.assignmentintegerCorriente asignada al conector (mA).---
data.elements.now.currentarrayCorriente instantánea por fase (mA).-format (uint32_t[3])-
data.elements.now.current (single item)integer----
data.elements.now.pfactorarrayFactor de potencia por fase.-format (float[3])-
data.elements.now.pfactor (single item)number----
data.elements.now.aPowarrayPotencia activa por fase (W).-format (uint32_t[3])-
data.elements.now.aPow (single item)integer----
data.elements.now.rPowarrayPotencia reactiva por fase (VAr).-format (uint32_t[3])-
data.elements.now.rPow (single item)integer----
data.elements.chargeProcessobject---additional properties are allowed
data.elements.chargeProcess.idintegerIdentificador del proceso de carga.---
data.elements.chargeProcess.phaseinteger----
data.elements.chargeProcess.pwmintegerValor actual de la corriente señalada al VE (mA).---
data.elements.chargeProcess.minPwmintegerValor mínimo a señalar al VE (mA).---
data.elements.chargeProcess.startobjectInformación en el momento de iniciar el proceso de carga.--additional properties are allowed
data.elements.chargeProcess.start.timestampintegerMarca de tiempo.---
data.elements.chargeProcess.start.sourcestringAgente que inició el proceso.---
data.elements.chargeProcess.start.activeintegerEnergía activa (Wh).---
data.elements.chargeProcess.start.reactiveintegerEnergía reactiva (VArh).---
data.elements.chargeProcess.lastobjectInformación instantánea del proceso de carga.--additional properties are allowed
data.elements.chargeProcess.last.timestampintegerMarca de tiempo.---
data.elements.chargeProcess.last.sourcestringAgente que inició el proceso.---
data.elements.chargeProcess.last.activeintegerEnergía activa (Wh).---
data.elements.chargeProcess.last.reactiveintegerEnergía reactiva (VArh).---
data.splElementsarrayInformación sobre los cargadores enlazados a la red SPL.---
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.pwmarrayCorriente señalada en cada fase.-format (uint32_t[3])-
data.splElements.pwm (single item)number----
data.splElements.currentarrayCorriente intantánea en cada fase (mA).-format (uint32_t[3])-
data.splElements.current (single item)number----
data.splElements.powerarrayPotencia activa intantánea en cada fase (W).-format (uint32_t[3])-
data.splElements.power (single item)number----
data.splElements.phasearrayInidica la presencia de cada fase.-format (boolean[3])-
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,
"heapSize": 0
},
"data": {
"uid": 0,
"maxPower": 0,
"limitPower": 0,
"limitPowerByPhase": [
0
],
"totalPower": 0,
"totalPowerByPhase": [
0
],
"midLEnabled": true,
"midREnabled": true,
"totalEnery": 0,
"totalEnergyByPhase": [
0
],
"homeEnergy": 0,
"homeEnergyByPhase": [
0
],
"homePower": 0,
"evsePower": 0,
"totalCurrent": [
0
],
"splMode": 0,
"splSlaveFailPower": 0,
"status": 0,
"splMeter": 0,
"relOverload": 0,
"relOverloadByPhase": [
0
],
"mbusDetected": true,
"splDetected": true,
"ctxDetected": true,
"elements": [
{
"connectorId": 1,
"connectorType": 0,
"connectorName": "string",
"state": 0,
"now": {
"timestamp": 0,
"active": 0,
"reactive": 0,
"assignment": 0,
"current": [
0
],
"pfactor": [
0
],
"aPow": [
0
],
"rPow": [
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
],
"current": [
0
],
"power": [
0
],
"phase": [
true
],
"phaseCount": 0,
"chargeEnergy": 0,
"totalEnergy": 0
}
]
}
}

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

Resumen del proceso de carga una vez finalizada esta.

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringCada dispositivo pertenece a una red "mesh". El formato es "0xxxxx" donde los caracteres 'x' se obtienen de los últimos 5 dígitos del identificador del dispositivo.--required
deviceIdstringIdentificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).--required

Message <anonymous-message-2>

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobject---additional properties are allowed
header.timestampintegerEtiqueta de tiempo, en formato UNIX, en el momento del envío del mensaje---
header.heapSizeintegerTamaño del heap de aplicación, en el momento del envío del mensaje.---
dataobject---additional properties are allowed
data.uidintegerIdentificador único del módulo.---
data.idintegerIdentificador de la carga realizada.---
data.connectorIdintegerIdentificador numérico del conector.---
data.connectorTypeintegerTipo de conector.---
data.connectorNamestringCadena que identifica al conector.---
data.phaseintegerFases activas durante la carga (0-ninguna, 1-R, 2-S, 3-T, 4-RST).---
data.minPwmintegerValor mínimo del PWM (mA).---
data.startobject---additional properties are allowed
data.start.timestampintegerFecha y hora del inicio de la carga (formato "UNIX Time").---
data.start.userstringUsuario que inició la carga.---
data.start.sourcestringOrigen del inicio de la carga.---
data.start.activeintegerEnergía activa total en el inicio de la carga (Wh)---
data.lastobject---additional properties are allowed
data.last.timestampintegerFecha y hora en el momento de finalizar la carga (formato "UNIX Time").---
data.last.userstringUsuario que finalizó la carga.---
data.last.sourcestringOrigen de la finalización de la carga.---
data.last.activeintegerEnergía activa total al finalizar la carga (Wh).---
data.activearrayParcial de la Energía Activa entregada en la carga (total y por periodos tarifarios - Wh).-format (uint32_t[4])-
data.active (single item)integer--format (uint32_t)-

Examples of payload (generated)

{
"header": {
"timestamp": 0,
"heapSize": 0
},
"data": {
"uid": 0,
"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
]
}
}

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

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
meshIdstringCada dispositivo pertenece a una red "mesh". El formato es "0xxxxx" donde los caracteres 'x' se obtienen de los últimos 5 dígitos del identificador del dispositivo.--required
deviceIdstringIdentificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).--required

Message <anonymous-message-3>

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idTransintegerIdentificador de la publicación.default (1)--
dataobject---additional properties are allowed
data.periodintegerPeriocidad (en segundos) con la que se quiere enviar la trama RT. Este valor no puede ser inferior a 3 segundos.default (3)--
data.timeoutintegerTiempo (en segundos) que estará activo el envío de la trama RT.default (120)--
data.statusbooleanFlag de activación/desactivación de la trama rtSchema: - true = activar trama RT - false = desactivar trama RT---

Examples of payload (generated)

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

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

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

Parameters

NameTypeDescriptionValueConstraintsNotes
meshIdstringCada dispositivo pertenece a una red "mesh". El formato es "0xxxxx" donde los caracteres 'x' se obtienen de los últimos 5 dígitos del identificador del dispositivo.--required
deviceIdstringIdentificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).--required

Message <anonymous-message-4>

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
headerobject---additional properties are allowed
header.timestampintegerEtiqueta de tiempo, en formato UNIX, en el momento del envío del mensaje---
header.heapSizeintegerTamaño del heap de aplicación, en el momento del envío del mensaje.---
dataobject---additional properties are allowed
data.uidintegerIdentificador del módulo.---
data.maxPowerintegerPotencia máxima del cargador (W).---
data.limitPowerintegerPotencia contratada (W).---
data.limitPowerByPhasearrayPotencia contratada por fase (W).-format (uint32_t[3])-
data.limitPowerByPhase (single item)integer--format (uint32_t)-
data.totalPowerintegerPotencia total consumida en la instalación (W).---
data.totalPowerByPhasearrayPotencia consumida en la instalación discriminada por fase (W).-format (uint32_t[3])-
data.totalPowerByPhase (single item)integer--format (uint32_t)-
data.midLEnabledbooleanContador MID de la izquierda habilitado.---
data.midREnabledbooleanContador MID de la derecha habilitado.---
data.totalEnerynumberEnergía total medida en la instalación (Wh).-format (float)-
data.totalEnergyByPhasearrayEnergía medida por fase en la instalación (Wh).-format (float[3])-
data.totalEnergyByPhase (single item)number--format (float)-
data.homeEnergynumberEnergía estimada consumida en la vivienda (Wh).-format (float)-
data.homeEnergyByPhasearrayEnergía estimada consumida en la vivienda por fase (Wh).-format (float[3])-
data.homeEnergyByPhase (single item)number--format (float)-
data.homePowerintegerPotencia medida en la vivienda, es decir, sin contar el cargador (W).-format (uint32_t)-
data.evsePowerintegerPotencia medida en el cargador (W).-format (uint32_t)-
data.totalCurrentarrayCorriente total medida en la instalación.-format (uint32_t[3])-
data.totalCurrent (single item)integer--format (uint32_t)-
data.splModeintegerModo de funcionamiento SPL. - (0) SPL deshabilitado. - (1) SPL activo en modo Master. - (2) SPL activo en modo Esclavo.---
data.splSlaveFailPowerintegerCorrriente de carga máxima ante pérdida de comunicaciones SPL.---
data.statusintegerEstado intento---
data.splMeterintegerTipo de medidor usado en la red SPL: - (0) Contador CONTAX-D-0643-BU - (1) Medidor TMC100---
data.relOverloadnumberRelación de sobrecarga en el conjunto de fases de la instalación eléctrica.-format (double)-
data.relOverloadByPhasearrayRelación de sobrecarga en cada fase de la instalación eléctrica.-format (double[3])-
data.relOverloadByPhase (single item)number--format (double)-
data.mbusDetectedbooleanIndica si se ha detectado o no la presencia de dispositivos de medida TMC100.---
data.splDetectedbooleanIndica si el modo SPL está habilitado.---
data.ctxDetectedbooleanIndica si se ha detectado o no la presencia del dispositivo de medida CONTAX-D0643.---
data.elementsarray--[ 1 .. 2 ] items-
data.elements.connectorIdinteger--[ 1 .. 2 ]-
data.elements.connectorTypeintegerIndica el tipo de conector: - (0) Schuko - (1) Manguera Mennekes - (2) Base Mennekes---
data.elements.connectorNamestringNombre del conector: - "mennekes" - "schuko" En el caso de cargadores con 2 conectores Mennekes: - "mennekes1" - "mennekes2"---
data.elements.stateintegerEstado del conector.---
data.elements.nowobject---additional properties are allowed
data.elements.now.timestampintegerMarca de tiempo.---
data.elements.now.activeintegerPotencia activa instantánea (W).---
data.elements.now.reactiveintegerPotencia reactiva instantánea (VAr).---
data.elements.now.assignmentintegerCorriente asignada al conector (mA).---
data.elements.now.currentarrayCorriente instantánea por fase (mA).-format (uint32_t[3])-
data.elements.now.current (single item)integer----
data.elements.now.pfactorarrayFactor de potencia por fase.-format (float[3])-
data.elements.now.pfactor (single item)number----
data.elements.now.aPowarrayPotencia activa por fase (W).-format (uint32_t[3])-
data.elements.now.aPow (single item)integer----
data.elements.now.rPowarrayPotencia reactiva por fase (VAr).-format (uint32_t[3])-
data.elements.now.rPow (single item)integer----
data.elements.chargeProcessobject---additional properties are allowed
data.elements.chargeProcess.idintegerIdentificador del proceso de carga.---
data.elements.chargeProcess.phaseinteger----
data.elements.chargeProcess.pwmintegerValor actual de la corriente señalada al VE (mA).---
data.elements.chargeProcess.minPwmintegerValor mínimo a señalar al VE (mA).---
data.elements.chargeProcess.startobjectInformación en el momento de iniciar el proceso de carga.--additional properties are allowed
data.elements.chargeProcess.start.timestampintegerMarca de tiempo.---
data.elements.chargeProcess.start.sourcestringAgente que inició el proceso.---
data.elements.chargeProcess.start.activeintegerEnergía activa (Wh).---
data.elements.chargeProcess.start.reactiveintegerEnergía reactiva (VArh).---
data.elements.chargeProcess.lastobjectInformación instantánea del proceso de carga.--additional properties are allowed
data.elements.chargeProcess.last.timestampintegerMarca de tiempo.---
data.elements.chargeProcess.last.sourcestringAgente que inició el proceso.---
data.elements.chargeProcess.last.activeintegerEnergía activa (Wh).---
data.elements.chargeProcess.last.reactiveintegerEnergía reactiva (VArh).---
data.splElementsarrayInformación sobre los cargadores enlazados a la red SPL.---
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.pwmarrayCorriente señalada en cada fase.-format (uint32_t[3])-
data.splElements.pwm (single item)number----
data.splElements.currentarrayCorriente intantánea en cada fase (mA).-format (uint32_t[3])-
data.splElements.current (single item)number----
data.splElements.powerarrayPotencia activa intantánea en cada fase (W).-format (uint32_t[3])-
data.splElements.power (single item)number----
data.splElements.phasearrayInidica la presencia de cada fase.-format (boolean[3])-
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,
"heapSize": 0
},
"data": {
"uid": 0,
"maxPower": 0,
"limitPower": 0,
"limitPowerByPhase": [
0
],
"totalPower": 0,
"totalPowerByPhase": [
0
],
"midLEnabled": true,
"midREnabled": true,
"totalEnery": 0,
"totalEnergyByPhase": [
0
],
"homeEnergy": 0,
"homeEnergyByPhase": [
0
],
"homePower": 0,
"evsePower": 0,
"totalCurrent": [
0
],
"splMode": 0,
"splSlaveFailPower": 0,
"status": 0,
"splMeter": 0,
"relOverload": 0,
"relOverloadByPhase": [
0
],
"mbusDetected": true,
"splDetected": true,
"ctxDetected": true,
"elements": [
{
"connectorId": 1,
"connectorType": 0,
"connectorName": "string",
"state": 0,
"now": {
"timestamp": 0,
"active": 0,
"reactive": 0,
"assignment": 0,
"current": [
0
],
"pfactor": [
0
],
"aPow": [
0
],
"rPow": [
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
],
"current": [
0
],
"power": [
0
],
"phase": [
true
],
"phaseCount": 0,
"chargeEnergy": 0,
"totalEnergy": 0
}
]
}
}