API para el módulo EVStateMachine
El módulo EVStateMachine controla los estados generales del cargador.
< Volver a la página principal.
Table of Contents
Operations
SEND XEO/VIARIS/{meshId}/get/0/{deviceId}/value/evsm/{connId} Operation
- Operation ID:
GetValueEvsmOp
Permite solicitar el estado de un conector
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 |
| conId | string | Nombre del conector. | examples ("mennekes", "schuko", "mennekes1", "mennekes2") | - | 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}/value/evsm/{connId} Operation
- Operation ID:
StatValueEvsmOp
Enviado por el dispositivo para informar del estado de un conector
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 |
| conId | string | Nombre del conector. | examples ("mennekes", "schuko", "mennekes1", "mennekes2") | - | required |
Message CfgSysMsg
- Message ID:
CfgSysMsg - Content type: appication/json
Datos de estado de un conector
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 (15) | - | - |
| data.name | string | Nombre del conector (según modelo de cargador): - "mennekes" - "schuko" - "mennekes1" - "mennekes2" | - | - | - |
| data.stat | object | - | - | - | additional properties are allowed |
| data.stat.event | integer | Valor del último evento | - | - | - |
| data.stat.state | integer | Estado numérico del conector | - | - | - |
| data.stat.idCharge | integer | Identificador de la última carga | - | - | - |
| data.stat.user | string | Último usuario con acceso al conector | - | - | - |
| data.stat.localtime | integer | Marca de tiempo actual | - | - | - |
Examples of payload (generated)
{
"idTrans": 0,
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 15,
"name": "string",
"stat": {
"event": 0,
"state": 0,
"idCharge": 0,
"user": "string",
"localtime": 0
}
}
}
RECEIVE XEO/VIARIS/{meshId}/stat/0/{deviceId}/evt/evsm/{connId} Operation
- Operation ID:
StatEvtEvsmMsg
Notificación de un evento de la máquina de estados del conector
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 |
| conId | string | Nombre del conector. | examples ("mennekes", "schuko", "mennekes1", "mennekes2") | - | required |
Message StatEvtEvsmMsg
- Message ID:
StatEvtEvsmMsg - Content type: appication/json
Datos de estado de un conector
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.uid | integer | Identificador del módulo | const (15) | - | - |
| data.name | string | Nombre del conector (según modelo de cargador): - "mennekes" - "schuko" - "mennekes1" - "mennekes2" | - | - | - |
| data.stat | object | - | - | - | additional properties are allowed |
| data.stat.event | integer | Valor del último evento | - | - | - |
| data.stat.state | integer | Estado numérico del conector | - | - | - |
| data.stat.idCharge | integer | Identificador de la última carga | - | - | - |
| data.stat.user | string | Último usuario con acceso al conector | - | - | - |
| data.stat.localtime | integer | Marca de tiempo actual | - | - | - |
Examples of payload (generated)
{
"header": {
"timestamp": 0,
"heapFree": 0
},
"data": {
"uid": 15,
"name": "string",
"stat": {
"event": 0,
"state": 0,
"idCharge": 0,
"user": "string",
"localtime": 0
}
}
}