Show / Hide Table of Contents

Peripheral Event

Peripheral events are used to inform you of activity related to POS peripherals other than the printer that are connected to your CloudPRNT device, such as a USK Barcode Scanner.

Barcode Scanned "barcode_scan"

If your device has a Barcode scanner attached that has been claimed by the CloudPRNT service, then new barcode scans will trigger a peripheral event, with barcode_scan sub-type.

Example JSON event data:

{
  "EventType": "connection",
  "SubType": "added_new",
  "DeviceGroup": {
    "Path": "dgrp",
    "Name": "Demo Group"
  },
  "Device": {
    "Mac": "001C62030846",
    "Name": "Demonstration mC-Print2",
    "AppID": "e9442f5f"
  },
  "EventData": {
    "Scans": [
      {
        "BCR": "MainBCR",
        "Ascii": "3700597302378",
        "Base64": "MzcwMDU5NzMwMjM3OA=="
      }
    ]
  }
}
Field Description
Scans An array of scanned barcodes. This is reported as an array as it is possible tht multiple scans will be reported in a single event if scanned very quickly.
BCR Name of the barcode reader that reported the scan, for current CloudPRRN devices, this will always be "MainBCR".
Ascii The scanned data Ascii encoded. Note that any non-Ascii characters in the source barcode will not be reported in this field.
Base64 The Scanned date base64 encoded, this can be useful if you may require scanning of barcodes that contain non-Ascii characters.
Important

Barcode scans will only be reported by your device, if the barcode reader has been claimed by the CloudPRNT service. This can be enabled for all devices in a Device Group by modifying your Device Group settings. Barcode Readers are not claimed by default on a new Device Group, to avoid conflicting with an existing POS application.

In this article
Back to top Generated by DocFX