MQTT


This group contains settings associated with the MQTT client.


Q00

Mode

Enable/disable the MQTT client.

0 = disabled / 1 = enabled - Default: disabled

Q01

Minimum time between uploads

To limit the amount of data on paid networks, it is possible to force a minimum time interval between one connection and the next, grouping the transfers into periodic sessions interspersed with pause periods.

0 = off / 1 ... 10080 [minutes] - Default: 1

Q02

Keepalive interval

The time within which the MQTT broker expects to receive a communication from the client, which automatically carries out a sending in order to keep the connection open.

The server considers the connection closed if it is not contacted within 1.5 times this time.

0 = off / 1 ... 1080 [minutes] - Default: 10

Q03

Broker address

Address of the MQTT broker.

It must begin with mqtt:// (will connect to port 1883)

or with mqtts:// (will connect to port 8883)

A custom port could be specified at the end of broker address:

mqtts://mybroker.com:8234

Support of mqtts over WiFi is not guaranteed.

Q04

Quality of Service (QoS)

Quality of service of MQTT:

0: once (not guaranteed)

1: at least once (guaranteed)

2: only once (guaranteed)

Default: 0

Q05

Username

Optional username used to connect to broker.

0 ... 160 characters

Q06

Password

Optional password used to connect to broker.

To insert special characters use the hexadecimal ASCII format, for example %20 for space.

0 ... 160 characters

Q07

Client ID

Identifier with which the device topics are published. If not specified, the WebId will be used. By specifying an existing identifier, the previous device with the same identifier will be disconnected.

0 ... 64 characters

Q08

Last Will and Testament topic

Name of the topic that the broker will keep for publication in case an unwanted disconnection of the device occurs.

Published without delay (delay=0, retain=0) using the same QoS set for publishing the other messages.

The content of the topic is: Avior <WebId> disconnected

0 ... 64 characters

Q09

Topic SUB to receive commands

Name of the subscribed topic from which the device retrieves any commands sent.

The command must be identified by a reconciliation code thanks to which it will recognize the response (if any). The code precedes the command and must be included in between < and > :

<code>out1=on

0 ... 64 characters

Q10

Topic PUB to reply command

Name of the topic that contains the response (if any) to the last command received from the device through the command topic.

If the command included a reconciliation code, this will be reported at the beginning of the response:

<code>OK

If multiple commands are sent, each response will be preceded by the reconciliation code to which a progressive index is added:

<code-1>OK

<code-2>OK

<code-3>OK

0 ... 64 characters

Q11

Topic PUB on map changes

Name assigned to the topic published at each modification of a map parameter. The topic contains the parameters changed since the last publication. 

0 ... 64 characters

Q12

Topic PUB on log changes

Name assigned to the topic published at each modification of the log file. The topic contains the last event recorded in the file.

0 ... 64 characters

Q13

Topic PUB on users changes

Name assigned to the published topic whenever a user is added, removed or modified.

The topic contains the information of the interested user.

0 ... 64 characters

Q14

Topic PUB on rules changes

Name assigned to the published topic whenever a rule is added, changed or removed.

The topic contains the definition of the rule concerned.

0 ... 64 characters

Q15

Status of connection

0: not connected

1: connected to MQTT broker

If connection is performed via cellular network and there isn't data exchange for a long time the carrier operator may close the connection to broker; in this situation Avior is not able to detect such disconnection until the next data transmission. In this case parameter Q15 is meaningless.

0 / 1