MQTTClient - 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 MQTTClient.
Table of Contents
Operations
SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/ping/mqtt_user Operation
Mensaje tipo PING para señalizar la existencia de comunicación con el broker MQTT.
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 |
Examples of payload (generated)
{}
SUB XEO/VIARIS/{meshId}/stat/0/{deviceId}/last_will/mqtt_user Operation
Indica que se ha producido una desconexión con el broker.
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-2>
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
Examples of payload (generated)
{}
PUB XEO/VIARIS/{meshId}/get/0/{deviceId}/cfg/mqtt_user Operation
Solicitud de la configuración MQTT.
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 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}/cfg/mqtt_user Operation
Configuración MQTT de usuario.
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-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 | - | - | - | additional properties are allowed |
| data.uid | integer | - | - | - | - |
| data.cfg | object | Configuración de la conexión MQTT del cliente. | - | - | additional properties are allowed |
| data.cfg.keepAlive | integer | - | default (180) | - | - |
| data.cfg.groupMask | integer | - | - | - | - |
| data.cfg.qos | integer | Calidad de servicio | default (1) | - | - |
| data.cfg.verbosity | integer | Nivel de detalle en las trazas de depuración | - | - | - |
| data.cfg.mqttUrl | string | URL del servidor MQTT. | - | - | - |
| data.cfg.mqttPort | integer | Puerto de conexión con el servidor MQTT. | default (1883) | - | - |
| data.cfg.mqttClientId | string | - | - | - | - |
| data.cfg.mqttUser | string | - | - | - | - |
| data.cfg.pingInterval | integer | - | default (900) | - | - |
Examples of payload (generated)
{
"header": {
"timestamp": 0,
"heapSize": 0
},
"data": {
"uid": 0,
"cfg": {
"keepAlive": 180,
"groupMask": 0,
"qos": 1,
"verbosity": 0,
"mqttUrl": "string",
"mqttPort": 1883,
"mqttClientId": "string",
"mqttUser": "string",
"pingInterval": 900
}
}
}
PUB XEO/VIARIS/{meshId}/set/0/{deviceId}/cfg/mqtt_user Operation
Configuración MQTT de usuario.
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-5>
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
| idTrans | integer | Identificador de la transacción. | - | - | - |
| data | object | - | - | - | additional properties are allowed |
| data.uid | integer | Identificador del módulo. | - | - | - |
| data.cfg | object | Configuración de la conexión MQTT del cliente. | - | - | additional properties are allowed |
| data.cfg.keepAlive | integer | Tiempo máximo para enviar un mensaje de PING que mantenga la conexión establecida. | default (180) | - | - |
| data.cfg.groupMask | integer | - | - | - | - |
| data.cfg.qos | integer | Calidad de servicio: - (0) At most once - (1) Al least once - (2) Exactly once | default (1) | - | - |
| data.cfg.verbosity | integer | Nivel de detalle en las trazas de depuración. | - | - | - |
| data.cfg.mqttUrl | string | URL del servidor MQTT. | - | - | - |
| data.cfg.mqttPort | integer | Puerto de conexión con el servidor MQTT. | default (1883) | - | - |
| data.cfg.mqttClientId | string | Cadena que identifica al cliente sobre el broker MQTT. | - | - | - |
| data.cfg.mqttUser | string | Nombre de usuario de acceso al broker. | - | - | - |
| data.cfg.pingInterval | integer | Periodo de tiempo en el envío del mensaje "ping/mqtt_user". | default (900) | - | - |
Examples of payload (generated)
{
"idTrans": 0,
"data": {
"uid": 0,
"cfg": {
"keepAlive": 180,
"groupMask": 0,
"qos": 1,
"verbosity": 0,
"mqttUrl": "string",
"mqttPort": 1883,
"mqttClientId": "string",
"mqttUser": "string",
"pingInterval": 900
}
}
}