IMAGETEAM™ 4X00 Series For Adaptus Imaging Technology Imagers: IT4000, IT4100, and IT4300 Hardware Interface Layer Specification 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 document without prior notice, and the reader should in all cases consult Hand Held Products to determine whether any such changes have been made. The information in this publication does not represent a commitment on the part of Hand Held Products.
Laser Eye Safety Statement for IT4300 Series Engines The IT4300 is intended for use in CDRH/IEC Class 2 devices. /$6(5 /,*+7 '2 127 67$5( ,172 %($0 &/$66 /$6(5 352'8&7 P: 0$; 287387 WR Q0 (1 $ $ &RPSOLHV ZLWK &)5 DQG H[FHSW IRU GHYLDWLRQV SXUVXDQW WR /DVHU 1RWLFH 1R GDWHG -XO\ Note: It is the OEM manufacturer’s responsibility to comply with applicable regulation(s) in regard to standards for specific equipment combinations.
Table of Contents Chapter 1 - Introduction and Overview Design Overview .................................................................................................................................... 1 User Layer........................................................................................................................................ 1 OEM API Layer ...............................................................................................................................
ii IMAGETEAM™ 4X00 Series Hardware Interface Layer Specification User’s Guide
Introduction and Overview 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 (IMAGETEAM 4X00 SDK User’s Guide) is provided as a part of that imaging software.
Alphabetic Function List The following is a list of functions that the ImagerHardware DLL must export to support the imaging device driver. The functions described below are specific to the IC Media imager and the ICMedia product specification and should be reviewed for coherency with this document. AimIsOnICMedia This function returns the state of the aimer. BOOL AimIsOnICMedia( void ) Returns Zero if OFF, non-zero if ON. AimOffICMedia This function turns off the aimer.
BindPhysicalMemoryToVirtualMemoryICMedia This function binds the physical memory of an image, specified by "hPhysical," to a virtual memory location specified by "pVirtual." Note: It is possible that multiple calls to this function may be made with the same physical pseudo-handle, but a different virtual address, i.e., binding multiple virtual addresses to the same physical space at the same time. This is normal.
Returns Zero on failure, non-zero on success. DisableImageLineDataProcessingICMedia This function disables the calling of the ImageLineDataCallback function registered with RegisterImageLineDataNotificationICMedia (see page 1-11). DWORD DisableImageLineDataInterruptICMedia( void ) Returns Zero on failure, non-zero on success.
FreePhysicalScanSpaceICMedia This function frees the physical memory for a single image. DWORD FreePhysicalScanSpaceICMedia( DWORD hImage ) Passed Arguments DWORD hImage Description A "pseudo-handle" to a reserved physical memory slot. This was the value returned by AllocatePhysicalScanSpaceICMedia when the space was allocated. Returns DWORD - This function returns non-zero on success, zero on failure.
GetImagerPropertiesICMedia This function requests the properties of the imager currently interfacing to the hardware layer. BOOL GetImagerPropertiesICMedia( const DWORD * pBuffIn, DWORD * pBuffOut, DWORD dwLen ) Passed Arguments pBuffIn pBuffOut dwLen Description Pointer to a buffer of DWORDs that are TAGs to the properties the scan driver is requesting. Pointer to output buffer that has corresponding values and order to TAGs in pBuffin. Length of both pBuffin and pBuffOut.
GetRegisterSettingsForHHPExposureControlICMedia This function is used for the hardware DLL to give the driver access to the register settings needed for its hardware platform.
IllumOffICMedia This function turns off the illumination LEDs. BOOL TurnLEDsOffICMedia( void ) Returns Zero on failure, non-zero on success. IllumOnICMedia This function turns on the illumination LEDs. BOOL TurnLEDsOnICMedia( void ) Returns Zero on failure, non-zero on success. ImagerIsPoweredICMedia This function indicates whether or not the image engine is currently in powerdown mode. BOOL ImagerIsPoweredICMedia( void ) Returns Zero if the engine is currently in powerdown mode, non-zero if it is not.
Returns TRUE if successful, FALSE otherwise. ImagerPowerOnAndResumeICMedia This function controls a physical switch to cycle power on the imager. This is typically implemented for Win CE suspend/resume. DWORD ImagerPowerOnAndSuspendICMedia( DWORD ) Passed Arguments 0 1 2 Description Normal case. Win 32 API functions are still allowed. Suspend/Resume. (For example, in Win CE this implies that it is not safe to call Win32 or user layer functions.) Resume, but don't power on.
InitCaptureICMedia This function indicates that a transfer will begin on the next Vsync pulse, and the image data will go into the physical memory location referenced by "hPhysical." This function can be called at any time during a frame, and the driver relies on the hardware DLL and associated functionality to synchronize to the next Vsync to begin a frame. The Vsync is the border. Anything that comes in before the front edge of a Vsync will initiate a transfer on the next Vsync.
ReadIIC_ICMedia This function uses the i2c interface protocol to read data from 'ucSubaddress' register location and places it at the location specified by 'pucBuffer'. unsigned int ReadIIC_ICMedia( unsigned char ucSubaddress, unsigned char *pucBuffer ) Passed Arguments unsigned char ucSubaddress unsigned char *pucBuffer Description The register location where the data will be read from. A pointer to the location where the data from the imager will be stored.
Returns None. ResetTransferHardwareICMedia This function stops a transfer that is either ready to run, or currently running. It also resets the system making it ready for the next call to InitCaptureICMedia. void ResetTransferHardwareICMedia( void ) Returns None. SynchronizedPowerDownICMedia This function puts the imager in power down mode upon receiving the next front edge of Vsync.
WaitMillisecondsICMedia This function waits the number of milliseconds indicated before returning. void WaitMillisecondsICMedia( DWORD nTime ) Passed Arguments NTime Description The number of milliseconds to delay. Returns None. WriteIIC_ICMedia This function uses the i2c interface protocol to write the 'ucBuffer' data to the imager at the 'ucSubaddress' location.
Programming Notes 1. It is essential that callbacks for Vsync processing and Image Line Data processing not run at the same time, for example, with 2 separate threads. It is essential that checks are made in the Hardware Interface DLL to ensure that a call to one callback is complete before a second call to that callback, or a call to the other callback is made. To avoid this, use ISRs that do not allow nesting. Or, if using ISTs in the Windows CE model, use the same thread to process both callbacks. 2.
Customer Support Technical Assistance If you need assistance using the IT4X00 Series OEM imaging software, please call your Distributor or the nearest Hand Held Products technical support office: North America/Canada: Telephone: Fax number: E-mail: (800) 782-4263, option 4 (8 a.m. to 6 p.m. EST) (315) 685-4960 natechsupport@handheld.com Europe, Middle East, and Africa: TelephoneEuropean Ofc: Int+31 (0) 40 79 99 393 U.K. Ofc: Int+44 1925 240055 E-mail: eutechsupport@handheld.
16 IMAGETEAM™ 4X00 Series Hardware Interface Layer Specification
Hand Held Products, Inc. 700 Visions Drive P.O.
