BicamTrigger Class Reference

#include <Bicam.h>

List of all members.

---

Detailed Description

Triggers an image capture via the Lantronix XPort.

Camera trigger is connected to XPort GPIO pins. BicamTrigger uses an XPort object to activate and deactivate the GPIO pins.

BicamGPS synthesizes NMEA GPS strings and uses the XPort serial port to send the GPS strings to the camera's GPS input port.

See also:

XPort

BicamGPS

NMEA

Public Member Functions
	BicamTrigger ()
	Default no argument constructor.
	BicamTrigger (XPort *pXPort, unsigned int selMask, unsigned int camOnMask, unsigned int camOffMask)
	Initializing constructor.
	BicamTrigger (unsigned int selMask, unsigned int camOnMask, unsigned int camOffMask)
	Initializing constructor.
	~BicamTrigger ()
	Default destructor.
XPort *	connect (char *host, int gpioIPPort, unsigned int dirMask, unsigned int dirValues, unsigned int levelMask, unsigned int levelValues)
	Establish XPort socket connections for GPIO and serial communications.
int	configure (XPort *pXPort, unsigned int selMask, unsigned int camOnMask, unsigned int camOffMask)
	Configure XPort parameters.
XPort *	getXPort ()
	Returns: XPort member variable
void	setXPort (XPort *)
	Set XPort member variable.
int	triggerCamera ()
	Trigger camera.
unsigned int	getCamOnMask ()
	Returns: camera ON mask member variable
unsigned int	getCamOffMask ()
	Returns: camera OFF mask member variable
unsigned int	getCamSelectMask ()
	Returns: GPIO control mask member variable
void	setCamOnMask (unsigned int mask)
	Set GPIO camera ON mask member variable.
void	setCamOffMask (unsigned int mask)
	Set GPIO camera OFF mask member variable.
void	setCamSelectMask (unsigned int mask)
	Set GPIO control mask member variable.
Protected Attributes
XPort *	xport
	Lantronix XPort single port terminal server w/ GPIO.
unsigned int	cameraSelectMask
	GPIO mask indicating which XPort GPIO pins to use when triggering the camera.
unsigned int	cameraOnMask
	GPIO mask indicating which XPort GPIO pins to activate when turning the camera ON.
unsigned int	cameraOffMask
	GPIO mask indicating which XPort GPIO pins to activate when turning the camera OFF.

---

Constructor & Destructor Documentation

BicamTrigger::BicamTrigger	(	XPort *	pXPort,
		unsigned int	selMask,
		unsigned int	camOnMask,
		unsigned int	camOffMask
	)

Initializing constructor.

Parameters:

	pXPort	XPort to use
	selMask	GPIO pin select mask (pins to activate when triggering)
	camOnMask	GPIO levels to use for camera ON
	camOffMask	GPIO levels to use for camera OFF

BicamTrigger::BicamTrigger	(	unsigned int	selMask,
		unsigned int	camOnMask,
		unsigned int	camOffMask
	)

Initializing constructor.

Parameters:

	selMask	GPIO pin select mask (pins to activate when triggering)
	camOnMask	GPIO levels to use for camera ON
	camOffMask	GPIO levels to use for camera OFF

---

Member Function Documentation

XPort * BicamTrigger::connect	(	char *	host,
		int	gpioIPPort,
		unsigned int	dirMask,
		unsigned int	dirValues,
		unsigned int	levelMask,
		unsigned int	levelValues
	)

Establish XPort socket connections for GPIO and serial communications.

Parameters:

	host	XPort TCP/IP host name/address
	gpioIPPort	XPort TCP/IP port for GPIO
	dirMask	GPIO direction control mask
	dirValues	GPIO direction value mask (set input/output)
	levelMask	GPIO level control mask
	levelValues	GPIO level value mask

int BicamTrigger::configure	(	XPort *	pXPort,
		unsigned int	selMask,
		unsigned int	camOnMask,
		unsigned int	camOffMask
	)

Configure XPort parameters.

Parameters:

	pXPort	XPort to use
	selMask	GPIO pin select mask (pins to activate when triggering)
	camOnMask	GPIO levels to use for camera ON
	camOffMask	GPIO levels to use for camera OFF

void BicamTrigger::setXPort

(

XPort *

xp

)

Set XPort member variable.

Parameters:

xp

pointer to XPort

int BicamTrigger::triggerCamera

(

)

Trigger camera.

Activates then deactivates GPIO pins set using the configure method.

void BicamTrigger::setCamOnMask

(

unsigned int

mask

)

Set GPIO camera ON mask member variable.

Parameters:

mask

new mask value

void BicamTrigger::setCamOffMask

(

unsigned int

mask

)

Set GPIO camera OFF mask member variable.

Parameters:

mask

new mask value

---

The documentation for this class was generated from the following files:

• camera/Bicam.h
• camera/BicamTrigger.cc

---