Download Print this page

Honeywell 8680i User Manual

Wearable mini mobile computer
Hide thumbs

Advertisement

Quick Links

8680i
WiFi Software Development Kit
User Guide

Advertisement

loading

  Related Manuals for Honeywell 8680i

  Summary of Contents for Honeywell 8680i

  • Page 1 8680i WiFi Software Development Kit User Guide...
  • Page 2 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.
  • Page 3: Table Of Contents

    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 8680i WiFi SDK User Guide...
  • Page 4 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...
  • Page 5 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 8680i WiFi SDK User Guide...
  • Page 6 8680i WiFi SDK User Guide...
  • Page 7: Customer Support

    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...
  • Page 8 8680i WiFi SDK User Guide...
  • Page 9: Chapter 1 - Get Started

    CHAPTER 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.
  • Page 10: C++ Programming

    The Gen7WiFiSDK.dll is in the bin folder and the sample projects are in the samples folder. C# Programming • Add the Gen7WiFiSDKAssembly.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. 8680i WiFi SDK User Guide...
  • Page 11: Buttonpressnotify

    ButtonPressNotify • Structure. • Holds the button pressed notification. Button Press Notification Structure Field Description The connection ID for the scanner unsigned long connID Enumeration. Indicates which button is pressed. ButtonPressFlag_WiFi whichButtonPressed DecodeResult_WiFi • Structure. 8680i WiFi SDK User Guide...
  • Page 12: Elogginglevel

    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 LanguageOptions_WiFi • Enumeration. 8680i WiFi SDK User Guide...
  • Page 13: Menucmdresponse

    The operation was not supported by the engine RESULT_ERR_EXCEPTION_WIFI An exception was detected in the engine ScannerInfo_WiFi • Structure. • Holds the scanner information. Scanner Information Structure Field Description The connection ID for the scanner unsigned long connID 8680i WiFi SDK User Guide...
  • Page 14: Symbpropresponse

    The connection ID for the scanner unsigned long connID The ID for the symbology property unsigned long propID The value for the specified symbology property unsigned long value Indicates whether the operation is successful bool successful TextColors_WiFi • Enumeration. 8680i WiFi SDK User Guide...
  • Page 15: Textcolortype_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 8680i WiFi SDK User Guide...
  • Page 16: Textlinetype_Wifi

    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 8680i WiFi SDK User Guide...
  • Page 17: Chapter 3 - Api

    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. 8680i WiFi SDK User Guide...
  • Page 18: Enablenfybtnpressbarcodewithwifi

    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. 8680i WiFi SDK User Guide...
  • Page 19: Start/Stop Server

    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 8680i WiFi SDK User Guide...
  • Page 20 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. 8680i WiFi SDK User Guide...
  • Page 21 RESULT_SUCCESS_WIFI if the property is successfully retrieved. RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized. RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started. RESULT_ERR_PARAMETER_WIFI if the connID or symbolCodeID are not correct. RESULT_ERR_EXCEPTION_WIFI if the menu command fails. 8680i WiFi SDK User Guide...
  • Page 22 RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started. RESULT_ERR_PARAMETER_WIFI if the connID is not correct. RESULT_ERR_EXCEPTION_WIFI if the menu command for scanning fails. SetLogLevelWifi Set the log level for the specified log entries output. Parameters EloggingLevel 8680i WiFi SDK User Guide...
  • Page 23 RESULT_ERR_EXCEPTION_WIFI if the menu command for setting display text fails. SetDisplayColorWithWifi Set the background or foreground color of the text on the scanner screen by send- ing an asynchronous menu command. Parameters unsigned long connID The connection ID for the scanner. 8680i WiFi SDK User Guide...
  • Page 24 RESULT_SUCCESS_WIFI if the menu command for setting font size is successfully sent. RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized. RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started. RESULT_ERR_PARAMETER_WIFI if the connID is not correct. RESULT_ERR_EXCEPTION_WIFI if the menu command for setting font size fails. 8680i WiFi SDK User Guide...
  • Page 25 Return Value RESULT_SUCCESS_WIFI if the command for enabling notifications is successfully sent. RESULT_ERR_NOT_INITIALIZE if the SDK is not successfully initialized. RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started. RESULT_ERR_PARAMETER_WIFI if the connID is not correct. 8680i WiFi SDK User Guide...
  • Page 26 Show the status image on the scanner screen by an asynchronous menu com- mand. Parameters unsigned long connID The connection ID for the scanner. ScannerStatus_WiFi status The scanner status, such as good scan or bad scan. See ScannerStatus_WiFi. 8680i WiFi SDK User Guide...
  • Page 27 RESULT_ERR_SERVICE_NOT_STARTED if the TCP server is not started. RESULT_ERR_PARAMETER_WIFI if the connID is not correct. RESULT_ERR_EXCEPTION_WIFI if the menu command fails. GetClientAddress Get the IP address and port of the socket of the connected scanner. 8680i WiFi SDK User Guide...
  • Page 28 The connection ID for the scanner. TextColorType_WiFi colorType Enumerations: BgColor_WiFi, FgColorUpLine_WiFi, FgColorBottomLine_WiFi. See TextColorType_WiFi for more details. const char* hexColor The RGB hex code string. Return Value RESULT_SUCCESS_WIFI if the menu command for setting text color is success- fully sent. 8680i WiFi SDK User Guide...
  • Page 29 Note: This API is only for C# version assembly. Add the scanner to be flashed. Parameters uint connID The connection ID for the scanner. Return Value N.A. FlashFirmware Note: This API is only for C# version assembly. 8680i WiFi SDK User Guide...
  • Page 30 N.A. OnFileFlashed Note: This API is only for C# version assembly. This delegate function is invoked when the flash is complete or an exception occurs. public delegate void OnFileFlashed(ulong connID, FlashResult res); Parameters uint connID 8680i WiFi SDK User Guide...
  • Page 31 The connection ID for the scanner. FlashResult res The result of flashing. See FlashResult for more details. Return Value N.A. 8680i WiFi SDK User Guide...
  • Page 32 8680i WiFi SDK User Guide...
  • Page 33: Start Server

    // Logging doesn’t rely on the Server, so we can initialize the level at the beginning. SetLogLevelWifi(ELL_DEBUG); Result_t res = StartServer(strIP, lPort); If (res == RESULT_SUCCESS) // Register the callback functions for receiving the events. RegCallbacksWithWifi(OnConnect, OnDisconnect, OnDecode, OnPressButton, OnGetSymbProp, OnSendMenuCmd); 8680i WiFi SDK User Guide...
  • Page 34: Stop Server

    != nullptr) m_pStopSrvCb(); stopEvent.unsingal(); // The main thread of the application to stop server. CStopServerThread m_stopSrvThread; void CApp::StopServer() m_stopSrvThread.setStopServerCallback(OnStopServer); m_stopSrvThread.stopServer(); // Stop the server in another thread. // Stop server callback for the thread void OnStopServer() 8680i WiFi SDK User Guide...
  • Page 35: Connection/Disconnection

    // Remove the scanner information when it disconnects to the server in the // callback function void OnDisconnect(const unsigned long connID) for(ScannerIT it = m_vcScanners.begin(); it != m_vcScanners.end(); ++it) if((*it)->connID == scannerID) = m_vcScanners.erase(it); break; 8680i WiFi SDK User Guide...
  • Page 36: Configure Scanner

    OnGetSymbProp(const SymbPropResponse &resp) if(resp.successful) OutputSymbProp(resp); Trigger a Scan Scan Asynchronously DecodeAsyncWithWifi(connID); // Send scan command // Retrieve the scan result in the callback function void OnDecode(const DecodeResult_WiFi &decRes) OutputDecodeResult(decRes); Cancel Scan CancelDecodeWifi(connID); // Cancel scan 8680i WiFi SDK User Guide...
  • Page 37: Set Language

    // Show the foreground color of the up line in Green SetDisplayColorWithWifi(connID, FgColorUpLine_WiFi, Green_WiFi); // Show the background color in yellow SetDisplayColorHexWithWifi(connID, BgColor_WiFi, “ffff00”); // Show the foreground color of the up line in brown SetDisplayColorHexWithWifi(connID, FgColorUpLine_WiFi, “800000”); 8680i WiFi SDK User Guide...
  • Page 38: Set Text Size

    // Notes: When using SingleLineSmall_WiFi, SingleLineMedium_WiFi, // SingleLineLarge_WiFi for font sizes, the SetDisplayTextWithWifi should pass // UpLine_WiFi for displaying content. SetDisplayColorWithWifi(connID, BgColor_WiFi, Red_WiFi); SetDisplayColorWithWifi(connID, FgColorUpLine_WiFi, Green_WiFi); SetTextSizeWithWifi(connID, UpLine_WiFi, SingleLineLarge_WiFi); SetDisplayTextWithWifi(connID, UpLine_WiFi, “Welcome”); Show Alert Popup ShowStatusAlertWithWifi(connID, ssGoodScan_WiFi); 8680i WiFi SDK User Guide...
  • Page 39: Get Version

    // Handle the button press event in the callback function void OnPressButton(const ButtonPressNotify &notify) switch(notify.whichButtonPressed) case LeftButtonPressed_WiFi: // Do something when left button is pressed break; case RightButtonPressed_WiFi: // Do something when right button is pressed break; 8680i WiFi SDK User Guide...
  • Page 40: Flash Firmware

    // Flash firmware to the selected scanners private void btnFlashFW_Click(object sender, EventArgs e) List<uint> ids = GetSelectedScannerIDs(); if(ids.count == 0) return; apiWrapper.SetFirmwareInfo(tbFwPath.Text, tbFwVersion.Text); foreach (uint id in ids) Log(string.Format("Start to flash firmware, connecting to Scanner [{0}] ...", id)); apiWrapper.AddFlashingClient(id); 8680i WiFi SDK User Guide...
  • Page 41 (Exception ex) Log(string.Format("Exception: {0}", ex.Message)); 8680i WiFi SDK User Guide...
  • Page 42 8680i WiFi SDK User Guide...
  • Page 44 Honeywell Scanning & Mobility 9680 Old Bailes Road Fort Mill, SC 29707 www.honeywellaidc.com 8680WiFiSDK-EN-UG Rev A 7/18...