SysManager - API MQTT a nivel de usuario 0.1.0 documentation

Default content type: application/json

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

Operations

Operations

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

Permite solicitar al cargador su configuración básica.

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Cada 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
deviceId	string	Identificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).	-	-	required

Message `GetMessage`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador de la transacción.	-	-	-

Examples of payload (generated)

{
  "idTrans": 0
}

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

Información relativa a la identificación del cargador y configuración básica.

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Cada 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
deviceId	string	Identificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).	-	-	required

Message `<anonymous-message-2>`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador de la publicación.	-	-	-
header	object	-	-	-	additional properties are allowed
header.timestamp	integer	Etiqueta de tiempo, en formato UNIX, en el momento del envío del mensaje	-	-	-
header.heapSize	integer	Tamaño del heap de aplicación, en el momento del envío del mensaje.	-	-	-
data	object	Información de identificación y configuración básica.	-	-	additional properties are allowed
data.model	string	Modelo de cargador.	-	format (`char[18]`)	-
data.serial	string	Número de serie del cargador.	-	format (`char[18]`)	-
data.maxPower	integer	Potencia máxima del cargador (W).	-	-	-
data.ampacity	integer	Corriente máxima por fase (A), definida por el usuario.	-	-	-
data.maxAmpacity	integer	Corriente máxima del cargador por fase (A), definida en el proceso de fabricación.	-	-	-
data.limitPower	integer	Potencia máxima de la instalación (W).	-	-	-
data.selectorPower	integer	Indica la potencia máxima de la instalación selecciona a través del selecctor rotativo interno (W). Si la posición del selector es 0 el valor coincidirá con el programado en el parámetro limitPower.	-	-	-
data.mac	string	Dirección MAC del módulo WiFi del cargador	-	format (`char[18]`)	-
data.fwv	string	Versión del firmware de aplicación.	-	format (`char[18]`)	-
data.hwv	string	Versión del hardware.	-	format (`char[18]`)	-
data.fwv_pot	string	Versión de firmware de la placa de potencia.	-	format (`char[18]`)	-
data.hwv_pot	string	Versión del hardware de la placa de potencia.	-	format (`char[18]`)	-
data.fwv_cortex	string	Versión de firmware del módulo Cortex.	-	format (`char[36]`)	-
data.schuko	boolean	Indicador de la presencia del conector Schuko.	-	-	-
data.rfid	boolean	Indica si el módulo RFID está activo.	-	-	-
data.ethernet	boolean	Módulo Ethernet instalado.	-	-	-
data.spl	boolean	Módulo SPL activo.	-	-	-
data.ocpp	boolean	Conexión OCPP establecida.	-	-	-
data.modbus	boolean	Módulo Modbus habilitado.	-	-	-
data.solar	boolean	Módulo Solar habilitado.	-	-	-
data.extraInfo	string	-	-	format (`char[32]`)	-
data.elements	array	-	-	-	-
data.elements.id	integer	Identificador numérico del conector	-	-	-
data.elements.type	string	Tipo de conector	-	-	-
data.elements.name	string	Nombre del conector	-	-	-
data.elements.info	string	Información adicional del conector	-	-	-
data.rst_reason	string	Motivo del reset	-	format (`char[32]`)	-
data.phase	integer	Número de fases	-	-	-
data.midAnalyzers	integer	Número de contadores de magnitudes eléctricas	-	-	-

Examples of payload (generated)

{
  "idTrans": 0,
  "header": {
    "timestamp": 0,
    "heapSize": 0
  },
  "data": {
    "model": "string",
    "serial": "string",
    "maxPower": 0,
    "ampacity": 0,
    "maxAmpacity": 0,
    "limitPower": 0,
    "selectorPower": 0,
    "mac": "string",
    "fwv": "string",
    "hwv": "string",
    "fwv_pot": "string",
    "hwv_pot": "string",
    "fwv_cortex": "string",
    "schuko": true,
    "rfid": true,
    "ethernet": true,
    "spl": true,
    "ocpp": true,
    "modbus": true,
    "solar": true,
    "extraInfo": "string",
    "elements": [
      {
        "id": 0,
        "type": "string",
        "name": "string",
        "info": "string"
      }
    ],
    "rst_reason": "string",
    "phase": 0,
    "midAnalyzers": 0
  }
}

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

Enviado por el cargador cuando establece conexión con el broker.

Parameters

Name	Type	Description	Value	Constraints	Notes
meshId	string	Cada 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
deviceId	string	Identificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS).	-	-	required

Message `<anonymous-message-3>`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
header	object	-	-	-	additional properties are allowed
header.timestamp	integer	Etiqueta de tiempo, en formato UNIX, en el momento del envío del mensaje	-	-	-
header.heapSize	integer	Tamaño del heap de aplicación, en el momento del envío del mensaje.	-	-	-
data	object	Información de identificación y configuración básica.	-	-	additional properties are allowed
data.model	string	Modelo de cargador.	-	format (`char[18]`)	-
data.serial	string	Número de serie del cargador.	-	format (`char[18]`)	-
data.maxPower	integer	Potencia máxima del cargador (W).	-	-	-
data.ampacity	integer	Corriente máxima por fase (A), definida por el usuario.	-	-	-
data.maxAmpacity	integer	Corriente máxima del cargador por fase (A), definida en el proceso de fabricación.	-	-	-
data.limitPower	integer	Potencia máxima de la instalación (W).	-	-	-
data.selectorPower	integer	Indica la potencia máxima de la instalación selecciona a través del selecctor rotativo interno (W). Si la posición del selector es 0 el valor coincidirá con el programado en el parámetro limitPower.	-	-	-
data.mac	string	Dirección MAC del módulo WiFi del cargador	-	format (`char[18]`)	-
data.fwv	string	Versión del firmware de aplicación.	-	format (`char[18]`)	-
data.hwv	string	Versión del hardware.	-	format (`char[18]`)	-
data.fwv_pot	string	Versión de firmware de la placa de potencia.	-	format (`char[18]`)	-
data.hwv_pot	string	Versión del hardware de la placa de potencia.	-	format (`char[18]`)	-
data.fwv_cortex	string	Versión de firmware del módulo Cortex.	-	format (`char[36]`)	-
data.schuko	boolean	Indicador de la presencia del conector Schuko.	-	-	-
data.rfid	boolean	Indica si el módulo RFID está activo.	-	-	-
data.ethernet	boolean	Módulo Ethernet instalado.	-	-	-
data.spl	boolean	Módulo SPL activo.	-	-	-
data.ocpp	boolean	Conexión OCPP establecida.	-	-	-
data.modbus	boolean	Módulo Modbus habilitado.	-	-	-
data.solar	boolean	Módulo Solar habilitado.	-	-	-
data.extraInfo	string	-	-	format (`char[32]`)	-
data.elements	array	-	-	-	-
data.elements.id	integer	Identificador numérico del conector	-	-	-
data.elements.type	string	Tipo de conector	-	-	-
data.elements.name	string	Nombre del conector	-	-	-
data.elements.info	string	Información adicional del conector	-	-	-
data.rst_reason	string	Motivo del reset	-	format (`char[32]`)	-
data.phase	integer	Número de fases	-	-	-
data.midAnalyzers	integer	Número de contadores de magnitudes eléctricas	-	-	-

Examples of payload (generated)

{
  "header": {
    "timestamp": 0,
    "heapSize": 0
  },
  "data": {
    "model": "string",
    "serial": "string",
    "maxPower": 0,
    "ampacity": 0,
    "maxAmpacity": 0,
    "limitPower": 0,
    "selectorPower": 0,
    "mac": "string",
    "fwv": "string",
    "hwv": "string",
    "fwv_pot": "string",
    "hwv_pot": "string",
    "fwv_cortex": "string",
    "schuko": true,
    "rfid": true,
    "ethernet": true,
    "spl": true,
    "ocpp": true,
    "modbus": true,
    "solar": true,
    "extraInfo": "string",
    "elements": [
      {
        "id": 0,
        "type": "string",
        "name": "string",
        "info": "string"
      }
    ],
    "rst_reason": "string",
    "phase": 0,
    "midAnalyzers": 0
  }
}

SysManager - API MQTT a nivel de usuario 0.1.0 documentation

Table of Contents​

Operations​

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

Parameters​

Message GetMessage​

Payload​

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

Parameters​

Message <anonymous-message-2>​

Payload​

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

Parameters​

Message <anonymous-message-3>​

Payload​

Table of Contents

Operations

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

Parameters

Message `GetMessage`

Payload

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

Parameters

Message `<anonymous-message-2>`

Payload

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

Parameters

Message `<anonymous-message-3>`

Payload