API MQTT a nivel de usuario 0.1.0 documentation
- Default content type: application/json
Definición de la API MQTT disponible en los cargadores Viaris UNI y Viaris COMBIPLUS.
Esta API permite al usuario monitorizar de forma remota el estado de sus cargadores.
La API MQTT de cada módulo se puede consultar en los siguientes enlaces:
- SysManager
sys: Gestor de la operativa del Cargador. - EVStateMachine
evsm: Gestor de las máquinas de estados asociados a los diferentes conectores del Cargador. - ModulatorManager
modulator: Gestor del Modulador de cargas. - MqttClient
mqtt_user: Gestor del cliente MQTT de usuario.
EL USO DE COMANDOS NO DESCRITOS EN ESTA ESPECIFICACIÓN PUEDE HACER QUE EL CARGADOR DEJE DE FUNCIONAR.
Table of Contents
Operations
PUB XEO/VIARIS/{meshId}/get/0/{deviceId}/{paramId}/{moduleId} Operation
Solicitud de datos.
Parameters
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| meshId | string | Identificador de la red "mesh" a la que pertenece el cargador. | - | - | required |
| deviceId | string | Identificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS). | - | - | required |
| paramId | string | Identificador del tipo de parámetro: cfg boot historic etc... | - | - | required |
| moduleId | string | Identificador del módulo sobre el que se realiza la solicitud: sys: Gestor de la operativa del Cargador. evsm: Gestor de las máquinas de estados asociados a los diferentes conectores del Cargador. modulator: Gestor del Modulador de cargas. mqtt_user: Gestor del cliente MQTT del usuario. | - | - | 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}/{paramId}/{moduleId} Operation
- Operation ID:
statOperation
Estados del cargador.
Parameters
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| meshId | string | Identificador de la red "mesh" a la que pertenece el cargador. | - | - | required |
| deviceId | string | Identificador del dispositivo, con formato "EVVC3xxxxxxxx" (modelo Viaris UNI) o "EVVC4xxxxxxxx" (modelo Viaris COMBIPLUS). | - | - | required |
| paramId | string | Identificador del tipo de parámetro: cfg boot historic etc... | - | - | required |
| moduleId | string | Identificador del módulo sobre el que se realiza la solicitud: sys: Gestor de la operativa del Cargador. evsm: Gestor de las máquinas de estados asociados a los diferentes conectores del Cargador. modulator: Gestor del Modulador de cargas. mqtt_user: Gestor del cliente MQTT del usuario. | - | - | required |
Message <anonymous-message-2>
El contenido del mensaje variará en función de los valores que tomen los parámetros para construir el topic.
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
Examples of payload (generated)
{}