Instruction/ maintenance manual of the product 4X00 Hand Held Products
Go to page of 90
IMAGETEAM ™ 4X00 Series For Adaptus Imaging Technology Imagers: IT4000, IT4100, and IT4300 Software Development Kit (SDK) User’s Guide.
Disclaimer Hand Held Products, Inc. d/b/a Hand Held Products (“Hand Held Products”) reserves the right to make changes in specifications and other information contained in this do cument without prior notice, and the reader should in al l cases consult Hand Held Products to determine whether any such changes have been made .
i Chapter 1 - Introduction Design Overview ........ ......................................................................................................................... 1-1 User Layer ..............................................................
ii oemGetSetupCode39 ............................................................................................................. .... 2-19 oemGetSetupCode49 ............................................................................................
iii oemSetupCode128 ............................................................................................................... ...... 2-49 oemSetupCode16K ...........................................................................................
iv.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 1 1 Introduc tion This document is an overview of the stru cture of the IT4X00 Series OEM imaging soft ware provided by Hand Held Products.
1 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Features of the 4X00 Series The 4X00 Series consists of the following: • The API Definition and Documentation • API Lib.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 3 Image Engine API Library Summary The following is a summary of the API functions.
1 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupCodabar Gets the Codabar sym bology decoding options 2-16 oemGetSetupCodablock Gets the Codablock sy mbology dec.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 5 oemSetDecodeMode Sets the decoding mode of the engine 2-45 oemSetLinearRange Sets the size of the window used in the Advanc.
1 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Data T ype Definitions Throughout this document the foll owing variable types are used.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 7 Result_t Enumerated integer type that define s API function result values. See Function Result Values on page 3-2. ScanIlluminat_t Enumerated integer type that identifies possible illumination modes used during image acquisition.
1 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 1 2 API F unction D escriptions The following is an alphabetic listing of each API function with its complete descript ion and a prototype for each function. A ll API functions return a result co de of type Result_t.
2 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s bEnable If TRUE, the aiming mechanism is turned on; ot herwise the aiming mechanism is turned off. oemConnect The application should call this function before any other API functions.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 3 oemDisableSymbologyAll This function disables all symbologies from decoding, including an y unknown symbologies. Result_t oemDisableSymbologyAll ( void ) Return V alues RESULT_SUCCESS Pa r a m e t e r s None.
2 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetAPIRevision This function returns an ASCII string containing the API's current revision.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 5 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. PbEnabled Pointer to a BOOL which returns TRUE if ce ntering mode enabled or FALSE if it's not.
2 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetErrorMessage This function returns a string contai ning the description of the error corresponding to the nError parameter.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 7 oemGetImage This function retrieves an image from the engine and stores it in memo ry pointed to by pImageBuffer.
2 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide nExposeAttempts The number of attempts the unit makes to ge t the image to the co rrect exposure level. nGap How close the white value of the image mu st be to the nWhiteValue for the image to be accepted.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 9 Pa r a m e t e r s pnCols Upon successful return, this variable points to the number of column pixels in the Imager. pnRows Upon successful return, this variable points to the number of row pixels in the Imager.
2 - 10 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetLastImage This function is used to retrieve the last image acquired by the image engine.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 11 oemGetLastImageSize This function returns the number of rows, number of columns and size in bytes of t he last image returned by one of the other imaging functions: oemAcquireImage, oemGe tImage/oemGetImageData or oemImageStreamRead.
2 - 12 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetLinearRange This function is used to get the size of the window used in th e Advanced Linear decoding mode.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 13 oemGetScanDriverRevision This function returns the revision of the scan driv er component that interfaces to the OEM API layer.
2 - 14 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupAusPost This function is used to get the Australian Postal Code symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 15 Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.
2 - 16 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupCodabar This function is used to get th e Codabar symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 17 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 18 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupCode128 This function is used to get the Code 128 symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 19 oemGetSetupCode32 This function is used to get the Code 32 symbology specific options.
2 - 20 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 21 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 22 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 23 oemGetSetupCouponCode This function is used to get the UPC-A with extended Coupon Code symbology specific options.
2 - 24 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupDutchPost This function is used to get theKIX (N etherlands) Post symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 25 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 26 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 27 oemGetSetupImager This function gets the cu rrent Imager setup values. Prototype Result_t oemGetSetupImager ( SetupType_t SetupType, ImagerSetup_t *pImagerSetup ) Return V alues RESULT_SUCCESS Pa r a m e t e r s pImagerSetup Data structure that sets up the Imager.
2 - 28 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupISBT This function is used to get the ISBT 128 symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 29 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 30 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupMesa This function is used to get the Azte c Mesa Code symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 31 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 32 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupMx25 This function is used to get the Matr ix 2 of 5 symbology specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 33 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. nFont This determines which OCR fonts (if any) are select ed for decoding.
2 - 34 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 35 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
2 - 36 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupPostnet This function is used to get th e Postnet symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 37 oemGetSetupRSS This function is used to get the RSS Expanded symbology-specific options.
2 - 38 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupTelepen This function is used to get the Telepen symbology specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 39 oemGetSetupTrioptic This function is used to get the Tri optic Code symbology specific options.
2 - 40 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 41 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pE0Enabled Points to a BOOL variable that contains the enabled state of UPC-E0 symbology upon returning from the function.
2 - 42 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemImageStreamInit This function is used to intialize the imag e stream interface. The caller is allowed to specifiy the skip (subsample) value. Note: If nSkip is greater than 1, the resultin g image will be subsampled by nSkip.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 43 oemImageStreamStop This function causes the Image Engine to stop continous collecting of image s started by oemImageStreamInit() and oemImageStreamStart().
2 - 44 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide This function allows the applicat ion to fully power down the imag er for additional power control.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 45 oemSetDecodeMode This function sets the de coding mode of the engine. Result_t oemSetDecodeMode ( SetupType_t SetupType, W.
2 - 46 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetLinearRange This function sets the size of the window used in the Advanced Linear decoding mode.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 47 oemSetSearchTimeLimit This function is used to set the maximum time limit for the decoders se arch processing. The limit, specified in milliseconds, is the maximum amount of time the search process may use to look for poten tial labels in the current image.
2 - 48 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s nMinLength The minimum length decoded Chi na Post message the engine should return. China Post messages smaller than this minimum length are not reported by th e engine.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 49 Pa r a m e t e r s nMinLength The minimum length decoded Codablock me ssage the engine should return. Coda block messages smaller than this minimum length are not reported by th e engine.
2 - 50 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupCode16K This function is used to set the Code 16K symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 51 Pa r a m e t e r s bSSXmit Points to a BOOL variable that determines if the start a nd stop characters are returned in the data string after a successful Code 39 decode. If bSSXmit is TRUE, the start and stop characters are included.
2 - 52 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupCode93 This function is used to set the Code 93 symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 53 Pa r a m e t e r s nMinLength The minimum length decoded EANoUCC Composite message the engine should return. EANoUCC Composite messages smaller than this minimum length are not reported by the engine.
2 - 54 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after a successful decode.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 55 oemSetupIATA25 This function is used to set the Straight 2 of 5 IATA symbology-specific options.
2 - 56 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupKoreanPost This function is used to set the Ko rean Post symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 57 oemSetupMesa This function is used to set the Azte c Mesa Code symbology-specific options. Note: The minimum and maximu m parameters are set using oemSetupAztec (page 2-47).
2 - 58 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupMSI This function is used to set th e MSI symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 59 oemSetupOCR This function is used to set the Optical Character Recognition (OCR) decoding options. OCR char acter recognition is less secur e than reading bar codes. Misreads may oc cur if a check character is not used.
2 - 60 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupPDF417 This function is used to set th e PDF417 symbology-specific options.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 61 oemSetupPosiCode This function is used to set the PosiCode symbology-specific options.
2 - 62 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s nMinLength The minimum length decoded QR Code message the engine should return. QR Code me ssages smaller than this minimum length are not reported by th e engine.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 63 oemSetupTelepen This function is used to set th e Telepen symbology-specific options.
2 - 64 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check di git as part of the data string after a successful decode.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 65 Pa r a m e t e r s bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check di git as part of the data string after a successful decode.
2 - 66 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide This function uses the dimensions of the bar code as its coordinate system. Thus, all parameters describin g the image size and position are in units called Intelligent Ba r Code Units.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 67 Pa r a m e t e r s pImageDesc Pointer to a data structure describ ing the image to to be retrieved.
2 - 68 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s dwTimeout Time in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero. pchMessage Upon successful return, this variable po ints to the decoded message.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 69 Pa r a m e t e r s dwTimeout Time in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero. pchMessage Upon successful return, this variable po ints to the decoded message.
2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s dwTimeout Maximum amount of time in millisec onds that the decoder may use to attempt to find and decode symbols. fpMultiReadCallBack Pointer to a callback function that takes a DecodeMsg_t variable as a pa rameter and returns a BOOL.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 3 - 1 3 S ymbology Identifiers Symbology Identifiers The following symbology identifiers are def ined in the Oemdecodece.h header file. Note: AIMID output is a pointer to the second character of the AIM ID string in the fo llowing chart.
3 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Function Result V alues The following function result values are a sample of the values defined in th e Oemdecodece.h header file. RESULT_SUCCESS The API function succeeded. RESULT_ERR_BADREGION An image was reques ted using an invalid image region.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) 4 - 1 4 Customer Suppor t T echnical Assist ance If you need assistance using the SDK, please call your Distributo r or the nearest Hand Held Pr oducts technical support office: North America/Canada: Telephone: (800) 782-4263, option 4 (8 a.
4 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK).
.
™ Hand Held Products, Inc. 700 Visions Drive P.O. Box 208 Skaneateles Falls, NY 13153-0208 4X00SDK-UG Rev A 6/05 Note: This document replaces the OEMAPI-UG Rev C.
An important point after buying a device Hand Held Products 4X00 (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought Hand Held Products 4X00 yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data Hand Held Products 4X00 - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, Hand Held Products 4X00 you will learn all the available features of the product, as well as information on its operation. The information that you get Hand Held Products 4X00 will certainly help you make a decision on the purchase.
If you already are a holder of Hand Held Products 4X00, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime Hand Held Products 4X00.
However, one of the most important roles played by the user manual is to help in solving problems with Hand Held Products 4X00. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device Hand Held Products 4X00 along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
