Scanapi Introduction - Socket ScanAPI Reference Manual

Socket ScanAPI Reference
Implement the 1D EZ Pair process in your app to select a pre discovered scanner
and configure it to be an initiator to the host device. This process is explained in
Socket EZ Pair feature
paragraph 8.6 .
Method 2:
-Manually create an EZ Pair barcode with each host system Bluetooth address
so that the 1D scanner simply needs to scan the barcode to configure it as an
initiator to the host device
For the 7Xi series scanners you can just present the EZ pair barcode as part of
your application setup process.
Either way once that part is done your app just needs to have ScanAPI initialized
and waiting to receive the incoming connection of the scanner.

2 ScanAPI Introduction

ScanAPI delivers an application programming interface (API) to control and
configure Socket Bluetooth Cordless Handled Scanners (CHS) connected to a host
computer.
A ScanApi Helper component is provided for Objective C, C# and Java platforms to
integrate more easily ScanAPI into an application. ScanAPI Helper handles the
asynchronous events through callbacks, and gives an easy way to manipulate the
asynchronous commands an application can send to a CHS by providing a callback
mechanism that is invoked when the command response is received.
A CHS has severall properties that can be retrieved, modified or actioned.
CHS properties can be by example a symbology state, its friendly name, or triggering
a scan.
This API is asynchronous. The property operation is therefore a 2-step process. The
application sends a property get or set command and if this is successful, a property
get or set complete event is received with the CHS result of that property command.
At any time a CHS can send events to the host that are retrieved using the same
mechanism as the completion of the property operation.
ScanAPI has only one entry point to receive these asynchronous events making it
very easy to manage.
The other benefit of this asynchronous API is to be able to drive a scanner from a
graphical user interface (GUI) application without danger of blocking the user
interface while waiting for a lengthy operation to complete.
© 2013 Socket Mobile, Inc. 10/152