Barcode & QR Code Scanning Settings

Native Camera Scanning Settings

Aila Scanning Settings

Bluetooth Scanning Settings

JavaScript API Documentation


Native Camera Scanning

This feature allows you to use the iPad's native on-board cameras to scan and interpret UPC barcodes and QR codes.

Options:

  • None (default)
  • Front
  • Back

Depending on your use case and enclosure, you can decide to use either the front or rear camera. The rear camera features a higher resolution camera, which may provide more reliable scanning results than the front camera.

We've added custom JavaScript functions that you can call to begin the scan, at which point the camera goes full-screen allowing the visitor to easily position the code for scanning. When the scan had been captured, the data from the barcode is returned to your page through a JavaScript callback.

More information and sample code demonstrating these functions are available here.


Supported Codes

This setting gives you control over the type of barcode scanning your visitors can perform, only returning results for the selected type of code.

Default: All

All includes:

  • EAN-2, GS1 2-digit add-on
  • EAN-5, GS1 5-digit add-on
  • EAN-8
  • EAN-13
  • UPC-A
  • UPC-E
  • ISBN-10 (from EAN-13)
  • ISBN-13 (from EAN-13)
  • EAN/UPC composite
  • GS1 DataBar (RSS)
  • GS1 DataBar Expanded
  • Code 39
  • Code 93
  • Code 128
  • QR Code

Other options include QR codes only, UPC barcodes only, and Interleaved 2 of 5 - use of these narrower categories when appropriate may decrease the amount of time it takes the app to interpret and return barcode data.

Note: 'Interleaved 2 of 5' is not supported as a part of 'All' due to default behavior of the underlying ZBar library Kiosk Pro uses for scanning. ZBar turns off support for Interleaved 2 of 5 to improve scanning time for other barcode types.


Show Help Icon

Added in version 7.0

This toggle lets you choose to show or hide the help icon that appears when scanning a barcode.

Default: On


Scan Area

Added in version 7.5

This setting allows you define how much of the camera overlay can be used for scanning when using the app’s native camera scanning through the JavaScript API. The scan area is outlined on screen with a blue rectangular overlay.

Scan area is defined as a set of four coordinates: leftCorner, topCorner, width, height. These are expressed as a decimal percentage of the screen where 0 = 0% and 1 = 100%.

Default: 0, 0, 1, 1

The default value, ‘0, 0, 1, 1’, uses the full camera overlay. A value of ‘0.25, 0.25, 0.5, 0.5’ would allow scanning in a rectangular area that covered the center 50% of the screen.


Aila Scanning

Added in version 8.0

Kiosk Pro Enterprise supports 1D and 2D barcode scanning through Aila’s line of kiosk and handheld scanners for iOS. Supported barcode types for this integration include UPC-EAN, QR, Code 128, Code 39, and Interleaved 2 of 5.

These scanners use a mirrored camera system for barcode capture and recognition and the audio jack for communication with the app. Current models can be viewed on their site at http://ailatech.com/.

While the scanner is active, white LED lights illuminate the scanning area and a red LED helps the visitor accurately position the barcode for scanning.

Use of these scanners requires integration of our JavaScript API. Calls are available to begin and end a scanning session, to check the current state of scanning, to return which type of scanner is being used, and to manually trigger a beep from the scanner.


Scanning Mode

The scanning mode setting determines whether the scanner continues to scan after a successful scan is registered or stops automatically.

Default: Autoconfigure

In Single scanning mode, the scanner is turned on through a JavaScript call and remains on until a successful scan occurs or the scanner is turned off through a second JavaScript API call or is physically disconnected.

In Continuous scanning mode, the scanner is turned on by a JavaScript call and then remains on until the scanner is turned off through a second JavaScript API call or is physically disconnected.

The Autoconfigure option sets the scanning mode based on the type of scanner being used. For kiosk cases where the scanner is expected to have a permanent power source, Autoconfigure opts for Continuous scanning mode. For handheld cases, where scanning can be manually triggered through a button on the case itself and the device is more likely to be unplugged, Autoconfigure uses Single scanning mode.


Motion Detection Mode

The motion detection mode setting allows you to configure when the scanner registers new scans.

Default: Autoconfigure

When motion detection mode is turned off, the scanner will continuously focus the camera and analyze the image for recognizable barcodes. When motion detection mode is turned on, the scanner will monitor the camera for motion. Once motion is detected, the scanner will focus and analyze the image for barcodes.

Motion detection mode does not affect the Aila scanner's LED lighting, which remains on whenever scanning is active.

In Autoconfigure mode, the motion detection mode is determined by the type of scanner being used. For kiosk cases where the scanner is generally set to a continuous scanning mode, Autoconfigure opts for motion detection to be turned on. For handheld cases, Autoconfigure turns motion detection off.


Automatically Beep on Scan

This toggle allows you to set whether the scanner automatically beeps when a successful scan is registered or not.

Default: On

In addition to automatically triggering a beep, it is also possible to trigger a beep through the JavaScript API.


Enabled Codes

Supported barcode types for this integration include UPC-EAN, QR, Code 128, Code 39, and Interleaved 2 of 5. This setting allows you to define which types of codes are registered as a successful scan.

Default: UPCEAN;QR;128;39;25

The default entry allows for all supported codes to scan. Multiple entries must be separated by a semicolon (‘;’) character.


Bluetooth Scanning

Kiosk Pro Enterprise includes support for barcode scanners that can connect to the iPad via Bluetooth, returning the results of a scan directly to your page through a JavaScript callback.

Default: Off

This type of barcode scanner uses the iPad's native connection for Bluetooth keyboards to emulate keyboard input. This means that while the scanner is directly connected to the iPad, no on-screen keyboard will be shown when focus enters text fields so the use of this type of scanner is not recommended for projects where visitors would need access to the on-screen keyboard. While certain scanners have physical buttons that allow you to connect and disconnect the scanner to gain access to the keyboard, we've had varying levels of success with these in testing and cannot provide support if problems arise.

There are two primary API calls - one that triggers an alert popup requesting a scan (with customizable text) and one that listens in the background for scanner data.

Data encoded in the barcode or QR code is returned as a string to your page through a JavaScript callback.

Sample code demonstrating these functions are available here.

Still stuck? How can we help? How can we help?