Hand Held Products 4X00 manual Introduction

Page 7

1

Introduction

This document is an overview of the structure of the IT4X00 Series OEM imaging software provided by Hand Held Products. Detailed information that describes the Hand Held Products OEM Application Programming Interface is provided as a part of the 4X00 Series.

Design Overview

The Hand Held Products OEM imaging software supports a number of different Hand Held Products imaging engines, while exposing the user to a common programming interface for all supported imagers. This approach provides Hand Held Products with a simple way of adding support for new imaging hardware, while allowing user software to remain largely unchanged. In support of this design approach, the software components implemented in the Hand Held Products OEM imaging software have been organized in the following layered format:

User Layer

OEM API Layer

Image Acquisition Layer

Hardware Interface Layer

Of the four layers, Hand Held Products supplies the OEM API and Image Acquisition layers.

User Layer

The User Layer can be the application that is written by a developer or end user that accesses the imaging system by using the OEM API functions. The User Layer can alternatively be an abstraction layer provided by an OEM that allows the OEM to customize the level of API functionality exposed to their end user. Either option has access to all the applicable 4X00 Series functions that access and control the imaging subsystem

OEM API Layer

The OEM API Software is supplied by Hand Held Products and is the primary interface to the imaging system. For Windows

CE© applications, the OEM API Software functionality is provided in the form of a Windows Dynamic Link Library. For non- Windows CE applications, the form of the OEM API is to be determined. Full explanation of the 4X00 Series is provided later in this document.

Image Acquisition Layer

The Image Acquisition Software layer is the software supplied by Hand Held Products that is responsible for imager auto detection, initialization, state management, exposure control, and image acquisition. During application execution, this software maintains the state and control of the imager, processes requests for images, and executes configuration and control requests. For Windows CE applications, this layer is implemented in a stream device driver and is used by the OEM API layer. For non- Windows CE applications, the form of this layer and its interface to the OEM API layer is to be determined.

Hardware Interface Layer

The Hardware Interface Software is the hardware-specific software provided by the system developer and used by the Image Acquisition Software to access the physical imaging hardware and run hardware-specific tasks on the system. This software is called upon by Image Acquisition Software to handle physical control of the hardware, such as communication with the imager, timing functionality, low level interrupt service routine control, DMA initialization and control, system specific memory control, and illumination functionality. For Windows CE applications, this layer is provided in the form of a Windows Dynamic Link Library that is loaded by the Imaging device driver. For non-Windows CE applications, the form of this layer and its interface to the Image Acquisition Software is to be determined.

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide

1 - 1

Page 6 Page 8
Image 7
Page 6 Page 8
Contents User’s Guide Disclaimer Table of Contents Page Symbology Identifiers Page Introduction Features of the 4X00 Series Image Engine API Library Summary Page Page Data Type Definitions Tchar Page OemAimerOn OemAcquireImageOemDisableSymbology OemDefaultSymbologyOemConnect OemDisconnect OemDisableSymbologyAllOemEnableSymbology OemEnableSymbologyAllOemGetDecodeAttemptLimit OemGetAPIRevisionOemGetDecodeCenteringWindow OemGetDecoderRevision OemGetDecodeModeOemGetDecodeTime Resultt oemGetExposureSettings OemGetErrorMessageOemGetExposureSettings Resultt oemGetErrorMessageResultt oemGetImage OemGetImageResultt oemGetImagerInfo OemGetImageDataOemGetImagerInfo Prototype Resultt oemGetImageDataPImgProp OemGetImagerPropertiesPnCols Resultt oemGetImagerPropertiesResultt oemGetLastImageExt OemGetLastImageOemGetLastImageExt Resultt oemGetLastImageResultt oemGetLeaveLightsOn OemGetLastImageSizeOemGetLeaveLightsOn Resultt oemGetLastImageSizeOemGetLinearRange OemGetPrintWeightOemGetMaxMessageChars OemGetScanDriverRevision OemGetSetupAllOemGetSearchTimeLimit OemGetSetupAztec OemGetSetupAusPostOemGetSetupBPO Resultt oemGetSetupChinaPost OemGetSetupCanPostOemGetSetupChinaPost Resultt oemGetSetupCanPostResultt oemGetSetupCodablock OemGetSetupCodabarOemGetSetupCodablock Resultt oemGetSetupCodabarResultt oemGetSetupCode11 OemGetSetupCode11Resultt oemGetSetupCode16K OemGetSetupCode128OemGetSetupCode16K Resultt oemGetSetupCode128Resultt oemGetSetupCode39 OemGetSetupCode32OemGetSetupCode39 Resultt oemGetSetupCode32PbAppend OemGetSetupCode49Resultt oemGetSetupCode49 PbFullAsciiResultt oemGetSetupComposite OemGetSetupCode93OemGetSetupComposite Resultt oemGetSetupCode93Resultt oemGetSetupCompositeEx OemGetSetupCompositeExPbCompositeOnUpcEan Resultt oemGetSetupDataMatrix OemGetSetupCouponCodeOemGetSetupDataMatrix Resultt oemGetSetupCouponCodeResultt oemGetSetupEAN8 OemGetSetupDutchPostOemGetSetupEAN8 Resultt oemGetSetupDutchPostOemGetSetupEAN13 Resultt oemGetSetupIATA25 OemGetSetupIATA25Resultt oemGetSetupInt25 OemGetSetupImagerOemGetSetupInt25 Prototype Resultt oemGetSetupImagerOemGetSetupJapost OemGetSetupISBTOemGetSetupKoreanPost Resultt oemGetSetupMaxicode OemGetSetupMaxicodePCarrierMsgOnly Resultt oemGetSetupMesa OemGetSetupMesaP9MSEnabled Resultt oemGetSetupMSI OemGetSetupMSIPMinLength PMaxLength Resultt oemGetSetupOCR OemGetSetupMx25OemGetSetupOCR Resultt oemGetSetupMx25PszGroupH PszGroupGPszCheckChar Resultt oemGetSetupPlessey OemGetSetupPlanetOemGetSetupPlessey Resultt oemGetSetupPlanetResultt oemGetSetupPosiCode OemGetSetupPosiCodePLimited Resultt oemGetSetupQR OemGetSetupPostnetOemGetSetupQR Resultt oemGetSetupPostnetResultt oemGetSetupStrt25 OemGetSetupRSSOemGetSetupStrt25 Resultt oemGetSetupRSSResultt oemGetSetupTLC39 OemGetSetupTelepenOemGetSetupTLC39 Resultt oemGetSetupTelepenResultt oemGetSetupUPCA OemGetSetupTriopticOemGetSetupUPCA Resultt oemGetSetupTriopticResultt oemGetSetupUPCE OemGetSetupUPCEPbExpandVersionE PE0EnabledPE1Enabled OemGetVideoReverseOemImageStreamStart OemImageStreamInitOemImageStreamRead OemLightsOn OemPowerOffImagerOemImageStreamStop OemLeaveLightsOnResultt oemSetDecodeAttemptLimit Resultt oemPowerOffImagerOemSetDecodeAttemptLimit OemSetDecodeCenteringWindowOemSetDecodeMode OemSetExposureSettingsOemSetExposureMode Resultt oemSetLinearRange OemSetPrintWeightOemSetLinearRange OemSetScanningLightsModeOemSetupChinaPost OemSetupAztecOemSetSearchTimeLimit Resultt oemSetupCodablock OemSetupCodabarOemSetupCodablock Resultt oemSetupCodabarResultt oemSetupCode128 OemSetupCode11OemSetupCode128 Resultt oemSetupCode11Resultt oemSetupCode39 OemSetupCode16KOemSetupCode39 Resultt oemSetupCode16KBAppend OemSetupCode49Resultt oemSetupCode49 BFullAsciiOemSetupComposite OemSetupCode93OemSetupCompositeEx Resultt oemSetupEAN8 OemSetupDataMatrixOemSetupEAN8 Resultt oemSetupDataMatrixResultt oemSetupEAN13 OemSetupEAN13BAddendaReq Resultt oemSetupInt25 OemSetupIATA25OemSetupInt25 Resultt oemSetupIATA25Resultt oemSetupMaxicode OemSetupKoreanPostOemSetupMaxicode Resultt oemSetupKoreanPostResultt oemSetupMesa OemSetupMesaResultt oemSetupMx25 OemSetupMSIOemSetupMx25 Resultt oemSetupMSIPszTemplate OemSetupOCRResultt oemSetupOCR NFontResultt oemSetupPlessey OemSetupPlanetOemSetupPlessey Resultt oemSetupPlanetOemSetupPostnet OemSetupPosiCodeOemSetupQR Resultt oemSetupStrt25 OemSetupRSSOemSetupStrt25 Resultt oemSetupRSSResultt oemSetupUPCA OemSetupTelepenOemSetupUPCA Resultt oemSetupTelepenResultt oemSetupUPCE OemSetupUPCEBXmitNumSys BExpandVersionE BEnabledOemSetVideoReverse OemStartIntellImgXferResultt oemStartIntellImgXfer Resultt oemWaitForDecode OemWaitForDecodeResultt oemWaitForDecodeRaw OemWaitForDecodeRawResultt oemWaitMultipleDecode OemWaitMultipleDecodeResultt oemWaitMultipleDecodeRaw OemWaitMultipleDecodeRawFpMultiReadCallBack FpContinueCallBackSymbology Identifiers Function Result Values Mail eutechsupport@handheld.com Mail latechsupport@handheld.comMail aptechsupport@handheld.com Imageteam 4X00 Series Software Development Kit SDK Page Hand Held Products, Inc
Top Page Image Contents