manualshive.com logo in svg

DEVA DEVA028, User Manual

Share
Download
DEVA DEVA028 User Manual Download Page 44

 

 

3.7.5  stop_capture_render 

result stop_capture_render (capture, dest) 

Parameter 

Type 

Description 

capture 

U32 

The 

handle 

of  the  capture  stream  to  be 

flushed. 

result 

U32 

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

. 

 

Summary of Contents for DEVA028

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

Page 2: ......

Page 3: ...ll 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 4: ......

Page 5: ...iver installation 4 3 Software Development Kit 5 3 1 Common definitions 5 3 1 1 Data types 5 3 2 Programming definitions 6 3 2 1 CAM_CLIENT_TYPES 7 3 2 2 CAM_OPERATION_MODES 7 3 2 3 CAM_CAPTURE_TYPES 7 3 2 4 CAM_FORMAT_TYPES 8 3 2 5 CAM_SYNC_TYPES 8 3 2 6 CAPTURE_CONTROL_TYPES 9 3 2 7 CAPTURE_COORDINATE_TYPES 9 3 2 8 CAPTURE_CALLBACK_TYPES 9 3 2 9 CAPTURE_AUTO_ADJUST_MODES 10 3 2 10 CAPTURE_IMAGE_...

Page 6: ...2 CAPTURE_RENDER_CONFIG 20 3 3 13 CAMERA_SETTINGS 20 3 4 Initialisation and camera setup functions 21 3 4 1 open_cam 21 3 4 2 close_cam 21 3 4 3 reset_cam 21 3 4 4 num_cameras 22 3 4 5 enumerate_cameras 22 3 4 6 get_camera_id 23 3 4 7 get_camera_description 23 3 4 8 set_camera_description 24 3 4 9 get_camera_settings 24 3 4 10 set_camera_settings 25 3 5 Capture stream allocation and control functi...

Page 7: ...info 32 3 7 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 35 3 7 4 start_capture_render 35 3 7 5 stop_capture_render 36 3 7 6 capture_overlay 37 3 7 7 capture_cursor 38 3 8 Automatic adjustment functions 39 3 8 1 setup_auto_adjust 39 3 8 2 get_auto_adjust_params 39 3 9 Hardware functions 40 3 9 1 setup_sync 40 ...

Page 8: ......

Page 9: ...ens assembly or within the optional enclosure that is available with a C Mount The camera may be integrated with Deva s motion control products to provide advanced auto focus and measurement features 1 1 Product Features High speed USB 2 0 interface 2048 x 1536 3M pixel colour image Cropping panning skipping and binning modes 6 frames per second at max resolution Flexible capture modes Touch trigg...

Page 10: ...eva office to determine its availability 1 3 1 Windows XP32 Vista32 Windows Driver Model WDM drivers support the DEVA028 colour camera module whilst the Deva capture library functions are exported by a Win32 dynamic link library DLL Both of these items are installed automatically from the Deva software support CDROM when the camera is first installed For software developers the Deva capture librar...

Page 11: ...s or software development 1 4 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: ... functions Demonstration image capture utility software 2 2 System requirements The camera requires an IBM PC compatible Pentium 4 or above recommended running XP32 or Vista32 with one spare USB 2 0 connection 2 2 1 Camera connection An A to mini B cable connects the camera to the PC USB 2 0 port 2 3 Device driver installation Plug n Play software support for Windows XP32 and Vista32 enables simpl...

Page 13: ...st call library routines in the 32 bit camlib dll to access the functions described in this manual from 32 bit Windows applications written in Microsoft Visual Basic Microsoft C Borland Delphi etc Various C header files and Visual Basic modules are provided to enable the developer to interface to the Deva capture library and example source code is provided to illustrate it s use 3 1 Common definit...

Page 14: ... Visual Basic type float single Single F64 64 bit double precision floating point C type Visual Basic type double Double STR handle pointer to character array C type Visual Basic equivalent char Long HDL handle pointer to memory area C type Visual Basic equivalent type Long 3 2 Programming definitions Many of the functions and data structures in the system can accept a limited number of predefined...

Page 15: ...rd resolution at full speed CAM_HIGH_RES_HALF_SPE ED This mode is not currently implemented These values are used by functions such as setup_capture to specify the operating mode for a capture stream 3 2 3 CAM_CAPTURE_TYPES Type Description CAPTURE_STOP The capture stream is reset image captures are no longer triggered and the frame buffer cleared CAPTURE_IMMEDIATE The image capture is triggered e...

Page 16: ...bles in ascending order red green and blue CAM_GREYBYTE There is one greyscale byte per pixel These values specify the different types of format available for the image capture data contained in the frame returned by a call to copy_capture_buffer 3 2 5 CAM_SYNC_TYPES Type Description CAM_SYNC_OFF The specified sync signal is disabled CAM_SYNC_CAPTURE_PUL SE The specified sync signal will pulse on ...

Page 17: ...ES Type Description CAPTURE_COORDINATE_CA M Specifies that the associated values relate to captured image pixels CAPTURE_COORDINATE_WI NDOW Specifies that the associated values relate to user s application window pixels These values are used by functions such as capture_overlay and capture_cursor to determine whether parameter values specified relate to captured image pixels or user s application ...

Page 18: ...age and exposure adjustment 3 2 10 CAPTURE_IMAGE_ADUSTMENT_TYPES Type Description CAPTURE_IMAGE_ADJUSTM ENT_PER_COLOUR The range of pixel values in the red green and blue channel histograms are maximised independently of each other CAPTURE_IMAGE_ADJUSTM ENT_COMBINED_COLOURS The combined red green and blue channel histogram is maximised by applying the same adjustment to each channel The adjustment...

Page 19: ...sor gain and integration time are adjusted from their nominal values The gain would change at twice the rate of integration time with a ratio of 2 0 and at half the rate with a ratio of 0 5 A ratio of 1 0 may be used to specify equal adjustment of each parameter Both parameters are only adjusted within the user specified limits CAPTURE_AUTO_EXPOSUR E_GAIN_AND_INTEGRATION _MIN_TO_MAX The user speci...

Page 20: ...AN DARD A user supplied overlay is applied to the capture stream CAPTURE_OVERLAY_RAW_ HISTOGRAM A histogram representing the pixel data for the raw image data is overlaid on the capture stream CAPTURE_OVERLAY_ADJUS TED_HISTOGRAM A histogram representing the pixel data for the post processed image adjusted data is overlaid on the capture stream These values are used by functions such as capture_ove...

Page 21: ...camera description An array of these structures is returned by the enumerate_cameras function to assist with identification of the one or more cameras connected to the PC 3 3 2 CAPTURE_COLOUR_ADJUSTMENT Parameter Type Description contrast F64 No adjustment is applied to the image when a contrast value of 1 0 is specified Larger smaller values increase decrease the contrast proportionally brightnes...

Page 22: ... I32 The horizontal position of the window centre relative to the centre pixel of the image sensor cy I32 The vertical position of the window centre relative to the centre pixel of the image sensor dx I32 The number of horizontal pixels required in the captured image accounting for current resolution dy I32 The number of vertical pixels required in the captured image accounting for current resolut...

Page 23: ... the application s window ox I32 The horizontal origin of the frame destination within the window oy I32 The vertical origin of the frame destination within the window dx I32 The width of the window dy I32 The height of the window The members of this structure passed in a call to setup_timer_capture define the size and position in pixels of a window on the screen where a capture stream is to be re...

Page 24: ..._MOD ES The operating mode for the capture stream capture_type CAM_CAPTURE_TYPES The trigger event for the capture stream cam_format CAM_FORMAT_TYPES The format of the image capture data res I32 The image resolution x1 x2 x4 values control pixel skip and bin modes If an image capture window of 512x384 is specified with a resolution of 2 then each pair of adjacent pixels is combined so that the res...

Page 25: ..._integration_time F64 The minimum value of integration time that the auto adjustment can employ max_integration_time F64 The maximum value of integration time that the auto adjustment can employ gain_and_intgegratio n_time_ratio F64 The ratio between gain and integration time employed when the exposure mode is CAPTURE_AUTO_EXPOSURE_GAI N_AND_INTEGRATION_RATIO exposure_mode CAPTURE_AUTO_EXP OSURE_M...

Page 26: ...djustment max_threshold F64 Specifies the percentage of pixels to ignore and prevent dark pixels from affecting the adjustment The members of this structure encapsulate the user defined requirement for automatic post process image and exposure adjustment of capture stream 3 3 9 CAPTURE_HISTOGRAM Parameter Type Description total I32 The total number of pixels in the data sum I32 The sum of all the ...

Page 27: ...lue representing the sharpness of the image that may be used to detect focus frame_number U32 The frame number for each capture stream is incremented each time a new capture is triggered on the stream time_stamp U32 The time stamp value ms indicates the time measured from the start of the camera drivers at which the frame capture was triggered num_missed_pixels U32 If there has been an error durin...

Page 28: ... display images where pixels have been lost during the image capture due to an error of some form The members of this structure configure the operation of the capture rendering functions and are passed in a call to set_capture_render_config 3 3 13 CAMERA_SETTINGS Parameter Type Description description STR Ascii null terminated character descriptive text string read from a camera vertical_flip U32 ...

Page 29: ...tion should be called once usually at the start of the application whilst a corresponding call to close_cam is made when the application terminates 3 4 2 close_cam result close_cam Parameter Type Description result U32 0 Operation failed 1 Operation completed Closes the connection to the camera drivers This function should be called when the application terminates 3 4 3 reset_cam result reset_cam ...

Page 30: ... detected as connected to the USB ports of the PC This function fills an application supplied ident array with information about the cameras connected to the PC The num_ident parameter must be set to the number of items in the application supplied array The information returned in the CAM_IDENTIFICATION array includes an id and descriptive text string that may then be used to identify and referenc...

Page 31: ...ed into the camera using the set_camera_description function 3 4 7 get_camera_description result get_camera_description camera descr descr_len Parameter Type Description camera U32 The id of the camera for which the descriptive text string is required descr STR Handle to application supplied string where the descriptive text will be read descr_len U32 The maximum length of the application supplied...

Page 32: ...as and get_camera_id The camera description is also included in the CAMERA_SETTINGS structure referenced by the get_camera_description and set_camera_description functions 3 4 9 get_camera_settings result get_camera_settings camera settings Parameter Type Description camera U32 The id of the camera settings HDL Handle to an application supplied CAMERA_SETTINGS structure result U32 0 Operation fail...

Page 33: ...is to be allocated result U32 0 if operation failed otherwise the handle of the allocated capture stream Allocates a capture stream on the camera with the specified id Currently up to 4 capture streams may operate simultaneously and independently on each camera For example one stream might be high speed low resolution with automatic image and exposure adjustments for a live window on the screen A ...

Page 34: ...s Please see alloc_capture for more information on the allocation and freeing of capture streams 3 5 3 reset_capture result reset_capture capture Parameter Type Description capture U32 The handle of the capture stream to be reset result U32 0 Operation failed 1 Operation completed Resets the specified capture stream This function resets the capture stream aborting any image capture in progress flu...

Page 35: ... capture_control capture control_type Parameter Type Description capture U32 The handle of the capture stream control_type CAPTURE_CONTROL _TYPES Specifies the required control as one of the valid CAPTURE_CONTROL_TYPES result U32 0 Operation failed 1 Operation completed Controls the capture stream Valid CAPTURE_CONTROL_TYPES values passed in the control_type parameter allow the application to play...

Page 36: ...to be disabled result U32 0 Operation failed 1 Operation completed Hooks an application defined callback routine This function hooks or registers an application defined callback routine that will be called when events occur on the capture stream for example when a new image capture has been completed The value passed to the context parameter may be used to pass application specific data to the cal...

Page 37: ...sical pixels on the image sensor The window size relates to the captured image pixels and therefore the physical pixels covered by the image depend on image resolution res I32 The image resolution x1 x2 x4 values control pixel skip and bin modes If an image capture window of 512x384 is specified with a resolution of 2 then each pair of adjacent pixels is combined so that the resulting 512x384 capt...

Page 38: ...e captured at higher speeds Various data format types may be specified by the cam_format parameter so that the image capture data returned by a call to copy_capture_buffer is of the required type The size of the image capture data is returned in the frame_size parameter The default post process brightness and contrast that are to be applied to the colour content of an image are set by the adj para...

Page 39: ... area of sufficient size to receive the image capture data The format of the data is previously defined in the call to setup_capture that setup the capture stream and this functions also returns the required size of the memory area Information about the captured image is stored in an application defined structure passed to the info parameter If the function returns 0 then there is no image capture...

Page 40: ...d capture stream into the application defined CAPTURE_REQUIREMENT_PARAMS structure passed to the params parameter 3 6 6 get_frame_info result get_frame_info capture info Parameter Type Description capture U32 The handle of the capture stream to be flushed info HDL HDL to a CAPTURE_FRAME_INFO structure result U32 0 Operation failed 1 Operation completed Reads the most recent captured image informat...

Page 41: ...ensor This may be used to effectively pan a capture window around the image sensor The window centre relates to physical pixels on the image sensor The window size relates to the captured image pixels and therefore the physical pixels covered by the image depend on image resolution res I32 The image resolution x1 x2 x4 values control pixel skip and bin modes If an image capture window of 512x384 i...

Page 42: ...odes so that lower resolution images may be captured at higher speeds The default post process brightness and contrast that are to be applied to the colour content of an image are set by the adj parameter whilst default camera gain and integration_time are also specified for the stream The setup_auto_adjust function may be used to change these parameters automatically to improve image quality 3 7 ...

Page 43: ...pe Description capture U32 The handle of the capture stream to be flushed dest HDL Handle to a DEST_WINDOW structure that defines the size and position of a window on the application screen where the capture stream is to be displayed result U32 0 Operation failed 1 Operation completed Renders the capture stream to an application defined window This function may be used as an alternative to the set...

Page 44: ...ture U32 The handle of the capture stream to be flushed result U32 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: ...s CAPTURE_OVERLAY_STANDARD cx I32 The horizontal centre of the overlay relative to the centre of the captured image pixels or the user s application window pixels depending on coordinate_type cy I32 The vertical centre of the overlay relative to the centre of the captured image pixels or the user s application window pixels depending on coordinate_type transparent_ colour U32 An RGB colour in the ...

Page 46: ... of the captured image pixels or the user s application window pixels depending on coordinate_type cy I32 The vertical centre of the cursor relative to the centre of the captured image pixels or the user s application window pixels depending on coordinate_type cursor_colour U32 The RGB colour of the cursor angle F64 A cursor rotation angle may be specified result U32 0 Operation failed 1 Operation...

Page 47: ...pture data is received according to the specified requirements If post process exposure adjustment is enabled it is expected that a small number of image captures are performed before stable settings of gain and integration time are calculated for a give image and lighting conditions 3 8 2 get_auto_adjust_params result get_auto_adjust_params capture params Parameter Type Description capture U32 Th...

Page 48: ..._SYNC_PARAMETERS structure result U32 0 Operation failed 1 Operation completed Setup the hardware sync signals on the specified camera An application defined CAPTURE_SYNC_PARAMETERS structure is passed to the params parameter to setup and configure the hardware sync signal specified by the sync parameter on the specified camera The hardware sync signals may be configured to latch or pulse high or ...

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 ...

Reviews:

No comments

Brands by name

Popular brands

Load more brands