Socket ScanAPI Reference

© 2013 Socket Mobile, Inc. 71/152 message by using Release API and close ScanAPI by using the Close API with the ScanAPI object reference. This property can only be set. A get operation on this property will return an error. Parameter type Get Get Complete Set Set Complete Not applicable Not applicable None None Version ScanAPI Interface Version 1.0.0 or higher 13.2 Property kSktScanPropIdVersion This property is used to retrieve the version of ScanAPI. This property can only be used with the Get function. The value returned in a Get Complete Response is a Version str ...

© 2013 Socket Mobile, Inc. 16/152 An important point is the fact that a property set or get can fail for many reasons, and some of them will require the application to retry the operation and some should just be taken into consideration. For example, if a property returns a REQUEST TIMEOUT error because the scanner is out of the range for a brief instant or busy receiving decoded data, having retry logic can fix this issue. 4.7 Example of sending a command This section describes the steps for sending a command to a device. Let’s imagine an application using ScanAPI ...

© 2013 Socket Mobile, Inc. 93/152 ScanAPI Interface Version 1.0.0 or higher 14.11 Property kSktScanPropIdFriendlyNameDevice This property is used to read or modify the friendly name of a device. The friendly name is carried as a string in the property. The friendly name of a device is what appears during a Bluetooth device discovery process. The main purpose of changing the friendly name of a device is to have an easy way to identify a particular device. The changes are active immediately upon success of the Set Complete operation. The friendly name size can be as lon ...

© 2013 Socket Mobile, Inc. 14/152 4.4 Using ScanAPI An application has two things to do in order to setup ScanAPI correctly. It needs first to open ScanAPI by specifying no name in the open parameter API, and then starts either a timer or a thread to consume the asynchronous events coming from ScanAPI. When a CHS connects to the host, ScanAPI sends a Device Arrival event to the application through the application ScanAPI consumer logic. The Device Arrival event contains an UUID identifying a Device Object that represents a CHS. The application can open the Device Obje ...

© 2013 Socket Mobile, Inc. 58/152 [in] a timeout value expressed in milliseconds. The timeout cannot be bigger than 10000ms otherwise an error will be returned. C#: long ISktScanApi.WaitForScanObject( ISktScanObject out scanObj, long ulTimeout ); scanObj [out] reference to a ScanObject that is allocated by ScanAPI. This object must be released when it is no longer needed. ulTimeout [in] a timeout value expressed in milliseconds. The timeout cannot be bigger than 10000ms otherwise an error will be returned. Objective C: -(SKTRESULT) waitForScanObject: (id

© 2013 Socket Mobile, Inc. 10/152 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 paragraph 8.6 Socket EZ Pair feature. 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 don ...

© 2013 Socket Mobile, Inc. 66/152 The Buttons Event is not activated by default. The device notification must be modified in order to turn on this notification. This is accomplished by using the property kSktScanPropIdNotificationDevice. The same property can be used to configure which button event the device will send. See the Property kSktScanPropIdNotificationsDevice for more information. The buttons code is a byte value with a bit field value and is defined as follows: 7 6 5 4 3 2 1 0 Reserved Reserved Reserved Ring Detached Power button Middle button Right button ...