Introduction

Trigger your scanner to go into mode and capture an image, then send it directly to 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 whenever required.

Message fields

Name	Type	Description	Accepted values	Required
`api_version`	String	The API version in which this request is valid.	`"1.1"`, `"1.2"`, `"3.0"`	Yes
`event_type`	String	The type of event.	`"capture_image!"`	Yes
`event_id`	String	The UUID of the event.	Example: `“02114da8-feae-46e3-8b00-a3f7ea8672df"`	Yes
`time_created`	Integer	The timestamp in milliseconds.	`1546300800000`	Yes
`device_serial`	String	The serial of the for which the command is intended.	Any valid serial number.	Yes
`gateway_serial`	String	The serial number of the that will receive the command.	Any valid serial number	Yes
`resolution`	String	The resolution of the image to be captured.	`320x240`, `640x480`, `1280x960`	No
`encoding_quality`	Integer	The JPEG encoding quality of the image to be captured.	Any integer between 5 and 100.	No
`timeout`	Integer	The timeout in milliseconds until the scanner aborts mode without capturing an image.	Any Integer from 1000 to 10000.	No
`report_title`	String	The title of the generated Photo Report.	Photo report from `device_serial`	No
`report_summary`	String	The summary of the generated Photo Report.	Photo report summary from `device_serial`	No
`report_description`	String	The description of the generated Photo Report.	Detailed photo report description from `device_serial`	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

is not supported on scanners.
Carefully test the performance of your scanners when using both and in parallel, as certain technical difficulties may occur.
via using Streams API defines each photo as a separate Photo Report in .

Table 13. Feature availability

Devices and firmware	Subscription plan	Lifecycle status	Resources
, , - version 2.10.0 - version 1.3.0 - version 1.0.2 - version 2.4.0		BETA feature	Firmware, Release notes

Devices and firmware

Subscription plan

Lifecycle status

Resources

, , - version 2.10.0

- version 1.3.0

- version 1.0.2

- version 2.4.0

BETA feature

Firmware, Release notes

FAQs

1.	Is the resolution of the image that is sent via configurable?
	Yes. The resolution can be defined within the API message. Refer to the example listed above.
2.	Can I send photos directly to without a Connectivity Device?
	No, a Connectivity Device is necessary for your scanners to connect with and send data to your account.
3.	Is there another way to trigger Photo Reporting mode on my ?
	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?
	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 account.

ProGlove documentation