Getting Started with CaptureSDK for iOS

Requirements

The Socket Mobile CaptureSDK uses Bluetooth Classic through the External Accessory framework for the barcode scanner products and Bluetooth Low Energy (BLE) for the Contactless Reader/Writer products (Such as the Socket Mobile D600 and S550).

For applications that need to work with barcode scanners, make sure the following requirements are met:

  1. Your application needs to be registered in our whitelist before submitting your application to the Apple Store. It will not pass the Apple Store review if this is not done.

  2. Your application must have the string com.socketmobile.chs in the Supported External Protocol setting.
    ExternalAccessory

  3. Your application’s Info.plist MUST have the NSBluetoothAlwaysUsageDescription key with a string value explaining to the user how the app uses this data. This is an iOS/Apple requirement for applications that use the CoreBluetooth framework. Without it, your application will crash with a message in the Xcode console explaining that you must add the description key. Additionally, if your application has a deployment target earlier than iOS 13.0, you will need to add NSBluetoothPeripheralUsageDescription along with the NSBluetoothAlwaysUsageDescription. More information can be found here in the official Apple Documentation

  4. Your application will need a SocketMobile AppKey. Follow the link to create an AppKey. AppKeys can be generated online and at no additional cost beyond the nominal registration fee. The AppKey is validated by the SDK library on the device, no internet connection is required. Note: You don’t need to create your own AppKey to compile and run the sample apps.

  5. You must have version 1.10.x or greater of Cocoapods installed Our iOS SDK requires a minimum version of 1.10 (if installing the SDK as a dependency through Cocoapods). Take a look at this official guide to install or update cocoapods on your machine before continuing.

  6. The scanner needs to be paired with your devices in Application Mode. This can be done using Socket Mobile Companion app (recommended), which can be downloaded from the App Store . To pair your scanner in Application Mode without using Companion app, follow the instructions at: Configure and Pair Socket Mobile Devices in Application Mode for iOS.

  7. Try the sample app Single Entry in Swift.

SDK Installation

The CaptureSDK is released as a CocoaPods package.

Minimum Deployment Requirement
iOS 11.0 (as of June 2022)

The SDK for iOS supports both Swift and Objective C.

Generating a Podfile

If your project already uses cocoapods, you make skip the following steps and move to the “Adding CaptureSDK to Podfile” section:

  • Open a terminal window and navigate to the directory of your project

  • Run this command in the terminal: pod init

  • This will generate a new file called Podfile. Open this file by typing open Podfile in your terminal. (Or simply open from the Finder window)

Adding CaptureSDK to Podfile

Add this line to your Podfile:

  • pod 'CaptureSDK', '~> 1.4'

The content of the file should look like this:

platform :ios, '10.0'
target 'MyApp'
  pod 'CaptureSDK', '~> 1.4'

Note

The use_frameworks! is no longer necessary as of CocoaPods version 1.5.0 and should be removed. Otherwise, multiple “double symbols” link warnings will be displayed when you run your application in Debug mode.

Installing the CaptureSDK

Once you have added the pod name to your Podfile, you will need to install the SDK.

  • Save your changes/additions to the Podfile. You can safely close it now.

  • Go back to your terminal window and run this command: pod install

  • This will install the SDK within your project.

  • Once this completes, a new file will be generated called: {Name_Of_Your_Project}.xcworkspace

  • If you had the .xcodeproj open during this time, please close it and open this newly created .xcworkspace instead.

Opening the XCWorkspace file

Once you have finish

Using CaptureSDK

The easiest way to use the CaptureSDK in your application is to use Capture Helper, which is released in source code form as part of the CaptureSDK CocoaPods. Please refer to Capture Helper for Objective C or Capture Helper for Swift.