1. Manuals
  2. Brands
  3. Hand Held Products Manuals
  4. Software
  5. 5080
  6. User manual

Hand Held Products 5080 User Manual

Decoded miniature image scan engines software development kit (sdk)
Hide thumbs Also See for 5080:
Table of Contents

Advertisement

Quick Links

User's Guide
Software Development Kit (SDK)
for 5080, 5180, and 5380
Decoded Miniature Image Scan Engines

Advertisement

Table of Contents
loading

Related Manuals for Hand Held Products 5080

Summary of Contents for Hand Held Products 5080

  • Page 1 User’s Guide Software Development Kit (SDK) for 5080, 5180, and 5380 Decoded Miniature Image Scan Engines...
  • Page 2 Hand Held Products. Hand Held Products 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.

  • Page 3: Table Of Contents

    Table of Contents Chapter 1 - Introduction Features of the 5X80 SDK ... 1-1 Target Operating Systems for the 5X80 SDK... 1-1 Interface Diagram... 1-2 5X80 SDK Library Files ... 1-2 5X80 SDK API Library Summary... 1-3 Data Types, Structures, and Enumerated Types ... 1-5 Chapter 2 - API Function Descriptions hhpAcquireImage ...
  • Page 4 Chapter 3 - Enumerated Types and Definitions Error Codes ...3-1 Setup Type Enumerated Type...3-2 Symbology ID Enumeration ...3-2 Supported OCR Fonts ...3-3 Image Formats...3-3 Compression Mode Formats ...3-4 Capture Illumination Duty Cycle ...3-4 Auto Exposure Type ...3-4 Gain Values Enum ...3-4 Frame Rates Enum ...3-4 Beeper Volume Enum ...3-5 Decoder Mode Enum ...3-5...
  • Page 5 Chapter 6 - Program Samples Configuration Management ...6-1 Barcode Capture ...6-2 Image Capture...6-5 Chapter 7 - Customer Support Technical Assistance ...7-1 Online Technical Assistance ...7-1 5X80 Series Software Development Kit (SDK) User’s Guide...
  • Page 6 5X80 Series Software Development Kit (SDK) User’s Guide...

  • Page 7: Chapter 1 - Introduction

    • A single API is used for all Hand Held Products decoding engines. The libraries for all engines are identical for a given host platform. There are different libraries for each platform, but the API interface is the same for all of them, so you only need to learn a single API.

  • Page 8: Interface Diagram

    Interface Diagram The following diagram shows the interface between the 5X80 SDK and the Image Engine: SDK Driver Interface Layer - hhpImgrSdk.dll SDK API Interface Layer - commDrv.dll SDK API Interface Layer - commDrv.dll 5X80 SDK Library Files The SDK API and SDK communications layers are provided in the dynamic link libraries, hhpImgrSdk.dll and commDrv.dll, respectively.

  • Page 9: 5X80 Sdk Api Library Summary

    5X80 SDK API Library Summary The following is a summary of the API functions. The full description of each function is found on the page noted. Core Functions Core Function Error Management Function hhpGetErrorMessage Connection Functions These functions open, close, and verify a connection to an imager. hhpConnect hhpDisconnect hhpEngineConnected...

  • Page 10: Barcode Capture

    Core Functions (Continued) Core Function hhpReadImagerCapabilities hhpReadEngineInfo hhpSetConfigItemToDefaults hhpWriteConfigItem hhpWriteConfigStream Symbology Configuration Functions These functions allow you to read and set the symbology configurations. hhpEnableDisableSymbology hhpReadSymbologyConfig hhpReadSymbologyRangeMaxMin hhpSetSymbologyDefaults hhpWriteSymbologyConfig Barcode Capture Functions The 5X80 SDK captures barcodes from imagers that have hardware triggers or some other non-SDK initiated barcode captures without having to poll the imager to see if there is any data to read.

  • Page 11: Data Types, Structures, And Enumerated Types

    Core Functions (Continued) Core Function hhpGetLastImage Intelligent Imaging (Signature Capture) Functions Intelligent imaging is barcode capture combined with an image window capture. The image window is cut from the same image used to capture a barcode. This is how the SDK provides the ability to capture a signature associated with a barcode. In fact, a successful barcode capture is required before the intelligent image window is sent by the imager.
  • Page 12 Windows Data Types (Continued) SDK Enumerated Types Beep Options Enumeration (not an enumerated type) that can be used with an hhpSendActionCommand. Enumerated type for specifying the form of compression (if any) to use when transferring an Compression_t image from the imager to the SDK. See Enumerated type to specify that the configuration structure is being sent to the Read/Write ConfigItems_t config item functions.

  • Page 13: Image Capture

    SDK Structure Types A full description of the SDK structure types can be found in Important: Make sure to set the structure members dwStructSize and dwMask. Individual Symbology Structures All symbologies, except OCR, use either SymFlagsOnly_t or SymFlagsRange_t for configuration. There is a define for each symbology (except OCR) that points to one of these two structures.
  • Page 14 1 - 8 5X80 Series Software Development Kit (SDK) User’s Guide...

  • Page 15: Chapter 2 - Api Function Descriptions

    API Function Descriptions The following is an alphabetic listing of each API function with its complete description and a prototype for each function. All API functions (with the exception of hhpEngineConnected 3-1 for the result code values. hhpAcquireImage This function causes the imager to capture an image and transfer it to the host. Values to be used from the structures are specified by setting the appropriate bit mask for each item in the structure’s mask member.

  • Page 16: Hhpcancelio

    Note: Since the HHP_INTEL_IMG structure requires that image offsets and size be specified in barcode units, the HHP_INTEL_IMG structure has a size member that allows you to specify (in pixels) the maximum allowable width and height for the returned image. hhpAcquireIntelligentImage ( Syntax PHHP_INTEL_IMG...

  • Page 17: Hhpcapturerawbarcode

    hhpCaptureRawBarcode This function causes the imager to capture images and attempt to decode them. Decoded data returned is unmodified 8 bit ASCII data. Barcode capture can be synchronous or asynchronous. Synchronous capture is specified by setting the bWait parameter hhpCaptureRawBarcode to TRUE. In this case, the function will not return until a barcode is read, an error occurs, or the decode timeout is reached.

  • Page 18: Hhpdisconnect

    hhpDisconnect Closes the communications port and stops the read data thread. Syntax hhpDisconnect( void hhpEnableDisableSymbology Enables/disables an individual symbology or all symbologies. hhpEnableDisableSymbology ( Syntax int nSymId, BOOL Parameter Description nSymId One of the symbology enumerated types, e.g., SYM_CODE39, SYM_OCR, or SYM_ALL to enable/ disable all symbologies.

  • Page 19: Hhpgeterrormessage

    hhpGetErrorMessage This function returns a text message describing the meaning of a Result_t error code. See descriptions. hhpGetErrorMessage ( Syntax Result_t PTCHAR int nMaxChars Parameter Description nErrorCode Error code returned from one of the other 5X80 SDK functions. ptcErrMsg TCHAR buffer to hold error message string. nMaxChars Maximum number of characters that can fit in ptcErrorMsg including NULL.

  • Page 20: Hhprawacquireintelligentimage

    hhpRawAcquireIntelligentImage Captures a portion of the image in which a barcode is decoded. The position of the image is specified relative to the center of the barcode. This function differs from (untranslated) byte data array. Note: Since the HHP_INTEL_IMG structure requires that image offsets and size be specified in barcode units, the HHP_INTEL_IMG structure has a size member that allows you to specify (in pixels) the maximum allowable width and height for the returned image.

  • Page 21: Hhpreadconfigstream

    SERIAL_PORT_CONFIG If using a serial connection imager, this returns the serial port setup IMAGE_ACQUISITION IMAGE_TRANSFER SEQUENCE_CONFIG ALL_CONFIG pStruct Pointer to the appropriate structure based on parameter “item:” HHP_BEEPER HHP_TRIGGER HHP_DECODER_CONFIG HHP_POWER_SETTINGS HHP_VERSION_INFO HHP_SYM_CONFIG HHP_SERIAL_PORT_CONFIG HHP_IMAGE_ACQUISITION HHP_IMAGE_TRANSFER HHP_SEQUENCE HHP_CONFIG hhpReadConfigStream Reads the full imager configuration as a single stream of data into a buffer. The buffer contains all the configuration items in an ASCII stream so that it can be written to a disk for storage.

  • Page 22: Hhpreadsymbologyconfig

    Note: As with all other HHP structures, the dwStructSize member of the structure must be set before calling this function. (Set to sizeof (HHP_IMAGER_CAPS).) hhpReadImagerCapabilities ( Syntax HHP_IMAGER_CAPS Parameter Description pImgrCaps Pointer to the HHP_IMAGER_CAPS structure. hhpReadSymbologyConfig Reads configuration items for a single symbology or for all symbologies. Individual items to be read are specified by adding the appropriate mask bit (OR it) to the mask member of the structure to which it belongs.

  • Page 23: Hhpsendactioncommand

    hhpSendActionCommand This command allows the application to modify some of the imager hardware states. The items that can be modified include turning the illumination LEDs on/off, turning the aimer LEDs on/off, or causing the device’s beeper to beep/double beep. hhpSendActionCommand ( Syntax HHP_ACTION actionCmd, int nVal )

  • Page 24: Hhpsetasyncmethods

    hhpSetAsyncMethods hhpSetAsyncMethods sets the methods by which the caller wishes to be notified upon receipt of a barcode or image. hhpSetAsyncMethods ( Syntax HANDLE HWND HHP_EVENT_CALLBACK Parameter Description hEventHandle Handle to a Windows Event. The event should specify manual reset. hWndHandle Handle to the application window that should receive the SDK defined message WM_HHP_EVENT_HWND_MSG.

  • Page 25: Hhpsethardwarelinedllfilename

    hhpSetHardwareLineDllFileName The SDK API provides the ability to provide OEM device-dependent extensions to support the imager hardware sleep lines, and hardware trigger and/or special COM port driver configuration/initialization. The definitions and function prototype are located in the header file OemDll.h. Also see OEM-Configurable SDK Functionality hhpSetHardwareLineDllFileName ( Syntax...

  • Page 26: Hhpwriteconfigitem

    hTransferNotifyHwnd Handle to the window that is to receive the transfer update messages. The message is sent when the percentage changes by more than 1%. The window associated with the handle should hook the WM_HHP_PROGRESS_HWND_MSG message. After file transfer is complete and while the imager is storing the new code in flash, the message WM_HHP_IMAGER_FLASHING is sent to the window HWND (if valid).

  • Page 27: Hhpwriteconfigstream

    HHP_IMAGE_ACQUISITION HHP_IMAGE_TRANSFER HHP_SEQUENCE HHP_CONFIG hhpWriteConfigStream Writes an entire data stream of programmable parameters to the device. hhpWriteConfigStream ( Syntax PBYTE int nLen Parameter Description puchCfgStream Buffer to hold the raw imager configuration stream. nMaxLen Maximum number of bytes that fit in buffer puchCfgStream. hhpWriteSymbologyConfig Writes configuration items for a single symbology or for all symbologies.
  • Page 28 Symbology Code 32 Pharmaceutical (PARAF) Code 39 Code 49 Code 4CB (4 State Customer Barcode) Code 93 Data Matrix EAN-8 EAN-13 EAN•UCC Composite Interleaved 2 of 5 ISBT 128 Japanese Post KIX (Netherlands) Post Korea Post Matrix 2 of 5 MaxiCode MicroPDF417 PDF417...

  • Page 29: Error Codes

    Enumerated Types and Definitions Error Codes RESULT_INTIALIZE = -1 RESULT_SUCCESS = 0 RESULT_EOT = 256 RESULT_ERR_BADFILENAME RESULT_ERR_BADINTELIMAGE RESULT_ERR_BADPORT RESULT_ERR_BADREGION RESULT_ERR_BADSMARTIMAGE RESULT_ERR_BAUD_TOO_HIGH RESULT_ERR_BUFFER_TOO_SMALL RESULT_ERR_CAPTURE_IMAGE_FAILED RESULT_ERR_COMPRESSION_FAILED RESULT_ERR_CONNECT_BOOT_CODE RESULT_ERR_DECOMPRESSION_FAILED RESULT_ERR_DLL_FILE RESULT_ERR_DRIVER RESULT_ERR_ENGINEBUSY RESULT_ERR_FILE RESULT_ERR_FILEINCOMPATIBLE RESULT_ERR_FILEINVALID RESULT_ERR_INTERNAL_ERROR RESULT_ERR_INVALID_COMM_PARAMS RESULT_ERR_MEMORY RESULT_ERR_MENUDECODE RESULT_ERR_NAK RESULT_ERR_NODECODE RESULT_ERR_NODRIVER RESULT_ERR_NOIMAGE RESULT_ERR_NOINTELBARCODE RESULT_ERR_NOINTELIMAGE RESULT_ERR_NORESPONSE...

  • Page 30: Setup Type Enumerated Type

    Error Codes (Continued) RESULT_ERR_SHIP_IMAGE_FAILED RESULT_ERR_SMARTIMAGETOOLARGE RESULT_ERR_SYMBOLOGY_HAS_NO_RANGE RESULT_ERR_UNICODE_UNSUPPORTED RESULT_ERR_UNSUPPORTED RESULT_ERR_UPGRADE RESULT_ERR_USER_CANCEL RESULT_ERR_WRONGRESULTSTRUCT Setup Type Enumerated Type SETUP_TYPE_CURRENT, SETUP_TYPE_DEFAULT = 0, Symbology ID Enumeration Total number of supported NUM_SYMBOLOGIES symbologies SYM_ALL=100 All active symbologies SYM_AUSPOST, Australian Post SYM_AZTEC = 0, Aztec Code SYM_BPO, British Post SYM_CANPOST,...

  • Page 31: Supported Ocr Fonts

    Symbology ID Enumeration (Continued) SYM_INT25, Interleaved 2 of 5 SYM_ISBT, ISBT SYM_JAPOST, Japanese Post SYM_KORPOST Korean Post SYM_MATRIX25, Matrix 2 of 5 SYM_MAXICODE, MaxiCode SYM_MESA, Aztec Mesas SYM_MICROPDF, MicroPDF417 SYM_MSI, MSI Code OCR (OCR-A, OCR-B, OCR US SYM_OCR, Money Font, MICR) SYM_PDF417, PDF417 SYM_PLANET,...

  • Page 32: Compression Mode Formats

    Image Formats (Continued) FF_TIFF_GRAY, FF_JPEG_GRAY, FF_BMP_GRAY Compression Mode Formats COMPRESSION_NONE=0, COMPRESSION_LOSSLESS, COMPRESSION_LOSSY Capture Illumination Duty Cycle HHP_DUTY_CYCLE_OFF =0, HHP_DUTY_CYCLE_ON #define HHP_CAPTURE_ALWAYS_OFF #define HHP_CAPTURE_ALWAYS_ON Auto Exposure Type HHP_AUTOEXPOSURE_BARCODE=0, HHP_AUTOEXPOSURE_PHOTO, HHP_AUTOEXPOSURE_MANUAL #define HHP_AUTOEXPOSURE_NONE #define HHP_AUTOEXPOSURE_FIXED Gain Values Enum Only used when in manual capture mode. HHP_GAIN_1x=1, HHP_GAIN_2x, HHP_GAIN_4x=4,...

  • Page 33: Beeper Volume Enum

    HHP_30_FRAMES_PER_SEC=30 Beeper Volume Enum BEEP_OFF=0, BEEP_LOW=1, BEEP_MEDIUM=2, BEEP_HIGH=3 Decoder Mode Enum DECODE_METHOD_STANDARD=0, DECODE_METHOD_QUICK_OMNI DECODE_METHOD_NONOMNI_ALD DECODE_METHOD_OMNI_LINEAR System (MPU) Clock Speeds Note: CPU clock speed must always be greater than system clock speed. POWER_SYS_SPEED_96MHZ=0, POWER_SYS_SPEED_48MHZ, POWER_SYS_SPEED_32MHZ Configuration Structure Item Enum for hhpReadConfigItem() and hhpWriteConfigItem() BEEPER_CONFIG=0, TRIGGER_CONFIG, DECODER_CONFIG,...

  • Page 34: Sequence Mode

    Trigger Modes Enum (Continued) HHP_MANUAL_LOW_POWER, HHP_PRESENTATION, HHP_SCANSTAND, HHP_HOST_NOTIFY HHP_SNAP_AND_SHIP Sequence Mode HHP_SEQ_DISABLED = 0, HHP_SEQ_ENABLED, HHP_SEQ_REQUIRED Serial Port Baud Rates SERIAL_BAUD_300 = 300, SERIAL_BAUD_600 = 600, SERIAL_BAUD_1200 = 1200, SERIAL_BAUD_2400 = 2400, SERIAL_BAUD_4800 = 4800, SERIAL_BAUD_9600 = 9600, SERIAL_BAUD_19200 = 19200, SERIAL_BAUD_38400 = 38400, SERIAL_BAUD_57600 = 57600, SERIAL_BAUD_115200 = 115200,...

  • Page 35: Serial Data Bits

    Serial Data Bits SERIAL_DATA_BITS_7 = 7, SERIAL_DATA_BITS_8 Parity SERIAL_PARITY_NONE = ‘N’, SERIAL_PARITY_ODD = ‘O’, SERIAL_PARITY_EVEN = ‘E’, SERIAL_PARITY_MARK = ‘M’, SERIAL_PARITY_SPACE = ‘S’ Stop Bits SERIAL_ONE_STOPBITS = 1, SERIAL_TWO_STOPBITS, Connection Types Currently limited to serial ports. HHP_COM1=0, HHP_COM2, HHP_COM3, HHP_COM4, HHP_COM5, HHP_COM6, HHP_COM7,...

  • Page 36: Decoder Symbology Support

    USB serial 5080 VGA imager with internal decoder. Serial (RS-232) 5080 VGA imager with internal decoder and PSOC. USB serial 5080 VGA imager with internal decoder and PSOC. Serial (RS-232) 5080 imager with internal decoder. USB serial 5080 imager with internal decoder.

  • Page 37: Symbology Structures And Defines

    Structures and Mask Definitions Important: All structures have a dwStructSize member that MUST BE SET before calling any of the 5X80 SDK API functions. This insures that the proper structure has been passed to the function being called. Most structures have a dwMask member. This specifies which structure members are active (to be read or written). Select structure items by ORing the individual structure masks for each of the items you wish to be active together.
  • Page 38 #define SYMBOLOGY_POSICODE_LIMITED_2 #define SYMBOLOGY_CODABAR_CONCATENATE Flags for OCR are reused, since none of the other flags apply to OCR. #define SYMBOLOGY_ENABLE_OCR_A #define SYMBOLOGY_ENABLE_OCR_B #define SYMBOLOGY_ENABLE_OCR_MONEY #define SYMBOLOGY_ENABLE_OCR_MICR Symbology structure sets masks to specify which items of config structure are to be set or read. #define SYM_MASK_FLAGS #define SYM_MASK_MIN_LEN #define SYM_MASK_MAX_LEN...
  • Page 39 Min/Max barcode lengths for symbologies that have length settings: Code Aztec China Post Codabar Codablock F Code 11 Code 16K Code 128 Code 2 of 5 Code 39 Code 49 Code 93 DataMatrix EAN•UCC Composite IATA Code 2 of 5 Interleaved 2 of 5 Korean Post Matrix 2 of 5...
  • Page 40 TCHAR tcGroupH[ MAX_GROUP_G_LEN ]; TCHAR tcCheckChar[ MAX_CHECK_CHAR_LEN ]; Check character string. } SymCodeOCR_t, *PSymCodeOCR_t; Structure of all Symbology Structures There is one structure for each symbology. This info is stored in imager config. Define aliases for each symbology structure: #define AZTEC_T #define MESA_T #define CODABAR_T #define CODE11_T...
  • Page 41 typedef struct _tagSymCfg DWORD dwStructSize; Set to sizeof( SymCfg_t ); Linear Codes - Flags supported for this code: CODABAR_T codabar; CODE32_T code32; COUPONCODE_T couponCode; TRIOPTIC_T triopticCode; CODE11_T code11; CODE128_T code128; CODE39_T code39; CODE49_T code49; CODE93_T code93; COMPOSITE_T composite; EAN8_T ean8; EAN13_T ean13;...

  • Page 42: Imaging Structures And Defines

    4 - 6 None (See SymCodeOCR_t) 4096 Size of decode structure. decoded message data AIM Id of symbology Hand Held Products Id of symbology Modifier characters length of the decoded message Size of decode structure Decoded message data AIM ID of symbology...
  • Page 43 Image Acquisition structure: typedef struct _tagHHP_IMAGE_ACQUISITION DWORD dwStructSize; DWORD dwMask; Config items DWORD dwWhiteValue; DWORD dwWhiteWindow; DWORD dwMaxNumExposures; HHP_DUTY_CYCLE illuminatCycle; HHP_DUTY_CYCLE aimerCycle; HHP_GAIN fixedGain; DWORD dwFixedExposure; HHP_FRAME_RATE frameRate; HHP_AUTOEXPOSURE captureMode; Capture time only, not real config items: BOOL bWaitForTrigger; BOOL bPreviewImage;...

  • Page 44: Other Imager Configuration Structures And Defines

    DWORD dwCompressionFactor; DWORD dwEdgeEhancement; DWORD dwGammaCorrection; DWORD dwTextEnhancement; BOOL bInfinityFilter; BOOL bFlipImage; BOOL bNoiseFilter; Transfer time only, not stored in imager: HWND hTransferNotifyHwnd; PDWORD pdwTransferPercent; } HHP_IMAGE_TRANSFER, *PHHP_IMAGE_TRANSFER; Data structure for captured image: hhpAcquireImage(), hhpGetLastImage() and hhpGetAsyncResult(). Not stored in im- ager.
  • Page 45 #define BPMASK_ALL Beeper structure: typedef struct _tagHHP_BEEPER DWORD DWORD BOOL BOOL BOOL BEEPER_VOLUME } HHP_BEEPER, *PHHP_BEEPER; Trigger timeout range: #define MIN_TRIGGER_TIMEOUT_VAL #define MAX_TRIGGER_TIMEOUT_VAL 300000 Trigger structure masks: #define TRGMASK_TRIG_MODE #define TRGMASK_TIMEOUT #define TRGMASK_ALL Triggering control: typedef struct _tagHHP_TRIGGER DWORD dwStructSize; DWORD dwMask;...
  • Page 46 LONG nPixelClockFreq; TCHAR tcRegisterChecksum[ MAX_CHECKSUM_LEN ]; } HHP_ENGINE_INFO, *PHHP_ENGINE_INFO; Sequence structure defines: #define MAX_SEQ_BARCODES #define MAX_NUM_START_CHARS #define SEQ_ALL_LENGTH Sequence structure masks: #define SEQMASK_MODE #define SEQMASK_BARCODES 0x00002 #define SEQMASK_ALL Individual sequence barcode structure: typedef struct _tagSeqItem LONG nSymId; LONG nLength; TCHAR tcStartChars[ MAX_NUM_START_CHARS+1 ]; Matching string (from start) } SeqBarCode_t, *PSeqBarCode_t;...
  • Page 47 BOOL bUseAimers; DWORD dwPrintWeight; DECODE_METHOD decodeMethod; BOOL bCenterDecodeEnable; RECT centerWindow; ILLUM_LED_COLOR illumLedColor; } HHP_DECODER_CONFIG, *PHHP_DECODER_CONFIG; Aimer Modes: typedef enum AIMER_MODE_ALWAYS_OFF=0, AIMER_MODE_ILLUM_AND_AIM, AIMER_MODE_ALWAYS_ON } HHP_AIMER_MODES; Power setting item masks: #define PWRMASK_TRIGGER_MODE #define PWRMASK_SERIAL_TRIGGER_TIMEOUT #define PWRMASK_LOW_POWER_TIMEOUT #define PWRMASK_STOP_MODE_TIMEOUT #define PWRMASK_ILLUM_LED_INTENSITY #define PWRMASK_SYS_SPEED #define PWRMASK_AIMER_MODE #define PWRMASK_AIMER_DURATION #define PWRMASK_AIMER_DELAY...
  • Page 48 These are used to notify on suspend (WinCE Suspend) – Not stored in imager: HANDLE hPowerOffHandle; HWND hPowerOffHwnd; } HHP_POWER_SETTINGS, *PHHP_POWER_SETTINGS; Version setting item masks – Items are read only: #define VERMASK_SDK_API #define VERMASK_IMAGER_FIRMWARE #define VERMASK_IMAGER_PART_NUM #define VERMASK_IMAGER_BOOT_CODE #define VERMASK_IMAGER_DEVICE_TYPE #define VERMASK_ALL Revision information: #define MAX_VERSION_STRING_LEN64...
  • Page 49 Serial (RS-232) 4080 imager with internal decoder. USB serial 4080 imager with internal decoder Incorporated 4000 imager. USB serial 5080 VGA imager with internal decoder. Serial (RS-232) 5080 VGA imager with internal decoder and PSOC. Incorporated 5000 VGA imager. Serial (RS-232) 5080 imager with internal decoder.
  • Page 50 4 - 14 5X80 Series Software Development Kit (SDK) User’s Guide...

  • Page 51: Oem Supplied Dll

    OEM-Configurable SDK Functionality The 5X80 accommodates a variety of PDA/PDT, static mount, and "gun" type installations, so the 5X80 SDK has included the flexibility to modify some SDK behaviors. You can provide a DLL that affords the SDK access to the hardware trigger, hardware sleep lines, and access to the open driver handle and registry entries, which can be used to specify high speed baud rates (greater than 115200).

  • Page 52: Setcommdriverhandle

    Registry Entries There are two registry entries used to modify the SDK default behavior. The values are both located in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Hand Held Products\MatrixDemos. Baud Rate The SDK will not normally allow high speed serial connections (connections greater than 115200 baud) unless it recognizes the driver name in the registry.

  • Page 53: Configuration Management

    Program Samples Configuration Management Sample 1 - Set code 39 defaults turning on Full ASCII CODE39_T code39; TCHAR tcErrMsg[ 128 ]; Result_t nResult = RESULT_ERR_INTIALIZE; code39.dwStructSize = sizeof( CODE39_T ); code39. dwMask = SYM_MASK_FLAGS; if( (nResult = hhpReadSymbologyConfig( SETUP_TYPE_DEFAULT,SYM_CODE39,&code39 )) == RESULT_SUCCESS ) code39.dwFlags |= SYMBOLOGY_ENABLE_FULLASCII;...

  • Page 54: Barcode Capture

    Barcode Capture Sample 3 - A synchronous barcode capture HHP_DECODE_MSG decodeInfo; TCHAR tcErrMsg[ 128 ]; Result_t nResult = RESULT_ERR_INTIALIZE; // Make sure to set the structure size! decodeInfo.dwStructSize = sizeof( HHP_DECODE_MSG ); // Call the SDK function to capture a barcode setting the bWait parameter to TRUE, 6 second timeout.
  • Page 55 _tprintf( _T(“Symbol Modifier: %c\n”),decodeInfo.chSymModifier ); else hhpGetErrorMessage( _tprintf( _T(“Capture Barcode Returned: %s\n”),tcErrMsg ); Sample 5 - An asynchronous barcode capture message notification Note: You must hook the message WM_HHP_EVENT_HWND_MSG in your message loop to receive a barcode event notification. In this example, the message is hooked to call OnEventMsg. TCHAR tcErrMsg[ 128 ];...
  • Page 56 Sample 6 - An asynchronous barcode capture using Callback function // Message Handler function BOOL CALLBACK EventCallback(HHP_EVENT_TYPE eventType,DWORD dwBytes ) HHP_DECODE_MSG TCHAR Result_t // Verify the event type is barcode if( eventType == HHP_BARCODE_EVENT ) // Make sure to set the structure size! decodeInfo.dwStructSize = sizeof( HHP_DECODE_MSG );...

  • Page 57: Image Capture

    Image Capture Sample 7 - A synchronous image capture // Capture image specifies: for capture - Photo Mode and Lights On During Frames. for Transfer - Subsample value of 1 and Lossless transfer. Note: You don’t really have to pass anything except the HHP_IMAGE structure as long as you want the imager config settings for capture and transfer.
  • Page 58 _tprintf( _T(“Image Capture Failed: %s\n”),tcErrMsg ); // Remember to delete your buffer. delete [ ] image.puchBuffer; Sample 8 - An asynchronous image capture using Windows Messaging Note: You must hook the message WM_HHP_PROGRESS_HWND_MSG in your message loop to receive a barcode event notification.
  • Page 59 LRESULT OnProgressMsg( WPARAM wParam,LPARAM lParam ) DWORD dwBytesSoFar = wParam; DWORD dwBytesToRead = lParam; return( 0 ); // Message Handler for image acquisition ended function (can be result of a failure as well) LRESULT OnEventMsg( WPARAM wParam,LPARAM lParam ) hhpEventTye_t eventType = (hhpEventType_t)wParam; DWORD dwBytes = lParam;...
  • Page 60 6 - 8 5X80 Series Software Development Kit (SDK) User’s Guide...

  • Page 61: Technical Assistance

    Customer Support Technical Assistance If you need assistance with the SDK, please call your Distributor or the nearest Hand Held Products technical support office: North America/Canada Telephone: (800) 782-4263, option 4 (8 a.m. to 6 p.m. EST) Fax number: (315) 685-4960 E-mail: natechsupport@handheld.com...
  • Page 62 7 - 2 5X80 Series Software Development Kit (SDK) User’s Guide...
  • Page 64 Hand Held Products, Inc. 700 Visions Drive P.O. Box 208 Skaneateles Falls, NY 13153-0208 ™ 5X10-80SDK-UG Rev C 9/07...

This manual is also suitable for:

518053805x80 sdk

Table of Contents