Metrologic IS4910 Series - Manuals

1 IS4910 S YSTEM H ARDWARE A RCHITECTURE Figure 1 : IS4910 System Hardware Architecture Communication with the image sensor is done over two buses – the control bus ( I 2 C ) and the data bus. The control bus is used to send commands to the image sensor, and the data bus is used to transfer images f...

2 O VERVIEW OF THE IS4910 S OFTWARE C OMPONENTS The IS4910 camera engine cannot operate on its own and must be supported by the underlying hardware and software systems. The IS4910 user system software architecture is shown on Figure 2. Figure 2 : IS4910 User System Architecture Metrologic is curren...

3 O VERVIEW OF THE IS4910 S OFTWARE C OMPONENTS IS4910 Device Driver and Its Configuration Parameters IS4910 Device Driver is a software component that does all the physical communications with IS4910 camera device. It is pre-compiled as a DLL (vuqdrv.dll) for Windows CE OS and a particular processi...

4 10 lg 20 1000 1000 20 GaindB AbsGain AbsGain GaindB ⋅ = ⋅ = O VERVIEW OF THE IS4910 S OFTWARE C OMPONENTS Minimum and Maximum Illumination Times These values, specified in microseconds, control the IS4910 illumination system in the snapshot mode. The minimum illumination time specifies the minimum...

5 O VERVIEW OF THE IS4910 S OFTWARE C OMPONENTS Data Readout Order ReverseRows and ReverseCols entries in the VuQuest2D.ini file provide information on whether the pixel read-out order for the image sensor rows and columns respectively should be reversed. The specified value can be either 0 (FALSE) ...

6 I NSTALLING IS4910 S OFTWARE Installation of the IS4910 software is a two-stage process. In the first stage, the IS4910 software development kit (SDK) must be installed on a Windows PC. To perform the first-stage installation, insert the IS4910 CD into the CD drive of the Windows PC and follow the...

7 I NSTALLING IS4910 S OFTWARE Easy Downloading Using Device Setup Tool and MS ActiveSync Connection The easiest way to download software to the target device is to use the installation program "Device Setup Tool", which is installed on the host Windows PC during the first-stage installation...

8 I NSTALLING IS4910 S OFTWARE Manual Downloading Using MS ActiveSync Connection Alternatively to using the Device Setup Tool, the IS4910 target device-specific software components can be manually transferred to the target device by following the procedure described below. 1. Make sure that Microsof...

9 C AMERA S UPPORT L IBRARY C AM L IB The IS4910 Camera Support Library CamLib provides convenient interface between an application and the IS4910 Device Driver. The library is available in two versions: static library (camlib.dll) and dynamic-link library (camdll.dll). Both versions provide exactly...

10 C AMERA S UPPORT L IBRARY C AM L IB camOpen This function establishes communication with the specified camera device. Note: The target OS must support the MultiByteToWideChar function in order for the camera support library to open the device driver properly. Prototype: int camOpen (char * device...

11 C AMERA S UPPORT L IBRARY C AM L IB Clocks The IS4910 camera has the master and pixel clocks. The master clock provides the image sensor with the input clock. The pixel clock used by the host system to sample the sensor data. The master clock is provided by the onboard oscillator and its frequenc...

12 C AMERA S UPPORT L IBRARY C AM L IB camSetCenteredWOI This function sets the window of interest (WOI) of the given size centered horizontally and vertically in the field of view of the camera. Prototype: int camSetCenteredWOI (int cam_handle, int img_width, int img_height ); Parameters: cam_handl...

13 C AMERA S UPPORT L IBRARY C AM L IB camGetImageSize This function returns the size of the window of interest (WOI). Prototype: int camGetImageSize (int cam_handle, int *img_width, int *img_height, int *num_bytes_per_row ); Parameters: cam_handle - [in] handle to the camera device returned by the ...

14 C AMERA S UPPORT L IBRARY C AM L IB Parameters: cam_handle - [in] handle to the camera device returned by the camOpen function. gain - [out] the gain value, in dB. Can be in the range from 0 to 24 dB. Return Value: 0: Success; -1: Failure camSetAutoGainRange_db This function sets the minimum and ...

15 C AMERA S UPPORT L IBRARY C AM L IB For the purposes of automatic brightness adjustments, an application can specify the minimum and maximum boundaries for the image integration time. By default, the minimum image integration time is set to 10 µs and the maximum is set to 8000 µs. If the camera i...

16 C AMERA S UPPORT L IBRARY C AM L IB camGetAutoExpoRange This function returns the minimum and maximum boundaries for the image integration time during an execution of the automatic brightness adjustment, see the function camAdjustBrightness() for more details. Prototype: int camGetAutoExpoRange (...

17 C AMERA S UPPORT L IBRARY C AM L IB Parameters: cam_handle - [in] handle to the camera device returned by the camOpen function. reverse_left_right - [out] 0 if normal readout from left to right, or 1 if inverted. reverse_top_bottom - [out] 0 if normal readout from top to bottom, or 1 if inverted....

18 C AMERA S UPPORT L IBRARY C AM L IB Prototype: int camSetMinFlashTime(int cam_handle , long min_time_µs ); Parameters: cam_handle - [in] handle to the camera device returned by the camOpen function. min_time_µs - [in] minimum illumination time, in microseconds. Return Value: 0: Success; -1: Failu...

19 C AMERA S UPPORT L IBRARY C AM L IB camAcquireImage This function performs an image acquisition and delivers the image data to the application. If called when the camera is running in the video mode, the function delivers the image of the most recent video frame. The image buffer of the size suff...

20 C AMERA S UPPORT L IBRARY C AM L IB Parameters: cam_handle - [in] handle to the camera device returned by the camOpen function. image_buf - [out] image data buffer (optional in the video mode). image_buf_size - [in] image data buffer’s size, in bytes (optional in the video mode). frame_offset - [...

21 C AMERA S UPPORT L IBRARY C AM L IB camStopVideo This function stops video mode and turns the camera back into snapshot mode. Prototype: int camStopVideo (int cam_handle ); Parameters: cam_handle - [in] handle to the camera device returned by the camOpen function. Return Value: 0: Success; -1: Fa...

22 C AMERA S UPPORT L IBRARY C AM L IB Aiming APIs The camera’s aiming system can be turned on or off by calling camTurnAimingOn() or camTurnAimingOff() respectively. Note, however, that even if the aiming is turned on, the function camStartVideo() turns the aiming off until the video is stopped. ca...

23 C AMERA S UPPORT L IBRARY C AM L IB Automatic Brightness Adjustment APIs The set of automatic brightness adjustment APIs allows an application to automatically adjust the camera’s gain and image integration time based on the quality of the previous images. camAdjustBrightness This function adjust...

24 C AMERA S UPPORT L IBRARY C AM L IB The flags parameter indicates whether the gain and/or image integration time (exposure) are allowed to be adjusted, and whether the new values should be applied to the camera immediately after taking the current image or postponed until and applied upon the nex...

25 IS4910 D EVICE D RIVER The device driver is a software component that provides the low-level interface between operating system and the IS4910 camera module. It is strongly recommended that the applications use CamLib APIs to communicate with the IS4910 camera instead of calling the IS4910 Device...

26 IS4910 D EVICE D RIVER Registry Settings The registry settings allow to load and to configure the driver. The driver must be properly configured on the target device in order to work properly. For that purpose the driver reads the configuration parameters from the registry during loading. The dri...

27 IS4910 D EVICE D RIVER Value Type Description GPIO_CIF_FV DWORD Specifies the GPIO pin connected to the “VSYNC” signal. If it’s not specified the driver fails to load. GPIO_CIF_LV DWORD Specifies the GPIO pin connected to the “HSYNC” signal. If it’s not specified the driver fails to load. GPIO_CI...

29 IS4910 D EVICE D RIVER Power Management The driver supports the standard power management interface PMCLASS_GENERIC_DEVICE used by the Power Manager under Windows CE to query the power capabilities of the device and to control its state. The supported power states are as follows: • D0 – device is...

31 A PPENDIX B: IS4910 D RIVER I NITIALIZATION F ILE The IS4910 Driver initialization file VuQuest2D.ini contains the driver configuration settings. The file uses the following format: [Device] SubKey= Index= DLL= Path= [Pins] GPIO_CIF_FV= GPIO_CIF_LV= GPIO_CIF_PCLK= GPIO_CIF_DD0= GPIO_CIF_DD1= GPIO...

32 A PPENDIX B: IS4910 D RIVER I NITIALIZATION F ILE Index (optional) defines the instance number of the device and can be a single decimal digit starting from 1 (first instance) to 9 (ninth instance) and 0 (tenth instance). The Index number is appended to the VUQ prefix to construct the device name...

33 A PPENDIX B: IS4910 D RIVER I NITIALIZATION F ILE Gain1000 (optional) defines the image sensor absolute gain multiplied by 1000. It ranges from 1000 (Gain = 1 or 0 dB) to 1600 (Gain = 16 or 24.08 dB). Default is 1000 (Gain = 1 or 0 dB). PixelClock (optional) defines the image sensor pixel clock f...

34 A PPENDIX C: D EMO A PPLICATION The demo application CamTest is simple and easy to use. Just follow the on-screen instructions. The Push me button starts/stops or continues image acquisition and real-time displaying. The currently displayed image can be stored in BMP file (\My Documents\My Pictur...