MQTT integration

Allows you to integrate the ProGlove INSIGHT Mobile (Android) app with your system using the MQTT protocol.

Streams API is used to define events and messages that can be exchanged between your system and ProGlove apps. This way your server would be able to exchange messages with INSIGHT Mobile as the client.

To enable this connection, use our Config tool in INSIGHT to set up MQTT client and make the connection with your MQTT broker.

Devices and communication setup

Download the latest .apk version of the INSIGHT Mobile (Android) app and install it on your Android device.

Next, create a ProGlove.proconfig file by creating a device configuration for Android in the INSIGHT Config tool and set up all the required fields. Refer to the table below for more details about the available and necessary fields.

Once you have created the file, apply it to your Android device. This can be done in two ways:

Copy the ProGlove.proconfig file to the following location on your Android device: yourphone/InternalStorage/Android/data/de.proglove.connect/Files
Pair your scanner with the INSIGHT Mobile app and scan the QR code generated in the Config tool in INSIGHT to apply the configuration. Note that this QR code could be provided in any visual form, i.e. screenshot, digital image or a printed version.
Note
Due to limitations of Android 11, you can no longer copy files to the Android/data/de.proglove.connect folder using the Android device only or via MDM (Mobile Device Management). For earlier Android versions, downloading the .apk directly to the Android device still works. On Android 11, you can still use the adb push command to push or pull files or folders to Android/data/de.proglove.connect. Additionally, permissions for installing third party applications (unknown sources) must be granted on your Android device.

Fields and sample messages

INSIGHT Mobile app handles only 2 topics - the one where it publishes events, and the other to which it subscribes and receives all the Streams API messages.

Field	Type	Description	Value example	Required / configurable
`Domain/IP Address`	String	The domain or address of the broker.	broker.MQTTdashboard.com	Mandatory / Yes
`port`	Integer	The port number to connect to the broker.	1883	Mandatory / Yes
`MQTT over Web socket`	Boolean	Which protocol to use. If `MQTT over Web socket` is disabled, tcp will be used and a `tcp://` prefix will be automatically added before the domain. If `MQTT over Web socket` is enabled, web socket protocol will be used and a `ws://` prefix will be automatically added before the domain.	false	Mandatory / Yes
`username`	String	Username	Proglove	Optional / Yes
`password`	String	The password to use in case the connection requires an authentication.	Proglove-scanX	Optional / Yes
`qos`	Integer	The quality of service to use for publishing and subscribing.	Exactly once	Mandatory / Yes
`topic_prefix`	String	This is an optional prefix to be included before every predefined topic (see below).	prefix/gateway/gw_id/request prefix/gateway/gw_id/event	Optional / Yes
`subscribe_topic`	String	A predefined topic that the broker should listen in order to receive events from client. In the example on the right, `gw_id` represents a unique identifier of the Gateway/Android that runs the client. If available, `gw_id` is Android device’s serial number. Since the serial number is not available on most of the latest Android OS versions, as a fallback - unique installation ID is used. Unique installation ID is created when app is installed, and it is preserved with the app updates. If app is uninstalled then installed again, new unique installation ID is created.	gateway/gw_id/event	Optional / No
`publish_topic`	String	A predefined topic to which the INSIGHT Mobile’s MQTT client is subscribed in order to receive the requests that should be executed. In the example on the right, `gw_id` represents some unique identifier of the Gateway/Android that runs the client. For more details about it see the `subscribe_topic` description.	gateway/gw_id/request	Optional / No

You can publish various Streams API request messages to for execution of the commands or to gather some information. Ensure these are all published on the same request topic (e.g. gateway/3a142769-95de-4c46-b38e-a4e97f315c57/request).

See below for example messages of scan events and scan requests:

Scan event message containing barcode data:

{
    "api_version":"1.0",
    "event_type":"scan",
    "event_id":"22d4a950-b373-42a3-8428-7a3887e78583",
    "time_created":1699621609245,
    "scan_code":"YVQGZZNSXU",
    "device_serial":"MDMR102104863"
}

Scan request message that will display data on the connected scanner's display:

{
   "api_version":"1.0",
   "event_type":"display!",
   "event_id":"02114da8-feae-46e3-8b00-a3f7ea8672df",
   "time_created":1546300800000,
   "time_validity_duration":5000,
   "device_serial":"MDMR000000064",
   "display_template_id":"PG3",
   "display_refresh_type":"DEFAULT",
   "display_fields":[
      {
         "display_field_id":1,
         "display_field_header":"Storage Unit",
         "display_field_text":"R15"
      },
      {
         "display_field_id":2,
         "display_field_header":"Item",
         "display_field_text":"Engine 12"
      },
      {
         "display_field_id":3,
         "display_field_header":"Quantity",
         "display_field_text":"10"
      }
   ]
}

Make sure that the device_serial value corresponds to your scanner's serial number.

Note that, in this example, the data will be displayed for exactly 5000 milliseconds, after which the scanner will continue displaying the previous screen. In order to remove the time limit, edit the time_validity_duration value to 0.

Additional information

For more information on Streams API, see supported streams.

Table 21. Feature availability

Devices	Subscription plan	Lifecycle status	Resources
MARK Basic, MARK Display, MARK 2 LEO, MARK 3 Gateway INSIGHT Mobile (Android)	INSIGHT Visibility, INSIGHT Analytics	Released	Firmware Release notes

Devices

Subscription plan

Lifecycle status

Resources

MARK Basic, MARK Display, MARK 2

LEO, MARK 3

Gateway

INSIGHT Mobile (Android)

INSIGHT Visibility, INSIGHT Analytics

Released

Firmware Release notes

In this section:

ProGlove Documentation

MQTT integration

Devices and communication setup

Note

Fields and sample messages

Additional information

Search results