HALCON 7.1 Frame Grabber Interface for eneo SC Cameras

This page provides the documentation of the HALCON eneo frame grabber interface for the eneo SC camera series from Videor Technical. Registered customers can download the latest revision of this interface from the MVTec WWW server.

Revision: 2.2

System Requirements

• Intel compatible PC with Windows 2000/XP/Vista

• Camera firmware 3.2.x.

• Windows (remote): Successfully installed ORemoteCamera SDK version 3.2.0.

• Linux (local): HALCON frame grabber interface hAcqeneo.so. If you have properly installed the interface, this shared object should reside in lib/arm-eneo-linux2.6 within the HALCON base directory $HALCONROOT you have chosen during the installation of HALCON.
• Windows (remote): HALCON frame grabber interface hAcqeneo.dll or parhAcqeneo.dll, respectively. If you have properly installed the interface, both DLLs should reside in bin\%HALCONARCH% within the HALCON base directory %HALCONROOT% you have chosen during the installation of HALCON.

Features

• Synchronous and asynchronous grabbing.
• External trigger.
• Software control of shutter time.
• Software control of illumination.

Limitations

• grab_region and grab_region_async not supported.
• No LUTs.

Description

Parameters for open_framegrabber():

	Name		'eneo'		The name of the HALCON frame grabber interface.
	HorizontalResolution		---		Ignored.
	VerticalResolution		---		Ignored.
	ImageWidth		width		The width of the desired image part (note that ImageWidth*ImageHeight must be a multiple of 32). Default: Complete sensor width.
	ImageHeight		height		The height of the desired image part (note that ImageWidth*ImageHeight must be a multiple of 32). Default: Complete sensor height.
	StartRow		0, row		The row coordinate of the upper left pixel within the desired image part. Default: 0.
	StartColumn		0, column		The column coordinate of the upper left pixel within the desired image part. Default: 0.
	Field		---		Ignored.
	BitsPerChannel		8		Number of bits per image channel. Default: 8.
	ColorSpace		'bayer', 'gray', 'rgb'		Specify the desired color space and thus the number of image channels of the resulting HALCON image. Default: Depending on the actual camera 'gray' or 'bayer'.
	Gain		---		Ignored.
	ExternalTrigger		'true', 'false'		Activate/deactivate external triggering. Default: 'false'.
	CameraType		---		Ignored. The camera type is detected automatically depending on the used camera model.
	Device		ip-address[:port]		Remote interface only: Specify the camera via IP address and port. If no port is specified, the standard port 8080 is used.
	Port		---		Ignored.
	LineIn		---		Ignored.

Parameters for set_framegrabber_param():

	'do_abort_grab'		---		Abort the current image acquisition.
	'driver_buffer_size'		min ... max		Sets the buffer size of the camera (in bits). Default: 640*480*3.
	'grab_timeout'		-1, 100 ... 327680		Specifies the desired timeout (milliseconds passed as an integer) for aborting a pending grab. If -1 is specified, the timeout is set to INFINITE. Default: 5000.
	'gain'		min ... max (float)		Specifies the desired gain value.
	'illumination_delay'		0 ... 10000		Specifies the delay of the illumination. Default: 0.
	'illumination_mode'		0, 1, 2		Specifies the mode of the illumination. mode 0: off mode 1: normal mode 2: pulsed Default: 0.
	'illumination_mode_extern'		0, 1, 2		Specifies the external mode of the illumination. mode 0: external off mode 1: positive external signal mode 2: negative external signal Default: 0.
	'illumination_period'		min ... max		Specifies the period of the illumination (in us). Default: 8000.
	'illumination_timing_mode'		0, 1		Enables (1) / disables (0) the auto timing mode of the illumination. If auto timing mode is enabled, the timing value equals the shutter time. If it is disabled, the timing value can be set via the parameter 'illumination_period'. Default: 1.
	'shutter_time'		min ... max		Specifies the desired shutter time (in us) of the camera. Default: 8000.
	'trigger_delay'		min ... max		Specifies the delay of the trigger signal. Default: 0.
	'trigger_signal'		'falling', 'rising'		Specifies the desired type of trigger signal. Default: 'rising'.
	'volatile'		'enable', 'disable'		Grayscale only. In the volatile mode the frame grabber interface buffers are used directly to store HALCON images. This is the fastest mode avoiding to copy raw images in memory. However, be aware that older images are overwritten again and again as a side-effect. Thus, you can only process one image while you grab another image. Older images are invalid! Default: 'disable'.

Parameters for get_framegrabber_param():

Additional parameters supported by get_framegrabber_param only. Note that all parameters supported by set_framegrabber_param except the ones with prefix 'do_' can also be accessed by get_framegrabber_param. Furthermore, corresponding to the parameters supported by set_framegrabber_param, there may exist additional read-only parameters with the following postfixes:

• '_description': These parameters provide the tooltip of the corresponding parameter as a string.
• '_range': These parameters provide the minimum, maximum, stepwidth, and default values for the corresponding integer or float parameter as a tuple with 4 elements, e.g., get_framegrabber_param(..,'exposure_range',..) will return the output tuple [min,max,step,default]. Optionally, this tuple can also contain additional valid string values like 'auto' or 'manual'.
• '_values': These parameters provide the valid value list for the corresponding parameter as a tuple, e.g., get_framegrabber_param(..,'volatile_values',..) will return the output tuple ['enable','disable'].

'image_available'	0, 1	Returns the status of the last asynchronous grab command. The value 1 means that the image is already acquired and thus can be fetched by grab_image_async without delay. Note that this parameter is especially useful in combination with external triggering.
'revision'	revision	The revision number of the HALCON eneo interface.

Release Notes

• Revision 2.2 (Jul 15, 2008):
  
  • First official release of the remote interface for Windows x86.
  • The parameter 'grab_timeout' now supports also the value -1 (infinite timeout).
  • Bugfix in grab_image_start to discard pending grabs.
  • Bugfix in grab_image_async.
  • New parameter 'do_abort_grab'.
  • Default value of parameter 'illumination_mode' changed to 0 (off).
• Revision 2.1 (Apr 23, 2008):
  
  • Adaptation to camera firmware 3.2.0.
• Revision 2.0 (Feb 9, 2007):
  
  • First official release.