Port Access, Device Initialization

Modules
	Generic Device property control
	Auxiliary and miscellaneous functions/macros
	Error Handling
	Auxiliary functions
Functions
	APIFUNC (int, PortInit,(int *numOfPorts)) APIFUNC(int
int char int char int int int *type	APIFUNC (int, IsBaudRateSupported,(int port, int baudrate)) APIFUNC(int
int char int char int int int *type int int *baudrate	APIFUNC (int, SetBaudRate,(int port, int baudrate)) APIFUNC(int
int char int char int int int *type int int *baudrate int port	APIFUNC (int, DeviceClose,(int port)) APIFUNC(const char *
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len int TOKEN const char *string	APIFUNC (int, Write,(int port, unsigned short addr, const unsigned char *buf, unsigned int size)) APIFUNC(int
Variables
	PortInfo
int	port
int char *	manu
int char int *	mBytes
int char int char *	name
int char int char int *	nBytes
int char int char int int *	version
int char int char int int int *type	GetBaudRate
int char int char int int int *type int int *baudrate	DeviceOpen
int char int char int int int *type int int *baudrate int port	DeviceGetDllVersion
int char int char int int int *type int int *baudrate int port int int *	major
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len int TOKEN const char *string	Read
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len int TOKEN const char *string int unsigned short	addr
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len int TOKEN const char *string int unsigned short unsigned char *	buf
	Value_ToString
PFValue *	val

---

Detailed Description

This module contains the initialization routines for the camera ports

---

Function Documentation

int char int char int int int* type int int* baudrate int port APIFUNC	(	int	,
		DeviceClose	,
		(int port)
	)			const

Close device communication. This should be called at the end of an application, when the device is no longer accessed.

Parameters:

port

Port number of the camera

Returns:

0: success
< 0: error

Type Constraints

int char int char int int int* type int int* baudrate APIFUNC	(	int	,
		SetBaudRate	,
		(int port, int baudrate)
	)

Set baud rate. The camera port must be opened, before setting the baud rate

Parameters:

	port	Port number of the camera
	baudrate	Baud rate to set (eg. 57600)

Returns:

0: successful
< 0: error.
Open Device

Parameters:

port

Port number of the camera

Returns:

0: successful
< 0: error
A value > 0 means, the device was opened, but some non blocking failure was detected (bad device identity, etc.). In this case, some int index device features may not be accessible, but the it can be normally fixed via an update.

Type Constraints

int char int char int int int* type APIFUNC	(	int	,
		IsBaudRateSupported	,
		(int port, int baudrate)
	)

Check if required baud rate is possible. The camera port must be opened, before checking the required baud rate

Parameters:

	port	Port number of the camera
	baudrate	Baud rate to check (eg. 57600)

Returns:

1: baud rate suporrted
0: baud rate not supported
< 0: error. Get current baud rate

Parameters:

	port	Port number of the camera
	baudrate	Baud rate

Returns:

0: successful
< 0: error.

Type Constraints

APIFUNC	(	int	,
		PortInit	,
		(int *numOfPorts)
	)

Init of all camera ports. This has to be called as first

Parameters:

numOfPorts

Number of available camera ports

Returns:

0: successful
< 0: error

Get information about a port (manufacturer, name, etc)

Parameters:

	port	Port number of the camera
	manu	Name of the manufacturer of this port
	mBytes	Lenght of (manu+1)
	name	Name of the manufacturer of this port
	nBytes	Lenght of (name+1)
	version	Version of CLALLSERIAL (0 if no ClAllSerial port) 1 : CL_DLL_VERSION_NO_VERSION Not a CL dll 2 : CL_DLL_VERSION_1_0 Oct 2000 compliant 3 : CL_DLL_VERSION_1_1 Oct 2001 compliant
	type	Type of this port 0 : ClAllSerial port 1 : port with clser.dll at pfremote directory 2 : USB port 3 : RS-232 port

Returns:

0: successful
< 0: error