HandHeld 4X00 User Manual
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.
Hand Held Products shall not be liable for technical or editorial errors or omissions contained herein; nor for incidental or
consequential damages resulting from the furnishing, performance, or use of this material.
This document contains proprietary information which is protected by copyright. All rights are reserved. No part of this document
may be photocopied, reproduced, or translated into another language without the prior written consent of Hand Held Products.
© 2000-2005 Hand Held Products, Inc.. All rights reserved.
Web Address: www.handheld.com
Microsoft
or trademarks of Microsoft Corporation in the United States and/or other countries.
Other product names mentioned in this document may be trademarks or registered trademarks of other companies and are the
property of their respective owners.
®
Visual C/C++®, Windows® 95, Windows® 98, Windows® 2000, and Windows NT® are either registered trademarks
FCC/CE
The IMAGETEAM™ (IT) 4X00 Series Image Engine, integrated into an OEM device, may require testing by the OEM to insure
compliance with the following federal regulations:
47 CFR Part 15
EC’s Electromagnetic Compatibility Directive (89/336/EEC) and Low Voltage Directive (73/23/EEC)
For CE-related inquiries, please contact:
Hand Held Products, Inc.
5627 BT Eindhoven
The Netherlands
LED Eye Safety Statement for IT4000 and IT4100 Series Engines
The IT4000 and IT4100 series engine meets the requirements of a Class 1 Product as specified in IEC 825-1:1993 and EN
60825-1:1994 when tested in a standard IT4410 and IT4710.
Note: It is the OEM manufacturer’s responsibility to comply with applicable regulation(s) in regard to standards for specific
equipment combinations.
Laser Eye Safety Statement for IT4300 Series Engines
The IT4300 is intended for use in CDRH/IEC Class 2 devices.
/$6(5/,*+7'212767$5(,172%($0
&/$66/$6(5352'8&7
P:0$;287387WRQ0
(1$$
&RPSOLHVZLWK&)5DQG
H[FHSWIRUGHYLDWLRQVSXUVXDQWWR/DVHU
1RWLFH1RGDWHG-XO\
Note: It is the OEM manufacturer’s responsibility to comply 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 result in
hazardous radiation exposure.
Table of Contents
Chapter 1 - Introduction and Overview
Design Overview....................................................................................................................................1
User Layer........................................................................................................................................1
OEM API Layer............................................................................................................................... 1
Image Acquisition Layer.................................................................................................................. 1
Hardware Interface Layer ................................................................................................................1
Alphabetic Function List ........................................................................................................................2
AimIsOnICMedia ............................................................................................................................2
AimOffICMedia ..............................................................................................................................2
AimOnICMedia ..............................................................................................................................2
AllocatePhysicalScanSpaceICMedia .............................................................................................. 2
BindPhysicalMemoryToVirtualMemoryICMedia .......................................................................... 3
CaptureInitiatedICMedia ................................................................................................................3
DeinitializeImageLineDataProcessingICMedia ..............................................................................3
DeinitializeVsyncProcessingICMedia ............................................................................................ 3
DisableImageLineDataProcessingICMedia .................................................................................... 4
DisableVsyncInterruptICMedia ......................................................................................................4
EnableImageLineDataProcessingICMedia ..................................................................................... 4
EnableVsyncInterruptICMedia .......................................................................................................4
FreePhysicalScanSpaceICMedia ....................................................................................................5
GetFrequencyPerFrameOfLineDataCallbackICMedia ................................................................... 5
GetHardwareDllRevisionICMedia ..................................................................................................5
GetImagerPropertiesICMedia .........................................................................................................6
GetNumberOfValidRowsICMedia .................................................................................................6
GetRegisterSettingsForHHPExposureControlICMedia ..................................................................7
GetScanHeightICMedia .................................................................................................................. 7
GetScanWidthICMedia ...................................................................................................................7
IllumIsOnICMedia ..........................................................................................................................7
IllumOffICMedia ............................................................................................................................8
IllumOnICMedia .............................................................................................................................8
ImagerIsPoweredICMedia ..............................................................................................................8
ImagerPowerDownICMedia ...........................................................................................................8
ImagerPowerOffAndSuspendICMedia ........................................................................................... 8
ImagerPowerOnAndResumeICMedia ............................................................................................ 9
ImagerPowerUpICMedia ................................................................................................................9
InDownTimeICMedia .....................................................................................................................9
InitCaptureICMedia ......................................................................................................................10
InitializeImageLineDataProcessingICMedia ................................................................................ 10
InitializeVsyncProcessingICMedia ...............................................................................................10
ReadIIC_ICMedia .........................................................................................................................11
RegisterImageLineDataNotificationICMedia ............................................................................... 11
RegisterVsyncNotificationICMedia ..............................................................................................11
RequestSynchronizedPowerDownICMedia ..................................................................................11
ResetTransferHardwareICMedia .................................................................................................. 12
SynchronizedPowerDownICMedia ..............................................................................................12
UnBindPhysicalMemoryFromVirtualMemoryICMedia ...............................................................12
WaitForVsyncICMedia .................................................................................................................12
WaitMillisecondsICMedia ............................................................................................................13
WriteIIC_ICMedia ........................................................................................................................ 13
Chapter 2 - Customer Support
Technical Assistance ............................................................................................................................ 15
Online Technical Assistance..........................................................................................................15
IMAGETEAM™ 4X00 Series Hardware Interface Layer Specification User’s Guide i
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 (
User’s Guide
) is provided as a part of that imaging software.
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 imagers supported. 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.
IMAGETEAM 4X00 SDK
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 OEM API
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. All members of
the OEM Image Engine Family are supplied with a Software Developers Kit to facilitate command and control of the image
engines. For Windows CE
Link Library. For non-Windows CE applications, the form of the OEM API Software is to be determined. Full explanation of the
OEM API is provided in the
®
applications, the OEM API Software functionality is provided in the form of a Windows Dynamic
IMAGETEAM 4X00 SDK User’s Guide
.
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 nonWindows 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, it is expected that this layer will be provided in the form of a Windows
Dynamic Link Library that will be 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 Hardware Interface Layer Specification 1
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.
2 IMAGETEAM™ 4X00 Series Hardware Interface Layer Specification
Loading...