Honeywell 5080, 5180, and 5380 hhpReadConfigStream

2 - 7

Parameter Description

cfgType Use SETUP_TYPE_CURRENT for the current settings, or SETUP_TYPE_DEFAULT for

the customer default settings.

item One of the members of the enumerated type ConfigItems_t. The valid values are:

BEEPER_CONFIG Returns beeper control settings for devices with audible

beepers. The settings include volume, beep on decode,

and beep on reset.

TRIGGER_CONFIG Returns values for all trigger timeouts and current

trigger mode.

DECODER_CONFIG Returns the decoder setup. This includes single

decode, multiple decodes, print weight, centered

decode, and aimer.

POWER_CONFIG Contains low power configuration settings: trigger

mode, low power timeout, low power imaging, LED

brightness, aimer LED settings, and system clock

speed.

VERSION_INFO Returns the SDK, imager firmware, and imager boot

code versions.

SYMBOLOGY_CONFIG Returns the enable and setup parameters for all

symbologies. Individual symbologies can be read by

calling hhpReadSymbologyConfig.

SERIAL_PORT_CONFIG If using a serial connection imager, this returns the

serial port setup parameters of the imager.

IMAGE_ACQUISITION Returns the current imager settings for capture mode,

manual exposure, manual gain, manual frame rate,

target white value, target window, aimer and

illumination duty cycle, and triggering mode (hardware

trigger dependent).

IMAGE_TRANSFER Returns the current image transfer protocols, such as

cropping window, pixel subsample, and transfer

compression.

SEQUENCE_CONFIG Returns the sequence mode enable/disable state and

the data sequence command string.

ALL_CONFIG All of the above except serial port 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

HP_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. No interpretation is done on the data stream, therefore, the data

stream contains both read only, and read/write data.

Contents

Main Disclaimer Table of Contents Chapter 1 - Introduction Chapter 2 - API Function Descriptions Chapter 3 - Enumerated Types and Definitions Chapter 4 - Structures and Mask Definitions Chapter 5 - OEM-Configurable SDK Functionality Page Page 1 - 1 Introduction Features of the 5X00 Series Target Operating Systems for the 5X00 Series 1 - 2 Interface Diagram 5X00 Series Library Files SDK Library File Where Resides Function 1 - 3 5X00 Series API Library Summary Core Functions Error Management Function Connection Functions Asynchronous Notification and Control Functions Core Functions (Continued) 1 - 5 Data Types, Structures, and Enumerated Types Note: A P in front of a data type means a pointer to the type. Intelligent Imaging (Signature Capture) Functions Miscellaneous Functions Windows Data Types SDK Enumerated Types Windows Data Types (Continued) Note: A special driver is required if a baud rate greater than 115200 is selected. 1 - 7 SDK Structure Types Note: Important: Make sure to set the structure members dwStructSize and dwMask. Individual Symbology Structures Configuration Structures Page 2 - 1 API Function Descriptions hhpAcquireImage hhpAcquireIntelligentImage 2 - 2 hhpCancelIo hhpCaptureBarcode hhpCaptureRawBarcode 2 - 3 hhpConnect hhpDisconnect hhpEnableDisableSymbology 2 - 4 hhpEngineConnected hhpGetAsyncResult hhpGetErrorMessage hhpGetLastImage 2 - 5 hhpNamedConnect hhpRawAcquireIntelligentImage Page 2 - 7 hhpReadConfigStream 2 - 8 hhpReadEngineInfo hhpReadImagerCapabilities hhpReadSymbologyConfig 2 - 9 hhpReadSymbologyRangeMaxMin hhpSendActionCommand hhpSendMessage 2 - 10 hhpSetAsyncMethods hhpSetBarcodeDataCodePage hhpSetConfigItemToDefaults 2 - 11 hhpSetHardwareLineDllFileName hhpSetSymbologyDefaults hhpUpgradeFirmware 2 - 12 hhpWriteConfigItem 2 - 13 hhpWriteConfigStream 2 - 14 hhpWriteSymbologyConfig Symbology Identifiers Symbology Enumeration AIM ID Code ID (hex) 2 - 15 Symbology Enumeration AIM ID Code ID (hex) Page 3 - 1 Enumerated Types and Definitions Error Codes 3 - 2 Setup Type Enumerated Type Error Codes (Continued) Symbology ID Enumeration 3 - 3 Supported OCR Fonts Symbology ID Enumeration (Continued) Image Formats 3 - 4 Gain Values Enum Image Formats (Continued) Frame Rates Enum Compression Mode Formats Capture Illumination Duty Cycle System (MPU) Clock Speeds Note: CPU clock speed must always be greater than system clock speed. Beeper Volume Enum Decoder Mode Enum Configuration Structure Item Enum for hhpReadConfigItem() and hhpWriteConfigItem() Trigger Modes Enum Sequence Mode Serial Port Baud Rates Baud Rates that Require USB Serial or SIO950 Compatible Serial Port Driver 3 - 7 Serial Data Bits Parity Stop Bits Connection Types Page 4 - 1 Structures and Mask Definitions Symbology Structures and Defines 4 - 2 4 - 3 4 - 4 Structure of all Symbology Structures 4 - 5 4 - 6 Imaging Structures and Defines 4 - 7 4 - 8 4 - 9 Other Imager Configuration Structures and Defines 4 - 10 4 - 11 4 - 12 4 - 13 4 - 14 5 - 1 OEM-Configurable SDK Functionality OEM Supplied DLL ConfigureCommPort ImagerPoweredDown ModifyCommPortDCB Registry Entries Baud Rate ForceHmodem 6 - 1 Program Samples Configuration Management 6 - 2 Barcode Capture 6 - 3 6 - 4 6 - 5 Image Capture 6 - 6 6 - 7 Page Customer Support Product Service and Repair Online Product Service and Repair Assistance Technical Assistance Online Technical Assistance