This page provides the documentation of the HALCON 1394IIDC-2 interface which is based on the libdc1394 v2 library via any OHCI compliant IEEE 1394 adapter cards. With this interface you can acquire images from all IEEE 1394 (FireWire) cameras that are compliant to the IIDC 1394 standard. Registered customers can download the latest revision of this interface from the MVTec WWW server.

• Intel compatible PC with Linux x86 or x86_64 operating system and OHCI compliant IEEE 1394 adapter. We recommend to use kernel 2.6.38 or higher.
• The following kernel modules must be loaded: firewire-ohci and firewire-core.
• Read/write access to the devices /dev/fw*.
• Installed system libraries libraw1394 (version 2.0.5) and libdc1394 (version 2.1.2).
• HALCON image acquisition interface hAcq1394IIDC-2.so or hAcq1394IIDC-2xl.so, respectively.
  If you have properly installed the interface, the shared object files should reside in lib/$HALCONARCH within the HALCON base directory $HALCONROOT you have chosen during the installation of HALCON.
• Please note that this interface has been tested on kernel version 2.6.32 and will probably not work with older Linux kernel versions.

• Supports all IEEE 1394a and IEEE 1394b cameras that are compliant to the IIDC 1394-based Digital Camera Specification.
• Synchronous and asynchronous grabbing.
• Multiple cameras.
• External camera triggering.
• Support of scalable image formats (Format_7).
• Software control of all IIDC 1394 parameters.

• Bus reset not supported.
• Format_6 not supported.
• This interface does no more support the old FireWire kernel drivers, i.e., it cannot be used together with devices connected to /dev/raw1394 and /dev/video1394.

Only if you are using the scalable image format (Format_7), you can crop images by changing the used camera sensor size with the following parameters:

• horizontal_offset
• horizontal_resolution
• vertical_offset
• vertical_resolution

Note that because of the smaller used sensor size the frame rate will raise.

Specify the desired video settings in IIDC 1394 notation as a string consisting of the video format (0,1,2,7), the video mode (0,1,2,3,4,5,6,7), and the frame rate (0,1,2,3,4,5), separated by colons. Video format 7 is the scalable image mode; here, the frame rate depends from the chosen image size and the packet_size parameter. For the supported modes and frame rates please see the manual of your specific camera. frame rate:

• 0 = 1.875 fps
• 1 = 3.75 fps
• 2 = 7.5 fps
• 3 = 15 fps
• 4 = 30 fps
• 5 = 60 fps
• 6 = 120 fps
• 7 = 240 fps

format 0

• mode 0 - 160 X 120 YUV(4:4:4) Mode (24bit/pixel) - frame rates 2, 3, 4, 5, 6, 7
• mode 1 - 320 X 240 YUV(4:2:2) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 2 - 640 X 480 YUV(4:1:1) Mode (12bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 3 - 640 X 480 YUV(4:2:2) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 4 - 640 X 480 RGB Mode (24bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 5 - 640 X 480 Y (Mono) Mode (8bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 6 - 640 X 480 Y (Mono16) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7

format 1

• mode 0 - 800 X 600 YUV(4:2:2) Mode (16bit/pixel) - frame rates 1, 2, 3, 4, 5, 6, 7
• mode 1 - 800 X 600 RGB Mode (24bit/pixel) - frame rates 2, 3, 4, 5, 6
• mode 2 - 800 X 600 Y (Mono) Mode (8bit/pixel) - frame rates 2, 3, 4, 5, 6, 7
• mode 3 - 1024 X 768 YUV(4:2:2) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6
• mode 4 - 1024 X 768 RGB Mode (24bit/pixel) - frame rates 0, 1, 2, 3, 4, 5
• mode 5 - 1024 X 768 Y (Mono) Mode (8bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6, 7
• mode 6 - 800 X 600 Y (Mono16) Mode (16bit/pixel) - frame rates 1, 2, 3, 4, 5, 6, 7
• mode 7 - 1024 X 768 Y (Mono16) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6

format 2

• mode 0 - 1280 X 960 YUV(4:2:2) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5
• mode 1 - 1280 X 960 RGB Mode (24bit/pixel) - frame rates 0, 1, 2, 3, 4, 5
• mode 2 - 1280 X 960 Y (Mono) Mode (8bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6
• mode 3 - 1600 X 1200 YUV(4:2:2) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5
• mode 4 - 1600 X 1200 RGB Mode (24bit/pixel) - frame rates 0, 1, 2, 3, 4
• mode 5 - 1600 X 1200 Y (Mono) Mode (8bit/pixel) - frame rates 0, 1, 2, 3, 4, 5, 6
• mode 6 - 1280 X 960 Y (Mono16) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5
• mode 7 - 1600 X 1200 Y (Mono16) Mode (16bit/pixel) - frame rates 0, 1, 2, 3, 4, 5

format 7

• 7:X:0 - Y8
• 7:X:1 - YUV411
• 7:X:2 - YUV422
• 7:X:3 - YUV444
• 7:X:4 - RGB8
• 7:X:5 - Y16
• 7:X:6 - RGB16
• 7:X:7 - Signed Y16
• 7:X:8 - Signed RGB16
• 7:X:9 - RAW8
• 7:X:10 - RAW16

Please note that 'X' is a number, which depends of the supported formats of the camera. Possible values: 0...7.
'default' means to adopt the current settings of the camera.

Note that most of the following parameters (and also the valid parameter values!) depend on the capabilities of the used camera. Additionally, the default values of these parameters depend on the current camera settings.
For many camera features the corresponding parameter (like 'shutter' and 'brightness') allows to set the operation mode of this feature by a string value:

• 'auto' means that the camera controls the value automatically by itself.
• 'manual' activates a feature, which is off.
• 'off' fixes the specified value. In the HDevelop Image Acquisition Assistant you can enable a feature, which is off, by setting it to 'manual'.
• 'one_push' means that the camera controls the value automatically by itself only once and returns to manual setting by integer values. You can request the valid minimal and maximal integer values and the step width required for the manual setting as well as the supported modes of these parameters by calling get_framegrabber_param(...,'<parameter_name>_range',...).
  Other parameters like 'camera_type or 'trigger_mode' support a camera-specific set of values. This set of values can be requested by calling get_framegrabber_param(...,'<parameter_name>_values',...).

There may exist additional read-only parameters with the following postfixes:

• '_description': These parameters provide the tool-tip of the corresponding parameter as a string.
• '_range': These parameters provide the minimum, maximum, step width, and default values for the corresponding integer or float parameter as a tuple with 4 elements, e.g., get_framegrabber_param(..,'Shutter_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'].

All these postfixed parameter names are not returned when calling info_framegrabber(..,'parameters',..) and are used to enable the easy parameterization via a generic graphical user interface, particularly the HDevelop Image Acquisition Assistant.

Not supported by this interface.

Not supported by this interface.

Not supported by this interface.

Not supported by this interface.

Starts a new asynchronous grab. See also grab_image_start.

grab_image starts a new synchronous grab. See also grab_image. Note that the interface converts the image from the device to the desired image format specified by the parameters 'image_width', 'image_height', 'start_row', 'start_column', 'bits_per_channel', and 'color_space'.

grab_image_async returns an image and starts the next asynchronous grab. See also grab_image_async. Note that the interface converts the image from the device to the desired image format specified by the parameters 'image_width', 'image_height', 'start_row', 'start_column', 'bits_per_channel', and 'color_space'.

Not supported by this interface.

Not supported by this interface.

This operator closes the device. See also close_framegrabber.

For this interface there are the following examples available:

• 1394iidc2.hdev - Benchmark.
• 1394iidc2_2cameras.hdev - Concurrent grabbing from two connected cameras.
• 1394iidc2_camera_types.hdev - Query and use all supported camera types.
• 1394iidc2_crop.hdev - Grabbing images using software cropping.
• 1394iidc2_parameters.hdev - Lists all parameters of a device.
• 1394iidc2_register_access.hdev - Example for using direct register access.
• 1394iidc2_simple.hdev - A simple example to show the usage of the interface.

• Revision 5.0 (May 15, 2012):
  • HALCON 11 version of the interface (included in HALCON 11 DVD).
  • Fixed thread safety problem in grab_image and grab_image_async that could occur if a pending grab was aborted via the 'do_abort_grab' parameter of set_framegrabber_param.
• Revision 4.1 (Jul 27, 2011):
  • Adapted to new versions of the underlying system libraries libraw1394 and libdc1394 to support the new FireWire kernel drivers firewire-ohci and firewire-core. Note that the interface currently only works together with the new drivers, i.e., it cannot be used together with devices connected to /dev/raw1394 and /dev/video1394.
  • Added generic parameter 'phy_speed'.
• Revision 4.0 (Mar 17, 2010):
  • HALCON 10 version of the interface (included in HALCON 10 DVD).
  • First official release.