API para el módulo MQTTClient
El módulo MQTTClient permite conectar el cargador a un broker local del cliente.
< Volver a la página principal.
Table of Contents
Operations
RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/ping/mqtt_user Operation
- Operation ID:
StatPingMQTTOp
Mensaje tipo PING para señalizar la existencia de comunicación con el broker MQTT
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 StatPingMQTTMsg
- Message ID:
StatPingMQTTMsg - Content type: appication/json
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | Este mensaje no tiene parámetros definidos | - | - | additional properties are allowed |
Examples of payload (generated)
{}
RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/last_will/mqtt_user Operation
- Operation ID:
StatLastWillMQTTOp
Indica que se ha producido una desconexión 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 StatLastWillMQTTMsg
- Message ID:
StatLastWillMQTTMsg - Content type: appication/json
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | Este mensaje no tiene parámetros definidos | - | - | additional properties are allowed |
Examples of payload (generated)
{}
SEND XEO/VIARIS/{meshId}/get/0/{deviceId}/cfg/mqtt_user Operation
- Operation ID:
GetCfgMQTTOp
Permite solicitar la configuración MQTT 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 GetCfgMQTTMsg
- Message ID:
GetCfgMQTTMsg - 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}/cfg/mqtt_user Operation
- Operation ID:
StatCfgMQTTOp
Configuración MQTT 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 StatCfgMQTTMsg
- Message ID:
StatCfgMQTTMsg - Content type: appication/json
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.uid | integer | Identificador del módulo | const (24) | - | - |
| data.cfg | object | Valores de la configuración MQTT | - | - | additional properties are allowed |
| data.cfg.keepAlive | integer | Tiempo máximo (segundos) para enviar un mensaje de PING a nivel MQTT que mantenga la conexión establecida | examples (120) | - | - |
| data.cfg.groupMask | integer | (Propiedad reservada) | - | - | - |
| data.cfg.qos | integer | Calidad de servicio MQTT | allowed (0, 1, 2) | - | - |
| data.cfg.verbosity | integer | Nivel de detalle de los mensajes de log (niveles altos proporcionan mayor detalle): - 0: ERROR level - 1: WARNING level - 2: INFO level - 3: DEBUG level - 4: VERBOSE level | allowed (0, 1, 2, 3, 4) | - | - |
| data.cfg.mqttUrl | string | URL o dirección IP del broker MQTT | examples ("192.168.1.24") | - | - |
| data.cfg.mqttPort | integer | Puerto de conexión con el broker MQTT | examples (1883) | - | - |
| data.cfg.mqttClientId | string | Identificador del cargador como cliente MQTT | examples ("EVVC3AC668F1C") | - | - |
| data.cfg.mqttUser | string | Nombre de usuario usado para la conexión MQTT | examples ("evseORB") | - | - |
| data.cfg.pingInterval | integer | Periodo de tiempo (segundos) en el envío del mensaje "ping/mqtt_user" | examples (300) | - | - |
Examples of payload (generated)
{
"idTrans": 0,
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 24,
"cfg": {
"keepAlive": 120,
"groupMask": 0,
"qos": 0,
"verbosity": 0,
"mqttUrl": "192.168.1.24",
"mqttPort": 1883,
"mqttClientId": "EVVC3AC668F1C",
"mqttUser": "evseORB",
"pingInterval": 300
}
}
}
SEND XEO/VIARIS/{meshId}/set/0/{deviceId}/cfg/mqtt_user Operation
- Operation ID:
SetCfgMQTTOp
Permite modificar la configuración MQTT 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 SetCfgMQTTMsg
- Message ID:
SetCfgMQTTMsg - Content type: appication/json
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.uid | integer | Identificador del módulo | const (24) | - | - |
| data.cfg | allOf | - | - | - | additional properties are allowed |
| data.cfg.0 (allOf item) | object | Valores de la configuración MQTT | - | - | additional properties are allowed |
| data.cfg.0.keepAlive | integer | Tiempo máximo (segundos) para enviar un mensaje de PING a nivel MQTT que mantenga la conexión establecida | examples (120) | - | - |
| data.cfg.0.groupMask | integer | (Propiedad reservada) | - | - | - |
| data.cfg.0.qos | integer | Calidad de servicio MQTT | allowed (0, 1, 2) | - | - |
| data.cfg.0.verbosity | integer | Nivel de detalle de los mensajes de log (niveles altos proporcionan mayor detalle): - 0: ERROR level - 1: WARNING level - 2: INFO level - 3: DEBUG level - 4: VERBOSE level | allowed (0, 1, 2, 3, 4) | - | - |
| data.cfg.0.mqttUrl | string | URL o dirección IP del broker MQTT | examples ("192.168.1.24") | - | - |
| data.cfg.0.mqttPort | integer | Puerto de conexión con el broker MQTT | examples (1883) | - | - |
| data.cfg.0.mqttClientId | string | Identificador del cargador como cliente MQTT | examples ("EVVC3AC668F1C") | - | - |
| data.cfg.0.mqttUser | string | Nombre de usuario usado para la conexión MQTT | examples ("evseORB") | - | - |
| data.cfg.0.pingInterval | integer | Periodo de tiempo (segundos) en el envío del mensaje "ping/mqtt_user" | examples (300) | - | - |
| data.cfg.1 (allOf item) | object | - | - | - | additional properties are allowed |
| data.cfg.1.mqttPass | string | Contraseña de acceso al broker MQTT | - | - | required |
Examples of payload (generated)
{
"idTrans": 0,
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 24,
"cfg": {
"keepAlive": 120,
"groupMask": 0,
"qos": 0,
"verbosity": 0,
"mqttUrl": "192.168.1.24",
"mqttPort": 1883,
"mqttClientId": "EVVC3AC668F1C",
"mqttUser": "evseORB",
"pingInterval": 300,
"mqttPass": "string"
}
}
}