Photo Reporting
Introduction
Trigger your scanner to go into Photo Reporting mode and capture an image, then send it directly to INSIGHT webportal for review. The message format for Streams API serial communication is described below. Alternatively, you can print out and use this QR code, so your workforce can have it at hand to activate Photo Reporting whenever required.
Message fields
Name | Type | Description | Accepted values | Required |
|---|---|---|---|---|
| String | The API version in which this request is valid. |
| Yes |
| String | The type of event. |
| Yes |
| String | The UUID of the event. | Example: | Yes |
| Integer | The timestamp in milliseconds. |
| Yes |
| String | The serial of the ProGlove scanners for which the command is intended. | Any valid MARK serial number. | Yes |
| String | The serial number of the Gateway that will receive the command. | Any valid Gateway serial number | Yes |
| String | The resolution of the image to be captured. |
| No |
| Integer | The JPEG encoding quality of the image to be captured. | Any integer between 5 and 100. | No |
| Integer | The timeout in milliseconds until the scanner aborts Photo Reporting mode without capturing an image. | Any Integer from 1000 to 10000. | No |
| String | The title of the generated Photo Report. | Photo report from | No |
| String | The summary of the generated Photo Report. | Photo report summary from | No |
| String | The description of the generated Photo Report. | Detailed photo report description from | No |
Example
{
"api_version": "3.0",
"event_type": "capture_image!",
"event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
"time_created": 1546300800000,
"device_serial": "M2MR111101051",
"gateway_serial": "PGGW101203662",
"resolution": "320x240",
"encoding_quality": 99,
"timeout": 5000
"report_title": "My photo report",
"report_summary": "My photo report summary",
"report_description": "My detailed photo report description"
}Additional information
Availability and limitations:
Important
Photo Reporting is not supported on LEO scanners.
Carefully test the performance of your scanners when using both Photo Reporting and Continuous Scanning in parallel, as certain technical difficulties may occur.
Photo Reporting via Gateway using Streams API defines each photo as a separate Photo Report in INSIGHT.
Devices and firmware | Subscription plan | Lifecycle status | Resources |
|---|---|---|---|
MARK Basic, MARK Display, MARK 2 - Scanner Firmware Gen1 version 2.10.0 MARK 3 - Scanner Firmware Gen2 version 1.3.0 Gateway - version 2.4.0 | INSIGHT Productivity, INSIGHT Analytics |
FAQs
- 1. Is the resolution of the image that is sent via Gateway configurable?
- 2. Can I send photos directly to INSIGHT without a Connectivity Device?
- 3. Is there another way to trigger Photo Reporting mode on my ProGlove scanners?
- 4. Why should I use this feature when I can take a photo with my smartphone or Android device?
1. | Is the resolution of the image that is sent via Gateway configurable? |
Yes. The resolution can be defined within the API message. Refer to the example listed above. | |
2. | Can I send photos directly to INSIGHT without a Connectivity Device? |
No, a Connectivity Device is necessary for your scanners to connect with and send data to your INSIGHT account. | |
3. | Is there another way to trigger Photo Reporting mode on my ProGlove scanners? |
Yes. You can use Android devices to create Photo Reports. For more details, see here. | |
4. | Why should I use this feature when I can take a photo with my smartphone or Android device? |
Photo Reporting allows you to use the scanner that is already on the back of your hand and saves you the time and effort of handling an additional device for the purpose of capturing photos. Moreover, all photos are sent directly to your INSIGHT account. |