AVAL APX-3302 User Manual

APX-3302

User's Manual

APX-3302 User's Manual (OM110000019A)

Notes:

1. Reproduction of the contents of this manual in part or in whole without the permission of the copyright holder is prohibited.

2. Contents of this manual are subject to change without notice.

3. We made assurance doubly sure on the contents of this manual. However, if you find something questionable, incorrect, or omitted, please contact the shop of purchase.

4. Please note that AVAL DATA assumes no responsibility for any effects resulting from the application notwithstanding the article 3 above.

Manufacturer names and product names used in this manual are trademarks or registered trademarks of each company.

APX-3302 User's Manual (OM110000019A)

Before Reading User's Manual

Following symbols and signal words are used in this manual to ensure that our customer can use this product safely and to prevent the harm to persons or property. Fully understand the meanings of these symbols before reading the body of the manual.

WARNING:

Indicates a potentially hazardous situation that can result in death or serious injury if you do not follow instructions.

CAUTION:

Indicates a potentially hazardous situation that can result in minor/moderate injury or property damage if you do not follow instructions.

Indicates a potentially hazardous situation that can result in electric shock if you do not follow the instruction.

Indicates a potentially hazardous situation that can result in injury if you do not follow the instruction.

Indicates a potentially hazardous situation that can result in heat-induced disorder if you do not follow the instruction.

Instructs the operator to pull out the plug of power cable without fail for safety.

Indicates a potentially hazardous situation that can result in smoking or fire if you do not follow the instruction.

APX-3302 User's Manual (OM110000019A)

CAUTION:

◆♦Do not use this product in a watery or humid place. Otherwise it can cause electric shock.

◆ Do not hold the plug of equipment’s power cord with wet hand when connecting it to AC outlet. Otherwise it can cause electric shock.

◆ Do not touch this equipment with wet hand when power cord is connected to AC outlet. Otherwise it can cause electric shock and damage to the equipment.

◆ Pull out the plug of power cord from AC outlet before installing/removing peripheral device. Installing/removing peripheral device with power cord connected to AC outlet can cause electric shock.

◆ Connect the plug of equipment’s power cord to an independent AC outlet with a ground terminal. No connection or loose connection of ground can cause electric shock or malfunction. Many loads on one AC outlet can cause the outlet to overheat and result in fire.

◆ In the case of failure or abnormality, stop the use immediately and let us know at the specified contact address.

◆ Never repair or modify the product by yourself.

APX-3302 User's Manual (OM110000019A)

Table Of Contents

Chapter 1 Precautions ................................................................................................................................ 1

1.1 Handling of the Product ................................................................................................................ 1

1.1.1 Place to use or store the product .................................................................................................... 1

1.1.2 Cautions for use of product ............................................................................................................. 2

1.2 After-Sales Service ....................................................................................................................... 3

1.2.1 User's registration ........................................................................................................................... 3

1.2.2 Customer Support ........................................................................................................................... 4

1.2.3 User’s manual ................................................................................................................................. 4

1.2.4 Serial number .................................................................................................................................. 5

1.2.5 Dealing with occurrence of failure or abnormality .......................................................................... 5

1.2.6 Before connect us ........................................................................................................................... 6

1.2.7 Repair and maintenance service .................................................................................................... 6

1.2.8 In the case of transferring the product to a third party.................................................................... 7

1.3 Disposal Method of the Product .................................................................................................... 7

Chapter 2 General Description ................................................................................................................... 8

2.1 Product Summary ......................................................................................................................... 8

2.2 Feature .......................................................................................................................................... 8

2.3 Specifications ................................................................................................................................ 9

2.4 Block Diagram ............................................................................................................................. 10

2.5 Front Panel .................................................................................................................................. 11

2.6 Connector Pin Assignment .......................................................................................................... 12

2.6.1 CameraLink connector CN1-CN2 ................................................................................................. 12

2.6.2 Expansion connector CN6 ............................................................................................................ 13

Chapter 3 Settings and Interface.............................................................................................................. 14

3.1 Hardware initial setting ................................................................................................................ 14

3.1.1 SW1 setting ................................................................................................................................... 15

3.1.2 SW2 setting ................................................................................................................................... 15

3.1.3 SW3 setting ................................................................................................................................... 15

3.1.4 CN7, CN8 setting .......................................................................................................................... 15

3.1.5 Mount APX-3302 into PCI Express slot ........................................................................................ 16

3.1.6 Cable connection .......................................................................................................................... 17

3.2 Software initial setting ................................................................................................................. 18

3.2.1 What is SDK-AcapLib2 ................................................................................................................. 18

3.2.2 SDK-AcapLib2 installation procedure ........................................................................................... 19

3.2.3 Serial communication driver (virtual COM driver) ......................................................................... 23

3.2.4 Registration Tool ........................................................................................................................... 24

APX-3302 User's Manual (OM110000019A)

3.2.5 Firmware update tool .................................................................................................................... 25

3.2.6 Uninstallation of each software ..................................................................................................... 26

3.2.7 Installation trouble shooting .......................................................................................................... 27

Chapter 4 AcapLib2Viewer Image acquisition ......................................................................................... 28

4.1 What is AcapLib2Viewer ............................................................................................................. 28

4.2 What is ini file .............................................................................................................................. 28

4.3 Image acquisition using AcapLib2Viewer ................................................................................... 29

Chapter 5 Programming guide ................................................................................................................. 34

5.1 AcapLib2 flow chart ..................................................................................................................... 34

5.2 Programming example ................................................................................................................ 35

5.2.1 Snap (one shot snap) .................................................................................................................... 35

5.2.2 Grab (Streaming) .......................................................................................................................... 37

5.3 Sample capture application ......................................................................................................... 39

5.3.1 SimpleApplication ......................................................................................................................... 39

5.3.2 OtherSample ................................................................................................................................. 40

Chapter 6 Function ................................................................................................................................... 42

6.1 CameraLink Configuration .......................................................................................................... 42

6.1.1 How to configure for 2TAP output cameras .................................................................................. 43

6.1.2 How to configure for 3TAP output cameras .................................................................................. 44

6.2 Power Over CameraLink ............................................................................................................. 45

6.3 Camera exposure control signal CC ........................................................................................... 47

6.4 Serial interface ............................................................................................................................ 49

6.5 External signal input .................................................................................................................... 51

6.6 The noise rejection function of external input signal................................................................... 56

6.7 Strobe output ............................................................................................................................... 57

6.8 Timing adjustment of CC output and strobe output .................................................................... 57

6.9 Synchronizing signal between frame-grabbers (SYNCLT) ......................................................... 60

6.9.1 Configuration steps using SYNCLT (Area sensor) ....................................................................... 61

6.9.2 Configuration steps using SYNCLT (Line sensor) ........................................................................ 61

6.10 Encoder input .............................................................................................................................. 69

6.10.1 Encoder input circuit ................................................................................................................... 69

6.10.2 Encoder count timing .................................................................................................................. 70

6.11 Encoder operation method .......................................................................................................... 71

6.11.1 Relative position encoder ............................................................................................................ 71

6.11.2 Absolute position encoder single point ....................................................................................... 73

6.11.3 Absolute position encoder multi point ......................................................................................... 76

6.12 MEGA-FIFO ................................................................................................................................ 84

6.13 Interruption .................................................................................................................................. 87

6.13.1 Event usage ................................................................................................................................ 88

6.13.2 Callback function usage .............................................................................................................. 90

APX-3302 User's Manual (OM110000019A)

6.14 Notes for interrupt event, callback function................................................................................. 94

Chapter 7 Error codes .............................................................................................................................. 96

7.1 Common error codes .................................................................................................................. 96

7.2 Board error code ......................................................................................................................... 99

7.3 Extended error code (Windows) ............................................................................................... 101

7.3.1 Extended error codes returned by driver .................................................................................... 102

7.3.2 Extended error codes related to buffer ....................................................................................... 104

Firmware Update History............................................................................................................................. 105

Revision History........................................................................................................................................... 106

Inquiry .......................................................................................................................................................... 107

-1 -

Chapter 1 Precautions

Thank you for purchasing「APX-3302」 Please read this user's manual thoroughly to ensure the proper use of this product.

Cautions:

If you insert our products to x 16-lane port that is specified for the graphics card on the PC or motherboard, it may not work correctly. These lanes are not in operation guarantee because these lane's specification are not clear, and might be made to be able to maximize the capabilities of the graphics card.

1.1 Handling of the Product

1.1.1 Place to use or store the product

■Do not use this product at a place where it can be subject to spillage of chemicals etc. Spilled chemical on this product can cause short-circuit and result in fire, failure or deformation.

■ Do not use or store the product in a place where it can subject to spillage of liquids such as water and oil, a place exposed to steam, or a place of high humidity. Otherwise it can cause failure of the product.

■ Use or store the product in a flat place with sufficient strength. Do not apply vibration or impact on the product

■ Do not use or store the product in a place exposed to direct sunlight or a place close to fire

or heaters such as stoves. Otherwise, it can cause failure or deformation.

■ Do not use or store the product in a dusty place.

■ Do not use the product at a place close to TV, radio or cordless phone. Otherwise, TV, radio

or cordless phone can sound noise.

■Do not use or store the product at a place close to the equipment generating magnetism or electric wave. Otherwise, it can cause failure of the module.

■ Do not put heavy goods on the product. Otherwise it can cause failure of the module.

■ Do not pour liquid such as water in the product. Otherwise it can cause electric shock.

■ Static electricity can cause failure of the product. Take sufficient preventive measure

against static electricity such as discharging static electricity of human body when handling the module.

APX-3302 User's Manual (OM110000019A)

-2 -

■ Be careful not to get your hand injured by the front or rear surface of the module when handling the product.

1.1.2 Cautions for use of product

■ Precautions for installing procedure of the product

a) Check the switch on the product is set correctly b) After confirming the installation of the product in the system, turn on the power of

the system and check the operation

■ Precautions for removing procedure of the product

a) Be sure to turn OFF the power of the system before removing the product, Otherwise it can cause failure

b) Right after turn OFF the power of the system, the product may be heated to

a high temperature. please handle it with care.

* Refer to the manual for the use of the system

Cautions

Be sure to unplug the power code and turn off the power of the system before installing or removing this product. Otherwise it can cause electric shock.

APX-3302 User's Manual (OM110000019A)

-3 -

1.2 After-Sales Service

1.2.1 User's registration

User's registration is required to use the after sales service. Otherwise, you may not obtain the maintenance service from AVAL DATA.

Select one of the following methods for registration.

Registration on the Website : A maintenance service registration page is in the support homepage of our homepage. A page for maintenance service registration in the support page on AVAL DATA’s homepage.

http://www.avaldata.co.jp/support/regist_user.html

Registration by FAX : Fill out a FAX registration form for maintenance service that is included with shipment.

FAX: 042-732-1032.

AVALDATA handles personal information appropriately and safely. The handling of privacy policy is on the Website below:

http://www.avaldata.co.jp/policy/privacy.html

APX-3302 User's Manual (OM110000019A)

-4 -

1.2.2 Customer Support

For the products inquiries, please contact to the support line below.

Customer service

AVAL DATA CORPORATION (URL http://www.avaldata.co.jp/) Head Quarters / Machida OFFICE SALES DEPARTMENT 1-25-10, Asahimachi, Machida-shi, Tokyo TEL 042-732-1030 FAX 042-732-1032 Business hours ：Monday-Friday 9:00AM-17：00PM(except for a national holiday) E-mail sales@avaldata.co.jp

For the Technical inquiries, please contact to the support line below.

Technical support Line

E-mail support@avaldata.co.jp

1.2.3 User’s manual

A printed manual is not included with the shipment. The manual is provided for download on the

website or provided for the purchase of the Software Development Kit(SDK). It is based on concepts of environmental consideration and providing continuous updates in the ever-changing industry.

AVAL DATA appreciate your understanding.

Download from the Website. * Membership registration is required.

http://www.avaldata.co.jp/support/manual.html

In addition, request a Support Line when it is difficult to download of the manual from the Website. AVAL DATA will send you it in electronic media, such as CD-R.

(The customer is responsible for the shipping cost of the items.)

APX-3302 User's Manual (OM110000019A)

-5 -

1.2.4 Serial number

The serial number of the product is printed on the label on the main unit, the warranty certificate, the box, given each. Location of the serial number label of the product is shown below.

Serial Number

Figure1-1: Location of the serial number label

1.2.5 Dealing with occurrence of failure or abnormality

When the following failure or abnormality occurred on the module, turn off the power of the system immediately and pull out the plug of power cord from AC outlet.

A) When the system smokes or gives abnormal smell B) When the system becomes too hot to touch by hand C) When the system sounds abnormal noise D) When the application that had been functioning correctly malfunctions

Contact to the company of purchase or customer service when failure or abnormality occurred.

APX-3302 User's Manual (OM110000019A)

-6 -

1.2.6 Before connect us

Check the followings in advance when consulting with us for the failure or abnormality of the product

A) Check the following in advance when consulting with us for the failure or abnormality of the product B) Have the Warranty certificate of the module at hand C) Prepare a simple note on the state of failure or abnormality. D) Prepare a note on the environment where the module is used (Hardware/ Software) E) Have the manual of the module at hand.

1.2.7 Repair and maintenance service

・Warranty certificate In case of failure of the product, we will repair the product in accordance with the contents of the

certificate. Refer to the certificate for details.

・Repair parts The minimum holding period of repair parts is 5 years after discontinuation of the product.

APX-3302 User's Manual (OM110000019A)

-7 -

1.2.8 In the case of transferring the product to a third party

A) User who transfers the product Following conditions shall be satisfied when the product is transferred to a third party.

・All attachments to the module (instruction manual, warranty certificate, accessories, etc.)

shall be transferred. No reproduction shall be kept.

・Conditions related to transfer and alienation described in the condition to use that is attached

to each software shall be satisfied.

・The software not permitted for its transfer and alienation shall be deleted before transfer.

B) User to whom the product is transferred

Be sure to inform us of the items necessary for changing the contents of user registration for the case when we send information to our users.

Items necessary for registration:

Warranty certificate number of the main unit, model name, and serial number. The name of company you purchased the used product, its address and phone number

1.3 Disposal Method of the Product

Observe the related ordinances of the local government when discarding the module. Consult with the local government for details.

APX-3302 User's Manual (OM110000019A)

-8 -

Chapter 2 General Description

General description of APX-3302

2.1 Product Summary

APX-3302 is a LowProfile type PCI-Express frame grabber which supports CameraLink interface. On-board mini SDR26 pin connector allows connecting up to two independent CameraLink Base Configuration cameras for each. It has an I/O interface circuit compatible with APX-3312 that provides image acquisition control in conjunction with external devises.

Cautions:

2.2 Feature

Features of APX-3302

・High speed image acquisition by using PCI Express x4 bus (Gen2 2.5GT/s) ・Capable connection to the line camera or area camera that support the CameraLink standard for

Base Configuration

・Capable of connecting up to two cameras ・Capable of synchronous / asynchronous image acquisition between camera ・PoCL function to supply power to the camera ・On-board APX-3312 compatible external I/O interface enables coordination with external device or

generates interrupts

・Strobe timing output allows to notify the exposure timing to external lighting devices ・256MB of on board MEGA-FIFO image buffer for each camera ・RoHS compliant

※MEGA-FIFO architecture

MEGA-FIFO architecture is a structure to store the image data from the camera in large capacity buffer on board temporarily, then it transfers the image data to host memory via the buffer. Hardware offers fastest operation of buffer input by the camera.

(Base Configurationcamera:Max 85MHzx32bit＝340MByte/sec)

It is possible to acquire the image until the buffer capacity is full even the bandwidth of PCI-Express is lower then the frame rate of a camera.

APX-3302 User's Manual (OM110000019A)

-9 -

2.3 Specifications

The specifications of APX-3302 are described as follows.

Item

Specification

Image Input

Two independent Camera Link Base Configuration CameraLink Clock 20MHz to 85MHz

Camera Control

CC output Shaft Encoder Interface On-board UART (communications to camera)

Power over Camera Link (PoCL)

Supported

I/O

Two TTL (trigger input/general-purpose input) Four RS422 (encoder/trigger input) Two Open-Collector (strobe/general-purpose output)

System bus

x4 PCI ExpressTM 2.0 Gen2 (2.5 GT/s)

MEGA-FIFO

DDR2 SDRAM 256MB

Interrupt

Start of acquisition End of DMA Falling edge of general-purpose input

Power Requirements

+12V 0.7A Max(PoCL OFF) +3.3V 0.3A Max

Environment Requirements

Temperature: 0ºC to 50ºC Humidity: 35% to 85% (non-condensing)

Dimension

167.65mm x 68.9mm (Low profile x4 PCI ExpressTM card)

Weight

100g

Software Support

Software Development Kit (SDK-AcapLib2) 32-bit and 64-bit Windows platform

RoHS compliant

Yes

Table2-1:Specifications

APX-3302 User's Manual (OM110000019A)

-10 -

2.4 Block Diagram

The block diagram of APX-3302

AVAL IP

PCI Express

Controller

256MB

DDR2-SDRAM

AVAL IP Memory

Controller

AVAL IP

DMA

Controller

x4 PCI ExpressTM

I/O Connecor

Capture

Controller

Capture

Controller

SDR 26Pin

Ch.1

Ch.2

AVAL IP

CrossPoint BusSwitch

AVAL IP

FIFO

Controller

AVAL IP

FIFO

Controller

AVAL IP

DMA

Controller

Flash

Controller

16MB

Flash-ROM

Camera

Controller

Camera

Controller

Trigger/Encoder

Control

Registers

Ch.6

Figure2-1:Block Diagram

APX-3302 User's Manual (OM110000019A)

-11 -

2.5 Front Panel

The front panel view of APX-3302 is shown below.

Figure2-2:Front panel

An optional PCI standard front panel is provided, replace a front panel according to the type of PC. Panel and board are connected with four of screw lock CameraLink connector.

Figure2-3:Front panel (Standard)

Ch.2

SDR26 pin CameraLink connector HDR-EC26LFDT1-SLD+ （FROM:HONDA TSUSHIN KOGYO）

Ch.1

APX-3302 User's Manual (OM110000019A)

-12 -

2.6 Connector Pin Assignment

This chapter describes connector on APX-3302.

Heat Sink

CN6

I/O connector

CN2

CN1

CameraLink

connector

Figure2-4: Connector layout drawing

2.6.1 CameraLink connector CN1-CN2

CameraLink connector specifications are shown below. Compliant with CameraLink standard Manufacturer : HONDA TSUSHIN KOGYO

Model : HDR-EC26LFDT1-SLD+

Signal

Inner_Shield/+12V

Inner_Shield

CC4-

CC4+

CC3+

CC3-

CC2-

CC2+

CC1+

CC1-

SerTFG+

SerTFG-

SerTC-

SerTC+

X3+

X3-

X_CLK+

X_CLK-

X2+

X2-

X1+

X1-

X0+

X0-

Inner_Shield

Inner_Shield/+12V

Table2-2: CameraLink connector pin assignment

APX-3302 User's Manual (OM110000019A)

-13 -

2.6.2 Expansion connector CN6

The expansion connector is assigned various I/O signal to connect external devices. Specifications are shown below. Manufacturer : OMRON

Model : XG4C-2634

Signal

Description

Signal

Description

GND

Ground

GND

Ground

ExTrg_1

ch1 external trigger input (TTL)

ExTrg_2

ch2 external trigger input (TTL)

Enc. A+

Encoder A phase input (RS422+)

Enc. A-

Encoder A phase input (RS422-)

Enc. B+

Encoder B phase input (RS422+) or ch1 external trigger input (RS422+)

Enc. B-

Encoder B phase input (RS422-) or ch1 external trigger input (RS422-)

Enc. Z+

Encoder Z phase input (RS422+) or ch2 external trigger input (RS422+)

Enc. Z-

Encoder Z phase input (RS422-) or ch2 external trigger input (RS422+)

Diff+

External differential trigger input (RS422+)

Diff-

External differential trigger input (RS422-)

GND

Ground

GND

Ground

N.C 16

N.C

N.C 18

N.C

GP_IN1

Inputs (TTL) in general

GP_OUT1

Outputs (TTL) in general

SYNCLT_OUT

The synchronizing-signal output (TTL) between frame-grabbers

GND

Ground

GP_OUT2

Outputs (TTL/OC) in general

SYNCLT_IN

The synchronizing-signal input (TTL) frame-grabbers

IN_RES1

Inputs (TTL) in general

OUT_RES1

Outputs (TTL/OC) in general

Table2-3: Expansion connector is assignment

AVAL DATA prepares from expansion connector to expansion panel cable ”CBL-Z091A” wired PCI standard panel.

OUT_RES1 cannot be used by APX-3302.

APX-3302 User's Manual (OM110000019A)

-14 -

Chapter 3 Settings and Interface

This chapter describes initial settings for Hardware and software of APX-3302.

3.1 Hardware initial setting

Set up the jumper and switch correctly before installing this product to the PC or devices.

Figure3-1: jumper, switch layout drawing

Be sure to turn OFF the power of the system before change jumper or switch settings.

SW2

SW1

CN7

CN8

SW3

APX-3302 User's Manual (OM110000019A)

-15 -

3.1.1 SW1 setting

SW1 should be used in OFF anytime.

3.1.2 SW2 setting

SW2 sets up Pull-Up as a general-purpose output.

Cut Pull-Up resistor off by OFF then connect Pull up by ON

Pull-Up resistor: 330Ω The relation between the switch and signals is shown below

Figure3-2: SW2 setting

SW2 is set as OFF, all Pull-up resistors are separated and are set as the open collector output in default setting.

3.1.3 SW3 setting

SW3 should be used in OFF anytime.

3.1.4 CN7, CN8 setting

Set up the validity or invalidity of PoCL function according to the channel of camera. PoCL is valid in ON and is invalid in OFF. CN7 corresponds to ch1 of camera and CN8 corresponds to ch2 of camera.

Figure3-3: CN7, CN8 setting

CN7 and CN8 are set as ON and PoCL function is valid in default setting.

* In order to use a PoCL function, it is necessary to control feeding power not only by this setting but also by software. Refer to [6.2 Power over CameraLink] for the details.

1 2 3 4

O N

SW2

SW2-1: General-purpose output -1 GP_OUT1 SW2-2: Reserved General-purpose output-1 OUT_RES1 SW2-3: General-purpose output -2 GP_OUT2 SW2-4: (Unused)

CN7/CN8

1 3 OFF

APX-3302 User's Manual (OM110000019A)

-16 -

3.1.5 Mount APX-3302 into PCI Express slot

Please note following points in addition to the instructions of the system when mounting or removing this product to the system with the PCI Express connector.

- Notes

a) Mount APC-3302 into PCI Express x4 or more slot. b) It is compliant with Gen1, Gen2.

- Notes for mounting APX-3302 into the system

a) Make sure that all jumpers of APX-3302 are set correctly. b) Insert it into the PCI Express slot straight without adding the extra power at this time.

Otherwise, it can cause of failure or damage the parts on the module by getting stuck with the input/output terminals assigned on the panel.

Check a connector of module on the PCI slot and a connector of the system are connected correctly.

c) After insert it into PCI slot, fix it with panel fixation screw tightly. Turn ON the power source of the system and check the operation after checking it is mounted into the

system.

- Notes for removing APX-3302 from the system

a) Be sure to turn OFF the power source of the system before removing it. it can cause of failure. Be cautious it becomes extremely hot soon after the power source OFF. b) Unfix panel fixing screw and remove it without touching the parts on a module and adding

the extra power. It can cause damage to a module or the connector of the system.

c) If it is getting stuck with the input/output terminals assigned on the panel when removing it, do not

remove by force, it can cause of failure.

PCI Express slot（x4 and over）

APX-3302

After insert APX-3302 into PCI slot, fix between a panel and case with fixation screw tightly.

Figure3-4: Insert into PCI Express slot

APX-3302 User's Manual (OM110000019A)

-17 -

3.1.6 Cable connection

Description of basic connection method of APX-3302 is shown below.

- Connect between APX-3302 to camera using the cable which is compliant with CameraLink standard.

- In the case of connecting between APX-3302 to an external device, use expansion cable CBL-Z091A. Refer to the cable pamphlet for the detail specification of CBL-Z091A.

Heatsink

CN51

CameraLink camera

Commercially available cable for CameraLink

Expansioncable

CBL-Z091A

External trigger

General purpose I/O

Figure3-5: Connection diagram of the power source connector and expansion cable.

Attention

The expansion cable is compliant with PCI standard panel. In the case of using I/O function on the PC which is compliant with Low profile, please contact us.

APX-3302 User's Manual (OM110000019A)

-18 -

3.2 Software initial setting

In order to control APX-3302, install SDK-AcapLib2.

3.2.1 What is SDK-AcapLib2

SDK-AcapLib2 (Software Development Kit AvalCaptureLibrary2) is a software package used for controlling many models of frame-grabbers including APX-3302. The followings are contained in SDK-AcapLib2.

■ Aval Capture Library 2 (hereafter referred as AcapLib2) AcapLib2 is a library which enables control of various models of frame-grabbers with a common interface.

■ Drivers for various models of frame-grabbers The driver for various models of frame-grabbers including APX-3302

■ Sample source Capture sample (VC++ / VC# / VB.NET) which supports any languages Sample for connecting various types of image-processing library

■ Tool AcapLib2Viewer, virtual COM tool, firmware update tool, line profile tool, AZP-8100-01 (image-processing tool).

■ Camera-setting (ini) file A file used for initial setting on frame-grabber side against the camera which has a connection record.

■ Document Manuals, installation instructions, sample documents.

APX-3302 User's Manual (OM110000019A)

-19 -

3.2.2 SDK-AcapLib2 installation procedure

Installation procedure of SDK-AcapLib2 is shown as below.

[Method 1] The web pages as below is be displayed when a install disc is set to CD-ROM/DVD-ROM drive, [software] from a menu.

Figure3-6: Web page

Precautions before installation

■ Check whether the frame-grabber is mounted in the PC before starting installation.

■ Check [DMA Master] is selected as [ON (YES)] on a BIOS screen. (*)

■ When you log in, the user name should be "Administrator" or "user name authorized to install driver and

others.

■ Cannot use the standby (ACPI S1/S3 mode) which has power saving function.

Turn sleeping state / hibernation off by using inside CD-ROM [Manual]-[Windows system standby cancellation procedure].

■ It does not support about for using 3G option in 32bit OS. AVAL DATA recommends using it by removing 3G option.

■ It is not supporting Windows XP Mode and Windows XP compatibility mode of Windwos7.

■ If the another version is installed already, be sure to install SDK-AcapLib2 after uninstalling it.

Refer to [3.2.6. Uninstallation of each software] for the procedure of uninstallation.

(*) Setting contents above may not included depending on the PC. If not, please disregard them.

APX-3302 User's Manual (OM110000019A)

-20 -

[Method 2] Click [install] at the side of [SDK-AcapLib2].

Figure3-7: Software

[Method 3] Select [run] on [File download] is displayed.

Figure3-8: Download of a file

[Method 4] Click [Install]. *NOTE: If another version is already installed, [Uninstall] becomes effective.

You can continue to uninstall if the same version is used. However if the version is different, the warning will

appear at the time.

Figure3-9: Menu

APX-3302 User's Manual (OM110000019A)

-21 -

[Method 5] Select [Browse] and chose other folder if you change the installation folder. Select [OK] if you do not need to change any settings.

Figure3-10: Installation item

[Method 6] When you check [Library] at installation selection, "Device Driver Installation Wizard" starts automatically. Follow instruction s and continue installing.

Figure3-11: Library installation

[Method 7] When you check [Registration] at installation selection, "AVALDATA Registration Tool" starts automatically. When the product key is included, select [Product version], then input product key and select [OK]. Refer to [3.2.4 Registration Tool] for the details.

Figure3-12: Software registration

APX-3302 User's Manual (OM110000019A)

-22 -

[Method 8] When you check [TransFlyer (For_CoaXPress)] at installation selection, "AVALDATA TransFlyer" starts automatically. Follow instruction s and continue installing. * It is not necessary to install this software other than CoaXPress frame-grabber.

Figure3-13: TransFlyer installation

[Method 9] Finish application by clicking " Finished"

Figure3-14: Completion

APX-3302 User's Manual (OM110000019A)

-23 -

[Method 10] Click Quit then the installation is finished.

Figure3-15: Menu

Press [Quit] to finish the installation.

3.2.3 Serial communication driver (virtual COM driver)

Virtual COM is a software which has the function to assign each camera link port of AVALDATA’s frame-grabber as a virtual COM port on Windows. It enables communicate from standard COM port on Windows to the camera.

Use virtual COM tool to assign virtual COM. Execute from Start [AVALDATA]=>[SDK-AcapLib2] =>[Tool]=>[VirtualCOM]=>[avdCOMmng]

Refer to a virtual COM tool user's manual(SDK-AcapLib2 VirtualComTool Manual (J2OM10016*).)for the installation or uninstallation procedure.

Figure3-16: Virtual COM tool

APX-3302 User's Manual (OM110000019A)

-24 -

3.2.4 Registration Tool

When you using a library, it is necessary to perform registration to PC using "Registration Tool." There is no case that the function takes restriction when it is used without registration. However the message, which tells that registration is not completed, will appear when the function of specific library is called,

Figure3-17: Unregistered message

■ Registration method

Description of the registration method is shown below.

[Method 1] Execute Start [AVALDATA]=>[SDK-AcapLib2] =>[Tool]=>[Registration]=>[AvdRegistTool]

[Method 2] Select [Product version]. then, enter 16 digit product key indicated on the yellow seal which attached to an install disc. Click [OK], when finished entering.

Figure3-18: Registration Tool and a product key

APX-3302 User's Manual (OM110000019A)

-25 -

[Method 3] Registration is completed if this message is appears.

Figure3-19: Registration success

3.2.5 Firmware update tool

Firmware update tool is the application for updating local FPGA firmware of APX-3302. It has the firmware update function as well as software switch setting function.

Execute Start [AVALDATA]=>[SDK-AcapLib2] =>[Tool]=>[FirmwareUpdateTool]=>[FirmwareUpdateTool]

Refer to Firmware update tool user's manual (SDK-AcapLib2 FirmwareUpdateTool Manual(J3OM10026*) for the procedure of this application.

Figure3-20: Firmware update tool

APX-3302 User's Manual (OM110000019A)

-26 -

3.2.6 Uninstallation of each software

■ Uninstalling Virtual COM Driver

[Method 1] Execute [Start] =>[AVALDATA]=>[SDK-AcapLib2] =>[Tool]=>[VirtualCOM]=>[avdCOMmng]

[Method 2] Cancel all assignment of COM. Refer to Virtual COM tool user's manual (SDK-AcapLib2 VirtualComTool Manual (J2OM10016*)) for the details.

[Method 3] Select [Control Panel] - [Management Tool]-[Management of computer]-[Device manager]

[Method 4] Right-click [AVALDATA Virtual COM Port (COM*)] in [Port (COM and LPT)], then select [delete]

[Method 5] Click "OK" after "check of device deletion" box appeared.

Figure3-21: Device manager

APX-3302 User's Manual (OM110000019A)

-27 -

■ Uninstallation of device driver and SDK-AcapLib2

[Method 1] Execute following programs.

[Start] =>[Control panel] => [Addition or deletion of program]

<WindwosVista> [Start] => [Setting] =>[Control panel] => [Uninstall a program]

[Start] => [Control panel] => [Uninstall a program]

[Method 2] Select [AVALDATA SDK-AcapLib2] and delete it.

Figure3-22: Uninstallation of a program

[Method 3] Close a program above once, execute a program again and uninstall if the following items remain.

- [AVALDATA Capture Library 2]

- [Windows driver package - AVAL DATA CORPORATION Aip (apx***)] (****)

- [AVAL DATA TransFlyer]

3.2.7 Installation trouble shooting

Check following points, if any problem occurs during installation.

・ Check whether the hardware is connected correctly again. ・ Check whether the same problem occurs when you mount APX-3302 into other PCI Express slot ・ Refer to [Precautions befor installation]

APX-3302 User's Manual (OM110000019A)

-28 -

Chapter 4 AcapLib2Viewer Image acquisition

This chapter describes the procedure until acquire images using APX-3302 and AcapLib2Viewer.

4.1 What is AcapLib2Viewer

AcapLib2Viewer is the software for acquiring images using the many models of frame-grabbers including APX-3302. Main functions of AcapLib2Viewer are shown below.

■ Frame-grabber initialization

Setting of Capture size, Shutter trigger, External trigger, Encoder, etc

■ Acquire images using the camera

Snap (One shot snap), AutoSnap (continuous snap-shot), and Grab (streaming) can be performed.

■ Display acquired images

Display enlarged, reduced, the same magnification images. Moreover, display the luminance value of specified pixels.

■ File output of acquired image

Output acquired images into various image formats such as (bmp, csv, bin, jpg, gif, tif, png).

■ Initialization file (ini file) output

Output each settings of AcapLib2Viewer as the ini file.

4.2 What is ini file

An ini file is a file which stored various setting points, such as capture size, shutter trigger, external trigger, and encoders. It can perform initialization of AcapLib2Viewer and AcapLib2. Moreover, ini file which can perform basic capturing is including in the SDK-AcapLib2 for the cameras which has tested with frame-grabber.

Latest ini file is available to downloadable from [supported camera information] in the Web site.

[supported camera information] * Japanese version only available

http://www.avaldata.co.jp/products/z2_imaging/supportcamera/camera.html

APX-3302 User's Manual (OM110000019A)

-29 -

4.3 Image acquisition using AcapLib2Viewer

Procedures until acquire images using AcapLib2Viewer. Refer to [SDK-AcapLib2 Viewer Manual (J2OM08014*)] for the detailed setting method.

[Method 1] Select [All programs] from the start menu of Windows.

Figure4-1: Start menu

[Method 2] Select AcapLib2Viewer in [AVALDATA]-> [SDK-AcapLib2]

Figure4-2: All the programs

APX-3302 User's Manual (OM110000019A)

-30 -

[Method 3] Select each item when a dialog appears which can be selected ini file, Board (frame-grabber) name, Board (frame-grabber) ID number, input channel.

Figure4-3: Board selection Figure 4-4: Board ID number selection

Figure4-5: Input-channel selection

■ Board ID number

Board ID number is a number which can be identified a solid when two or more APX-3302 are mounted into one PC. It is set as 0 at in the default. It can be changed into any value by using [Firmware Update Tool].

[Method 4] ini file selection dialog appears when click [Load]

Figure4-6: Check dialog for the board

APX-3302 User's Manual (OM110000019A)

-31 -

[Method 5] Select ini file of the camera be used from ini file by some camera manufactures in the folder. [SDK-AcapLib2 install folder] ->[AVALDATA]->[SDK-AcapLib2] ->[Sample]->[IniFile]

Figure4-7: Ini file selection dialog

[Method 6] Click [OK] after choosing ini file. Click [OK] then, initialize with ini file selected.

Figure4-8: Check dialog for the board

APX-3302 User's Manual (OM110000019A)

-32 -

[Method 7] The main window will be displayed when the initialization is successful. Click a camera icon in the red frame, one shot snap will be performed.

* A camera shall be set as a factory-shipments state, free run, and the power source shall be ON.

Figure4-9: Main window

APX-3302 User's Manual (OM110000019A)

-33 -

[Method 8] The acquired image, image acquisition time, frame rate will appear when the image acquisition succeeded.

Figure4-10: Acquired image

Error code with error dialog as below will appear when the image acquisition failed. Mis-setting of the frame-grabber or the camera, mis-connecting of the cable, input omission of external triggers or encoders, etc can cause of failure. Refer to [Chapter7 Error code] for the details.

Figure4-11: Error dialog

APX-3302 User's Manual (OM110000019A)

-34 -

Chapter 5 Programming guide

This chapter describes the programming procedure using AcapLib2 is shown below.

5.1 AcapLib2 flow chart

Processing procedure using AcapLib2

Figure5-1: Flow chart

// Get the board information AcapGetBoardInfo function // Open device AcapOpen function // Reading ini file AcapSelectFile

- Open frame-grabber, get information and initialize using ini file.

(1)

Initialization

(2)

Settings

// Get the setting value of the board AcapGetInfo function // Board setting AcapSetInfo function

- Set up shutter trigger(CC) or external interface(encoder). The setting specified with setting ID.

(3)

Buffer registration

(5)

Setting reflection

(4)

Event registration

// Buffer registration AcapSetBufferAddress function

- Set up the buffer to transfer of acquired image.

// Setting reflection AcapReflectParam function

- Reflect the settings from (2)-(4) into hardware or driver.

// Event registration AcapSetCallbackEvent function // Callback registration AcapRegistCallback function

- Resist the event or callback function when the system receiving the interrupt notification which related image acquisition.

(6)

Acquisition

// Start image acquisition AcapGrabStart function // Stop image acquisition AcapGrabStop function

- Transfer to the buffer after input the image data from a camera.

(7)

End processing

// Close board AcapClose function Close AcapLib2 after opening each resource.

APX-3302 User's Manual (OM110000019A)

-35 -

5.2 Programming example

The programming examples for Snap (one shot snap) and Grab (streaming) for each are shown as below. GUI, such as a screen display or a dialog is not used. Moreover, error processing is not be performed here either. The program is premised on being the following conditions.

Board : AVAL DATAs frame-grabber which found first by Windows,

if two or more frame-grabbers are mounted Ini file : Default.ini (*) Ini file path: Hierarchy with a project file or an executable file

(*) The main settings of Default.ini is as follows.

Input size : 640x480 XY delay : (x, y) = (0, 0) Processing bit : 8 bits

External trigger, random shutter: Invalid

5.2.1 Snap (one shot snap)

The programming example of Snap (one shot snap) is shown as below.

#include <stdio.h> #include <conio.h> #include "AcapLib2.h" #pragma comment(lib, "AcapLib2.lib")

#define INPUT_CH 1 #define CAM_LINE 1

int main(int argc, char *argv[])

{ HANDLE hDev;

int nXSize, nYSize, nBoardBit;

int nLoop = 1, nData = 0; int nCycle = 0, nScan = 0; int nCamera = 0; PUCHAR pUserBuffer = NULL; ACAPBOARDINFO abi;

// Get board information

AcapGetBoardInfo (&abi);)

// Open device

hDev = AcapOpen(abi.BOARDINDEX[0].pBoardName,

abi.BOARDINDEX[0].nBoardID, INPUT_CH); // Initialize by ini file. AcapSelectFile(hDev, INPUT_CH, "Default.ini", 0);

APX-3302 User's Manual (OM110000019A)

-36 -

// Check camera type AcapGetInfo (hDev, INPUT_CH, ACL_SCAN_SYSTEM, 0, &nCamera);) if(nCamera == CAM_LINE){

// If the camera is Line sensor, confirm that exposure setting is performed. AcapGetInfo (hDev, INPUT_CH, ACL_EXP_CYCLE, 0, &nCycle);) AcapGetInfo (hDev, INPUT_CH, ACL_EXPOSURE, 0, &nScan);) if((nCycle == 0) || (nScan == 0)){

printf ("exposure setting out is injustice ¥n");

return 0;

}

// Setting for performing DMA to the buffer.

AcapGetInfo (hDev, INPUT_CH, ACL_X_SIZE, 0, &nXSize);) AcapGetInfo (hDev, INPUT_CH, ACL_Y_SIZE, 0, &nYSize);) AcapGetInfo (hDev, INPUT_CH, ACL_BOARD_BIT, 0, &nBoardBit);) AcapSetInfo(hDev, INPUT_CH, ACL_MEM_NUM, 0, 1); pUserBuffer = (PUCHAR)_aligned_malloc(nXSize * nYSize * (nBoardBit / 8), 16); ZeroMemory(pUserBuffer, nXSize * nYSize * (nBoardBit / 8)); AcapSetBufferAddress(hDev, INPUT_CH, ACL_IMAGE_PTR, 1, pUserBuffer); printf ("in order to suspend an input, please input some keys ¥n");

do{

// Snap

AcapGrabStart(hDev, INPUT_CH, 1); // Stop capturing AcapGrabStop(hDev, INPUT_CH); Sleep(1);

// Dump the data of (x, y) = (100, 100)

nData = pUserBuffer[100 + 100 * nXSize]; printf ("taking-in number of sheets : %4d data (100, 100) : %3d¥n", nLoop++, nData); }while(!kbhit()); printf ("¥n which suspended the input");

// Close device

AcapClose(hDev, INPUT_CH);

// Release the buffer

if(pUserBuffer != NULL){ _aligned_free(pUserBuffer); pUserBuffer = NULL; } return 0; }

APX-3302 User's Manual (OM110000019A)

-37 -

5.2.2 Grab (Streaming)

The programming example of Grab (Streaming) is shown as below.

#include <stdio.h> #include <conio.h> #include "AcapLib2.h" #pragma comment(lib, "AcapLib2.lib")

#define INPUT_CH 1 #define CAM_LINE 1

void CALLBACK GrabCallbackFunc(int nChannel, DWORD dwEvent, int nParam1, int nParam2);

PUCHAR pUserBuffer[4];

int nXSize, nYSize, nBoardBit; int main(int argc, char *argv[])

{ HANDLE hDev; int nCount; int nCamera; int nCycle, nScan; DWORD dwEventMask; ACAPBOARDINFO abi;

// Get board (frame-grabber) information

AcapGetBoardInfo (&abi);)

// Open device

hDev = AcapOpen(abi.BOARDINDEX[0].pBoardName, abi.BOARDINDEX[0].nBoardID, INPUT_CH); // Initialize by ini file. AcapSelectFile(hDev, INPUT_CH, "Default.ini", 0);

// Check camera type AcapGetInfo (hDev, INPUT_CH, ACL_SCAN_SYSTEM, 0, &nCamera);) if(nCamera == CAM_LINE){

printf ("exposure setting out is injustice ¥n");

return 0;

}

// Set the number of memory as 4 frames for each ch

AcapSetInfo(hDev, INPUT_CH, ACL_MEM_NUM, 0, 4);

APX-3302 User's Manual (OM110000019A)

-38 -

// ch1: Setting for performing DMA to the buffer. AcapGetInfo (hDev, INPUT_CH, ACL_X_SIZE, 0, &nXSize);) AcapGetInfo (hDev, INPUT_CH, ACL_Y_SIZE, 0, &nYSize);) AcapGetInfo (hDev, INPUT_CH, ACL_BOARD_BIT, 0, &nBoardBit);) for(nCount= 0; nCount < 4; nCount++){ pUserBuffer[nCount] =

(PUCHAR)_aligned_malloc(nXSize * nYSize * (nBoardBit / 8), 16);

ZeroMemory(pUserBuffer[nCount], nXSize * nYSize * (nBoardBit / 8));

// Set nMemnum as negative value, for suspending reflection of setting at end.

AcapSetBufferAddress(hDev, INPUT_CH, ACL_IMAGE_PTR,

(nCount + 1)*(-1), &pUserBuffer[nCount][0]);

}

// Reflect configuration parameter

AcapReflectParam(hDev, INPUT_CH);

// Register callback function // ch1: Register ACL_INT_FRAMEEND (Frame decision interruption)

dwEventMask = ACL_INT_FRAMEEND; AcapRegistCallback(hDev, INPUT_CH, dwEventMask, GrabCallbackFunc);

// Grab start

printf ("in order to suspend an input, please input some keys ¥n"); AcapGrabStart(hDev, INPUT_CH, 0);

do{ Sleep(1); }while(!kbhit());

// Grab stop

AcapGrabStop(hDev, INPUT_CH); printf ("¥n which suspended the input");

// Close device

AcapClose(hDev, INPUT_CH);

// Release the buffer

for(nCount = 0; nCount < 4; nCount++){ if(pUserBuffer[nCount] != NULL){ _aligned_free(pUserBuffer[nCount]); pUserBuffer[nCount] = NULL; } }

return 0; }

//callback function

void CALLBACK GrabCallbackFunc(int nChannel, DWORD dwEvent, int nParam1, int nParam2)

{ int nIndex; int nData;

switch(dwEvent){ case ACL_INT_FRAMEEND: //Processing of Frame decision interruption

// Dump the data of (x, y) = (100, 100)

nData = pUserBuffer[nParam2-1][100 + 100 * nXSize]; printf ("taking-in number of sheets : %4d data (100, 100) : %3d¥n",

nParam1, nData); break; } }

APX-3302 User's Manual (OM110000019A)

-39 -

5.3 Sample capture application

The capture sample applications for each programming languages, the samples for connecting various types of image-processing library are prepared within AcapLib2.

5.3.1 SimpleApplication

The capture sample applications for each programming languages using AcapLib2 It is stored in the folder as below.

[Capturing sample using AcapLib2]

-[SDK-AcapLib2 install destination]=>[AVALDATA]=>[SDK-AcapLib2]=>[Sample]=>[SimpleApplication]

Figure5-2:SimpleApplication

[SimpleApplication]

Folder

Sample contents

VB.net

VB.net capture sample using AcapLib2.

VB6.0

VB6.0 capture sample using AcapLib2.

VC#

VC# capture sample using AcapLib2.

VC++

VC++ capture sample using AcapLib2. Including free run, random shutter, external trigger.

* 64bitOS is not supported except VC++ sample.

Table5-1:SimpleApplication

APX-3302 User's Manual (OM110000019A)

-40 -

5.3.2 OtherSample

The samples for connecting AcapLib2 with various types of image-processing library It is stored in the folder as below.

[Connecting samples using various types of image-processing library]

- [SDK-AcapLib2 install destination] =>[AVALDATA] =>[SDK-AcapLib2] =>[Sample]=>[OtherSample]

Figure5-3:OtherSample

APX-3302 User's Manual (OM110000019A)

-41 -

Following samples are contained in folder Refer to a manual of each sample for capturing samples when using other manufacture’s library. [SDK-AcapLib2 install destination] =>[AVALDATA] =>[SDK-AcapLib2] =>[Doc] =>[6_Technical]

[OtherSample]

Folder

Sample contents

AcapLib2Bayer

VC++ sample which captures the image by AcapLib2 then performs bayer conversion.

APX-742

VC++ sample for image distribution with "APX-742."

CVL

A sample which captures the image by AcapLib2 then performs image processing in CVL.

eVision

VC++ sample which captures the image by AcapLib2 then performs image distribution in eVision.

FVX

VC++ sample which captures the image by AcapLib2 then performs image processing in FVX.

HALCON

VC++ sample which captures the image by AcapLib2 then performs image distribution in HALCON.

MIL

VC++ sample which captures the image by AcapLib2 then performs image distribution in MIL.

OpenCV

VC++, CLI sample which captures the image by AcapLib2 then performs image processing in OpenCV.

PSM-3318-02AD01

VC++ sample which performs image distribution in with "PSM-3318-02."

Sapera

VC++ sample which captures the image by AcapLib2 then performs image processing in Sapera.

Serial

VC++ which performs serial communication across the camera.

VisionPro

VB.net sample which captures the image by AcapLib2 then performs image processing in VisionPro.

Wil

VC++ sample which captures the image by AcapLib2 then performs image processing in WIL.

* 64bitOS is not supported except samples AcapLib2Bayer and PSM-3318-02AD01.

Table5-2:OtherSample

APX-3302 User's Manual (OM110000019A)

-42 -

Chapter 6 Function

This chapter explains the function of APX-3302 and the examples how to use AcapLib2.

6.1 CameraLink Configuration

APX-3302 can acquire image from the camera corresponding to CameraLink Base Configuration. APX-3302 can connect up to two cameras and it carries 26PinSDR connector. The CameraLink input circuit is independent for each camera, so APX-3302 can connect with two cameras even if they are different models like area sensor camera and line sensor camera.

The graphics format that can be acquired by APX-3302 is as follows.

- 8bit x1tap Monochrome

- 8bit x2tap Monochrome

- 8bit x3tap Monochrome

- 10-16bit x1tap Monochrome

- 10-12bit x2tap Monochrome

- 24bitRGB x1tap Color

APX-3302 has pix rearrangement function for the cameras that have two or more tap outputs camera image. APX-3302 corresponds to 20 MHz - 85 MHz clock. (Receiver is DS90CR288 manufactured by N.S Company.) The CameraLink synchronizing-signal timing that can be acquired by APX-3302 is as follows.

FVAL

LVAL

FVAL"H" to LVAL"H"＝0clk(min)

LVAL"L" period＝1clk(min)

FVAL"L" period＝1clk(min)

Figure6-1: CameraLink synchronizing signal

APX-3302 User's Manual (OM110000019A)

-43 -

6.1.1 How to configure for 2TAP output cameras

■ The setting example for software The sample code for 2TAP output cameras is as follows. In this example, the data from camera is outputted in following order.

LVAL

Tap1

1024pixels Per 1 Line

Tap2

1024

1023 3 4

1022

1021

509

510

516

515

511

512

514

513

Figure6-2: Before rearrangement

514

Data

1 2 1024

1023

1022

511

512

513

Figure 6-3: After rearrangement

// Configuration of tap number

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_NUM, -1, 2)

// Configure rearranging method as all taps independent

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_ARRANGE, -1, 1)

// Configure the rearrangement direction as "-><-."

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_DIRECTION, -1, 0) AcapSetInfo(hDev, INPUT_CH, ACL_TAP_DIRECTION, -2, 1)

// Disable Line reverse function

AcapSetInfo(hDev, INPUT_CH, ACL_LINE_REVERSE, -1, 0)

// Configure the X direction delay of LVAL as 0

AcapSetInfo(hDev, INPUT_CH, ACL_LVAL_DELAY, -1, 0)

// Configure the whole pixel number from camera for 1 line

AcapSetInfo(hDev, INPUT_CH, ACL_ARRANGE_XSIZE, -1, 1024)

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-44 -

6.1.2 How to configure for 3TAP output cameras

■ The setting example for software The sample code for 3TAP output cameras is as follows. In this example, the data from camera is outputted in following order.

LVAL

Tap1

1536pixels Per 1 Line

Tap2

513

514

515

516

509

510

1021

1022

511

512

1023

1024

Tap3

1025

1026

1027

1028

1533

1534

1535

1536

Figure6-4: Before rearrangement

1023

Data

1 2 1534

1025 3 1024

511

512

513

1536

1535

Figure 6-5: After rearrangement

// Configuration of tap number

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_NUM, -1, 3)

// Configure rearranging method as all taps independent

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_ARRANGE, -1, 1)

// Configure the rearrangement direction as "->->."

AcapSetInfo(hDev, INPUT_CH, ACL_TAP_DIRECTION, -1, 0) AcapSetInfo(hDev, INPUT_CH, ACL_TAP_DIRECTION, -2, 0) AcapSetInfo(hDev, INPUT_CH, ACL_TAP_DIRECTION, -3, 0)

// Disable Line reverse function

AcapSetInfo(hDev, INPUT_CH, ACL_LINE_REVERSE, -1, 0)

// Configure the X direction delay of LVAL as 0

AcapSetInfo(hDev, INPUT_CH, ACL_LVAL_DELAY, -1, 0)

// Configure the whole pixel number from camera for 1 line

AcapSetInfo(hDev, INPUT_CH, ACL_ARRANGE_XSIZE, -1, 1536)

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-45 -

6.2 Power Over CameraLink

APX-3302 can supply +12V power source specified to the camera by PoCL standard. You can control the power supply ON/OFF for each camera independently by software.

In the following case APX-3302 notifies invalid status and stop supplying power automatically. *APX-3302 cannot detect CameraLink clock from the camera after supplying power within the set time. *Camera stops CameraLink clock for any causes, and cannot begin to start CameraLink clock with in the set time.

APX-3302 begins to supply power, if it doesn’t detect CameraLink clock when the driver starts.

The sequence of the power supply ON is as follows.

Power ON

Wait 3 sec after power supply start

Start Output Clock

+12V

Cameralink Clock

Clock Detect Flag

Ton

If it cannot detect clock detect flag within the set time of Ton, "Power ON Error" will occur and stop power supply.

Figure6-6: The sequence of the power supply ON

APX-3302 User's Manual (OM110000019A)

-46 -

The invalid sequence under turning on electricity is as follows.

Power ON

Stop Clock Output

+12V

Cameralink Clock

Clock Detect Flag

Toff

If it cannot detect clock detect flag within the set time of Toff, "Power OFF Error" will occur and stop power supply.

Stop Power Supply

Figure6-7: The invalid sequence under turning on electricity

■ The setting example for software The sample code which performs to supply 1ch side camera and to configure the set time as 3000ms is as follows.

Note: Supplying control is possible only when setting of the jumper (CN7/CN8) of APX-3302 is ON.

For more information of the jumper setting, refer to [3.1.4 CN7, CN8 setting].

// Clear error status of camera power supplying

AcapSetInfo(hDev, INPUT_CH, ACL_POWER_STATE, 0, 1)

// Begin power supplying to camera

AcapSetInfo(hDev, INPUT_CH, ACL_POWER_SUPPLY, 3000, 1)

APX-3302 User's Manual (OM110000019A)

-47 -

6.3 Camera exposure control signal CC

APX-3302 can output camera exposure control signal CC (Camera Control). One of the external generation systems which operates as a factor can choose external signal inputs, such as exposure time, an internal generation system which sets up and operates an exposure cycle by software, or external triggering, an encoder.

As for an internal generation system and an external generation system, the setting-out unit of exposure time / exposure cycle is 1uS. The timing of an internal generation system is shown below.

CC Output

Exposure

Cycle

Figure6-8: Internal generation CC

The timing of an external generation system is shown below.

CC Output

Exposure

Cycle depends on external input

External Factor

（External Signal Input, Board Internal Synchronization Signal）

Figure6-9: External generation CC

The delay time from an external signal input to CC output start should follow the following tables as a rule of thumb.

External input IF type

Delay time to CC output start

TTL input

1uS(Max)

RS422 input

1uS(Max)

Table6-1: Delay time of external signal input

This table is a value having no noise rejection time setting (with no digital filter setting out). If you enable the noise rejection function, the delay for settling time is added.

APX-3302 User's Manual (OM110000019A)

-48 -

■ The setting example for software The sample code in the case of setting CC output cycle as 100 micro sec, and below, setting CC output width as 30 micro sec is described.

* The output width of a CC signal should set up a value smaller than an output cycle.

CC output

30us

100us

Figure6-10: CC signal output timing

// Enable output CC signal

AcapSetInfo(hDev, INPUT_CH, ACL_EXP_EN, -1, 1);

// CC signal is set as positive logic

AcapSetInfo(hDev, INPUT_CH, ACL_EXP_POL, -1, 1);

// CC output width is set as 30us

AcapSetInfo(hDev, INPUT_CH, ACL_EXPOSURE, -1, 30);

// CC output cycle is set as 100us

AcapSetInfo(hDev, INPUT_CH, ACL_EXP_CYCLE, -1, 100);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-49 -

6.4 Serial interface

APX-3302 carries the serial interface for camera communication for 2ch.

- SerTC : The signal from APX-3302 to camera direction (transmit data)

- SerTFG: The signal from camera to APX-3302 direction (receive data)

Serial interface is connected to UART independent every channel of APX-3302. It is possible to assign UART to a COM port by using the virtual COM driver made by AVALDATA, and to communicate with a camera by two kinds of methods below.

・ Communication using the communicating software which a camera manufacturer offers ・ Communication using API (AcapLib2)

It can communicate by the following specifications between APX-3302 and a camera. Communication speed: 9600bps(default) - Change by register setting is possible. Start bit : 1 bit Data bit : 8 bit Stop bit : 1 bit Parity bit : Nothing Flow control : Nothing

Please refer to "SDK-AcapLib2 virtual COM tool user's manual" for virtual COM.

Camera A

Ch.1 UART

Virtual COM

Assign COM3

Virtual COM

Assign COM4

Camera B

Ch.2 UART

SerTC

SerTFG

Camera A

Communication

application

Camera B

Communication

application

SerTC

SerTFG

Hardware

Virtual COM Driver

Application

Figure6-11: Serial interface

APX-3302 User's Manual (OM110000019A)

-50 -

■ The setting example for software The sample code for sending command "AVAL" is as follows. In this code, an alphabetic code, a baud rate, and a final character carry out the following.

Communication speed: 9600 bps Final character : CR (¥r) character code : ASCII

// Open serial port

AcapSerialOpen(hDev, INPUT_CH);

// Configure serial parameter

AcapSerialSetParameter(hDev, INPUT_CH, 9600, 8, 0, 0, 0);

// Send command (writing)

AcapSerialWrite(hDev, INPUT_CH, TRUE, "AVAL¥r", NULL, NULL);

// Close serial port

AcapSerialClose(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-51 -

6.5 External signal input

APX-3302 can interface with peripheral device by using expansion connector (CN6). The signal names and the interfaces are shown below.

Signal name

Function

ExTrg_1

TTL level: External trigger input terminal for Ch.1. It is below available for three kinds of uses.

- For Ch.1 Image input start trigger

- For Ch.1 CC generating trigger

- For Ch.1 Encoder startup trigger A negative going edge is recognized as a trigger.

ExTrg_2

TTL level: External trigger input terminal for Ch.2. It is below available for three kinds of uses.

- For Ch.2 Image input start trigger

- For Ch.2 CC generating trigger

- For Ch.2 Encoder startup trigger A negative going edge is recognized as a trigger.

Enc.A±

RS422 level: Encoder input terminal. It is available as encoder A phase for Ch.1 and Ch.2.

Enc.B±

RS422 level: Encoder input terminal. It is below available for three kinds of uses.

- Encoder B phase for Ch.1 and Ch.2

- Image input start trigger for Ch.1

- CC generating trigger for Ch.1

Enc.Z±

RS422 level: Encoder input terminal. It is below available for three kinds of uses.

- Encoder Z phase for Ch.1 and Ch.2

- Image input start trigger for Ch.2

- CC generating trigger for Ch.2

Diff±

RS422 level: Common external trigger input terminal. It is below available for three kinds of uses.

- Image input start trigger for Ch.1 and Ch.2

- CC generating trigger for Ch.1 and Ch.2

- Encoder startup trigger for Ch.1 and Ch.2 A negative going edge is recognized as a trigger.

GP_IN1

TTL level: General-purpose input terminal. It is available as an interruption factor. An interrupt occurs in a negative going edge.

IN_RES1

TTL level: General-purpose input terminal. The H/L state of a terminal can be checked with a register.

GP_OUT1

TTL / open-collector level: General-purpose output terminal for Ch.1. It is below available for three kinds of uses.

- Outputs in general

- Stroboscope output for Ch.1

- Capture flag (Output "L" level while capturing) for Ch.1

GP_OUT2

TTL / open-collector level: General-purpose output terminal. It is below available for three kinds of uses.

- Outputs in general

- Stroboscope output for Ch.2

- Capture flag (Output "L" level while capturing) for Ch.2

SYNCLT_IN

TTL level, synchronizing-signal input terminal between frame-grabbers. Connect the SYNCLT_OUT terminal of a master frame-grabber (synchronizing-signal generating origin).

APX-3302 User's Manual (OM110000019A)

-52 -

SYNCLT_OUT

TTL level, synchronizing-signal output terminal between frame-grabbers. Connect with the SYNCLT_IN terminal of a slave frame-grabber (synchronizing-signal report destination).

OUT_RES1

It cannot be used in APX-3302.

Table6-2: I/F of an external signal input

APX-3302 User's Manual (OM110000019A)

-53 -

The input circuit of an external signal is shown below.

1. TTL Level Input Terminal

ExTrg_1 ExTrg_2

GP_IN1

IN_RES1

4.7KΩ +5V

Extension connector CN6

Internal

circuit

74LCX14 equivalent

Figure6-12: TTL input terminal

Don't apply the voltage beyond +5V to a TTL terminal.

Since a TTL signal tends to be affected by the influence of transmission length or a peripheral noise, Under the environment which a noise generates, use of a differential signal (RS422) is recommended strongly.

When you use external trigger Input the "L" level stabilized more than the period of at least 25 uS(s).

■ The setting example for software The sample code for using TTL signal is as follows. In this example, External trigger mode is set as continuation external trigger mode (CC signal is outputted whenever it detects external trigger.)

// Configure to use TTL signal

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_EN, -1, 1);

// Continuation external trigger mode

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_MODE, -1, 0);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-54 -

2. RS422 Level Input Terminal

26LS32

Enc.A+ Enc.B+ Enc.Z+

Diff+

Extension connector CN6

100Ω

Internal circuit

Enc.AEnc.BEnc.Z-

Diff-

Extension connector CN6

Figure6-13: RS422 input terminal

When you use external trigger Input the "L" level stabilized more than the period of at least 25 uS(s).

In an intact RS422 input, an input level becomes unfixed. If external triggering is validated in the unfixed state, a trigger may occur to unexpected timing. When you do not use a RS422 input, be sure to set up external triggering invalid.

■ The setting example for software The sample code for using RS-422 signal is as follows. In this example, External trigger mode is set as continuation external trigger mode (CC signal is outputted whenever it detects external trigger.)

// Configure to use RS-422 signal

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_EN, -1, 2);

// Continuation external trigger mode

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_MODE, -1, 0);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-55 -

3. TTL / Open Collector Output Terminal

Extension

connector CN6

SW2-1,2-2

330Ω

1/8W

+5V

Internal

circuit

ALS641A

GP_OUT1 GP_OUT2

Figure6-14: Open collector output terminal

Don't apply the voltage beyond +5V to TTL / open collector output terminal.

■ The setting example for software The sample code for using GP_OUT1 for below as a general-purpose output is as follows.

// Configure to use GP_OUT1 as a general-purpose output

AcapSetInfo(hDev, INPUT_CH, ACL_GPOUT_SEL, -1, 1);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

// Configure GP_OUT1 Low output.

AcapSetInfo(hDev, INPUT_CH, ACL_GPOUT_POL, 0, 0);

// Configure GP_OUT1 High output.

AcapSetInfo(hDev, INPUT_CH, ACL_GPOUT_POL, 0, 1);

APX-3302 User's Manual (OM110000019A)

-56 -

6.6 The noise rejection function of external input signal

APX-3302 carries the noise rejection circuit of external trigger in each channel. It is possible to cover a digital filter over the selected external trigger, and to remove a single noise and the noise at the time of level variation.

Input

Ignore

Output

Ignore

Filter time (L)

Filter time (H)

The timing that accept external trigger

Figure6-15: Noise rejection of external trigger

Noise rejection time can be set up per uS.

On the specification of a digital filter, Keep in mind that the delay for filter settling time occurs in an output.

■ The setting example for software The sample code that set external trigger noise removing time High and Low as 100us is as follows.

// Configure noise rejection time as 100us.

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_CHATTER, -1, 100);

// Configure external trigger period (the same value for High and Low period)

AcapSetInfo(hDev, INPUT_CH, ACL_EXT_CHATTER_SEPARATE, -1, 0);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH)

APX-3302 User's Manual (OM110000019A)

-57 -

6.7 Strobe output

APX-3302 can output strobe signal that need to connect with external illuminating equipment. Strobe output is the output signal for adjusting camera exposure timing with external illuminating equipment and it is outputted from GPOUT terminal. You can configure output period and delay time from basis signal to output start per 1uS.

■ The setting example for software The sample code to enable strobe output is as follows.

6.8 Timing adjustment of CC output and strobe output

You can configure delay time of CC output and strobe output individually.

Basis signal (Internal)

CC Delay

CC Output

Strobe Output

Strobe Delay

Figure6-16: CC / strobe output timing

CC output and strobe output are outputted as "0", they are outputted as same timing, when begin to supply power.

// Enable strobe output

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_EN, -1, 1);

// Configure strobe polarity as positive

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_POL, -1, 1);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-58 -

You can configure the illumination and exposure timing like the timing below by configuring delay time and output time.

1. Output strobe during camera exposure.

CC Output

Strobe Output

Delay

Strobe Delay＞CC Delay

Figure6-17: Strobe output pattern 1

■ The setting example for software The sample code to configure timing of CC output and strobe output is as follows. In this code, delay time and output time are as following timing.

- Strobe delay time : 100us

- Strobe output time: 50us

- CC delay time : 10us

// Strobe delay time

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_DELAY, -1, 100);

// Strobe output time

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_TIME, -1, 50);

// CC delay time

AcapSetInfo(hDev, INPUT_CH, ACL_CC_DELAY, -1, 10);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-59 -

2. Exposure camera during output strobe.

CC Output

Strobe Output

Delay

CC Delay＞Strobe Delay

Figure6-18: Strobe output pattern 2

■ The setting example for software The sample code to configure timing of CC output and strobe output is as follows. In this code, delay time and output time are as a following timing.

- Strobe delay time : 30us

- Strobe output time: 20us

- CC delay time : 200us

// Strobe delay time

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_DELAY, -1, 30);

// Strobe output time

AcapSetInfo(hDev, INPUT_CH, ACL_STROBE_TIME, -1, 20);

// CC delay time

AcapSetInfo(hDev, INPUT_CH, ACL_CC_DELAY, -1, 200);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-60 -

6.9 Synchronizing signal between frame-grabbers (SYNCLT)

APX-3302 has SYNCLT function that can synchronize camera exposure timing between multiple frame-grabbers. The connection diagram using SYNCLT to synchronize is as follows.

Ch.1

CC Generating Circuit

CC1

SYNCLT_OUT

※Ch1 and Ch2 output CC at the same time

Master

CC1

SYNCLT_IN

Slave

To other frame-grabber SYNCLT_IN

Ch.2

CC Generating Circuit

Ch.1

CC Generating Circuit

Ch.2

CC Generating Circuit

Figure6-19: SYNCLT connection diagram

APX-3302 User's Manual (OM110000019A)

-61 -

6.9.1 Configuration steps using SYNCLT (Area sensor)

Configuration steps for using Area sensor are as follows.

Figure6-20: Software configuration steps : Simple flow(Area sensor)

6.9.2 Configuration steps using SYNCLT (Line sensor)

Configuration steps for using Line sensor are as follows.

Figure6-21: Software configuration steps : Simple flow (Line sensor)

1. Open and Initialization

2. Configuration CC Output (with notice)

4. Start capturing

Open master board and slave board. Initialize master board and slave board.

Configure slave board to output CC by SYNCLT_IN. Configure master board to output CC normally.

The slave board that outputs CC by SYNCLT_IN must start capturing in first.

5. Stop capturing

Stop Capturing. Order stopping does not have particular restriction

3. Reflect configurations

Reflect configurations to Hardware

1. Open and Initialization

2. Configuration CC Output (with notice)

5. Start capturing (with notice)

Open master board and slave board. Initialize master board and slave board.

Configure slave board to output CC by SYNCLT_IN. Configure master board to output CC normally.

The slave board that outputs CC by SYNCLT_IN must start capturing in first.

6. Stop capturing

Stop Capturing. Order stopping does not have particular restriction

3. Reflect configurations

Reflect configurations to Hardware

4. Stop Outputting CC

In the case of a line sensor, Output CC is begun before start capturing. SYNC_LT is also outputted.

APX-3302 User's Manual (OM110000019A)

-62 -

■ The setting example for software The sample code to capture image with 4ch synchronization by SYNCLT function is as follows.

///////////////////////////////////////////////////////////////////////////////////// // Open and initialization // ///////////////////////////////////////////////////////////////////////////////////// // The sample code capture image with 4ch synchronization of two APX-3302.

#define MASTER_BID 0 #define SLAVE_BID 1

// Not to use hDev_Master [0] and hDev_Slave [0]

HANDLE hDev_Master[3] = {INVALID_HANDLE_VALUE}; HANDLE hDev_Slave[3] = {INVALID_HANDLE_VALUE};

int ch_1 = 1; int ch_2 = 2; int ch;

// Open channel 1 and 2 of the master board(BoardID=0) and slave board(BoardID=1) respectively // Configure Output CC enable

for (ch=ch_1; ch<=ch_2; ch++) {// Configure channel 1 and 2.

hDev_Master[ch] = AcapOpen ("APX-3302", MASTER_BID, ch); // Master board hDev_Slave[ch] = AcapOpen ("APX-3302", SLAVE_BID, ch); // Slave board

}

// Initialize basic settings by initial file.

AcapSelectFile(hDev_Master[ch_1], ch_1, "camera.ini", 0); AcapSelectFile(hDev_Master[ch_2], ch_2, "camera.ini", 0); AcapSelectFile(hDev_Slave[ch_1], ch_1, "camera.ini", 0); AcapSelectFile(hDev_Slave[ch_2], ch_2, "camera.ini", 0);

APX-3302 User's Manual (OM110000019A)

-63 -

Figure6-22: Output CC cycle and output CC width of the master frame-grabber

//////////////////////////////////////////////////////////////////////////////////////////// // Configure output CC (master boards ch1 and ch2) // ////////////////////////////////////////////////////////////////////////////////////////////

int CCCycle_us; // CC output cycle int CCWidth_us; // CC output width

// CC output setting out of a master board (ch1)

CCCycle_us = 100*1000; // 100[ms] CCWidth_us = 20*1000; // 20[ms]

AcapSetInfo(hDev_Master[ch_1], ch_1, ACL_EXP_CYCLE, -1, CCCycle_us); AcapSetInfo(hDev_Master[ch_1], ch_1, ACL_EXPOSURE, -1, CCWidth_us);

// Configure output CC cycle of the master board (ch2) as output CC width + 1.

CCCycle_us = (20*1000) + 1; // 20.001[ms] CCWidth_us = 20*1000; // 20[ms]

AcapSetInfo(hDev_Master[ch_2], ch_2, ACL_EXP_CYCLE, -1, CCCycle_us); AcapSetInfo(hDev_Master[ch_2], ch_2, ACL_EXPOSURE, -1, CCWidth_us);

// Configure ch1 and ch2 of master board output CC enable.

AcapSetInfo(hDev_Master[ch_1], ch_1, ACL_EXP_EN, -1, 1); AcapSetInfo(hDev_Master[ch_2], ch_2, ACL_EXP_EN, -1, 1);

//////////////////////////////////////////////////////////////////////////////////////// // Configure synchronous channel (master board) // //////////////////////////////////////////////////////////////////////////////////////// // Configure master board ch1 as the parent of master board ch2.

AcapSetInfo(hDev_Master[ch_2], ch_2, ACL_SYNC_CH, -1, ch_1);

Configure outputting CC as a following timing.

Master board

(ch1)

Master board

(ch2)

Synchronous output

Output width 20 [ms]

Output cycle 100 [ms]

It makes 4th argument of AcapSetInfo to “-1”and suspends reflection of setting at end. (Futility of processing time occurs if it is reflected every time.)

By followings, CC output cycle of master board ch2 must be set as “CC output width + 1”. * Both output cycle and width must be set to 1 or more if CC is outputted.

(Cannot output if it is “0”) * Outputted cycle must be bigger than output width. * Cannot get next synchronous request from output CC to finish output cycle period.

APX-3302 User's Manual (OM110000019A)

-64 -

Figure6-23: SYNCLT_OUT and SYNCLT_IN

////////////////////////////////////////////////////////////////////////////////////////////////////// // Configure SYNCLT (master board ch1) (slave board ch2) // //////////////////////////////////////////////////////////////////////////////////////////////////////

// The following configuration is required to synchronize slave board with SYNCLT.

// Enable external trigger of Slave board ch1

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_EXT_EN, -1, 1);

// Configure output CC method as Single-external trigger mode

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_EXT_MODE, -1, 0);

// Enable SYNCLT

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_SYNC_LT, -1, 1);

// There are some settings that depend on type of sensor.

int SensorType;

// Get sensor type

AcapGetInfo (hDev_Slave[ch_1], ch_1, ACL_SCAN_SYSTEM, 0, &SensorType);)

if(SensorType==0){

// In the case of Area sensor, enable rolling shutter.

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_ROLLING_SHUTTER, -1, 1);

}else{

//In the case of Line sensor, use external triggering (SyncLT) as coincidence pulse.

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_ENC_EN, -1, 1); AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_ENC_START, -1, 2);

}

SYNCLT_OUT that master board outputs is the same wave as CC output of master board. Since master board is combined with CC output and SYNCLT_OUT is also outputted, it is not necessary to configure SyncLT. The slave board needs to recognize the wave inputted into SYNCLT_IN as external triggering, and needs to set it up to output same CC.

Master board

(ch1)

CC1

Synchronous output

Output width 20 [ms]

Output cycle 100 [ms]

CC1

SYNCLT_OUT

Slave board

(ch1)

SYNCLT_IN

Synchronous output

APX-3302 User's Manual (OM110000019A)

-65 -

Figure6-24: Output CC cycle and output CC width of slave frame-grabber

///////////////////////////////////////////////////////////////////////////////////// // Configure CC output (slave boards ch1/ch2) // ///////////////////////////////////////////////////////////////////////////////////// // Configure output CC of slave board ch1 // Configure output CC cycle of slave board (ch1) as output CC width + 1.

CCCycle_us = (20*1000) + 1; // 20.001[ms] CCWidth_us = 20*1000; // 20[ms]

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_EXP_CYCLE, -1, CCCycle_us); AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_EXPOSURE, -1, CCWidth_us);

// Configure output CC cycle of slave board (ch2) as output CC width + 1.

CCCycle_us = 20*1000) + 1; // 20.001[ms] CCWidth_us = 20*1000; // 20[ms]

AcapSetInfo(hDev_Slave[ch_2], ch_2, ACL_EXP_CYCLE, -1, CCCycle_us); AcapSetInfo(hDev_Slave[ch_2], ch_2, ACL_EXPOSURE, -1, CCWidth_us);

// Enable output CC

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_EXP_EN, -1, 1); AcapSetInfo(hDev_Slave[ch_2], ch_2, ACL_EXP_EN, -1, 1);

///////////////////////////////////////////////////////////////////////////////////// // Configure synchronous channel (slave board) // ///////////////////////////////////////////////////////////////////////////////////// // Configure slave board ch1 as the parent of slave board ch2.

AcapSetInfo(hDev_Slave[ch_2], ch_2, ACL_SYNC_CH, -1, ch_1);

Master board

(ch1)

Synchronous output

Output width 20 [ms]

Output cycle 100 [ms]

CC1

SYNCLT_OUT

Slave board

(ch1)

SYNCLT_IN

CC1 [slave board

(ch2)]

CC1 [slave board

(ch1)]

Synchronous output

By followings, CC output cycle of slave board ch1 must be set as “CC output width + 1”.

* Both output cycle and width must be set to 1 or more if CC is outputted.

(Cannot output if it is “0”) * Outputted cycle must be bigger than output width. * Cannot get next synchronous request from output CC to finish output cycle period.

APX-3302 User's Manual (OM110000019A)

-66 -

///////////////////////////////////////////////////////////////////////////////////// // Reflect setting // ///////////////////////////////////////////////////////////////////////////////////// // Reflect setting

AcapReflectParam(hDev_Master[ch_1], ch_1); AcapReflectParam(hDev_Master[ch_2], ch_2); AcapReflectParam(hDev_Slave[ch_1], ch_1); AcapReflectParam(hDev_Slave[ch_2], ch_2);

///////////////////////////////////////////////////////////////////////////////////// // Specific setting of Line sensor // /////////////////////////////////////////////////////////////////////////////////////

// In the case of Line sensor, // Although you stop capturing, output CC is performed in order to prevent long exposure of camera. // If you do not use synchronize function between boards, there are no problems in particular. // But if you use it, capturing will be begun when slave board starts capturing // because SYNCLT is also outputted with CC. // There fore, you have to stop output CC before start capturing, // when you use SYNC_LT with Line sensor. // This processing is not supported in AcapLib2 standard function, // you have to configure the register of APX-3302 directly. // The contents of processing // In the case of CH1: Set Bit0 of the register 1060h address to 0. // In the case of CH2: Set Bit0 of the register 2060h address to 0.

DWORD cc_gen;

for (ch=ch_1; ch<=ch_2; ch++) {// Configure channel 1 and 2.

AcapGetReg (hDev_Master [ch], ch, 0, 0x60+ (ch-1) (*0x1000), &cc_gen);) cc_gen = cc_gen & 0xFFFFFFFE; AcapSetReg(hDev_Master[ch], ch, 0, 0x60+((ch-1)*0x1000), cc_gen);

}

APX-3302 User's Manual (OM110000019A)

-67 -

Figure6-25: Capture timing

///////////////////////////////////////////////////////////////////////////////// // Start capturing // /////////////////////////////////////////////////////////////////////////////////

// Register event (For description)

AcapSetEvent(hDev_Master[ch_1], ch_1, ACL_INT_GRABEND, TRUE); AcapSetEvent(hDev_Master[ch_2], ch_2, ACL_INT_GRABEND, TRUE); AcapSetEvent(hDev_Slave[ch_1], ch_1, ACL_INT_GRABEND, TRUE); AcapSetEvent(hDev_Slave[ch_2], ch_2, ACL_INT_GRABEND, TRUE);

// Master ch1 must start capturing in last.

AcapGrabStart(hDev_Slave[ch_2], ch_2, 5); //Slave ch2 AcapGrabStart(hDev_Slave[ch_1], ch_1, 5); //Slave ch1 AcapGrabStart(hDev_Master[ch_2], ch_2, 5); //Master ch2

// Master board starts capturing after 100[ms] (For description)

Sleep(100); AcapGrabStart(hDev_Master [ch_1], ch_1, 5); //Master ch1

// Waiting for GRABEND event (5 frame input end)

if(ACL_RTN_ERROR == AcapWaitEvent(hDev_Master[ch_1], ch_1, ACL_INT_GRABEND, 10000))

{; TimeOut etc.}

if(ACL_RTN_ERROR == AcapWaitEvent(hDev_Master[ch_2], ch_2, ACL_INT_GRABEND, 10000))

{; TimeOut etc.}

if(ACL_RTN_ERROR == AcapWaitEvent(hDev_Slave[ch_1], ch_1, ACL_INT_GRABEND, 10000))

{; TimeOut etc.}

if(ACL_RTN_ERROR == AcapWaitEvent(hDev_Slave[ch_2], ch_2, ACL_INT_GRABEND, 10000))

{; TimeOut etc.} The timing chart to start capturing by the above setting is as follows.

Capture

(Master board)

AcapGrabStart

0[ms]

100[ms]

200[ms]

300[ms]

400[ms]

500[ms]

AcapGrabStop

It stops at 5 shots automatically, since it is a 5 frame input.

Capture

(Slave board)

CC output

(Master board)

CC output

(Slave board)

APX-3302 User's Manual (OM110000019A)

-68 -

///////////////////////////////////////////////////////////////////////////////////// // Stop capturing // ///////////////////////////////////////////////////////////////////////////////////// // After GRABEND event notified, order of stop is free

AcapGrabStop(hDev_Master[ch_1], ch_1); AcapGrabStop(hDev_Master[ch_2], ch_2); AcapGrabStop(hDev_Slave[ch_1], ch_1); AcapGrabStop(hDev_Slave[ch_2], ch_2);

// Cancel parent setting and Disable SYNCLT for quitting synchronization capture // Cancel parent setting of slave ch2

AcapSetInfo(hDev_Slave[ch_2], ch_2, ACL_SYNC_CH, 0, 0);

// Cancel parent setting of master ch2

AcapSetInfo(hDev_Master[ch_2], ch_2, ACL_SYNC_CH, 0, 0);

// Disable SYNCLT

AcapSetInfo(hDev_Slave[ch_1], ch_1, ACL_SYNC_LT, 0, 0);

APX-3302 User's Manual (OM110000019A)

-69 -

6.10 Encoder input

APX-3302 has encoder input interface.

6.10.1 Encoder input circuit

APX-3302 has the incremental type encoder input circuit of RS422 interface. It can control exposure and image input timing interlocked with external devices (shaft encoder etc.).

For the count of encoder signal, quad edge evaluation that using encoder A,B phase and double edge evaluation that using only encoder A phase are available. Encoder Z phase is available for using as start timing of encoder. Moreover, it is also possible to use external trigger signal as a trigger to start encoder count up.(For using external trigger as a trigger to start encoder count up, you need to input trigger for each frame.)

The input frequency of encoder can be inputted to 1 MHz the maximum.

The encoder input timing must be kept the following regulations.

A Phase

B Phase

1uS(min)

250nS(min)

Figure6-26: Encoder input timing

The Duty ratio of an input impulse wave must be kept 50%.

APX-3302 User's Manual (OM110000019A)

-70 -

6.10.2 Encoder count timing

Double edge evaluation count of using A phase only is as follows.

A Phase

Figure6-27: Double edge evaluation counts of using A phase only

The encoder count of using A phase only performs only addition.

Quad edge evaluation count of using A and B phase is as follows.

A Phase

B Phase

down

Ignore

down

Figure6-28: Quad edge evaluation count of using A and B phase

Quad edge evaluation count performs addition when A phase is located 90 degrees ahead of B phase. And it performs subtraction when B phase is located 90 degrees ahead of A phase. For preventing miscount by noise, it checks phase when it detects each edges, then it specifies the edge that should be detected.

As shown in the above figure, if phase changes after A phase rising then it waits falling edge of B phase. Even if the other edges are inputted, they will be ignored.

It is also possible to replace addition and subtraction timing by register control.

APX-3302 User's Manual (OM110000019A)

-71 -

6.11 Encoder operation method

APX-3302 has three kinds of encoder operation methods. Each method is explained.

6.11.1 Relative position encoder

Relative position encoder is the mode suitable for the Web inspection using Line camera, etc. It performs 1 line-scan every time the encoder proceed fixed distance.

It generates a coincidence pulse by using 32-bit counter, Comparison Register 1 (delay pulse configuration) and Comparison Register 2 (Length between coincidence pulses). Coincidence pulse will be used as trigger generation factor in the internal circuit.

The relationship of pulse number, count value and coincidence pulse is as follows.

Figure6-29: Relative position encoder

Configure Comparison Register 1 to the number of delay pulses from start capturing to the first scan. Configure Comparison Register 2 to the interval of line-scan. Configure trigger for starting count. (Start with external trigger or Z phase, CPU)

Encoder count will be started after finishing configuration above.

Value of Comparison register 1 This value will be reset when encoder pulse number equal to this value.

Value of Comparison register 2 This value will be reset when encoder pulse number equal to this value.

Time

Counter value

Coincidence pulse

APX-3302 User's Manual (OM110000019A)

-72 -

■ The setting example for software The sample code for capturing by Relative position encoder and Encoder scan mode is as follows. The setting of encoder is shown below.

Select Encoder : Relative position encoder Encoder starting method : Not using external trigger Encoder operational mode : Encoder scan mode Select Encoder input impulse-wave : Phase AB Direction of encoder input impulse wave: CW direction Encoder Z phase input : Not using Z phase Encoder comparison register 1 : 10 Encoder comparison register 2 : 4

// Relative position encoder

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_EN, -1, 1);

// Not using external trigger

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_START, -1, 0);

// Encoder scan mode

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_MODE, -1, 0);

// Phase AB

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_PHASE, -1, 0);

// CW

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_DIRECTION, -1, 0);

// Not using Z phase

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_ZPHASE_EN, -1, 0);

// Configure comparison register 1 as 10.

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_COMPARE_1, -1, 10);

// Configure comparison register 2 as 4.

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_COMPARE_2, -1, 4);

// Reflect setting

AcapReflectParam(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-73 -

6.11.2 Absolute position encoder single point

Absolute position encoder single point is the mode that is suitable for capturing using stage. For Relative position encoder mode, it resets counter every time pulse coincidence. For this mode, it always keeps moving distance (counter value) from starting point, so it can be certain start position on the stage that performs proceeding and returning repeatedly.

It has 32-bit absolute counter and 16-bit interval counter. For comparison register 1, configure absolute counter value that starts interval counter. For comparison register 2, configure interval counter that counts number of pulse that generates coincidence pulse. After finishing configuration of comparison register 1 and 2, configure start condition of encoder count, then starts count.

Figure6-30: Absolute position encoder single point

- Absolute counter is not reset even if it coincides with comparison register 1. It always keeps the value.

- Interval counter is not reset even if it coincides with comparison register 2.

- Coincidence pulse is outputted when the value of comparison register 1, 2 coincide with each counter value. In the above-mentioned figure, configure comparison register 1 as start position A of proceeding direction, and configure comparison register 2 as generating interval of coincidence pulse. After start capturing, when absolute counter becomes higher than B, it stops interval count. Next, configure comparison register 1 as start position C of returning direction, and configure comparison register 2 as generating interval of coincidence pulse, then enable interval count. It stops interval count and absolute count when capturing of returning direction is finished and absolute count becomes lower than D.

Time

Absolute counter value

Value of comparison register 1 Start interval counter

Termination of interval counter

Starting point

Stage stopped

Stage proceed

Value of comparison register 2 Generate coincidence pulse at interval.

A B C

Stage return

Value of comparison register 1 Start interval counter

APX-3302 User's Manual (OM110000019A)

-74 -

■ The setting example for software The sample code for capturing 50 lines at round-trip each by Absolute position encoder single point and Encoder scan mode is as follows. The setting of encoder and the coordinate of each point that is shown at “Figure6-30: Absolute position encoder single point” is shown below.

[Encoder setting]

Select Encoder : Absolute position encoder single point Encoder starting method : Not using external trigger Encoder operational mode : Encoder scan mode Select Encoder input impulse-wave : Phase AB Direction of encoder input impulse wave: CW direction Encoder Z phase input : Not using Z phase Encoder comparison register 1 : 5000 Encoder comparison register 2 : 100

[Coordinates of every point]

A:point 5000 count B:point 9900 count C:point 9900 count D:point 5000 count

/////////////////////////////////////////////////////////////////////////////////////////////////////////////// // starting point : Configure outward setting and start capturing // /////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Outward trip : Start capturing at absolute encoder count "5000" // After that, capture 1 line every time counting "100" counts, and capture "50" lines.

// Configure encoder setting (outward trip)

AcapSetEncoder(hDev, INPUT_CH, 2, 0, 0, 0, 0, 0, 5000, 100);

// Start encoder count

AcapSetInfo(hDev, INPUT_CH, ACL_ENC_ABS_START, 0, 1);

// Snap

AcapGrabStart(hDev, INPUT_CH, 1)

///////////////////////////////////////////////////////////////////////////////////// // Point A : Start capturing of outward trip // ///////////////////////////////////////////////////////////////////////////////////// // Coincidence pulse will be generated and start capturing, when absolute count reaches "5000". // You can check current count value by the 11th argument of "AcapGetEncoder" or "ACL_ENC_ABC_COUNT".

// Get absolute position encoder count

ULONG ulAbsCount; AcapGetEncoder (hDev, INPUT_CH, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &ulAbsCount);) AcapGetInfo (hDev, INPUT_CH, ACL_ENC_ABS_COUNT, 0, &ulAbsCount);)

APX-3302 User's Manual (OM110000019A)

-75 -

///////////////////////////////////////////////////////////////////////////////////// // Point B: Finish capturing of outward trip // ///////////////////////////////////////////////////////////////////////////////////// // Outward trip : Finish "50" line acquiring. Then stop capturing and configure return trip setting // Start capturing at absolute encoder count "9900". Configure as "CCW".

// Stop capturing (waiting for "50" line input)

AcapGrabStop(hDev, INPUT_CH);

// Configure encoder (return trip)

AcapSetEncoder(hDev, INPUT_CH, 2, 0, 0, 0, 1, 0, 9900, 100);

//--- Since encoder count is already started, no need to configure here. ---

// Snap

AcapGrabStart(hDev, INPUT_CH, 1)

///////////////////////////////////////////////////////////////////////////////////// // Point C : Start capturing of return trip // ///////////////////////////////////////////////////////////////////////////////////// // Coincidence pulse will be generated and start capturing, when absolute count reaches "9900". // You can check current count value by the 11th argument of "AcapGetEncoder" or "ACL_ENC_ABC_COUNT".

// Get counting value

ULONG ulAbsCount; AcapGetEncoder (hDev, INPUT_CH, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &ulAbsCount);) AcapGetInfo (hDev, INPUT_CH, ACL_ENC_ABS_COUNT, 0, &ulAbsCount);)

///////////////////////////////////////////////////////////////////////////////////// // Point D : Finish capturing of return trip // ///////////////////////////////////////////////////////////////////////////////////// // Return trip : Finish "50" line acquiring. Then stop capturing and configure return trip setting // Start capturing at absolute encoder count "5000". Configure as "CW".

// Stop capturing (waiting for "50" line input)

AcapGrabStop(hDev, INPUT_CH);

// Configure as CW (outward trip)

AcapSetEncoder(hDev, INPUT_CH, 2, 0, 0, 0, 0, 0, 5000, 100);

//--- Since encoder count is already started, no need to configure here. ---

// Snap

AcapGrabStart(hDev, INPUT_CH, 1)

APX-3302 User's Manual (OM110000019A)

-76 -

6.11.3 Absolute position encoder multi point

Absolute position encoder single point is the expanded mode of Absolute position encoder multi point. It can generate coincidence pulse at any points you choose up to 256 during counting absolute count. This mode is suitable for capturing using stage by Area camera, for example capturing interval is not constant.

Figure6-31: Absolute position encoder multi point

Comparison register does not exist in this mode. Instead of comparison register, it has 256 comparison memories that are mapped in internal register area, and it can generate coincidence pulse at certain count value.

■ The setting example for software The sample code for capturing from point 1 to point 9 each by Absolute position encoder multi point is as follows. The setting of encoder and the coordinate of each point that is shown at “Figure6-31: Absolute position encoder multi point” is shown below.

[Encoder setting]

Select Encoder : Absolute position encoder multi point Encoder starting method : Not using external trigger Encoder operational mode : Encoder scan mode Select Encoder input impulse-wave : Phase AB Direction of encoder input impulse wave: CW direction Encoder Z phase input : Not using Z phase

Time

Absolute counter value

Starting point

Point 1

Point 2

Point 3

Point 4

Point 5

Point 6

Point 7

Point 8

Point 9

Stage stopped

Stage proceed

Stage return

APX-3302 User's Manual (OM110000019A)

-77 -

[Coordinates of every point]

Point 1: 1000 count Point 2: 2000 count Point 3: 3000 count Point 4: 4000 count Point 5: 5000 count Point 6: 4000 count Point 7: 3000 count Point 8: 2000 count Point 9: 1000 count

[Start capturing / Finish capturing point]

Outward-trip start point : Point 1 (1000 count) Outward-trip finish point :Point 5 (5000 count) Return-trip start point : Point 6 (4000 count) Return-trip finish point : Point 9 (1000 count)

APX-3302 User's Manual (OM110000019A)

-78 -

The address of comparison memory register is 5000h for ch1 and 6000h for ch2. For program above, it is configured as shown below table.

Comparison memory No

Address

Counter value

Comparison memory 0

5000h

1000

Comparison memory 1

5004h

2000

Comparison memory 2

5008h

3000

Comparison memory 3

500Ch

4000

Comparison memory 4

5010h

5000

Comparison memory 5

5014h

4000

Comparison memory 6

5018h

3000

Comparison memory 7

501Ch

2000

Comparison memory 8

5020h

1000

Table6-3: The example of comparison memory setting

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Starting point: Configure comparison memory (outward and return trip) // //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// Outward trip : Start capturing at absolute encoder count "1000" // After that, capture when counting reaches "2000","3000","4000" or "5000". // It captures 5 times in total.

#define INPUT_CH 1

DWORD dwRegOffset= 0; // register address DWORD dwRegVal= 0; // register setting value

int nStartPos= 0; // starting position int nEndPos= 0; // end position int i= 0; // variable for loop formations

// Outward trip: Configure comparison memory // Standard functions of AcapLib2 do not support this processing, // so you have to configure register of APX-3302 directly. // CH1: Configure comparison memory from register address 5000h // CH2: Configure comparison memory from register address 6000h

for(i = 0; i < 5; i++){

// Specify the counter value for capturing

dwRegVal = 1000 + (i * 1000);

// Specify comparison memory

dwRegOffset = 0x5000 + (i * 4) + (INPUT_CH - 1) * APX3302_CH_OFFSET;

// Configure counter to specified comparison memory

AcapSetReg(ghDev, INPUT_CH, 0, dwRegOffset, dwRegVal); }

// Outward trip: Configure comparison memory

for(i = 5; i < 9; i++){

// Specify the counter value for capturing

dwRegVal = 4000 - ((i - 5) * 1000);

// Specify comparison memory

dwRegOffset = 0x5000 + (i * 4) + (INPUT_CH - 1) * APX3302_CH_OFFSET;

// Configure counter to specified comparison memory

AcapSetReg(ghDev, INPUT_CH, 0, dwRegOffset, dwRegVal); }

APX-3302 User's Manual (OM110000019A)

-79 -

For configure comparison memory starting position and finish position, configure comparison register 2 by using AcapSetInfo function. The correspondence bit of starting position and finish position is as follows.

Comparison

memory

Correspondence bit

Starting position

Bit15-Bit8

Finish position

Bit7 -Bit0

Table6-4: Correspondence bit

For instance, if you use starting position as comparison memory 0 value and finish position as comparison memory 4 value, configure comparison register 2 as "0004h".

Comparison memory No

Address

Counter set value

Comparison memory 0

5000h

1000

Comparison memory 1

5004h

2000

Comparison memory 2

5008h

3000

Comparison memory 3

500Ch

4000

Comparison memory 4

5010h

5000

Comparison memory 5

5014h

4000

Comparison memory 6

5018h

3000

Comparison memory 7

501Ch

2000

Comparison memory 8

5020h

1000

Table6-5: Starting position and end position of outward trip

// Outward trip: Specify comparison memory starting position and finish position

nStartPos = 0; nEndPos = 4; dwRegVal = (0x000000FF & nStartPos) << 8; dwRegVal | = 0x000000FF & nEndPos;

// Configure the comparison memory starting position and finish position

AcapSetInfo(ghDev, INPUT_CH, ACL_ENC_COMPARE_2, 0, dwRegVal);

Outward trip

starting position

Outward trip

end position

APX-3302 User's Manual (OM110000019A)

-80 -

Change absolute position encoder type to multi point. Configure bit30 of APX-3302 encoder control register as 1 by using AcapSetReg function. Do not change other bit. The address of encoder control register is 1028h for ch1 and 2028h for ch2.

bit

Function

Select absolute position encoder type. 0: Single point 1: Multi point Power on status is "0": Single point

Table6-6: Encoder control register (bit30)

// Enable multipoint // Standard functions of AcapLib2 do not support this processing, // so you have to configure register of APX-3302 directly.

// CH1: Configure bit30 of register address 1028h as 1 // CH2: Configure bit30 of register address 2028h as 1

// Get the value of encoder control register

dwRegOffset = 0x1028 + (INPUT_CH - 1) * APX3302_CH_OFFSET; AcapGetReg(ghDev, INPUT_CH, 0, dwRegOffset, &dwRegVal);)

// Change to multipoint mode (configure bit30 as 1)

dwRegVal | = 0x40000000;

// Configure encoder control register

AcapSetReg(ghDev, INPUT_CH, 0, dwRegOffset, dwRegVal);

APX-3302 User's Manual (OM110000019A)

-81 -

Start counting of absolute position encoder multi point. Configure bit17 of APX-3302 encoder control register as 1 by using AcapSetReg function. Do not change other bit. The address of encoder control register is 1028h for ch1 and 2028h for ch2.

bit

Function

Configure counting start/stop of absolute position encoder. 0: Stop multipoint Count 1: Start multipoint Count When you write this bit as "0" during operation, abort counting. Power on status is "0".

Table6-7: Encoder control register (bit17)

// Start counting of multi point // Standard functions of AcapLib2 do not support this processing, // so you have to configure register of APX-3302 directly.

// CH1: Configure bit17 of register address 1028h as 1 // CH2: Configure bit17 of register address 2028h as 1

// Get the value of encoder control register

dwRegOffset = 0x1028 + (INPUT_CH - 1) * APX3302_CH_OFFSET; AcapGetReg(ghDev, INPUT_CH, 0, dwRegOffset, &dwRegVal);)

// Start counting of multi point mode (configure bit17 as 1)

dwRegVal | = 0x20000;

// Configure encoder control register

AcapSetReg(ghDev, INPUT_CH, REGTYPE_LOCAL, dwRegOffset, dwRegVal);

// Outward trip: Start frame number specifying capturing (Capture 5 frames)

AcapGrabStart(ghDev, INPUT_CH, 5);

///////////////////////////////////////////////////////////////////////////////////// // point 1 - point 4: Outward trip, start capturing // ///////////////////////////////////////////////////////////////////////////////////// // When absolute count reaches "1000", coincidence pulse is generated and capture 1 time. // After that, capture when counting reaches "2000","3000","4000" or "5000". // It captures 5 times in total. // You can get latest value of comparison memory by 10th argument of "AcapGetEncoder" function, // and can get current value by "ACL_ENC_ABC_COUNT".

ULONG ulCompMem, ulAbsCount;

// Get the latest value of comparison memory

AcapGetEncoder(hDev, INPUT_CH, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &ulCompMem, NULL);

// Get the value of absolute position encoder count

AcapGetInfo(hDev, INPUT_CH, ACL_ENC_ABS_COUNT, 0, &ulAbsCount);)

APX-3302 User's Manual (OM110000019A)

-82 -

For instance, if you use starting position as comparison memory 5 value and finish position as comparison memory 8 value, configure comparison register 2 as "0508h".

Comparison memory No

Address

Counter set value

Comparison memory 0

5000h

1000

Comparison memory 1

5004h

2000

Comparison memory 2

5008h

3000

Comparison memory 3

500Ch

4000

Comparison memory 4

5010h

5000

Comparison memory 5

5014h

4000

Comparison memory 6

5018h

3000

Comparison memory 7

501Ch

2000

Comparison memory 8

5020h

1000

Table6-8: Starting position and end position of return trip

///////////////////////////////////////////////////////////////////////////////////// // point 5: Outward trip, finish capturing // ///////////////////////////////////////////////////////////////////////////////////// // Outward trip: Finish 5 times capturing, then stop capturing and configure return trip. // Return trip: Specify comparison memory starting position and finish position.

// Stop capturing

AcapGrabStop(ghDev, INPUT_CH);

// Return trip: Specify comparison memory starting position and finish position.

nStartPos = 5; nEndPos = 8; dwRegVal = (0x000000FF & nStartPos) << 8; dwRegVal | = 0x000000FF & nEndPos;

// Configure comparison memory starting position and finish position.

AcapSetInfo(ghDev, INPUT_CH, ACL_ENC_COMPARE_2, 0, dwRegVal);

// Not to change to CCW, because counter will be count-up at return trip. //--- Since encoder count is already started, no need to configure here. ---

// Return trip: Start frame number specifying capturing (Capture 4 frames)

AcapGrabStart(ghDev, INPUT_CH, 4);

Outward trip end position

Outward trip

starting position

APX-3302 User's Manual (OM110000019A)

-83 -

///////////////////////////////////////////////////////////////////////////////////// // point 6 - point 8: Return trip, start capturing // ///////////////////////////////////////////////////////////////////////////////////// // When absolute count reaches "4000", coincidence pulse is generated and capture 1 time. // After that, capture when counting reaches "3000","2000" or "1000". // It captures 5 times in total. // You can get latest value of comparison memory by 10th argument of "AcapGetEncoder" function, // and can get current value by "ACL_ENC_ABC_COUNT".

ULONG ulCompMem, ulAbsCount;

// Get the latest value of comparison memory

AcapGetEncoder(hDev, INPUT_CH, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &ulCompMem, NULL);

// Get the value of absolute position encoder count

AcapGetInfo(hDev, INPUT_CH, ACL_ENC_ABS_COUNT, 0, &ulAbsCount);

///////////////////////////////////////////////////////////////////////////////////// // point 9: Return trip, finish capturing // ///////////////////////////////////////////////////////////////////////////////////// // Return trip: Finish 4 times capturing, then stop capturing and configure return trip. // Outward trip: Specify comparison memory starting position and finish position.

// Stop capturing

AcapGrabStop(ghDev, INPUT_CH);

// Outward trip: Specify comparison memory starting position and finish position.

nStartPos = 0; nEndPos = 4; dwRegVal = (0x000000FF & nStartPos) << 8; dwRegVal | = 0x000000FF & nEndPos;

// Configure comparison memory starting position and finish position.

AcapSetInfo(ghDev, INPUT_CH, ACL_ENC_COMPARE_2, 0, dwRegVal);

//--- Since encoder count is already started, no need to configure here. ---

// Outward trip: Start frame number specifying capturing (Capture 5 frames)

AcapGrabStart(ghDev, INPUT_CH, 5);

APX-3302 User's Manual (OM110000019A)

-84 -

6.12 MEGA-FIFO

APX-3302 can extract part from effective pixels of the camera, and input it into the image buffer.

The image transfer function of APX-3302 performs that stores the image from the camera to large capacity image input buffer temporarily, and executes DMA transfer to PC host memory via buffer. The DMA transfer function via large capacity buffer guarantees the acquiring image in the fastest operation of camera. This architecture is called MEGA-FIFO architecture.

By taking FIFO composition, the start of DMA is attained simultaneously with image input start, and a tact time can be shortened. Moreover, even when the band of PCI Express is temporarily less than the frame rate of camera, image input is possible until the image input buffer becomes full. As shown in the following figure, store image into image buffer is configurable by parameters below. * TRG_DELAY : Number of delay lines from FVAL to start capturing * Y_TOTAL : Number of lines that frame-grabber acquire * X_DELAY : Number of pixels from LVAL to start capturing * X_SIZE : Number of pixels of width that frame-grabber acquire

FVAL

LVAL

TRG_DELAY

Y_TOTAL

Image Input Area

X_DELAY

X_SIZE

Figure6-31: Image input configuration

The image data stored in the image buffer is transmitted to a host by DMA function on frame-grabber. There are DMA controllers of the same number as the number of channels, and operate independently.

DMA has transmission restrictions in a 128-bit unit. DMA transfer in a 64 bit/32bit unit may be supported in the future.

The image buffer has 64MByte per channel. If a buffer becomes full status, it outputs "FIFO overflow error" and stops capturing.

APX-3302 User's Manual (OM110000019A)

-85 -

■ The setting example for software The sample code to configure input size is as follows. In this code, the image input range and each signal timing are as a following figure.

FVAL(500Line)

LVAL(680clk)

(4)TRG_DELAY(10Line)

(3)Y_TOTAL(480Line)

Image Input Area

(2)X_DELAY(20pixel)

(1)X_SIZE(640pixel)

Figure6-32: Image input configuration

// (1)X_SIZE

AcapSetInfo(hDev, INPUT_CH, ACL_X_SIZE, -1, 640); // Configure ACL_X_SIZE

// (2)X_DELAY // For APX-3302, use not ACL_X_DELAY but ACL_LVAL_DELAY for configure ID. // For 1TAP camera, configure LVAL_DELAY as same value of X_DELAY. // For 2TAP camera, configure LVAL_DELAY as one-half value of X_DELAY. // For 3TAP camera, configure LVAL_DELAY as one-third value of X_DELAY.

AcapSetInfo(hDev, INPUT_CH, ACL_LVAL_DELAY, -1, 20); // Configure ACL_LVAL_DELAY

// (3)Y_TOTAL // Configure Y size and Y total as the same value, unless you use infinite length capturing.

AcapSetInfo(hDev, INPUT_CH, ACL_Y_SIZE, -1, 480); // Configure ACL_Y_SIZE AcapSetInfo(hDev, INPUT_CH, ACL_Y_TOTAL, -1, 480); // Configure ACL_Y_TOTAL

// (4)TRG_DELAY:

AcapSetInfo(hDev, INPUT_CH, ACL_Y_DELAY, -1, 10); // Configure ACL_Y_DELAY

//Reflection of a set point

AcapReflectParam(hDev, INPUT_CH);

APX-3302 User's Manual (OM110000019A)

-86 -

■ Setting range and Restriction ACL_X_SIZE, ACL_Y_SIZE, ACL_Y_TOTAL, ACL_LVAL_DELAY, and ACL_Y_DELAY have the following restrictions, respectively. Therefore, Be aware to use each configuration ID.

Configuration ID

Setting range and Restriction

ACL_X_SIZE

8bit/1tap

16-8192 (multiple of 16)

8bit/2tap

16-16384 (multiple of 16)

8bit/3tap

48-24576 (multiple of 48)

10 bit - 16 bit / 1tap

8-8192 (multiple of 8)

10 bit - 12 bit / 2tap

8-16384 (multiple of 8)

24bitRGB

16-8192 (multiple of 16)

32bitRGB

8-8192 (multiple of 8)

ACL_Y_SIZE

1-16777215

ACL_Y_TOTAL

0-16777215

ACL_LVAL_DELAY

0-65535

ACL_Y_DELAY

0-1023

Table6-9: Setting range and Restriction

APX-3302 User's Manual (OM110000019A)

-87 -

6.13 Interruption

APX-3302 can output one level interruption to PCI Express. You can choose multiple interrupts as a followings.

- DMA end interrupt

- Image input start interruption

- Input (GPIN) interruption in general

These interrupts is notified by the event or callback function.

- Event notification (AcapSetEvent/AcapWaitEvent)

- Callback function (AcapRegistCallback/AcapRegistCallbackEx)

Followings show definition of interrupts that able to notice.

Interrupt

Definition

Meaning

Input start interrupt

ACL_INT_GRABSTART

It notifies that starts data input of 1 frame.

1 frame input completion interrupt

ACL_INT_FRAMEEND

It notifies that finishes transferring data of 1 frame to buffer.

Input end interrupt

ACL_INT_GRABEND

It notifies that complete capturing of specified frame number if number of input frame is specified by InputNum of AcapGrabStart. It is not notified at streaming with InputNum=0.

GPIN interrupt

ACL_INT_GPIN

It notifies that negative going edge of GPIN (general input signal), which is assigned at specified channel, is detected.

Table6-10: The definition of interrupts

APX-3302 User's Manual (OM110000019A)

-88 -

6.13.1 Event usage

This section describes standby method of interrupt by notifying event.

■ Setting Use AcapSetEvent for setting up interrupt which wants to stand by. Multiple interrupt is able to be set, but please register interrupt event one by one.

■ Standby The Interrupt set by AcapSetEvent can be standby state by AcapWaitEvent.

■ The setting example for software The sample code to wait "Input start interrupt" and "1 frame input completion interrupt " is as follows.

// Open APX-3302

int rtn;

HANDLE hDevice;

int channel = 1;

hDevice = AcapOpen("APX-3302", 0, channel);

// Initialize by ini file.

rtn = AcapSelectFile(hDevice, channel, "camera.ini", 0);

// Set "Input start interrupt" and "1 frame input completion interrupt"

rtn = AcapSetEvent(hDevice, channel, ACL_INT_GRABSTART, TRUE); rtn = AcapSetEvent(hDevice, channel, ACL_INT_FRAMEEND, TRUE);

// Start capturing (Grab)

rtn = AcapGrabStart(hDevice, channel, 0);

// Wait to start capturing

int GrabStartTimeout_ms = 1000;

rtn = AcapWaitEvent(hDevice, channel, ACL_INT_GRABSTART, GrabStartTimeout_ms);

// Wait to be notified "1 frame input completion interrupt"

int FrameEndTimeout_ms = 1000;

rtn = AcapWaitEvent(hDevice, channel, ACL_INT_FRAMEEND, FrameEndTimeout_ms);

APX-3302 User's Manual (OM110000019A)

-89 -

■ Cancel standby (abort) In AcapWaitEvent, process does not return until it receives interrupt or timeout occurs. When AcapSetEvent is performed by using ACL_INT_ABORT flag from other thread, standby process of AcapWaitEvent can be abort.

■ The setting example for software The sample code to abort the thread (Thread_WaitFrameEnd) that is waiting to be notified under ACL_INT_FRAMEEND is as follows.

■ Cancellation You need to cancel setting if setting event is unnecessary to stand by. Perform AcapSetEvent, which 4th argument “bEventEnable” is set as FALSE, for cancel setting.

■ The setting example for software The sample code to cancel event setting is as follows.

When AcapWaitEvent is under performing (under standby state), it becomes error since cannot cancel that. In this case, cancels after execute “cancel standby”.

// Specify ACL_INT_ABORT and the event that will be aborted

rtn = AcapSetEvent(hDevice, channel, ACL_INT_FRAMEEND | ACL_INT_ABORT, TRUE);

//Thread which waits to be notified "1 frame input completion interrupt"

void Thread_WaitEvent(void* pParam)

{

// Omit here // Wait to be notified "1 frame input completion interrupt"

int FrameEndTimeout_ms = 10 * 1000;

rtn = AcapWaitEvent(hDevice, channel, ACL_INT_FRAMEEND, FrameEndTimeout_ms);

if(rtn == ACL_RTN_ERROR){

ACAPERRORINFO AcapErrInfo; AcapGetLastErrorCode(&AcapErrInfo, 0); if(AcapErrInfo.dwBoardErrorCode==ACL_ABORT_EVENT_WAIT){

// Function is returned as error if it is aborted

printf("AcapWaitEvent was aborted.¥n");

} }

// Cancel event setting

rtn = AcapSetEvent(hDevice, channel, ACL_INT_FRAMEEND, FALSE);

APX-3302 User's Manual (OM110000019A)

-90 -

6.13.2 Callback function usage

This section describes standby method of interrupt by callback function. Registration function has 2 kinds; AcapRegistCallback and AcapRegistCallbackEx.

■ Prototype of Callback Function The callback function registered into AcapRegistCallback must have following prototype.

The callback function registered into AcapRegistCallbackEx must have following prototype.

void CALLBACK CallbackFunc (int nChannel, DWORD dwEvent, int nFrameNo, int nMemoryNo);

nChannel : The channel which detected interruption dwEvent : Detected interrupt(ACL_INT_FRAMEEND and more)

nFrameNo : Current “frame number finished input”(Last result during stop capturing ) nMemoryNo : Current “memory number(1-) which finished input lastly”(Last result at stop capturing)

void CALLBACK CallbackExFunc (int nChannel, DWORD dwEvent, int nFrameNo, int nMemoryNo, void* pParam);

nChannel : The channel which detected interruption dwEvent : Detected interrupt(ACL_INT_FRAMEEND and more)

nFrameNo : Current “frame number finished input”(Last result during stop capturing) nMemoryNo : Current “memory number gets from last input(1-)”(Last result during stop capturing)

pParam : Address which is given to 5th argument by AcapRegistCallbackEx

*Note:pParam becomes pointer of user buffer. It becomes cause of violation of segmentation if memory

which is given at registration is released.

You can use either AcapRegistCallback or AcapRegistCallbackEx. You cannot use both at same time.

APX-3302 User's Manual (OM110000019A)

-91 -

■ Register callback function It registers callback function for notice of interrupt by AcapRegistCallback/AcapRegistCallbackEx. Only 1 callback function can be registered, but it can specify multiple interrupts.

■ The setting example for software The sample code to register callback function that occurs at "1 frame input completion interrupt" for ch1 is as follows.

void CALLBACK CallbackFunc (int nChannel, DWORD dwEvent, int nFrameNo, int nMemoryNo)

{ printf("CallbackFunc called. nChannel[%d] dwEvent[%d] nFrameNo[%d] nMemoryNo[%d]¥n", nChannel, dwEvent, nFrameNo, nMemoryNo);

//Process at 1 frame input completion

}

// Register callback function at main routine

int rtn; int channel = 1;

rtn = AcapRegistCallback(hDevice, channel, ACL_INT_FRAMEEND, (EVENT_FUNC)&CallbackFunc);

// Start capturing (Grab)

rtn = AcapGrabStart(hDevice, channel, 0);

// CallbackFunc is called as inputting 1 frame

<< Output result>> * If number of transfer destination memory = 3

CallbackFunc called. nChannel[1] dwEvent[2] nFrameNo[1] nMemoryNo[1] CallbackFunc called. nChannel[1] dwEvent[2] nFrameNo[2] nMemoryNo[2] CallbackFunc called. nChannel[1] dwEvent[2] nFrameNo[3] nMemoryNo[3] CallbackFunc called. nChannel[1] dwEvent[2] nFrameNo[4] nMemoryNo[1] CallbackFunc called. nChannel[1] dwEvent[2] nFrameNo[5] nMemoryNo[2]

APX-3302 User's Manual (OM110000019A)

-92 -

■ The setting example for software The sample code to register extended callback function that occurs at "input start interrupt" or "1 frame input completion interrupt" or "input end interrupt" for ch2 is as follows.

void CALLBACK CallbackFuncEx (int nChannel, DWORD dwEvent, int nFrameNo, int nMemoryNo, void*

pParam) { DWORD Param = *((DWORD*)pParam); printf("CallbackFuncEx called. nChannel[%d] dwEvent[%d] nFrameNo[%d] nMemoryNo[%d]

*pParam[%d]¥n", nChannel, dwEvent, nFrameNo, nMemoryNo, Param);

}

// Register extended callback function at main routine

int rtn; int channel = 2;

// Plural specifications by “OR”

DWORD dwEvent = ACL_INT_GRABSTART | ACL_INT_FRAMEEND | ACL_INT_GRABEND; DWORD Param = 123456; // Parameter that gives at 5th argument rtn = AcapRegistCallback(hDevice, channel, dwEvent, (EVENT_FUNC_EX)&CallbackFuncEx, (void*)&Param);

// Input 5 frame

rtn = AcapGrabStart(hDevice, channel, 5);

// Use ACL_INT_GRABSTART at input start of each frame // Use ACL_INT_FRAMEEND at input completion of each frame // Callback function of ACL_GRABEND is called when 5 frame input is completed

<< Output result>> * If number of transfer destination memory = 3

CallbackFuncEx called. nChannel[2] dwEvent[1] nFrameNo[0] nMemoryNo[3] *pParam[123456] *Note CallbackFuncEx called. nChannel[2] dwEvent[2] nFrameNo[1] nMemoryNo[1] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[1] nFrameNo[1] nMemoryNo[1] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[2] nFrameNo[2] nMemoryNo[2] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[1] nFrameNo[2] nMemoryNo[2] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[2] nFrameNo[3] nMemoryNo[3] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[1] nFrameNo[3] nMemoryNo[3] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[2] nFrameNo[4] nMemoryNo[1] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[1] nFrameNo[4] nMemoryNo[1] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[2] nFrameNo[5] nMemoryNo[2] *pParam[123456] CallbackFuncEx called. nChannel[2] dwEvent[4] nFrameNo[5] nMemoryNo[2] *pParam[123456]

*Note：Since first GRABSTART interrupt does not input any frame, “0” is got for nFrameNo and number of register memory (3) is got for nMemoryNo.

APX-3302 User's Manual (OM110000019A)

-93 -

■ Registration cancellation of callback function Registered callback function is able to be canceled if performs 4th argument of AcapRegistCallback/AcapRegistCallbackEx as “NULL”.

■ The setting example for software The sample code to re-register callback function by different interrupt is as follows. <Sample code>

// Register “GPIN interrupt“

int rtn;

rtn = AcapRegistCallback(hDevice, channel, ACL_INT_GPIN, (EVENT_FUNC)&CallbackFunc);

// Cancel “GPIN interrupt”

rtn = AcapRegistCallback(hDevice, channel, ACL_INT_GPIN, NULL);

// Register 1 frame input completion

rtn = AcapRegistCallback(hDevice, channel, ACL_INT_FRAMEEND, (EVENT_FUNC)&CallbackFunc);

AVAL APX-3302 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual