API MQTT pública para cargadores Viaris de ORBIS
- Default content type: application/json
Definición de la API MQTT pública soportada por los cargadores de la serie Viaris de ORBIS.
Las operaciones descritas permiten a los usuarios crear sus propias herramientas para gestionar y manejar sus propios cargadores empleando el protocolo MQTT.
La descripción de la API se organiza en módulos los cuales se encargan de gestionar distintas funcionalidades del cargador:
- SysManager. Control general del cargador.
- EVStateMachine. Controles acerca de los conectores de carga.
- ModulatorManager. Control del modulador de cargas.
- MqttClient. Configuración del servidor público MQTT.
EL USO DE COMANDOS NO DESCRITOS EN ESTA ESPECIFICACIÓN PUEDE HACER QUE EL CARGADOR DEJE DE FUNCIONAR.
Table of Contents
Operations
SEND XEO/VIARIS/{meshId}/get/0/{deviceId}/{paramId}/{moduleId} Operation
- Operation ID:
get-operation
Este tipo de topics pueden usarse para requerir información del dispositivo.
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 |
| paramId | string | Tipo de parámetro o elmento del módulo. | examples ("cfg", "boot", "historic") | - | required |
| moduleId | string | Identificador del módulo. | examples ("sys", "evsm", "modulator") | - | required |
Message getMessage
- Message ID:
getMessage - Content type: application/json
En función del topic la estructura del mensaje difiere. Acceder al módulo correspondiente para obtener más información.
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
Examples of payload (generated)
{}
RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/{paramId}/{moduleId} Operation
- Operation ID:
stat-operation
Mensajes publicados por el dispositivo ante determinados eventos.
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 |
| paramId | string | Tipo de parámetro o elmento del módulo. | examples ("cfg", "boot", "historic") | - | required |
| moduleId | string | Identificador del módulo. | examples ("sys", "evsm", "modulator") | - | required |
Message statMessage
- Message ID:
statMessage - Content type: application/json
En función del topic la estructura del mensaje difiere. Acceder al módulo correspondiente para obtener más información.
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
Examples of payload (generated)
{}
SEND XEO/VIARIS/{meshId}/set/0/{deviceId}/{paramId}/{moduleId} Operation
- Operation ID:
set-operation
Este tipo de topics permiten al usuario publicar cambios en la configuración de los módulos o provocar acciones en el propio dispositivo.
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 |
| paramId | string | Tipo de parámetro o elmento del módulo. | examples ("cfg", "boot", "historic") | - | required |
| moduleId | string | Identificador del módulo. | examples ("sys", "evsm", "modulator") | - | required |
Message setMessage
- Message ID:
setMessage - Content type: application/json
En función del topic la estructura del mensaje difiere. Acceder al módulo correspondiente para obtener más información.
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
Examples of payload (generated)
{}