Hamamatsu Photonics C7557-01 User manual

HAMAMATSU PHOTONICS K.K.
SOLID STATE DIVISION
1126-1 ICHINO-CHO,HIGASHI-KU,HAMAMATSU CITY
435-8558,JAPAN
TEL:[phone],FAX:[phone]
MCD CONTROLLER
C7557-01 DLL
INSTRUCTION MANUAL
Be sure to read the operation manual carefully before the product is used.
If operated differently from the standard procedure in the manual,
a serious accident may occur.
Keep this manual for future reference.
Doc. No. K46-B60019
Fourth Issued Jul.05,2012
FormKXX-3513 B

C7557-01 DLL INSTRUCTION MANUAL
1. SAFETY PRECAUTIONS
1-1 CLASSIFICATION OF WARNING
We have classified the warnings symbols that appear in this instruction manual and on
the system as follows for your convenience. Make sure that you fully understand them
and obey the instructions they contain.
WARNING
Improper handling of the system without observing
these warnings could lead to serious injury to the user
and even death.
CAUTION
Improper handling of the system without observing
these cautions could lead to personal injury to the user
or damage to property.
Note
This symbol indicates a note to help you get the best performance
from the system. Read the contents of the note carefully to ensure
correct and safe use. Failure to observe one of these notes might
impair the performance of the system.
This symbol indicates a cautionary item that should be obeyed when
handling the system. Read the contents carefully to ensure correct
and safe use.
This symbol indicates an action that is forbidden. Read the contents
carefully and be sure to obey them.
This symbol indicates a compulsory action or instruction. Read the
contents carefully and be sure to obey them.
1
HAMAMATSU PHOTONICS K.K.

C7557-01 DLL INSTRUCTION MANUAL
2. INTRODUCTION
Thanks for purchasing C7557-01. This manual describes the C7557-01 DLL. Please read
this manual carefully before using the C7557-01 DLL.
• A computer, USB2.0 interface is required for operating this software. Make
sure to provide the correct system requirements.
Note • This software may not work satisfactorily on some computers. This software
may fail to operate due to the operating system or system requirements.
Please read the clause of "System requirements" well and use it in the right
system requirements.
System requirements
The system requirements for this software are as follows.
Type of computer PC-AT compatibles
OS Windows 98, Me, 2000, XP, Vista, 7 (32bit)
Memory 128 MB or more
(More than 512 MB is recommended.)
Interface USB 2.0 interface x 1
Drive CD-ROM Drive
The following conditions apply to the development of the software.
1. Windows 2000 or later operating system.
All software developed for 32 bit applications.
2. MicroSoft Visual C++ 6.0 or later used as the development environment.
Trademarks
Windows 2000, XP, Vista and 7 are the registered trademarks of Microsoft
Corporation in the United States and other countries. Other brand names are
the trademarks or registered trademarks of each company.
2
HAMAMATSU PHOTONICS K.K.

C7557-01 DLL INSTRUCTION MANUAL
3
HAMAMATSU PHOTONICS K.K.
3. CHECK THE CONTENTS OF PACKAGE
When you open the package, check that the following items are included before use. If the
contents are incorrect, insufficient or damaged in any way, contact Hamamatsu subsidiary
or local distributor without attempting to operate the system.
C7557-01 Instruction manual ,APL Software,DLL (CD-ROM) 1

C7557-01 DLL INSTRUCTION MANUAL
4
HAMAMATSU PHOTONICS K.K.
C
Co on nt te en nt ts s
1. SAFETY PRECAUTIONS............................................................................ 1
1-1 CLASSIFICATION OF WARNING ......................................................................................1
2. INTRODUCTION ......................................................................................... 2
3. CHECK THE CONTENTS OF PACKAGE................................................... 3
4. OVERVIEW.................................................................................................. 5
5. MCDMAIN.DLL COMMAND REFERENCE................................................. 6
5-1 START USB DEVICE..........................................................................................................6
5-2 INITIALIZATION..................................................................................................................7
5-3 CHECKING CONNECTED DEVICES ................................................................................ 8
5-4 MCD SELECTION...............................................................................................................9
5-5 AMP GAIN CONTROL......................................................................................................10
5-6 A/D CONVERTER CONTROL.......................................................................................... 11
5-7 TRIGGER MODE CONTROL...........................................................................................12
5-8 DELAY TIME OF EXTERNAL START CONTROL............................................................13
5-9 TRIGGER POLARITY CONTROL ....................................................................................14
5-10 PULSE OUT CONTROL ...................................................................................................15
5-11 DELAY TIME OF PULSE OUT CONTROL.......................................................................16
5-12 PULSE WIDTH OF PULSE OUT CONTROL ...................................................................17
5-13 POLARITY OF PULSE OUT CONTROL ..........................................................................18
5-14 SENSOR TYPE CONTROL..............................................................................................19
5-15 NUMBER OF PIXELS CONTROL....................................................................................20
5-16 NUMBER OF SUMMING PIXELS CONTROL..................................................................21
5-17 MODE CONTROL.............................................................................................................22
5-18 EXPOSURE TIME CONTROL..........................................................................................23
5-19 TEMPERATURE CONTROL.............................................................................................24
5-20 PELTIER POWER CONTROL..........................................................................................25
5-21 TEMPERATURE MONITOR.............................................................................................26
5-22 MEASUREMENTAND READING DATA..........................................................................27
5-23 PIXEL CLOCK CONTROL................................................................................................28
5-24 END USB DEVICE............................................................................................................29
6. SOFTWARE USER AGREEMENT............................................................ 30
6-1 COPYRIGHTS ..................................................................................................................30
6-2 SCOPE OF USAGE RIGHTS...........................................................................................30
6-3 SCOPE OF WARRANTY LIMITED WARRANTY.............................................................31
6-4 DISCLAIMER OF LIABILITY FOR DAMAGES.................................................................31
6-5 GOVERNING LAW............................................................................................................31
6-6 ........................................................................................................................... 31OTHERS

C7557-01 DLL INSTRUCTION MANUAL
5
HAMAMATSU PHOTONICS K.K.
4. OVERVIEW
This software is made for measurement using the MCD controller C7557-01.
Controllable devices
This software controls the MCD controller C7557-01:
Library name
Library name is McdMain.dll.
The library is the DLL (Dynamic Link Library) form which can be used in common
on Windows.
Depelopment methode
In order to use the library, link McdMain.lib to the development project. Moreover,
since the function name of the library is described by header file, include the file to
the program.
The list of the files in a CD-ROM is shown below.
DLL for controlling MCD controller
McdMain.dll MCD control library file
McdMain.lib Library link file
MCDMainapi.h Library header file
WnMcdUSB.dll DLL file for McdMain.dll
wdapi811.dll DLL file for McdMain.dll
When the created application software is executed, put each dll file on the same directory
as application software, or a system directory. When not filling this condition, application
software outputs an error message.

C7557-01 DLL INSTRUCTION MANUAL
6
HAMAMATSU PHOTONICS K.K.
5. MCDMAIN.DLL COMMAND REFERENCE
5-1 START USB DEVICE
Initialization of MCD device driver.
Call only at once before using all other functions. Then the driver detects all USB devices
and acquires USB identification number.
Function name
WORD StartDevice();
Format WORD StartDevice();
ArgumentsNone
Return code
0x00 Normal termination
0xE4 Initialization failure

C7557-01 DLL INSTRUCTION MANUAL
7
HAMAMATSU PHOTONICS K.K.
5-2 INITIALIZATION
Check all the USB IDs, and confirm that the MCD controller is connected. If devices are
connected the return value represents the number of devices connected. The return value
is 0 if no devices are connected.
Function name
WORD ScanSensor();
Format WORD ScanSensor();
ArgumentsNone
Return code
1～7 Normal completion (number for which MCD controllers are
connected)
0 MCD controller not connected

C7557-01 DLL INSTRUCTION MANUAL
8
HAMAMATSU PHOTONICS K.K.
5-3 CHECKING CONNECTED DEVICES
Check that MCD controllers are connected for the specified USB ID numbers. The status
information is returned in the argument if a device is connected. If devices are connected
the return value is 1. If no device is connected the return value is 0x1001. An error is
returned in other cases.
Function name
WORD CheckSensor(ID, Status)
Format WORD CheckSensor(WORD, SENSOR_STATUS*);
Arguments
ID USB ID number
Specify the USB ID number of the connected device to be checked.
Status MCD controller status information.
Specify the pointer for the SENSOR_STATUS structure.
typedef struct tag_SENSOR_STATUS
{ int nSensorType; /* sensor type */
int nHPixel; /* number of horizontal pixels */
int nVPixel; /* number of vertical pixels */
int nADType; /* A/D type */
} SENSOR_STATUS;
Return code
0x01 Normal completion
0x1001 No connected

C7557-01 DLL INSTRUCTION MANUAL
9
HAMAMATSU PHOTONICS K.K.
5-4 MCD SELECTION
When multiple MCD controllers exist it becomes necessary to select which is to be
controlled. Running this function displays a selection dialog box from which the desired
controller is selected. When a controller is selected the status information is returned in the
argument. The selected controller ID is returned with normal completion, and 0xffff(-1) is
returned in the case of an error.
Function name
WORD SelectSensorUnit(Status);
Format WORD SelectSensorUnit(SENSOR_STATUS*);
Arguments
Status MCD controller status information.
Specify the pointer for the SENSOR_STATUS structure.
Structure the same as for the CheckSesnor function.
Return code
0 ～7 Normal completion (ID number for selected controller)
0xffff(-1) No MCD controller connected

C7557-01 DLL INSTRUCTION MANUAL
10
HAMAMATSU PHOTONICS K.K.
5-5 AMP GAIN CONTROL
Controls the gain for the sensor output amp in the MCD controller. The return values are 1
with normal completion, and other than 1 with an error. The amp gain status may be
obtained as the return value for the function.
Function name
WORD SetAmpGain(ID, AmpGain);
WORD GetAmpGain(ID);
Format WORD SetAmpGain(WORD, WORD);
WORD GetAmpGain(WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
AmpGain Set amp gain (Low/Middle/High)
x1/2：0 x1：1 x2：2 x5：3
x10：4 x20：5 x50：6 x100：7
Return code
For amp gain control
Same as for CheckSensor function
Status acquisition
0
：x1/2 1：x1 2：x2 3：x5
4
：x10 5：x20 6：x50 7：x100

C7557-01 DLL INSTRUCTION MANUAL
5-6 A/D CONVERTER CONTROL
Set the A/D converters in the MCD controller. The return values are 1 with normal
completion, and other than 1 with an error. The A/D converter status may be obtained as
the return value for the function.
Function name
WORD SetADType(ID, ADType);
WORD GetADType(ID);
Format WORD SetADType (WORD, WORD);
WORD GetADType (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
ADType Set A/Dconverter（12 bit(1 MHz) / 16 bit(250 kHz) ）
12 bit 0
16 bit 1
Return code
For A/D converter control
Same as for CheckSensor function
Status acquisition
0 12 bit
1 16 bit
Note • When SetADType function is executed, PixelClock return default.
11
HAMAMATSU PHOTONICS K.K.

C7557-01 DLL INSTRUCTION MANUAL
12
HAMAMATSU PHOTONICS K.K.
5-7 TRIGGER MODE CONTROL
Set the trigger mode(internal trigger, external trigger, external start) in the MCD controller.
The return values are 1 with normal completion, and other than 1 with an error. The trigger
mode status may be obtained as the return value for the function.
Function name
WORD SetTriggerMode (ID, TriggerMode);
WORD GetTriggerMode (ID);
Format WORD SetTriggerMode (WORD, WORD);
WORD GetTriggerMode (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
TriggerMode Set trigger mode（internal trigger, external trigger, external
start）
internal trigger 0
external trigger 1
external start 2
Return code
For trigger mode control
Same as for CheckSensor function
Status acquisition
0 internal trigger
1 external trigger
2 external start

C7557-01 DLL INSTRUCTION MANUAL
13
HAMAMATSU PHOTONICS K.K.
5-8 DELAY TIME OF EXTERNAL START CONTROL
When set the external start mode, controls the delay time between TRIG IN inputs and
sensor scan starts. The return values are 1 with normal completion, and other than 1 with
an error. The delay time status may be obtained as the return value for the function.
Function name
WORD SetDelayTime (ID, DelayTime);
WORD GetDelayTime (ID);
Format WORD SetDelayTime (WORD, WORD);
WORD GetDelayTime (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
DelayTime Set delay time ( external start mode )
Range：0～65535 ms
Return code
For delay time control
Same as for CheckSensor function
Status acquisition
Status returned within 0～65535 ms range

C7557-01 DLL INSTRUCTION MANUAL
14
HAMAMATSU PHOTONICS K.K.
5-9 TRIGGER POLARITY CONTROL
Controls the trigger polarity(positive, negative). The return values are 1 with normal
completion, and other than 1 with an error. The trigger polarity status may be obtained as
the return value for the function.
Function name
WORD SetTriggerPolarity (ID, TriggerPolarity);
WORD GetTriggerPolarity (ID);
Format WORD SetTriggerPolarity (WORD, WORD);
WORD GetTriggerPolarity (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
TriggerPolarity Set trigger polarity（positive, negative）
positive 0
negative 1
Return code
For trigger polarity control
Same as for CheckSensor function
Status acquisition 0 positive
1 negative

C7557-01 DLL INSTRUCTION MANUAL
15
HAMAMATSU PHOTONICS K.K.
5-10 PULSE OUT CONTROL
Controls the output from the PULSE OUT terminal. The return values are 1 with normal
completion, and other than 1 with an error. The PULSE OUT status may be obtained as the
return value for the function.
Function name
WORD SetShutterControl (ID, ShutterControl);
WORD GetShutterControl (ID);
Format WORD SetShutterControl (WORD, WORD);
WORD GetShutterControl (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
ShutterControl Set PULSE OUT output（ON, OFF）
OFF 0
ON 1
Return code
For PULSE OUT control
Same as for CheckSensor function
Status acquisition 0 OFF
1 ON

C7557-01 DLL INSTRUCTION MANUAL
16
HAMAMATSU PHOTONICS K.K.
5-11 DELAY TIME OF PULSE OUT CONTROL
Controls the delay time of PULSE OUT. The return values are 1 with normal completion,
and other than 1 with an error. The delay time status may be obtained as the return value
for the function.
Function name
WORD SetShutterDelayTime (ID, ShutterDelayTime);
WORD GetShutterDelayTime (ID);
Format WORD SetShutterDelayTime (WORD, WORD);
WORD GetShutterDelayTime (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
ShutterDelayTime Set delay time ( PULSE OUT )
Range：0～65535 ms
Return code
For delay time control
Same as for CheckSensor function
Status acquisition Status returned within 0～65535 ms range

C7557-01 DLL INSTRUCTION MANUAL
17
HAMAMATSU PHOTONICS K.K.
5-12 PULSE WIDTH OF PULSE OUT CONTROL
Controls the pulse width of PULSE OUT. The return values are 1 with normal completion,
and other than 1 with an error. The pulse width status may be obtained as the return value
for the function.
Function name
WORD SetShutterDurationTime (ID, ShutterDurationTime);
WORD GetShutterDurationTime (ID);
Format WORD SetShutterDurationTime (WORD, WORD);
WORD GetShutterDurationTime (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
ShutterDurationTime Set pulse width ( PULSE OUT )
Range：0～65535 ms
Return code
For pulse width control
Same as for CheckSensor function
Status acquisition Status returned within 0～65535 ms range

C7557-01 DLL INSTRUCTION MANUAL
18
HAMAMATSU PHOTONICS K.K.
5-13 POLARITY OF PULSE OUT CONTROL
Controls the polarity of PULSE OUT. The return values are 1 with normal completion, and
other than 1 with an error. The polarity status may be obtained as the return value for the
function.
Function name
WORD SetShutterPolarity (ID, ShutterPolarity);
WORD GetShutterPolarity (ID);
Format WORD SetShutterPolarity (WORD, WORD);
WORD GetShutterPolarity (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
ShutterPolarity Set polarity of PULSE OUT（positive, negative）
positive 0
negative 1
Return code
For polarity of PULSE OUT control
Same as for CheckSensor function
Status acquisition
0 positive
1 negative

C7557-01 DLL INSTRUCTION MANUAL
19
HAMAMATSU PHOTONICS K.K.
5-14 SENSOR TYPE CONTROL
Controls the sensor type. The return values are 1 with normal completion, and other than 1
with an error. The sensor type status may be obtained as the return value for the function.
Function name
WORD SetSensorType (ID, SensorType);
WORD GetSensorType (ID);
Format WORD SetSensorType (WORD, WORD);
WORD GetSensorType (WORD);
Arguments
ID USB ID number
Specify MCD controller USB ID number
SensorType Set sensor type.
InGaAs (Other than C806x seies) 0
CCD 1
InGaAs (C806x series) 2
N-MOS 3
Return code
For sensor type control
Same as for CheckSensor function
Status acquisition
0 InGaAs (Other than C806x seies)
1 CCD
2 InGaAs (C806x series)
3 N-MOS