EVStateMachine - 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 EVStateMachine.

Table of Contents

• Operations
  • SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/value/evsm
  • PUB XEO/VIARIS/{meshId}/get/0/{deviceId}/value/evsm/{connId}
  • SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/value/evsm/{connId}
  • SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/evt/evsm/{connId}

Operations

SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/value/evsm Operation

Estado de los conectores

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-1>

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador de la transacción. OPCIONAL. Sólo existe si el mensaje es enviado como resultado de una publicación previa.	-	-	-
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	-	-	-	additional properties are allowed
data.uid	integer	Identificador del módulo.	-	-	-
data.elements	array	-	-	-	-
data.elements.name	string	Nombre del conector.	-	-	-
data.elements.stat	object	Estado interno del conector.	-	-	additional properties are allowed
data.elements.stat.event	integer	Valor del último evento.	-	-	-
data.elements.stat.state	integer	Estado numérico.	-	-	-
data.elements.stat.idCharge	integer	Identificador de la última carga.	-	-	-
data.elements.stat.user	string	Último usuario con acceso al conector.	-	-	-
data.elements.stat.localtime	integer	Marca de tiempo actual.	-	-	-
data.state	integer	-	-	-	-

Examples of payload (generated)

{
  "idTrans": 0,
  "header": {
    "timestamp": 0,
    "heapSize": 0
  },
  "data": {
    "uid": 0,
    "elements": [
      {
        "name": "string",
        "stat": {
          "event": 0,
          "state": 0,
          "idCharge": 0,
          "user": "string",
          "localtime": 0
        }
      }
    ],
    "state": 0
  }
}

PUB XEO/VIARIS/{meshId}/get/0/{deviceId}/value/evsm/{connId} Operation

Permite solicitar el estado de un conector.

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
connId	string	Nombre del conector (según modelo de cargador). "mennekes" "schuko" "mennekes1" "mennekes2"	-	-	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}/value/evsm/{connId} Operation

Estado de un conector

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
connId	string	Nombre del conector (según modelo de cargador). "mennekes" "schuko" "mennekes1" "mennekes2"	-	-	required

Message <anonymous-message-3>

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
idTrans	integer	Identificador de la transacción. OPCIONAL. Sólo existe si el mensaje es enviado como resultado de una publicación previa.	-	-	-
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	-	-	-	additional properties are allowed
data.uid	integer	-	-	-	-
data.name	string	Nombre del conector.	-	-	-
data.stat	object	Estado interno del conector.	-	-	additional properties are allowed
data.stat.event	integer	Valor del último evento.	-	-	-
data.stat.state	integer	Estado numérico.	-	-	-
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,
    "heapSize": 0
  },
  "data": {
    "uid": 0,
    "name": "string",
    "stat": {
      "event": 0,
      "state": 0,
      "idCharge": 0,
      "user": "string",
      "localtime": 0
    }
  }
}

SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/evt/evsm/{connId} Operation

Notificación de un evento de la máquina de estados del conector.

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
connId	string	Nombre del conector (según modelo de cargador). "mennekes" "schuko" "mennekes1" "mennekes2"	-	-	required

Message <anonymous-message-4>

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	Descripción	-	-	additional properties are allowed
data.event	integer	Valor del último evento.	-	-	-
data.state	integer	Estado numérico.	-	-	-
data.idCharge	integer	Identificador de la última carga.	-	-	-
data.user	string	Último usuario con acceso al conector.	-	-	-
data.localtime	integer	Marca de tiempo actual.	-	-	-

Examples of payload (generated)

{
  "header": {
    "timestamp": 0,
    "heapSize": 0
  },
  "data": {
    "event": 0,
    "state": 0,
    "idCharge": 0,
    "user": "string",
    "localtime": 0
  }
}