background image

 2

IMAGETEAM™ 4X00 Series Hardware Interface Layer Specification

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.

BOOL TurnAimerOffICMedia(

void
)

Returns

Zero on failure, non-zero on success

AimOnICMedia

This function turns on the aimer.

BOOL TurnAimerOnICMedia(

void
)

Returns

Zero on failure, non-zero on success.

AllocatePhysicalScanSpaceICMedia

This function reserves the physical memory for a single image.  It does not matter to the driver how physical memory is handled 
on the specific platform.  When the "pseudo-handle" is passed to various functions, a specific block of physical memory is 
referenced.

DWORD AllocatePhysicalScanSpaceICMedia(

void
)

Returns

DWORD - a "pseudo-handle" to physical memory on success. This "pseudo-handle" will be used to communicate a 

specific physical buffer when other memory functions are called.  This function returns zero on failure.

Summary of Contents for 4X00

Page 1: ...User s Guide IMAGETEAM 4X00 Series For Adaptus Imaging Technology Imagers IT4000 IT4100 and IT4300 Hardware Interface Layer Specification...

Page 2: ...d Web Address www handheld com Microsoft Visual C C Windows 95 Windows 98 Windows 2000 and Windows NT are either registered trademarks or trademarks of Microsoft Corporation in the United States and o...

Page 3: ...ly with applicable regulation s in regard to standards for specific equipment combinations Caution Use of controls or adjustment or performance of procedures other than those specified herein may resu...

Page 4: ......

Page 5: ...a 5 GetHardwareDllRevisionICMedia 5 GetImagerPropertiesICMedia 6 GetNumberOfValidRowsICMedia 6 GetRegisterSettingsForHHPExposureControlICMedia 7 GetScanHeightICMedia 7 GetScanWidthICMedia 7 IllumIsOnI...

Page 6: ...ii IMAGETEAM 4X00 Series Hardware Interface Layer Specification User s Guide...

Page 7: ...mand and control of the image engines 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...

Page 8: ...L TurnAimerOffICMedia void Returns Zero on failure non zero on success AimOnICMedia This function turns on the aimer BOOL TurnAimerOnICMedia void Returns Zero on failure non zero on success AllocatePh...

Page 9: ...quire a new image has been successfully completed A request for a new capture that is made before the front edge of the Vsync signal an optional function should be carried out on the front edge of the...

Page 10: ...Zero on failure non zero on success EnableImageLineDataProcessingICMedia This function enables the calling of the call back function registered via RegisterImageLineDataNotificationICMedia see page 11...

Page 11: ...system the callback may be called from 28 33 times a safe number would be 27 DWORD GetFrequencyPerFrameOfLineDataCallbackICMedia void Returns A number N that completes this statement the line processi...

Page 12: ...o output buffer that has corresponding values and order to TAGs in pBuffin dwLen Length of both pBuffin and pBuffOut Tags typedef enum IP_SIZE IP_ENGINE_ID IP_NUM_ROWS IP_NUM_COLS IP_BITS_PER_PIXEL IP...

Page 13: ...nts Description ICMediaRegisterEntry_t ppRegisterEntries A pointer to a location where a pointer to the register settings can be set The ICMediaRegisterEntry_t is defined above The table itself is an...

Page 14: ...a void Returns Zero if the engine is currently in powerdown mode non zero if it is not ImagerPowerDownICMedia This function puts the image engine into powerdown mode via a power enable signal BOOL Ima...

Page 15: ...power on To be powered on during next image I 0 event Returns TRUE if successful FALSE otherwise ImagerPowerUpICMedia This function takes the image engine out of powerdown mode via a power enable sig...

Page 16: ...e was allocated Returns Zero on failure 1 capture request was initiated but it happened just after the front edge of Vsync i e in down time and therefore will only take effect on the next front edge o...

Page 17: ...oid Function pointer to a function that receives no arguments and returns nothing Returns Zero on failure non zero on success RegisterVsyncNotificationICMedia This function is called during initializa...

Page 18: ...y hPhysical from the virtual memory location specified by pVirtual This does not however free any memory The pVirtual pointer should still be a valid pointer pointing to RESERVED but not COMMITTED mem...

Page 19: ...WriteIIC_ICMedia This function uses the i2 c interface protocol to write the ucBuffer data to the imager at the ucSubaddress location DWORD WriteIIC_ICMedia unsigned char ucSubaddress const unsigned c...

Page 20: ...ardware DLL must synchronize it with the hardware Returning a 1 or 2 from InitCaptureICMedia is not mandatory If a specific hardware system allows for initiation of an image transfer after the front e...

Page 21: ...82 4263 option 4 8 a m to 6 p m EST Fax number 315 685 4960 E mail natechsupport handheld com Europe Middle East and Africa Telephone European Ofc Int 31 0 40 79 99 393 U K Ofc Int 44 1925 240055 E ma...

Page 22: ...16 IMAGETEAM 4X00 Series Hardware Interface Layer Specification...

Page 23: ......

Page 24: ...Hand Held Products Inc 700 Visions Drive P O Box 208 Skaneateles Falls NY 13153 0208 4X00HWIntfc UG Rev B 6 05...

Reviews: