DEVA DEVA028 User Manual

Usb 3 mega pixel colour camera

Advertisement

Quick Links

DEVA028 USB 3 Mega Pixel Colour Camera
User's Manual
V1.1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the DEVA028 and is the answer not in the manual?

Questions and answers

Summary of Contents for DEVA DEVA028

  • Page 1 DEVA028 USB 3 Mega Pixel Colour Camera User’s Manual V1.1...
  • Page 3 All information of a technical nature and particulars of the product and its use are given by Deva Electronic Controls Ltd. in good faith. However, it is acknowledged that there may be errors and omissions in this manual. We shall not be liable for loss or damage whatsoever arising from the use of any information or particulars in, or any omissions from, this document.
  • Page 5: Table Of Contents

    DEVA028 USB User’s Manual Overview Overview ................1 Product Features..............1 Typical applications ..............2 Support software..............2 1.3.1 Windows XP32/Vista32 ................2 1.3.2 Utilities......................2 Accessories ................3 Installation and configuration ........4 Software support CDROM ............4 System requirements .............. 4 2.2.1 Camera connection ...................
  • Page 6 Overview DEVA028 USB User’s Manual Data structures ..............13 3.3.1 CAM_IDENTIFICATION ................13 3.3.2 CAPTURE_COLOUR_ADJUSTMENT ............ 13 3.3.3 CAPTURE_IMAGE_ADJUSTMENT ............14 3.3.4 CAM_WINDOW ..................14 3.3.5 DEST_WINDOW..................15 3.3.6 CAPTURE_REQUIREMENT_PARAMS ..........16 3.3.7 CAPTURE_AUTO_EXPOSURE_PARAMS..........17 3.3.8 CAPTURE_AUTO_ADJUST_PARAMS ..........18 3.3.9 CAPTURE_HISTOGRAM................. 18 3.3.10 CAPTURE_FRAME_INFO ...............
  • Page 7 DEVA028 USB User’s Manual Overview 3.6.1 setup_capture ..................29 3.6.2 capture_occurred ..................30 3.6.3 copy_capture_buffer ................31 3.6.4 flush_capture_buffer................31 3.6.5 get_capture_params ................32 3.6.6 get_frame_info..................32 Capture rendering functions ..........33 3.7.1 setup_timer_capture ................33 3.7.2 set_capture_render_config ..............34 3.7.3 get_capture_render_config ..............
  • Page 9: Overview

    Overview The DEVA028 colour camera module is designed to enable a wide range of image capture applications to be realised. Based on a 3M pixel CMOS sensor with bayer mosaic for colour reproduction the Deva 028 makes use of high speed USB 2.0 to transfer image data to a PC host system.
  • Page 10: Typical Applications

    For software developers, the Deva capture library functions are described later in this manual. Example programs written using common modern visual programming tools are provided on the Deva software support CDROM to illustrate the use of the Deva capture library functions.
  • Page 11: Accessories

    Accessories When supplied as part of a development kit, the DEVA028 colour camera module is mounted in a compact enclosure with C-mount lens fitting and included with a 1m A to mini-B USB cable. Please contact Deva with your requirements.
  • Page 12: Installation And Configuration

    Installation and configuration Software support CDROM The DEVA28 is supplied with a software support CDROM that also includes support and information for many of Deva’s other products. The CDROM includes the following items: Windows XP32/Vista32 device drivers provide a coherent camera hardware management layer.
  • Page 13: Software Development Kit

    Software Development Kit For development of general-purpose image capture applications, Deva provides a suite of functions built into the Deva capture library. The library is designed to provide the facilities necessary for the configuration and control of live and still image capture from within a user application.
  • Page 14: Programming Definitions

    8-bit signed byte ‘C’ type: char Visual Basic type: Byte 8-bit unsigned byte ‘C’ type: unsigned char Visual Basic equivalent: Byte 16-bit signed integer ‘C’ type: Short Visual Basic type: Integer 16-bit unsigned integer ‘C’ type: unsigned short Visual Basic equivalent: Integer 32-bit signed integer ‘C’...
  • Page 15: Cam_Client_Types

    One of these values is passed in the call to function open_cam. In normal circumstances, the calling application or dll is running in user mode and so CAM_CLIENT_USER_TYPE is specified. Please contact Deva if more information is required regarding accessing the motion library functions from a windows driver or WDM.
  • Page 16: Cam_Format_Types

    3.2.4 CAM_FORMAT_TYPES Type Description CAM_RAW Raw pixel data returned from the image sensor without any image post-processing. CAM_RGB32 A pixel is represented by 4 bytes in ascending order red, green and blue. The 4 byte is not used. CAM_RGB24 A pixel is represented by 3 bytes in ascending order red, green and blue.
  • Page 17: Capture_Control_Types

    3.2.6 CAPTURE_CONTROL_TYPES Type Description CAPTURE_CONTROL_TYPE_ The capture stream is stopped. STOP CAPTURE_CONTROL_TYPE_ The capture stream is paused. PAUSE CAPTURE_CONTROL_TYPE_ The capture stream is started. In the case of a PLAY CAPTURE_IMMEDIATE stream a single image capture is triggered. Repeated images will be captured at the specified rate for a CAPTURE_REPEAT stream.
  • Page 18: Capture_Auto_Adjust_Modes

    3.2.9 CAPTURE_AUTO_ADJUST_MODES Type Description CAPTURE_AUTO_ADJUST_O The automatic adjustment of image and exposure is disabled. CAPTURE_AUTO_ADJUST_O The automatic adjustment of image and/or exposure is enabled. The adjustment_mode member of the CAPTURE_AUTO_ADJUST_PARAMS structure is set to one of these values to enable or disable the post-process image and exposure adjustment.
  • Page 19: Capture_Auto_Exposure_Modes

    3.2.11 CAPTURE_AUTO_EXPOSURE_MODES Type Description CAPTURE_AUTO_EXPOSUR The automatic exposure adjustment is disabled. E_OFF CAPTURE_AUTO_EXPOSUR Whilst lighting conditions are such that the image E_GAIN sensor gain remains within user specified limits, it is adjusted as required whilst the integration time remains fixed at its nominal value. However, if lighting conditions are such that the adjusted gain reaches one of its limits, the integration time is then adjusted as required within its own user specified limits.
  • Page 20: Capture_Overlay_Types

    The following graph illustrates how the gain and integration time change under varying lighting conditions for the different auto adjustment modes: Gain & integration time, ratio 2.0 Integration Integration Gain & integration time, ratio 0.5 time time Gain & integration time, min/max Adjust gain, integration time fixed Adjust Integration time, gain fixed Nominal...
  • Page 21: Data Structures

    3.3 Data structures 3.3.1 CAM_IDENTIFICATION Parameter Type Description A non-zero value is the ID of a camera and is used to identify the camera in calls to functions that perform operations on that camera. max_capture_size The maximum size of the image that may be captured –...
  • Page 22: Capture_Image_Adjustment

    3.3.3 CAPTURE_IMAGE_ADJUSTMENT Parameter Type Description rgbColourAdjust CAPTURE_COLOUR_AD Specifies adjustment made JUSTMENT equally to all three of the colour channels. redColourAdjust CAPTURE_COLOUR_AD Specifies adjustment made JUSTMENT individually to the red colour channel. greenColourAdjust CAPTURE_COLOUR_AD Specifies adjustment made JUSTMENT individually green colour channel.
  • Page 23: Dest_Window

    The following diagram illustrates the window sized and position in relation to the image sensor. 2048 Image sensor Window 1536 3.3.5 DEST_WINDOW Parameter Type Description hwnd handle application’s window. The horizontal origin of the frame destination within the window. The vertical origin of the frame destination within the window.
  • Page 24: Capture_Requirement_Params

    3.3.6 CAPTURE_REQUIREMENT_PARAMS Parameter Type Description image_adjustment CAPTURE_IMAGE_ADJU The post-process image adjustments STMENT applied to the colour content of an image CAM_WINDOW The size and position of a window on the image sensor gain Camera gain setting. integration_time Camera integration setting (ms). rate Frame rate for capture streams with a capture type of CAPTURE_REPEAT...
  • Page 25: Capture_Auto_Exposure_Params

    3.3.7 CAPTURE_AUTO_EXPOSURE_PARAMS Parameter Type Description flicker_frequency A non-zero value set to the frequency (i.e. 50/60Hz) of any artificial lighting prevents image flicker by ensuring integration times are a multiple of the flicker period. nominal_gain The nominal gain used for auto adjustment.
  • Page 26: Capture_Auto_Adjust_Params

    3.3.8 CAPTURE_AUTO_ADJUST_PARAMS Parameter Type Description exposure CAPTURE_AUTO_EXPO User-defined parameters SURE_PARAMS post-process automatic exposure adjustment of a capture stream adjust_mode CAPTURE_AUTO_ADJU Enables or disables the post-process ST_MODES image and exposure adjustment adjustment_type CAPTURE_IMAGE_ADUS Specifies the type of post-process TMENT_TYPES image adjustment applied to the image min_threshold Specifies the percentage of pixels to...
  • Page 27: Capture_Frame_Info

    3.3.10 CAPTURE_FRAME_INFO Parameter Type Description params CAPTURE_REQUIREME The user-defined requirements for NT_PARAMS the capture stream auto_adjust CAPTURE_AUTO_ADJU The user-defined requirement for ST_PARAMS post-process image and exposure adjustment of the capture stream rgbHist CAPTURE_HISTOGRAM Histogram data for the combined red, green and blue colour channels. redHist CAPTURE_HISTOGRAM Histogram data for the red colour...
  • Page 28: Capture_Sync_Parameters

    3.3.11 CAPTURE_SYNC_PARAMETERS Parameter Type Description sync_type CAM_SYNC_TYPES Configures the operation of signals on the camera sync connector. invert_logic A non-zero value inverts the logical sense of the sync signal. capture Identifies the capture stream to be associated with the sync signal. The members of this structure associate the operation of a sync signal with a capture stream.
  • Page 29: Initialisation And Camera Setup Functions

    In normal circumstances, the calling application or dll is running in user mode and so CAM_CLIENT_USER_TYPE specified. Please contact Deva if more information is required regarding accessing the motion library functions from a windows driver or WDM. result 0 = Operation failed 1 = Operation completed Open the connection to the camera drivers.
  • Page 30: Num_Cameras

    3.4.4 num_cameras result num_cameras () Parameter Type Description result The number of cameras detected Returns the number of cameras detected as connected to the USB ports of the PC. 3.4.5 enumerate_cameras result enumerate_cameras (ident, num_idents) Parameter Type Description ident Handle to an array of CAM_IDENTIFICATION structures where identification...
  • Page 31: Get_Camera_Id

    3.4.6 get_camera_id result get_camera_id (descr) Parameter Type Description descr Handle to descriptive text string or ‘name’ of the camera for which the id is required. result A non-zero value is the id of the camera. Returns the id of a camera with a descriptive text string that matches the application supplied descr string.
  • Page 32: Set_Camera_Description

    3.4.8 set_camera_description result set_camera_description (camera, descr) Parameter Type Description camera The id of the camera for which the descriptive text string is required to be written. settings Handle to application supplied string from where the descriptive text will be copied. result 0 = Operation failed 1 = Operation completed...
  • Page 33: Set_Camera_Settings

    3.4.10 set_camera_settings result set_camera_settings (camera, settings) Parameter Type Description camera The id of the camera. settings Handle application supplied CAMERA_SETTINGS structure. result 0 = Operation failed 1 = Operation completed Writes the application supplied CAMERA_SETTINGS structure to the camera with the specified id.
  • Page 34: Free_Capture

    3.5.2 free_capture result free_capture (capture) Parameter Type Description capture The handle of the capture stream to be freed. result 0 = Operation failed 1 = Operation completed Frees the specified capture stream. This function releases a capture stream previously allocated by a call to alloc_capture and frees it for other tasks.
  • Page 35: Chain_Capture

    3.5.4 chain_capture result chain_capture (capture, dest) Parameter Type Description capture The handle of the source capture stream to be chained. dest The handle of the destination capture stream. result 0 = Operation failed 1 = Operation completed Chains the specified capture stream to a destination capture stream. This function allows the application to ‘chain’...
  • Page 36: Hook_Capture_Callback

    3.5.6 hook_capture_callback result hook_capture_callback (capture, context, pCallback) Parameter Type Description capture The handle of the capture stream. context Application defined parameter that will be passed to the callback routine. pCallback Handle to the user defined callback routine or NULL if the callback is to be disabled. result 0 = Operation failed 1 = Operation completed...
  • Page 37: Capture Stream Setup And Image Data Functions

    3.6 Capture stream setup and image data functions 3.6.1 setup_capture result setup_capture (capture, cam_mode, rate, cam, res, integration_time, gain, capture_type, cam_format, frame_size, adj) Parameter Type Description capture The handle of the capture stream. cam_mode CAM_OPERATI Specifies operation mode for the camera, this ON_MODES should CAM_STANDARD_RES_FULL_SPEED.
  • Page 38: Capture_Occurred

    frame_size A handle to an I32 value in which the resulting size of the image capture data is returned. Handle to a CAPTURE_IMAGE_ADJUSTMENT structure that defines the post-process image adjustments that are to be applied to the colour content of an image. result 0 = Operation failed 1 = Operation completed...
  • Page 39: Copy_Capture_Buffer

    3.6.3 copy_capture_buffer result copy_capture_buffer(capture, buffer, info) Parameter Type Description capture The handle of the capture stream. buffer Handle to an application defined memory area where the image data will be transferred. The format of the data is defined in the call to setup_capture that originally setup the capture stream.
  • Page 40: Get_Capture_Params

    3.6.5 get_capture_params result get_capture_params (capture, params) Parameter Type Description capture The handle of the capture stream to be flushed. params CAPTURE_REQUIREMENT_PARAMS structure. result 0 = Operation failed 1 = Operation completed Reads the parameters previously setup for the specified capture stream. This function reads the parameters from the specified capture stream into the application defined CAPTURE_REQUIREMENT_PARAMS...
  • Page 41: Capture Rendering Functions

    3.7 Capture rendering functions 3.7.1 setup_timer_capture result setup_timer_capture (capture, rate, dest, cam_mode, cam, res, integration_time, gain, adj) Parameter Type Description capture The handle of the capture stream. rate The required frame rate for the capture stream. The frame rate that may be achieved is determined by capture size and integration time and is automatically reduced if it is too high for the current system settings.
  • Page 42: Set_Capture_Render_Config

    content of an image. result 0 = Operation failed 1 = Operation completed Set up a capture stream for automatic rendering to an application defined window. This function is the principle method to setup and configure a capture stream for rendering to an application defined window on a capture channel previously returned by a call to the alloc_capture function.
  • Page 43: Get_Capture_Render_Config

    3.7.3 get_capture_render_config result get_capture_render_config (capture, config) Parameter Type Description capture The handle of the capture stream. config Handle to a CAPTURE_RENDER_CONFIG structure that defines configuration to be used. result 0 = Operation failed 1 = Operation completed Reads the capture rendering function configuration for the capture stream. This function may be used to read the capture rendering functions configuration for the specified capture stream.
  • Page 44: Stop_Capture_Render

    3.7.5 stop_capture_render result stop_capture_render (capture, dest) Parameter Type Description capture The handle of the capture stream to be flushed. result 0 = Operation failed 1 = Operation completed Stops the rendering of an image capture to an application defined window. This function is used to stop the rendering of an image capture previously started by a call to start_capture_render.
  • Page 45: Capture_Overlay

    3.7.6 capture_overlay result capture_overlay (capture, coordinate_type, overlay_type, bitmap_handle, cx, cy, transparent_colour) Parameter Type Description capture The handle of the capture stream to be flushed. coordinate_ty CAPTURE_COORDIN Specifies whether the cy and cy parameters ATE_TYPES relate to captured image pixels or user’s application window pixels.
  • Page 46: Capture_Cursor

    3.7.7 capture_cursor result capture_cursor(capture, coordinate_type, cursor_type, cx, cy, cursor_colour, angle) Parameter Type Description capture The handle of the capture stream to be flushed. coordinate_ty CAPTURE_COORDIN Specifies whether the cy and cy parameters ATE_TYPES relate to captured image pixels or user’s application window pixels.
  • Page 47: Automatic Adjustment Functions

    3.8 Automatic adjustment functions 3.8.1 setup_auto_adjust result setup_auto_adjust (capture, params) Parameter Type Description capture The handle of the capture stream. params Handle CAPTURE_AUTO_ADJUST_PARAMS structure. result 0 = Operation failed 1 = Operation completed Setup the automatic post-process image and exposure adjustment for a capture stream. An application defined CAPTURE_AUTO_ADJUST_PARAMS structure is passed to the params parameter to setup and configure the automatic post-process image and exposure adjustment for a capture stream.
  • Page 48: Hardware Functions

    3.9 Hardware functions 3.9.1 setup_sync result setup_sync (capture, params) Parameter Type Description camera The id of the camera on which the sync hardware is to be configured. sync The 0 based index of the sync signal that is to be configured i.e.
  • Page 49 52 Woodside Business Park Birkenhead Wirral CH41 1EL United Kingdom Tel +44 (0)151 647 3222 Fax +44 (0)151 647 4511 Email: support@deva.co.uk Web : www.deva.co.uk...

Table of Contents