API para el módulo `SysManager`

El módulo SysManager permite controlar las operaciones generales del cargador.

< Volver a la página principal.

Operations

Operations

RECEIVE `XEO/VIARIS/{meshId}/stat/0/{deviceId}/init_boot/sys` Operation

Operation ID: InitBootSysOp

Enviado por el cargador tras establecerse la conexión MQTT con el broker

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Identificador 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
deviceId	string	Número de serie del dispositivo.	examples (`"EVVC3454F75B7"`, `"EVVC4AC4F415C"`)	-	required

Message `InitBootSysMsg`

Message ID: InitBootSysMsg
Content type: appication/json

Datos enviados cuando el dispositivo se conecta al broker MQTT

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
header	object	Cabecera común para el payload de cada mensaje	-	-	additional properties are allowed
header.timestamp	integer	Fecha y hora en formato UNIX Time Stamp	-	-	required
header.heapFree	integer	Cantidad de memoria libre en la sección Heap	-	-	-
data	object	-	-	-	required, additional properties are allowed
data.model	string	-	examples (`"VIARIS UNI"`, `"VIARIS COMBIPLUS"`)	-	-
data.serial	string	Número de serie	examples (`"EVVC3968B6240"`, `"EVVC4618BE104"`)	-	-
data.maxPower	integer	Potencia máxima que el cargador puede suministrar (W)	examples (`22080`)	-	-
data.ampacity	integer	Limitación de corriente durante una carga (A)	examples (`32`)	-	-
data.maxAmpacity	integer	-	examples (`32`)	-	-
data.limitPower	integer	Potencia contratada (W)	examples (`2300`, `4500`, `9200`, `43648`)	-	-
data.selectorPower	integer	Límite de potencia establecido por el selector interno (W)	-	-	-
data.mac	string	Número MAC	examples (`"C8:2B:96:8B:62:40"`)	-	-
data.fwv	string	Número de versión del firmware principal	examples (`"7.3.38"`)	-	-
data.hwv	string	Número de versión de la placa eléctrónica de control	examples (`"4.0"`)	-	-
data.fwv_pot	string	Número de versión del firmware de potencia	-	-	-
data.hwv_pot	string	Número de versión de la placa de potencia	-	-	-
data.fwv_cortex	string	Número de versión del firmware secundario	examples (`"003.005.013 Jun 5 2024 08:11:15"`)	-	-
data.schuko	boolean	Conector Schuko habilitado	-	-	-
data.rfid	boolean	Módulo RFID habilitado	-	-	-
data.ethernet	boolean	Módulo Ethernet habiltado	-	-	-
data.spl	boolean	Módulo SPL habilitado	-	-	-
data.ocpp	boolean	Módulo OCPP habilitado	-	-	-
data.modbus	boolean	Soporte MODBUS-RTU habilitado	-	-	-
data.solar	boolean	Módulo Solar habilitado	-	-	-
data.extraInfo	string	(información reservada)	-	-	-
data.elements	array<object>	Definición de los conectores disponibles en el cargador	-	-	-
data.elements.id	integer	Identificador del conector	-	-	-
data.elements.type	integer	Tipo de conector	-	-	-
data.elements.name	any	Nombre del conector	examples (`"mennekes"`)	-	additional properties are allowed
data.elements.info	string	Información adicional	-	-	-
data.rst_reason	string	Motivo del último reinicio	-	-	-
data.phase	integer	Número de fases eléctricas disponibles	-	-	-
data.midAnalyzers	integer	Número de medidores eléctricos (analizadores)	-	-	-
data.nvsFreeEntries	integer	Estimación del espacio de almacenamiento disponible	-	-	-
data.leakage	integer	Estado del sensor de fugas	-	-	-

Examples of payload (generated)

{
  "header": {
    "timestamp": 0,
    "heapFree": 0
  },
  "data": {
    "model": "VIARIS UNI",
    "serial": "EVVC3968B6240",
    "maxPower": 22080,
    "ampacity": 32,
    "maxAmpacity": 32,
    "limitPower": 2300,
    "selectorPower": 0,
    "mac": "C8:2B:96:8B:62:40",
    "fwv": "7.3.38",
    "hwv": "4.0",
    "fwv_pot": "string",
    "hwv_pot": "string",
    "fwv_cortex": "003.005.013 Jun 5 2024 08:11:15",
    "schuko": true,
    "rfid": true,
    "ethernet": true,
    "spl": true,
    "ocpp": true,
    "modbus": true,
    "solar": true,
    "extraInfo": "string",
    "elements": [
      {
        "id": 0,
        "type": 0,
        "name": "mennekes",
        "info": "string"
      }
    ],
    "rst_reason": "string",
    "phase": 0,
    "midAnalyzers": 0,
    "nvsFreeEntries": 0,
    "leakage": 0
  }
}

SEND `XEO/VIARIS/{meshId}/get/0/{deviceId}/boot/sys` Operation

Operation ID: GetBootSysOp

Permite al usuario solocitar la información básica del cargador

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Identificador 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
deviceId	string	Número de serie del dispositivo.	examples (`"EVVC3454F75B7"`, `"EVVC4AC4F415C"`)	-	required

Message `get_message`

Message ID: get_message
Content type: string

Usado por el usuario para solicitar información (valores de configuración, estados, medidas, ...)

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador del mensaje	-	-	required
header	object	Cabecera común para el payload de cada mensaje	-	-	additional properties are allowed
header.timestamp	integer	Fecha y hora en formato UNIX Time Stamp	-	-	required
header.heapFree	integer	Cantidad de memoria libre en la sección Heap	-	-	-
data	object	El formato y estructura de los datos depende del topic específico	-	-	additional properties are allowed

Examples of payload (generated)

{
  "idTrans": 0,
  "header": {
    "timestamp": 0,
    "heapFree": 0
  },
  "data": {}
}

RECEIVE `XEO/VIARIS/{meshId}/stat/0/{deviceId}/boot/sys` Operation

Operation ID: BootSysOp

Enviado por el cargador, notifica la información básica

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Identificador 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
deviceId	string	Número de serie del dispositivo.	examples (`"EVVC3454F75B7"`, `"EVVC4AC4F415C"`)	-	required

Message `BootSysMsg`

Message ID: BootSysMsg
Content type: appication/json

Información básica del cargador

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador del mensaje	-	-	required
header	object	Cabecera común para el payload de cada mensaje	-	-	additional properties are allowed
header.timestamp	integer	Fecha y hora en formato UNIX Time Stamp	-	-	required
header.heapFree	integer	Cantidad de memoria libre en la sección Heap	-	-	-
data	object	-	-	-	required, additional properties are allowed
data.model	string	-	examples (`"VIARIS UNI"`, `"VIARIS COMBIPLUS"`)	-	-
data.serial	string	Número de serie	examples (`"EVVC3968B6240"`, `"EVVC4618BE104"`)	-	-
data.maxPower	integer	Potencia máxima que el cargador puede suministrar (W)	examples (`22080`)	-	-
data.ampacity	integer	Limitación de corriente durante una carga (A)	examples (`32`)	-	-
data.maxAmpacity	integer	-	examples (`32`)	-	-
data.limitPower	integer	Potencia contratada (W)	examples (`2300`, `4500`, `9200`, `43648`)	-	-
data.selectorPower	integer	Límite de potencia establecido por el selector interno (W)	-	-	-
data.mac	string	Número MAC	examples (`"C8:2B:96:8B:62:40"`)	-	-
data.fwv	string	Número de versión del firmware principal	examples (`"7.3.38"`)	-	-
data.hwv	string	Número de versión de la placa eléctrónica de control	examples (`"4.0"`)	-	-
data.fwv_pot	string	Número de versión del firmware de potencia	-	-	-
data.hwv_pot	string	Número de versión de la placa de potencia	-	-	-
data.fwv_cortex	string	Número de versión del firmware secundario	examples (`"003.005.013 Jun 5 2024 08:11:15"`)	-	-
data.schuko	boolean	Conector Schuko habilitado	-	-	-
data.rfid	boolean	Módulo RFID habilitado	-	-	-
data.ethernet	boolean	Módulo Ethernet habiltado	-	-	-
data.spl	boolean	Módulo SPL habilitado	-	-	-
data.ocpp	boolean	Módulo OCPP habilitado	-	-	-
data.modbus	boolean	Soporte MODBUS-RTU habilitado	-	-	-
data.solar	boolean	Módulo Solar habilitado	-	-	-
data.extraInfo	string	(información reservada)	-	-	-
data.elements	array<object>	Definición de los conectores disponibles en el cargador	-	-	-
data.elements.id	integer	Identificador del conector	-	-	-
data.elements.type	integer	Tipo de conector	-	-	-
data.elements.name	any	Nombre del conector	examples (`"mennekes"`)	-	additional properties are allowed
data.elements.info	string	Información adicional	-	-	-
data.rst_reason	string	Motivo del último reinicio	-	-	-
data.phase	integer	Número de fases eléctricas disponibles	-	-	-
data.midAnalyzers	integer	Número de medidores eléctricos (analizadores)	-	-	-
data.nvsFreeEntries	integer	Estimación del espacio de almacenamiento disponible	-	-	-
data.leakage	integer	Estado del sensor de fugas	-	-	-

Examples of payload (generated)

{
  "idTrans": 0,
  "header": {
    "timestamp": 0,
    "heapFree": 0
  },
  "data": {
    "model": "VIARIS UNI",
    "serial": "EVVC3968B6240",
    "maxPower": 22080,
    "ampacity": 32,
    "maxAmpacity": 32,
    "limitPower": 2300,
    "selectorPower": 0,
    "mac": "C8:2B:96:8B:62:40",
    "fwv": "7.3.38",
    "hwv": "4.0",
    "fwv_pot": "string",
    "hwv_pot": "string",
    "fwv_cortex": "003.005.013 Jun 5 2024 08:11:15",
    "schuko": true,
    "rfid": true,
    "ethernet": true,
    "spl": true,
    "ocpp": true,
    "modbus": true,
    "solar": true,
    "extraInfo": "string",
    "elements": [
      {
        "id": 0,
        "type": 0,
        "name": "mennekes",
        "info": "string"
      }
    ],
    "rst_reason": "string",
    "phase": 0,
    "midAnalyzers": 0,
    "nvsFreeEntries": 0,
    "leakage": 0
  }
}

API para el módulo SysManager

Table of Contents​

Operations​

RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/init_boot/sys Operation​

Parameters​

Message InitBootSysMsg​

Payload​

SEND XEO/VIARIS/{meshId}/get/0/{deviceId}/boot/sys Operation​

Parameters​

Message get_message​

Payload​

RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/boot/sys Operation​

Parameters​

Message BootSysMsg​

Payload​

API para el módulo `SysManager`

Table of Contents

Operations

RECEIVE `XEO/VIARIS/{meshId}/stat/0/{deviceId}/init_boot/sys` Operation

Parameters

Message `InitBootSysMsg`

Payload

SEND `XEO/VIARIS/{meshId}/get/0/{deviceId}/boot/sys` Operation

Parameters

Message `get_message`

Payload

RECEIVE `XEO/VIARIS/{meshId}/stat/0/{deviceId}/boot/sys` Operation

Parameters

Message `BootSysMsg`

Payload