Honeywell 8680i Series User manual

User Guide
8680i
WiFi Software Development Kit

Disclaimer
Honeywell International Inc. (“HII”) reserves the right to make changes in specifications and other information contained in
this document without prior notice, and the reader should in all cases consult HII to determine whether any such changes
have been made. The information in this publication does not represent a commitment on the part of HII.
HII shall not be liable for technical or editorial errors or omissions contained herein; nor for incidental or consequential
damages resulting from the furnishing, performance, or use of this material. HII disclaims all responsibility for the selec-
tion and use of software and/or hardware to achieve intended results.
This document contains proprietary information that is protected by copyright. All rights are reserved. No part of this doc-
ument may be photocopied, reproduced, or translated into another language without the prior written consent of HII.
Copyright 2018 Honeywell International Inc. All rights reserved.
Web Address: www.honeywellaidc.com
For patent information, refer to www.hsmpats.com.
Microsoft® Windows®, Windows NT®, Windows 2000, Windows ME, Windows XP, and the Windows logo are trademarks or
registered trademarks of Microsoft Corporation.
The Bluetooth®word mark and logos are owned by Bluetooth SIG, Inc.
Android™ is a trademark of Google Inc.
Apple is a trademark of Apple Inc., registered in the U.S. and other countries.
Other product names or marks mentioned in this document may be trademarks or registered trademarks of other compa-
nies and are the property of their respective owners.

8680i WiFi SDK User Guide i
TABLE OF CONTENTS
Customer Support ........................................................................................................................ iii
Technical Assistance ............................................................................................................. iii
Product Service and Repair ................................................................................................ iii
Limited Warranty .................................................................................................................... iii
Chapter 1 - Get Started ....................................................................................1
About This Manual......................................................................................................................... 1
System Requirements .................................................................................................................. 1
Target Operating Systems.................................................................................................... 1
Use the SDK...................................................................................................................................... 1
C++ Programming.................................................................................................................... 2
C# Programming ..................................................................................................................... 2
Device Detection............................................................................................................................. 2
Chapter 2 - Definitions.....................................................................................3
ButtonPressFlag_WiFi ........................................................................................................... 3
ButtonPressNotify................................................................................................................... 3
DecodeResult_WiFi ................................................................................................................. 3
ELoggingLevel.......................................................................................................................... 4
FlashResult ................................................................................................................................ 4
LanguageOptions_WiFi......................................................................................................... 4
MenuCmdResponse............................................................................................................... 5
Return Value .............................................................................................................................. 5
ScannerInfo_WiFi..................................................................................................................... 5
ScannerStatus_WiFi................................................................................................................ 6

ii 8680i WiFi SDK User Guide
SymbPropResponse................................................................................................................6
TextColors_WiFi.........................................................................................................................6
TextColorType_WiFi .................................................................................................................7
TextFontSizes_WiFi..................................................................................................................7
TextLineType_WiFi ...................................................................................................................8
Chapter 3 - API...................................................................................................9
API List ................................................................................................................................................9
StartServer ...............................................................................................................................10
StopServer................................................................................................................................11
RegCallbacksWithWifi .........................................................................................................11
UnregResponseCallbackWifi............................................................................................12
SetSymbPropWithWifi.........................................................................................................12
GetSymbPropWithWifi ........................................................................................................13
CancelDecodeWifi.................................................................................................................14
DecodeAsyncWithWifi .........................................................................................................14
SetLogLevelWifi.....................................................................................................................14
SetDisplayTextWithWifi.......................................................................................................15
SetDisplayColorWithWifi....................................................................................................15
SetTextSizeWithWifi .............................................................................................................16
EnableNfyBtnPressWithWifi.............................................................................................17
EnableNfyBtnPressBarcodeWithWifi............................................................................17
SendMenuCmdWithWifi.....................................................................................................18
ShowStatusAlertWithWifi...................................................................................................18
GetGen7WifiSDKVersion....................................................................................................19
SetLanguageWithWifi .........................................................................................................19
GetClientAddress...................................................................................................................19
SetDisplayColorHexWithWifi............................................................................................20
SetFirmwareInfo ....................................................................................................................21
AddFlashingClient ................................................................................................................21
FlashFirmware........................................................................................................................21
OnFileTransfering .................................................................................................................22
OnFileFlashed ........................................................................................................................22

8680i WiFi SDK User Guide iii
Chapter 4 - Sample Code ...............................................................................25
Start/Stop Server .........................................................................................................................25
Start Server ..............................................................................................................................25
Stop Server...............................................................................................................................26
Connection/Disconnection .....................................................................................................27
Handle Connection Event ..................................................................................................27
Handle Disconnection Event ............................................................................................27
Configure Scanner.......................................................................................................................28
Pre-Defined Menu Command Parameters .................................................................28
Trigger a Scan................................................................................................................................28
Scan Asynchronously...........................................................................................................28
Cancel Scan .............................................................................................................................28
Send Menu Command ...............................................................................................................29
Configure Screen Layout ..........................................................................................................29
Set Language ..........................................................................................................................29
Set Display Text ......................................................................................................................29
Set Text Color...........................................................................................................................29
Set Text Size .............................................................................................................................30
Configure Text Properties for Up and Bottom Lines ...............................................30
Configure Text Properties for Single Line....................................................................30
Show Alert Popup.........................................................................................................................30
Get Version......................................................................................................................................31
Handle Button Press Event ......................................................................................................31
Flash Firmware .............................................................................................................................32

iv 8680i WiFi SDK User Guide

8680i WiFi SDK User Guide iii
Customer Support
Technical Assistance
To search our knowledge base for a solution or to log in to the Technical Support
portal and report a problem, go to www.hsmcontactsupport.com.
For our latest contact information, see www.honeywellaidc.com/locations.
Product Service and Repair
Honeywell International Inc. provides service for all of its products through service
centers throughout the world. To obtain warranty or non-warranty service, return
your product to Honeywell (postage paid) with a copy of the dated purchase
record. To learn more, go to www.honeywellaidc.com and select Service & Repair at
the bottom of the page.
Limited Warranty
For warranty information, go to www.honeywellaidc.com and click Get Resources >
Product Warranty.

iv 8680i WiFi SDK User Guide

CHAPTER
1
8680i WiFi SDK User Guide 1
GET STARTED
About This Manual
The 8680i WiFi Software Development Kit (SDK) provides a set of tools and sample
source code to help software developers create Windows® desktop applications for
the 8680i Wearable Mini-Mobile Computer using Bluetooth SPP protocol.
The following abbreviations are used in this guide:
• API Application Programming Interface
• SPP Serial Port Profile
System Requirements
.Net Framework 4.0 must be on the system.
Target Operating Systems
Microsoft® Windows® 7 and Windows 10, 32 and 64 bit.
Use the SDK
There are four folders inside the installation folder:
•include
•lib
•bin
•samples

28680i WiFi SDK User Guide
C++ Programming
• Add the header files HonScannerWifiAPI.h, HonScannerSettings.h and
HonScannerWifiStructs.h from the include folder into your application project.
• In the C++ desktop application, link the released lib file Gen7WiFiSDK.lib under
the lib folder. Gen7WiFiSDK.lib has different versions for 32bit and 64bit. Make
sure the right version is integrated into your application.
•TheGen7WiFiSDK.dll is in the bin folder and the sample projects are in the
samples folder.
C# Programming
•AddtheGen7WiFiSDKAssembly.dll from the bin folder into your desktop
application project.
Device Detection
Refer to the 8680i User Guide for information about connecting to a WiFi network.

CHAPTER
2
8680i WiFi SDK User Guide 3
DEFINITIONS
The following definitions are in the HonScannerWiFiStructs.h file.
ButtonPressFlag_WiFi
• Enumeration.
ButtonPressNotify
• Structure.
• Holds the button pressed notification.
DecodeResult_WiFi
• Structure.
Button Press Flag Enumerations
Value Description
NoButtonPressed_WiFi No button is pressed
LeftButtonPressed_WiFi Left button is pressed
RightButtonPressed_WiFi Right button is pressed
BothButtonsPressed_WiFi Left and right button are pressed
Button Press Notification Structure
Field Description
unsigned long connID The connection ID for the scanner
ButtonPressFlag_WiFi whichButtonPressed Enumeration. Indicates which button is pressed.

48680i WiFi SDK User Guide
• Holds the decoded bar code message.
ELoggingLevel
• Enumeration.
FlashResult
• Enumeration.
• Indicates the firmware flash results of the scanner.
LanguageOptions_WiFi
• Enumeration.
Decode Result Structure
Field Description
unsigned long connID The connection ID for the scanner
char chCodeID Honeywell Code ID
char chAimID AIM ID, the Symbology Identification
char chAimModifier AIM Modifier character
short nLength The length of the decode data
char chMessage[2048] The decode data buffer
Logging Level Enumerations
Value Description
ELL_NONE No log entries are generated, default value.
ELL_DATA Log the device communication data information
ELL_ERROR Log errors and all logs at ELL_DATA level.
ELL_INFO Log general information and all logs at
ELL_ERROR level
ELL_DEBUG Log all information
Flash Result Enumerations
Value Description
Success Flashed firmware successfully
ConnectFailed Can’t connect to the scanner
FileNotFound The specified firmware file is not found
FileRefusedByDevice The firmware file is refused by the scanner
FileTransferFailed Failed to transfer the firmware file to the scanner
FirmwareFlashFailed Failed to flash the firmware file for the scanner
FlashResponseTimeout The scanner doesn’t response in time

8680i WiFi SDK User Guide 5
• Indicates which language characters display on the scanner screen.
MenuCmdResponse
• Structure.
• Holds the response of menu command execution.
Return Value
•Enumeration.
• API function result codes.
ScannerInfo_WiFi
• Structure.
• Holds the scanner information.
Language Options Enumerations
Value Description
loEnglish_WiFi English
loCyrillic_WiFi Cyrillic
Menu Command Response Structure
Field Description
unsigned long connID The connection ID for the scanner
unsigned char response[512] The response of the menu command from the
scanner
unsigned long length The real length of the response
Return Values
Return Value Description
RESULT_ERR_NOT_INITIALIZE SDK was not initialized
RESULT_SUCCESS_WIFI Operation was successful
RESULT_ERR_SERVICE_NOT_STARTED The TCP socket service was not started
RESULT_ERR_SERVICE_ALREAY_STARTED The TCP socket service was already started
RESULT_ERR_PARAMETER_WIFI One of the function parameters was invalid
RESULT_ERR_UNSUPPORTED_WIFI The operation was not supported by the engine
RESULT_ERR_EXCEPTION_WIFI An exception was detected in the engine
Scanner Information Structure
Field Description
unsigned long connID The connection ID for the scanner

68680i WiFi SDK User Guide
ScannerStatus_WiFi
• Enumeration.
• Sets alert popup.
SymbPropResponse
• Structure.
• Holds the symbology property values.
TextColors_WiFi
• Enumeration.
char chName[128] The module name of the scanner
char chDesc[128] The description of the scanner
char chSerialNum[128] The serial number of the scanner
char chAppVersion[128] The application version of the scanner
char chAppDate[64] The application date of the scanner
char chAppTime[64] The application time of the scanner
char chBootVersion[128] The boot version of the scanner
char chBootDate[64] The boot date of the scanner
char chBootTime[64] The boot time of the scanner
Scanner Information Structure (continued)
Scanner Status Enumerations
Value Description
ssNormal_WiFi Don’t show any popup
ssBadScan_WiFi Show bad scan alert
ssGoodScan_WiFi Show good scan popup
Symbology Property Structure
Field Description
unsigned long connID The connection ID for the scanner
unsigned long propID The ID for the symbology property
unsigned long value The value for the specified symbology property
bool successful Indicates whether the operation is successful

8680i WiFi SDK User Guide 7
• Sets foreground or background text color.
TextColorType_WiFi
•Enumeration.
• Sets foreground or background color on the display.
TextFontSizes_WiFi
• Enumeration.
• Sets text font size.
Text Color Enumerations
Value Description
DefaultColor_WiFi Background color, default is black.
Foreground color, default is white.
Red_WiFi Red color
Green_WiFi Green color
Blue_WiFi Blue color
Text Color Type Enumerations
Value Description
BgColor_WiFi Background color
FgColorUpLine_WiFi Foreground color for up line
FgColorBottomLine_WiFi Foreground color for bottom line
Text Font Size Enumerations
Value Description
Small_WiFi Small size
Medium_WiFi Medium size, default value.
Large_WiFi Large size
ExtraLarge_WiFi Extra large size
SmallBold_WiFi Small and bold
MediumBold_WiFi Medium and bold
LargeBold_WiFi Large and bold
ExtraLargeBold_WiFi Extra large and bold
SingleLineSmall_WiFi Small size for single line, only works for the up
line
SingleLineMedium_WiFi Medium size for single line, only works for the up
line
SingleLineLarge_WiFi Large size for single line, only works for the up
line

88680i WiFi SDK User Guide
TextLineType_WiFi
• Enumeration.
• Sets on which line text should be set on the display.
Text Line Type Enumerations
Value Description
UpLine_WiFi Up line
BottomLine_WiFi Bottom line

CHAPTER
3
8680i WiFi SDK User Guide 9
API
API List
Windows Native C/C++ APIs are listed below. They have the same return value as
defined in Return Value (page 5). Additional information about APIs is available in
the HonScannerWiFiAPI.h file.
C/C++ API List
API Description
StartServer Starts the TCP socket server for incoming
scanner connections.
StopServer Stops the TCP socket server and releases the
connections.
RegCallbacksWithWifi Register the Callbacks in the SDK. SDK forwards
the events to them.
UnregResponseCallbackWifi Stop receiving events from the SDK layer.
SetSymbPropWithWifi Set the symbology settings of the scanner.
GetSymbPropWithWifi Get the symbology settings from the scanner.
CancelDecodeWifi Cancel decode action in process.
DecodeAsyncWithWifi Trigger an asynchronous scan and don’t wait for
the result.
SetLogLevelWifi Set the log level for outputting the specified log
information.
SetDisplayTextWithWifi Set the text content to display on the scanner
screen through sending a menu command
asynchronously.
SetDisplayColorWithWifi Set the background or foreground color of the
text on the scanner screen through sending a
menu command asynchronously.
SetTextSizeWithWifi Set the text font size of the text on the scanner
screen through sending a menu command
asynchronously.
EnableNfyBtnPressWithWifi Make the scanner send a notification to the host
when one or more scanner buttons are pressed.

10 8680i WiFi SDK User Guide
The following commands are only for C# version assembly.
StartServer
Starts the TCP socket server for incoming scanner connections.
Parameters
wchar_t* lpszBindAddress
The server IP address.
unsigned long usPort
The server port number.
Return Value
RESULT_SUCCESS_WIFI if the TCP socket server is successfully started.
EnableNfyBtnPressBarcodeWithWifi Make the scanner send a notification to the host
when one or more scanner buttons are pressed
and bar code data is sent.
SendMenuCmdWithWifi Send the raw menu command to the scanner
asynchronously.
ShowStatusAlertWithWifi Show the status screen image on the scanner by
sending a menu command asynchronously.
GetGen7WifiSDKVersion Get the current version of the SDK.
SetLanguageWithWifi Set which language characters are displayed on
the scanner.
GetClientAddress Get the IP address and port of the socket of the
connected scanner.
SetDisplayColorHexWithWifi Set the background or foreground color of the
text on the scanner screen with RGB hex code
through sending a menu command
asynchronously.
C# API List
API Description
SetFirmwareInfo Set the full file path and version of the firmware.
AddFlashingClient Add the scanner to be flashed.
FlashFirmware Flash the firmware file to scanners.
OnFileTransfering This delegate function is invoked when sending
a firmware file to the scanner.
OnFileFlashed This delegate function is invoked when the flash
is complete or an exception occurs.
C/C++ API List (continued)

8680i WiFi SDK User Guide 11
RESULT_ERR_PARAMETER_WIFI if the lpszBindAddress is null or usPort is out of
range (1 - 65535).
RESULT_ERR_SERVICE_ALREDAY_STARTED if the TCP server has already started.
RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized.
RESULT_ERR_EXCEPTION_WIFI if the server is not successfully started.
StopServer
Stops the TCP socket server and releases the connections.
Note: This API waits until all jobs are done then returns. It must be called in a thread
because this may take some time and can block the main thread.
Parameters
N.A.
Return Value
RESULT_SUCCESS_WIFI if the TCP server is closed successfully.
RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started.
RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized.
RESULT_ERR_EXCEPTION_WIFI if the server is not successfully stopped.
RegCallbacksWithWifi
This API allows the application to register a callback to receive the events from the
SDK such as bar code responses, disconnect events, button press events, and
other responses from the scanner.
Parameters
OnConnectCallback connCb
The function pointer that receives the connect events from the SDK layer.
typedef void (*OnConnectCallback)(const ScannerInfo_WiFi
&info);
OnDisconnectCallback disconnCb
The function pointer that receives disconnect events from the SDK layer.
typedef void (*OnDisconnectCallback)(const CLIENT_CONNID
connID);
OnDecodeCallback decCb

12 8680i WiFi SDK User Guide
The function pointer that receives scan bar code events from the SDK layer.
typedef void (*OnDecodeCallback)(const DecodeResult_WiFi
&decRes);
OnPressButtonCallback pressBtnCb
The function pointer that receives button press events from the SDK layer.
typedef void (*OnPressButtonCallback)(const ButtonPressNotify
&notify);
OnGetSymbPropCallback symbPropCb
The function pointer that receives get/set symbology property events from the SDK
layer.
typedef void (*OnGetSymbPropCallback)(const SymbPropResponse
&resp);
OnSendMenuCmdCallback menuCmdCb
The function pointer that receives the menu command responses from the SDK
layer.
typedef void (*OnSendMenuCmdCallback)(const MenuCmdResponse
&resp);
Return Value
RESULT_SUCCESS_WIFI if successfully registered.
RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized.
UnregResponseCallbackWifi
This is used to stop receiving events from the SDK layer.
Parameters
N.A.
Return Value
RESULT_SUCCESS_WIFI if successfully unregistered.
RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized.
SetSymbPropWithWifi
Set the symbol code property in the scanner by sending an asynchronous menu
command.