ZEBRA Barcode Scanner SDK for iOS v1.4 Owner’s Manual

Barcode Scanner SDK for iOS v1.4

“`html

Specifications

• Product: Zebra Scanner SDK for iOS
• Version: 1.4
• Release Date: July 2024

Product Information

The Zebra Scanner SDK for iOS enables MFi and BTLE cordless
scanners to be connected and controlled by an iPad / iPhone / iPod
Touch without using a cradle, after pairing over Bluetooth. The SDK
provides various functionalities including barcode data display,
LED and Beeper control, symbology management, scanning control,
event notifications, remote scanner management, aim control, page
motor support, firmware update support, and STC support for BTLE
scanners.

The SDK also includes source code for the Zebra Scanner Control
app available from the Apple Store. For the latest updates, please
visit Zebra Scanner SDK. For support, visit the Zebra support
page.

Product Usage Instructions

1. Connecting the Scanner

To connect the scanner to your iOS device:

1. Pair the scanner with your device over Bluetooth.
2. Open the application using the SDK.
3. The scanner should now be ready for use within the
   application.

2. Using Scanner Functionalities

The SDK allows you to:

• Display barcode data within your iOS application.

• Control LED and Beeper settings.

• Enable/disable symbologies.

• Manage scanning functions like remote trigger and
  enable/disable scanning.

• Receive event notifications such as scanner availability,
  connection status, and barcode data transmission.

• Manage remote scanner functions like asset tracking and device
  configuration.

• Utilize aim control and page motor support.

• Update firmware and utilize STC support for BTLE scanners.

FAQ

1. Can I update the scanner firmware using this SDK?

In iOS 17, scanner firmware update is temporarily not supported.
This feature will be available in a future release. Firmware
updates in older iOS versions like v16 and v15 function
correctly.

2. What iOS versions are supported by Zebra?

Zebra only supports the last 3 iOS versions from Apple. iOS v14
and older are no longer supported.

“`

Release Notes
Barcode Scanner SDK for iOS v1.4 July 2024
Contents
Contents…………………………………………………………………………………………………………………………………….. 1 Overview ……………………………………………………………………………………………………………………………………. 1 Device Compatibility ……………………………………………………………………………………………………………………. 2 Supported COM Protocols ……………………………………………………………………………………………………………. 2 Version History……………………………………………………………………………………………………………………………. 3 Components……………………………………………………………………………………………………………………………….. 6 Installation …………………………………………………………………………………………………………………………………. 6
Overview
The Zebra Scanner SDK for iOS enables MFi and BTLE cordless scanners to be connected and controlled by an iPad / iPhone / iPod Touch without using a cradle, after pairing over Bluetooth. Functionality,
1. Display bar code data within a iPad / iPhone / iPod Touch application. 2. Apps using the SDK can command and control the scanner.
a. LED and Beeper Control. b. Enable/disable Symbologies. c. Scanning control
i. Remote scanner trigger (i.e. Host app-initiated triggering). ii. Enable/disable scanning. d. Event notification.
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 1

i. Scanner available / unavailable. ii. Scanner connected / disconnected from host. iii. Bar code data transmission (i.e. host gets event stating bar code has been
scanned). iv. Firmware update progress (i.e. host gets event regarding the progress of the
firmware update). e. Automatic reconnection to last connected scanner (i.e. scanner goes out range and then
returns). 3. Remote Scanner Management.
a. Asset Tracking. i. Model number. ii. Serial number. iii. Date of manufacture. iv. Firmware.
b. Device Configuration (Get, Set and Store Scanner attributes). 4. Aim control. 5. Page motor support. 6. Firmware update support. 7. STC support for BTLE scanners.
The SDK also includes source code for the “Zebra Scanner Control” app available from the Apple Store (https://itunes.apple.com/us/app/zebra-scanner- control/id1034012069). For the latest SDK updates, please visit Zebra Scanner SDK For support, please visit http://www.zebra.com/support.
Device Compatibility
For the compatible devices list, please visit following page. https://www.zebra.com/us/en/support-downloads/software/developer-tools /scanner-sdk-for-iOS.html
Supported COM Protocols
SDK supported communication protocols include: · Simple Serial Interface (SSI) over Bluetooth Low-Energy (BLE) · Simple Serial Interface (SSI) over MFI
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 2

Query Assets Information Host Switching
Imaging and Video Faster Firmware Update Management and Firmware
Update Barcode

IBM Table-Top USB

IBM Hand-Held USB

IBM OPOS – IBM Hand-held USB with Full Scan Disable

HID Keyboard Emulation

USB CDC Host

Symbol Native API (SNAPI) with Imaging Interface

Symbol Native API (SNAPI) without Imaging Interface

Wincor-Nixdorf RS-232 Mode B

Simple Serial Interface (SSI) over RS232

Simple Serial Interface (SSI) over Bluetooth Classic

Simple Serial Interface (SSI) over Bluetooth Low-Energy

X

(BLE)

Simple Serial Interface (SSI) over MFI

X

X X X X

Version History
Version 1.4.43 ­ 07/2024
1. Enhanced XCFramework – M1 Chip now supported in the Simulator. 2. Updated the SDK to support Apple’s development recommendations – The
“libsymbolbt-sdk.a” static library has been discontinued. This capability has been replaced with the “ZebraScannerSDK.xcframework”. Please refer to Zebra TechDoc documentation for integration instructions. 3. Updated SCA to incorporate the XCFramework. Cut into Swift Zebra Scanner Control Application (SCA). Version 1.0.1
Version 1.4.41 ­ 04/2024
1. Updated Setting – Disabled Scanner SDK logs by default. 2. Added support for firmware update in iOS 17. 3. Initial release of the Swift version of the SCA. Version 1.0.0 ­ 4/2024. Note with
release of the Swift SCA, the outdated Objective C SCA has been obsoleted

ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 3

Version 1.4.39 ­ 10/2023
1. Added iOS 17 support. a. Scanner Firmware update in iOS 17 is temporarily not supported. This feature will be available in a future release. Note firmware update in older iOS versions like v16 and v15 function correctly.
2. Zebra only supports the last 3 iOS versions from Apple. iOS v14 and older are no longer supported.
Version 1.4.38 ­ 04/2023
1. Added ADF support for Barcode data. Now if an ADF rule is applied when connected to an iOS device, the ADF will be applied on output to the mobile device.
Version 1.4.37 ­ 01/2023
1. Added auto-reconnect to last paired scanner upon application launch. This is achieved through an API which enables/disables auto reconnecting.
Version 1.4.35 ­ 10/2022
1. Added iOS 16 support. Note iOS 11 and older versions no longer supported by Zebra’s SDK.
2. Bug fix ­ If 1st paired scanner disconnects/goes out of range and new 2nd scanner paired, the Scanner Control App (SCA) and iOS SDK now interact properly with 2nd scanner.
Version 1.4.33 ­ 07/2022
1. Added iOS 15 support. Note iOS 12 and older versions no longer supported by Zebra’s SDK.
Version 1.4.32 – 01/2022
1. Fixed Scan-To-Connect (STC) barcode issue on the Scanner Control App (SCA). STC barcode now, again defaults to the Bluetooth LE (BLE) comm protocol
Version 1.4.31 ­ 10/2021
1. Enhanced the Scanner Control App by adding a Scan-To-Connect (STC) barcode to the home screen.
2. Enhanced the Scanner Control App based on Apple’s API directive, we removed the “UIAlertView” API and replaced with Apple’s recommended “UIAlertControl”.
Version 1.4.30 ­ 08/2021
1. Enhanced the Scanner Control app by adding “Virtual Tether” host side feedback (beeper, LED, vibration) when scanner goes out of range.
2. Enhanced the Scanner Control app. For scanners connected to host manually (not using STC barcode) adding option to auto reconnect scanners.
3. Bug fix ­ Fixed a virtual tether alarm issue. Now upon reconnection of the scanner to the host, the virtual tether alarm stops.
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 4

Version 1.4.27 ­ 04/2021
1. Enhanced “Virtual Tether” support to include host feedback (vibrate, message popup, LED and beeper) in the iOS SDK and Scanner Control App.
2. Removed Bluetooth device friendly name support from the Scanner SDK and from the Scanner Control App (SCA).
3. Fixed MFi device reconnect issue after firmware update.
Version 1.4.19 ­ 10/2020
1. Added iOS 14 support. Note iOS 11 and older versions are no longer supported by Zebra’s SDK.
2. Simplified setup of STC (Scan-To-Connect) pairing process for cordless BTLE (Bluetooth Low Energy) scanner. Utility automatically generates unique pairing sequence. Users no longer must enter the Bluetooth MAC Address from host iOS device into app.
Version 1.4.15 ­ 07/2020
1. Added support for CS6080 Bluetooth scanner (Classic Bluetooth and BTLE). 2. Added support for manufacturer data format (kCBAdvDataManufacturerData).
Manuracturing data format was introduced by Apple with iOS v12.
Version 1.4.9 ­ 04/2020
1. Faster wireless firmware update for select scanners over the Bluetooth Classic communication protocol. See 123Scan’s release notes per scanner for product support details.
Version 1.4.8 ­ 01/2020
1. Firmware update improvements a. Loading firmware is skipped if firmware to be loaded is already present on the device. b. Enhanced firmware failure handling including new error messages
2. Performance improvement when initially discovering Zebra scanners. 3. Added support for CS6080 cordless Bluetooth scanner
Version 1.4.7 ­ 06/2019
1. Added iOS 13 support. Note iOS 10 and older versions no longer supported by Zebra’s SDK.
2. Added MFi certification to iOS SDK for DS8178.
Version 1.4.6 ­ 11/2018
1. Added iOS 12 support. Note iOS 9 and older versions no longer supported by Zebra’s SDK.
2. Bluetooth Low Energy (SSI LE) High Security feature support.
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 5

Version 1.4.5 ­ 06/2018
1. Enable AutoReconnect for MFi scanners.
Version 1.3 ­ 01/2018
1. Added iOS 11 support. Note iOS 8 and older versions no longer supported by Zebra’s SDK.
2. DS2278 and DS8178 support added. 3. CS4070 firmware update support.
Version 1.2 ­ 09/2016
1. SDK changes. a. Aim control supported. b. Page motor supported. c. Firmware update supported. d. STC supported for BTLE scanners.
Version 1.1 ­ 02/2016
1. Demo Application changes. a. Demo App name changed from “Zebra Scanner” to “Zebra Scanner Control”. b. Enhanced pairing and connection instructions. c. Miscellaneous user interface improvements. d. Release trigger button is disabled when connected to a CS4070 only. e. Button to permanently set Symbologies removed when connected to a CS4070 only. f. LED control button removed from Active scanner info section when connected to a RFD8500 only. g. Default communication mode set to MFi.
Version 1.0 ­ 10/2015
1. Initial SDK release.
Components
The SDK ZIP file contains the following components: · XCode project includes Scanner Control App code. · Zebra Scanner SDK for iOS package (.pkg).
Installation
Supported operating systems: · 15.x, 16.x and 17.x
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Page 6

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>