libfli.h File Reference

#include <sys/types.h>

Include dependency graph for libfli.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	FLI_BGFLUSH_START   (0x0001)
#define	FLI_BGFLUSH_STOP   (0x0000)
#define	FLI_FRAME_TYPE_DARK   (1)
#define	FLI_FRAME_TYPE_NORMAL   (0)
#define	FLI_MODE_16BIT   (1)
#define	FLI_MODE_8BIT   (0)
#define	FLI_SHUTTER_CLOSE   (0x0000)
#define	FLI_SHUTTER_EXTERNAL_TRIGGER   (0x0002)
#define	FLI_SHUTTER_EXTERNAL_TRIGGER_HIGH   (0x0004)
#define	FLI_SHUTTER_EXTERNAL_TRIGGER_LOW   (0x0002)
#define	FLI_SHUTTER_OPEN   (0x0001)
#define	FLIDEBUG_ALL   (FLIDEBUG_INFO | FLIDEBUG_WARN | FLIDEBUG_FAIL)
#define	FLIDEBUG_FAIL   (0x04)
#define	FLIDEBUG_INFO   (0x01)
#define	FLIDEBUG_NONE   (0x00)
#define	FLIDEBUG_WARN   (0x02)
#define	FLIDEVICE_CAMERA   (0x100)
#define	FLIDEVICE_FILTERWHEEL   (0x200)
#define	FLIDEVICE_FOCUSER   (0x300)
#define	FLIDEVICE_NONE   (0x000)
#define	FLIDOMAIN_INET   (0x04)
#define	FLIDOMAIN_NONE   (0x00)
#define	FLIDOMAIN_PARALLEL_PORT   (0x01)
#define	FLIDOMAIN_SERIAL   (0x03)
#define	FLIDOMAIN_USB   (0x02)
#define	LIBFLIAPI   long
Typedefs
typedef long	flibgflush_t
typedef long	flibitdepth_t
typedef long	flidebug_t
typedef long	flidev_t
typedef long	flidomain_t
typedef long	fliframe_t
typedef long	flishutter_t
Functions
LIBFLIAPI	FLICancelExposure (flidev_t dev)
LIBFLIAPI	FLIClose (flidev_t dev)
LIBFLIAPI	FLIConfigureIOPort (flidev_t dev, long ioportset)
LIBFLIAPI	FLIControlBackgroundFlush (flidev_t dev, flibgflush_t bgflush)
LIBFLIAPI	FLIControlShutter (flidev_t dev, flishutter_t shutter)
LIBFLIAPI	FLICreateList (flidomain_t domain)
LIBFLIAPI	FLIDeleteList (void)
LIBFLIAPI	FLIExposeFrame (flidev_t dev)
LIBFLIAPI	FLIFlushRow (flidev_t dev, long rows, long repeat)
LIBFLIAPI	FLIFreeList (char **names)
LIBFLIAPI	FLIGetArrayArea (flidev_t dev, long *ul_x, long *ul_y, long *lr_x, long *lr_y)
LIBFLIAPI	FLIGetExposureStatus (flidev_t dev, long *timeleft)
LIBFLIAPI	FLIGetFilterCount (flidev_t dev, long *filter)
LIBFLIAPI	FLIGetFilterPos (flidev_t dev, long *filter)
LIBFLIAPI	FLIGetFWRevision (flidev_t dev, long *fwrev)
LIBFLIAPI	FLIGetHWRevision (flidev_t dev, long *hwrev)
LIBFLIAPI	FLIGetLibVersion (char *ver, size_t len)
LIBFLIAPI	FLIGetModel (flidev_t dev, char *model, size_t len)
LIBFLIAPI	FLIGetPixelSize (flidev_t dev, double *pixel_x, double *pixel_y)
LIBFLIAPI	FLIGetStepperPosition (flidev_t dev, long *position)
LIBFLIAPI	FLIGetTemperature (flidev_t dev, double *temperature)
LIBFLIAPI	FLIGetVisibleArea (flidev_t dev, long *ul_x, long *ul_y, long *lr_x, long *lr_y)
LIBFLIAPI	FLIGrabRow (flidev_t dev, void *buff, size_t width)
LIBFLIAPI	FLIHomeFocuser (flidev_t dev)
LIBFLIAPI	FLIList (flidomain_t domain, char ***names)
LIBFLIAPI	FLIListFirst (flidomain_t *domain, char *filename, size_t fnlen, char *name, size_t namelen)
LIBFLIAPI	FLIListNext (flidomain_t *domain, char *filename, size_t fnlen, char *name, size_t namelen)
LIBFLIAPI	FLILockDevice (flidev_t dev)
LIBFLIAPI	FLIOpen (flidev_t *dev, char *name, flidomain_t domain)
LIBFLIAPI	FLIReadIOPort (flidev_t dev, long *ioportset)
LIBFLIAPI	FLISetBitDepth (flidev_t dev, flibitdepth_t bitdepth)
LIBFLIAPI	FLISetDebugLevel (char *host, flidebug_t level)
LIBFLIAPI	FLISetExposureTime (flidev_t dev, long exptime)
LIBFLIAPI	FLISetFilterPos (flidev_t dev, long filter)
LIBFLIAPI	FLISetFrameType (flidev_t dev, fliframe_t frametype)
LIBFLIAPI	FLISetHBin (flidev_t dev, long hbin)
LIBFLIAPI	FLISetImageArea (flidev_t dev, long ul_x, long ul_y, long lr_x, long lr_y)
LIBFLIAPI	FLISetNFlushes (flidev_t dev, long nflushes)
LIBFLIAPI	FLISetTemperature (flidev_t dev, double temperature)
LIBFLIAPI	FLISetVBin (flidev_t dev, long vbin)
LIBFLIAPI	FLIStepMotor (flidev_t dev, long steps)
LIBFLIAPI	FLIUnlockDevice (flidev_t dev)
LIBFLIAPI	FLIWriteIOPort (flidev_t dev, long ioportset)

---

Define Documentation

#define FLI_BGFLUSH_START   (0x0001)

Definition at line 129 of file libfli.h.

#define FLI_BGFLUSH_STOP   (0x0000)

Definition at line 128 of file libfli.h.

#define FLI_FRAME_TYPE_DARK   (1)

Definition at line 88 of file libfli.h.

#define FLI_FRAME_TYPE_NORMAL   (0)

Definition at line 87 of file libfli.h.

#define FLI_MODE_16BIT   (1)

Definition at line 99 of file libfli.h.

#define FLI_MODE_8BIT   (0)

Definition at line 98 of file libfli.h.

#define FLI_SHUTTER_CLOSE   (0x0000)

Definition at line 113 of file libfli.h.

#define FLI_SHUTTER_EXTERNAL_TRIGGER   (0x0002)

Definition at line 115 of file libfli.h.

#define FLI_SHUTTER_EXTERNAL_TRIGGER_HIGH   (0x0004)

Definition at line 117 of file libfli.h.

#define FLI_SHUTTER_EXTERNAL_TRIGGER_LOW   (0x0002)

Definition at line 116 of file libfli.h.

#define FLI_SHUTTER_OPEN   (0x0001)

Definition at line 114 of file libfli.h.

#define FLIDEBUG_ALL   (FLIDEBUG_INFO | FLIDEBUG_WARN | FLIDEBUG_FAIL)

Definition at line 144 of file libfli.h.

#define FLIDEBUG_FAIL   (0x04)

Definition at line 143 of file libfli.h.

#define FLIDEBUG_INFO   (0x01)

Definition at line 141 of file libfli.h.

#define FLIDEBUG_NONE   (0x00)

Definition at line 140 of file libfli.h.

#define FLIDEBUG_WARN   (0x02)

Definition at line 142 of file libfli.h.

#define FLIDEVICE_CAMERA   (0x100)

Definition at line 75 of file libfli.h.

#define FLIDEVICE_FILTERWHEEL   (0x200)

Definition at line 76 of file libfli.h.

#define FLIDEVICE_FOCUSER   (0x300)

Definition at line 77 of file libfli.h.

#define FLIDEVICE_NONE   (0x000)

Definition at line 74 of file libfli.h.

#define FLIDOMAIN_INET   (0x04)

Definition at line 72 of file libfli.h.

#define FLIDOMAIN_NONE   (0x00)

Definition at line 68 of file libfli.h.

#define FLIDOMAIN_PARALLEL_PORT   (0x01)

Definition at line 69 of file libfli.h.

#define FLIDOMAIN_SERIAL   (0x03)

Definition at line 71 of file libfli.h.

#define FLIDOMAIN_USB   (0x02)

Definition at line 70 of file libfli.h.

#define LIBFLIAPI   long

Definition at line 151 of file libfli.h.

---

Typedef Documentation

typedef long flibgflush_t

Type used for background flush operations for an FLI camera device.

Valid bgflush types are {FLI_BGFLUSH_STOP} and {FLI_BGFLUSH_START}.

See also:

FLIControlBackgroundFlush

Definition at line 126 of file libfli.h.

typedef long flibitdepth_t

The gray-scale bit depth for an FLI camera device.

Valid bit depths are {FLI_MODE_8BIT} and {FLI_MODE_16BIT}.

See also:

FLISetBitDepth

Definition at line 96 of file libfli.h.

typedef long flidebug_t

Type specifying library debug levels.

Valid debug levels are {FLIDEBUG_NONE}, {FLIDEBUG_INFO}, {FLIDEBUG_WARN}, and {FLIDEBUG_FAIL}.

See also:

FLISetDebugLevel

Definition at line 138 of file libfli.h.

typedef long flidev_t

An opaque handle used by library functions to refer to FLI hardware.

Definition at line 53 of file libfli.h.

typedef long flidomain_t

The domain of an FLI device.

This consists of a bitwise ORed combination of interface method and device type. Valid interfaces are {FLIDOMAIN_PARALLEL_PORT}, {FLIDOMAIN_USB}, {FLIDOMAIN_SERIAL}, and {FLIDOMAIN_INET}. Valid device types are {FLIDEVICE_CAMERA}, {FLIDOMAIN_FILTERWHEEL}, and {FLIDOMAIN_FOCUSER}.

See also:

FLIOpen

FLIList

Definition at line 66 of file libfli.h.

typedef long fliframe_t

The frame type for an FLI CCD camera device.

Valid frame types are {FLI_FRAME_TYPE_NORMAL} and {FLI_FRAME_TYPE_DARK}.

See also:

FLISetFrameType

Definition at line 85 of file libfli.h.

typedef long flishutter_t

Type used for shutter operations for an FLI camera device.

Valid shutter types are {FLI_SHUTTER_CLOSE}, {FLI_SHUTTER_OPEN}, {FLI_SHUTTER_EXTERNAL_TRIGGER}, {FLI_SHUTTER_EXTERNAL_TRIGGER_LOW}, and {FLI_SHUTTER_EXTERNAL_TRIGGER_HIGH}.

See also:

FLIControlShutter

Definition at line 111 of file libfli.h.

---

Function Documentation

LIBFLIAPI FLICancelExposure

(

flidev_t

dev

)

LIBFLIAPI FLIClose

(

flidev_t

dev

)

LIBFLIAPI FLIConfigureIOPort	(	flidev_t	dev,
		long	ioportset
	)

LIBFLIAPI FLIControlBackgroundFlush	(	flidev_t	dev,
		flibgflush_t	bgflush
	)

LIBFLIAPI FLIControlShutter	(	flidev_t	dev,
		flishutter_t	shutter
	)

LIBFLIAPI FLICreateList

(

flidomain_t

domain

)

LIBFLIAPI FLIDeleteList

(

void

)

LIBFLIAPI FLIExposeFrame

(

flidev_t

dev

)

LIBFLIAPI FLIFlushRow	(	flidev_t	dev,
		long	rows,
		long	repeat
	)

LIBFLIAPI FLIFreeList

(

char **

names

)

LIBFLIAPI FLIGetArrayArea	(	flidev_t	dev,
		long *	ul_x,
		long *	ul_y,
		long *	lr_x,
		long *	lr_y
	)

LIBFLIAPI FLIGetExposureStatus	(	flidev_t	dev,
		long *	timeleft
	)

LIBFLIAPI FLIGetFilterCount	(	flidev_t	dev,
		long *	filter
	)

LIBFLIAPI FLIGetFilterPos	(	flidev_t	dev,
		long *	filter
	)

LIBFLIAPI FLIGetFWRevision	(	flidev_t	dev,
		long *	fwrev
	)

LIBFLIAPI FLIGetHWRevision	(	flidev_t	dev,
		long *	hwrev
	)

LIBFLIAPI FLIGetLibVersion	(	char *	ver,
		size_t	len
	)

LIBFLIAPI FLIGetModel	(	flidev_t	dev,
		char *	model,
		size_t	len
	)

LIBFLIAPI FLIGetPixelSize	(	flidev_t	dev,
		double *	pixel_x,
		double *	pixel_y
	)

LIBFLIAPI FLIGetStepperPosition	(	flidev_t	dev,
		long *	position
	)

LIBFLIAPI FLIGetTemperature	(	flidev_t	dev,
		double *	temperature
	)

LIBFLIAPI FLIGetVisibleArea	(	flidev_t	dev,
		long *	ul_x,
		long *	ul_y,
		long *	lr_x,
		long *	lr_y
	)

LIBFLIAPI FLIGrabRow	(	flidev_t	dev,
		void *	buff,
		size_t	width
	)

LIBFLIAPI FLIHomeFocuser

(

flidev_t

dev

)

LIBFLIAPI FLIList	(	flidomain_t	domain,
		char ***	names
	)

LIBFLIAPI FLIListFirst	(	flidomain_t *	domain,
		char *	filename,
		size_t	fnlen,
		char *	name,
		size_t	namelen
	)

LIBFLIAPI FLIListNext	(	flidomain_t *	domain,
		char *	filename,
		size_t	fnlen,
		char *	name,
		size_t	namelen
	)

LIBFLIAPI FLILockDevice

(

flidev_t

dev

)

LIBFLIAPI FLIOpen	(	flidev_t *	dev,
		char *	name,
		flidomain_t	domain
	)

LIBFLIAPI FLIReadIOPort	(	flidev_t	dev,
		long *	ioportset
	)

LIBFLIAPI FLISetBitDepth	(	flidev_t	dev,
		flibitdepth_t	bitdepth
	)

LIBFLIAPI FLISetDebugLevel	(	char *	host,
		flidebug_t	level
	)

LIBFLIAPI FLISetExposureTime	(	flidev_t	dev,
		long	exptime
	)

LIBFLIAPI FLISetFilterPos	(	flidev_t	dev,
		long	filter
	)

LIBFLIAPI FLISetFrameType	(	flidev_t	dev,
		fliframe_t	frametype
	)

LIBFLIAPI FLISetHBin	(	flidev_t	dev,
		long	hbin
	)

LIBFLIAPI FLISetImageArea	(	flidev_t	dev,
		long	ul_x,
		long	ul_y,
		long	lr_x,
		long	lr_y
	)

LIBFLIAPI FLISetNFlushes	(	flidev_t	dev,
		long	nflushes
	)

LIBFLIAPI FLISetTemperature	(	flidev_t	dev,
		double	temperature
	)

LIBFLIAPI FLISetVBin	(	flidev_t	dev,
		long	vbin
	)

LIBFLIAPI FLIStepMotor	(	flidev_t	dev,
		long	steps
	)

LIBFLIAPI FLIUnlockDevice

(

flidev_t

dev

)

LIBFLIAPI FLIWriteIOPort	(	flidev_t	dev,
		long	ioportset
	)