MQTT

If you want to send the read data directly to a MQTT broker, you can configure MQTT information for your service here.

MQTT configuration screenshot

Enable MQTT:

Enables the MQTT publisher

Enable Batch List Reporting:

Publish the all the cumulative tag events between a START/STOP commands according to the Publish Interval parameter; The events list will be cleaned when a STOP command is received;

Clear Batch List on Reload Operation:

Clean-up the cumulative tag events when a reload command (MODE) is received;

Publish Batch List On-Change:

Publish the all the cumulative tag events with the addition of the latest tag event when a new tag is read according to the Publish Batch List On-Change Interval;

Publish Batch List On-Change Interval (in seconds): Time in seconds to publish the cumulative tag events with the addition of the latest tag event when a new tag is read;

Enable publish interval for Batch Lists:

This option will make the app publish the batch event list for the given Publish Interval;

Publish Interval (in seconds):

Interval in seconds to publish the batch event list (cumulative events);

Filter Batch Updates based on Antenna Zone grouping:

When selected the On-Change logic will filter events based on the antenna zone instead of the antenna port number;

Device ID:

MQTT client id to be used.

Broker Username:

Username to be set if authentication is required;

Broker Password:

Password to be set if authentication is required;

Publish Interval (in seconds):

Time in seconds used to group tag events;

Broker settings screenshot

Broker Address:

Address or IP for MQTT Broker.

Broker Port:

MQTT Broker port.

MQTT Broker Keepalive:

Keepalive parameter for MQTT;

MQTT Broker Clean Session:

Use a clean session when connecting;

MQTT Broker Protocol:

The following protocols are available:

• TCP for unsecure connection over TCP. (tcp)

• Web Socket for unsecure connection over Websocket. (ws)

• Secure Web Socket for secure connection over Websocket. (wss)

MQTT Topics:

Tag events topic:

Tag events topic screenshot

Tag Events Topic: Reader uses this topic to send tag read events.

Tag Events QoS Level: MQTT QoS level for the related topic;

Retain Messages: Flag to retain messages for the selected topic;

Data output example:

{ 
"readerName": "37020340131", 
"mac": "00:16:25:13:F9:0B", 
"tag_reads": 
    [ 
    { 
        "epc": "30395DFA82CFF54000000444", 
        "firstSeenTimestamp": 1676420347055000, 
        "antennaPort": 1, 
        "peakRssi": -55, 
        "txPower": 30, 
        "tagDataKey": "03583787372371", 
        "tagDataKeyName": "gtin", 
        "tagDataSerial": "1092" }, 
    { 
        "epc": "E2801191A503006075A97238", 
        "firstSeenTimestamp": 1676420330119000, 
        "antennaPort": 1, 
        "peakRssi": -53, 
        "txPower": 30, 
        "tagDataKey": "unknown", 
        "tagDataKeyName": "unknown", 
        "tagDataSerial": "0" 
    } 
    ] 
}

Management events topic:

Management events topic screenshot

Management Events Topic: Reader uses this topic to send asynchronous events like heartbeats, errors and warnings.

Management Events QoS Level: MQTT QoS level for the related topic;

Retain Messages: Flag to retain messages for the selected topic;

Metrics topic

Metrics topic screenshot

Metrics Topic: Reader uses this topic to send asynchronous metrics like uptime.

Metrics QoS Level: MQTT QoS level for the related topic;

Retain Messages: Flag to retain messages for the selected topic;

Command topics:

Command topics screenshot

Enable Command receiver: Flag to enable command processing over MQTT on the reader;

Management Topic

Topic for receiving management commands: Reader will subscribe to this topic and listening for commands from local network/cloud.

Management Command QoS Level: MQTT QoS level for the related topic;

Topic for Management Command Response publishing: Reader uses this topic to send responses to commands.

Management Command Response QoS Level: MQTT QoS level for the related topic;

Retain Messages: Flag to retain messages for the selected topic;

Control Topic:

Topic for Control Command: Reader will subscribe to this topic and listening for operational commands from local network/cloud.

Control Command QoS Level: MQTT QoS level for the related topic;

Topic for Control Command Response publishing: Reader uses this topic to send responses to operational commands.

Control Command Response QoS Level: MQTT QoS level for the related topic;

Retain Messages: Flag to retain messages for the selected topic;

Task Management Topic

Task Command Topic: Reader subscribes to smartreader/{deviceId}/api/v1/tasks/+ to receive task management commands such as create, update, get and delete. The logicalPointId, taskId and documentId values are provided in the JSON payload as needed. Omit logicalPointId to query tasks for all logical points. Include "progress": true alongside logicalPointId and taskId to request task progress.

All topics can receive the {{deviceId}} variable indicating to the app to replace the variable by the Device ID in use.