Sixclear

FLI Driver for LabVIEW Documentation

All the gory details on our FLI Driver for LabVIEW.


Overview

Introduction to the Sixclear FLI LabVIEW Driver

This document is intended for LabVIEW developers using the Sixclear FLI LabVIEW Driver. The driver VIs are wrapped in a polymorphic VI. This means they are all accessible from a single selector on a single VI on the block diagram. Said differently, this is the wrapper VI which provides access to ALL VIs in the driver. This is likely the ONLY VI in the driver, technically, you'll ever have to drop on your block diagram.

Here's how it looks when you drop it on your block diagram (note the selector) and when you select a function (by clicking on the selector):
            

What about examples?

We provide a set of examples to help you get started with the Sixclear LabVIEW FLI Driver. You are encouraged to open the block diagrams to see how the driver VIs are being used. The examples are intended to be simple and clearly show the use of the driver functions. For example, here's the block diagram of FLI Set and Validate Temperature _ Method 1.vi:

They are not meant to be complete applications, although you ought to be able to use them right out of the box. We also show how to write camera frame data to FITS files using the gfitsio library. However, Sixclear does not maintain and support the gfitsio library. We include it for convenience and to help you get started.

What about the API?

Each VI in the driver has an entry in this document which includes the name, description, icon with terminal names, and list of subVIs.

The VIs are listed in alphabetical order. In most cases, a description of the VI's behavior is included. In some cases, only a function prototype for the core underlying call to libfli.dll, the lower-level library published by Finger Lakes Instrumentation (FLI) used to write this LabVIEW driver, is included. Such VIs are lower-level calls for which FLI did not provide descriptions. We include those VIs for completion but cannot guarantee they will function. If you would like to use one of those VIs please contact us and we'll work with you and FLI. Using the driver, this document, and the examples provided you will have the tools necessary to control your FLI devices.

Finally, it's worth mentioning that all of these descriptions are in the VIs themselves. As you many know, VIs have a built-in documentation property in LabVEIW. You can view those descriptions in the LabVIEW Help Context Window by using CTRL + H in LabVIEW, and hovering over the VI icon nearly everywhere you see it.


Examples

Simple examples to help you get up and running quickly.

We provide examples to get you started using the Sixclear LabVIEW FLI Driver. They are simple by design so that you can clearly see how the driver VIs are used. They are meant to show basic yet relevant use cases for common functions. Note that Sixclear does not maintain or support the GFITSIO library used in some examples. It is included to show that data returned from the FLI Driver can be immediately written to images files, such as FITS. All examples can be found in the Examples folder under ther driver source directory.

FLI Set and Validate Temperature - Method 1.vi

This example shows how to use core FLI driver methods to set the camera temperature and wait until it reaches that temperature, to within a specified tolerance.

FLI Set and Validate Temperature - Method 1.vi

FLI Set and Validate Temperature - Method 1.vi


FLI Set and Validate Temperature - Method 2.vi

This example shows how to use a higher level function provided in the driver to set the camera temperature and wait until it reaches that temperature, to within a specified tolerance. It also allows you to pass a string reference, which will automatically update the corresponding string with status updates at the poll rate passed into the function.

FLI Set and Validate Temperature - Method 2.vi

FLI Set and Validate Temperature - Method 2.vi


FLI Configure Expose and Save to FITS.vi

This example uses two VIs also included as examples to take an exposure and save the result to a FITS file.

FLI Configure Expose and Save to FITS.vi

FLI Configure Expose and Save to FITS.vi


FLI Configure Expose and Save to FITS (debug).vi

This example uses two VIs also included as examples to take an exposure and save the result to a FITS file. It also shows how to produce a low level debug file using FLI Set Debug Level.vi.

FLI Configure Expose and Save to FITS (debug).vi

FLI Configure Expose and Save to FITS (debug).vi


FLI Configure and Expose Frame.vi

This example demonstrates how to configure various FLI camera parameters, take an exposure, and retrieve & display the raw data.

FLI Configure and Expose Frame.vi

FLI Configure and Expose Frame.vi


FITS Read 2D U16 from File.vi

This VI reads a FITS file into a 2D U16 array. For more information on FITS files see: http://en.wikipedia.org/wiki/FITS

FITS Read 2D U16 from File.vi

FITS Read 2D U16 from File.vi


FITS Save 2D U16 to File.vi

This VI takes 2D U16 data and writes it to a FITS file. For more information on FITS files see: http://en.wikipedia.org/wiki/FITS

FITS Save 2D U16 to File.vi

FITS Save 2D U16 to File.vi


FITS Keyword Convert Value String to Type and Write.vi

This VI writes data to the current FITS file HDU. It is used in another example VI.

FITS Keyword Convert Value String to Type and Write.vi

FITS Keyword Convert Value String to Type and Write.vi


API

All the gory details for every VI in the driver.

Below is a list of VIs provided in this driver, including the VI name, description, icon with termainal names, and list of subVIs.

FLI Module.vi

This is the wrapper VI which provides access to ALL VIs in the driver. This is likely the ONLY VI in the driver, technically, you'll ever have to drop on your block diagram.

FLI Module.vi

Here's how it looks when you drop it on your block diagram (note the selector) and when you select a function (by clicking on the selector):
      

Simply drop this VI on a block diagram and use the selector to choose a driver function. Drop as many copies of this as needed and choose the function to expose for each copy to build up your FLI application in LabVIEW.

SubVIs

FLI Compute and Set Image Area.vi

FLI Compute and Set Image Area.vi

FLI Cancel Exposure.vi

FLI Cancel Exposure.vi

FLI Close.vi

FLI Close.vi

FLI Configure IO Port.vi

FLI Configure IO Port.vi

FLI Control Background Flush.vi

FLI Control Background Flush.vi

FLI Control Shutter.vi

FLI Control Shutter.vi

FLI Create List.vi

FLI Create List.vi

FLI Delete List.vi

FLI Delete List.vi

FLI Enable Vertical Table.vi

FLI Enable Vertical Table.vi

FLI End Exposure.vi

FLI End Exposure.vi

FLI Expose Frame.vi

FLI Expose Frame.vi

FLI Flush Row.vi

FLI Flush Row.vi

FLI Free List.vi

FLI Free List.vi

FLI Get Array Area.vi

FLI Get Array Area.vi

FLI Get Camera Mode String.vi

FLI Get Camera Mode String.vi

FLI Get Camera Mode.vi

FLI Get Camera Mode.vi

FLI Get Cooler Power.vi

FLI Get Cooler Power.vi

FLI Get Device Status.vi

FLI Get Device Status.vi

FLI Get Exposure Status.vi

FLI Get Exposure Status.vi

FLI Get Filter Count.vi

FLI Get Filter Count.vi

FLI Get Filter Name.vi

FLI Get Filter Name.vi

FLI Get Filter Pos.vi

FLI Get Filter Pos.vi

FLI Get Focuser Extent.vi

FLI Get Focuser Extent.vi

FLI Get FW Revision.vi

FLI Get FW Revision.vi

FLI Get HW Revision.vi

FLI Get HW Revision.vi

FLI Get Lib Version.vi

FLI Get Lib Version.vi

FLI Get Model.vi

FLI Get Model.vi

FLI Get Pixel Size.vi

FLI Get Pixel Size.vi

FLI Get Readout Dimensions.vi

FLI Get Readout Dimensions.vi

FLI Get Serial String.vi

FLI Get Serial String.vi

FLI Get Stepper Position.vi

FLI Get Stepper Position.vi

FLI Get Steps Remaining.vi

FLI Get Steps Remaining.vi

FLI Get Temperature.vi

FLI Get Temperature.vi

FLI Get Vertical Table Entry.vi

FLI Get Vertical Table Entry.vi

FLI Get Visible Area.vi

FLI Get Visible Area.vi

FLI Grab Frame.vi

FLI Grab Frame.vi

FLI Grab Row.vi

FLI Grab Row.vi

FLI Grab Video Frame.vi

FLI Grab Video Frame.vi

FLI Home Device.vi

FLI Home Device.vi

FLI Home Focuser.vi

FLI Home Focuser.vi

FLI List First.vi

FLI List First.vi

FLI List Next.vi

FLI List Next.vi

FLI List.vi

FLI List.vi

FLI Lock Device.vi

FLI Lock Device.vi

FLI Open.vi

FLI Open.vi

FLI Read IO Port.vi

FLI Read IO Port.vi

FLI Read Temperature.vi

FLI Read Temperature.vi

FLI Read User EEPROM.vi

FLI Read User EEPROM.vi

FLI Set Active Wheel.vi

FLI Set Active Wheel.vi

FLI Set Bit Depth.vi

FLI Set Bit Depth.vi

FLI Set Camera Mode.vi

FLI Set Camera Mode.vi

FLI Set DAC.vi

FLI Set DAC.vi

FLI Set Debug Level.vi

FLI Set Debug Level.vi

FLI Set Exposure Time.vi

FLI Set Exposure Time.vi

FLI Set Fan Speed.vi

FLI Set Fan Speed.vi

FLI Set Filter Pos.vi

FLI Set Filter Pos.vi

FLI Set Frame Type.vi

FLI Set Frame Type.vi

FLI Set H Bin.vi

FLI Set H Bin.vi

FLI Set Image Area.vi

FLI Set Image Area.vi

FLI Set N Flushes.vi

FLI Set N Flushes.vi

FLI Set TDI.vi

FLI Set TDI.vi

FLI Set Temperature.vi

FLI Set Temperature.vi

FLI Set V Bin.vi

FLI Set V Bin.vi

FLI Set Vertical Table Entry.vi

FLI Set Vertical Table Entry.vi

FLI Start Video Mode.vi

FLI Start Video Mode.vi

FLI Step Motor Async.vi

FLI Step Motor Async.vi

FLI Step Motor.vi

FLI Step Motor.vi

FLI Stop Video Mode.vi

FLI Stop Video Mode.vi

FLI Trigger Exposure.vi

FLI Trigger Exposure.vi

FLI Unlock Device.vi

FLI Unlock Device.vi

FLI Usb Bulk IO.vi

FLI Usb Bulk IO.vi

FLI Write IO Port.vi

FLI Write IO Port.vi

FLI Write User EEPROM.vi

FLI Write User EEPROM.vi

FLI Get H Bin.vi

FLI Get H Bin.vi

FLI Get V Bin.vi

FLI Get V Bin.vi

FLI Wait for Exposure.vi

FLI Wait for Exposure.vi

FLI Wait for Temperature.vi

FLI Wait for Temperature.vi

 


FLI Cancel Exposure.vi

Cancel an exposure for a given camera. This function cancels an exposure in progress by closing the shutter.

FLI Cancel Exposure.vi

SubVIs

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

 


FLI Close.vi

Close a handle to a FLI device.

FLI Close.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Compute and Set Image Area.vi

Computes and sets the image area on a camera. The image area is computed based on upper left and lower right pixel definitions, or the option to use the full visible area on the camera (we read this from the camera in this case). The image area is also a function of the horizontal and vertical binning.

FLI Compute and Set Image Area.vi

SubVIs

FLI Module.vi

FLI Module.vi

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI Get Visible Area.vi

FLI Get Visible Area.vi

FLI Set Image Area.vi

FLI Set Image Area.vi

FLI Compute Image Area.vi

FLI Compute Image Area.vi

 


FLI Compute Image Area.vi

Computes the image area based on the upper left and lower right pixel inputs, as well as the horizontal and vertical binning.

FLI Compute Image Area.vi

SubVIs

FLI Transform Visible to Image Area Coordinates.vi

FLI Transform Visible to Image Area Coordinates.vi

 


FLI Configure IO Port.vi

Configure the I/O port of a given camera. This function configures the I/O port on camera dev with the value ioportset. The I/O configuration of each pin on a given camera is determined by the value of ioportset. Setting a respective I/O bit enables the port bit for output while clearing an I/O bit enables to port bit for input. By default, all I/O ports are configured as inputs.

FLI Configure IO Port.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Control Background Flush.vi

Enables background flushing of CCD array. This function enables the background flushing of the CCD array camera dev according to the bgflush parameter. Note that this function may not succeed on all FLI products as this feature may not be available.

FLI Control Background Flush.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Control Shutter.vi

Control the shutter on a given camera. This function controls the shutter function on camera dev according to the shutter parameter.

FLI Control Shutter.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Create List.vi

Creates a list of all devices within a specified domain. Use FLIDeleteList() to delete the list created with this function. This function is the first called begin the iteration through the list of current FLI devices attached.

FLI Create List.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Debug.vi

void __cdecl FLIDebug(int level, char *format, ...);

Sets the debug functionality for low level logging.

FLI Debug.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Delete List.vi

Deletes a list of devices created by FLICreateList().

FLI Delete List.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Enable Vertical Table.vi

LIBFLIAPI FLIEnableVerticalTable(flidev_t dev, long width, long offset, long flags);

FLI Enable Vertical Table.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI End Exposure.vi

LIBFLIAPI FLIEndExposure(flidev_t dev);

FLI End Exposure.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Expose Frame.vi

Expose a frame for a given camera. This function exposes a frame according to the settings (image area, exposure time, bit depth, etc.) of camera dev. The settings of dev must be valid for the camera device. They are set by calling the appropriate set library functions. This function returns after the exposure has started.

FLI Expose Frame.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Flush Row.vi

Flush rows of a given camera. This function flushes rows rows of camera dev repeat times.

FLI Flush Row.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Free List.vi

Free a previously generated device list. Use this function after FLIList() to free the list of device names.

FLI Free List.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Array Area.vi

Get the array area of the given camera. This function finds the total area of the CCD array for camera dev. This area is specified in terms of a upper-left point and a lowerright point. The upper-left x-coordinate is placed in ul x, the upper-left y-coordinate is placed in ul y, the lower-right x-coordinate is placed in lr x, and the lower-right y-coordinate is placed in lr y.

FLI Get Array Area.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Camera Mode String.vi

LIBFLIAPI FLIGetCameraModeString(flidev_t dev, flimode_t mode_index, char *mode_string, size_t siz);

FLI Get Camera Mode String.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Camera Mode.vi

LIBFLIAPI FLIGetCameraMode(flidev_t dev, flimode_t *mode_index);

FLI Get Camera Mode.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Cooler Power.vi

LIBFLIAPI FLIGetCoolerPower(flidev_t dev, double *power);

FLI Get Cooler Power.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Device Status.vi

LIBFLIAPI FLIGetDeviceStatus(flidev_t dev, long *status);

FLI Get Device Status.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Exposure Status.vi

Find the remaining exposure time of a given camera. This functions places the remaining exposure time (in milliseconds) in the location pointed to by timeleft.

FLI Get Exposure Status.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Filter Count.vi

Get the filter wheel filter count of a given device. Use this function to get the filter count of filter wheel dev.

FLI Get Filter Count.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Filter Name.vi

LIBFLIAPI FLIGetFilterName(flidev_t dev, long filter, char *name, size_t len);

FLI Get Filter Name.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Filter Pos.vi

Get the filter wheel position of a given device. Use this function to get the filter wheel position of dev. A return value of -1 indicates the position unknown. For some filter wheels (ex. CFW-2-7), the position is not persistent, meaning FLI Get Filter Pos.vi will return -1 after calls to FLIClose() or FLIOpen(). In these cases, only after homing or setting a position on the filter wheel will FLI Get Filter Pos.vi return an actual position.

FLI Get Filter Pos.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Focuser Extent.vi

Retreive the maximum extent for FLI focuser dev.

FLI Get Focuser Extent.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get FW Revision.vi

Get firmware revision of a given device.

FLI Get FW Revision.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get H Bin.vi

This VI returns the last value of H Bin written using FLI Set H Bin.vi.

FLI Get H Bin.vi

SubVIs

FLI H and V Bin Functional Global.vi

FLI H and V Bin Functional Global.vi

 


FLI Get HW Revision.vi

Get the hardware revision of a given device.

FLI Get HW Revision.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Lib Version.vi

Get the current library version. This function copies up to len - 1 characters of the current library version string followed by a terminating NULL character into the buffer pointed to by ver.

FLI Get Lib Version.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Model.vi

Get the model of a given device. This function copies up to len - 1 characters of the model string for device dev, followed by a terminating NULL character into the buffer pointed to by model.

FLI Get Model.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Pixel Size.vi

Find the dimensions of a pixel in the array of the given device.

FLI Get Pixel Size.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Readout Dimensions.vi

LIBFLIAPI FLIGetReadoutDimensions(flidev_t dev, long *width, long *hoffset, long *hbin, long *height, long *voffset, long *vbin);

FLI Get Readout Dimensions.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Serial String.vi

LIBFLIAPI FLIGetSerialString(flidev_t dev, char* serial, size_t len);

FLI Get Serial String.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Stepper Position.vi

Get the stepper motor position of a given device. Use this function to read the stepper motor position of filter wheel or focuser dev.

FLI Get Stepper Position.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Steps Remaining.vi

Get the number of motor steps remaining. Use this function to determine if the stepper motor of dev is still moving.

FLI Get Steps Remaining.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Temperature.vi

Get the temperature of a given camera. This function places the temperature of the CCD camera cold finger of device dev in the location pointed to by temperature.

FLI Get Temperature.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get V Bin.vi

This VI returns the last value of V Bin written using FLI Set V Bin.vi.

FLI Get V Bin.vi

SubVIs

FLI H and V Bin Functional Global.vi

FLI H and V Bin Functional Global.vi

 


FLI Get Vertical Table Entry.vi

LIBFLIAPI FLIGetVerticalTableEntry(flidev_t dev, long index, long *height, long *bin, long *mode);

FLI Get Vertical Table Entry.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Get Visible Area.vi

Get the visible area of the given camera. This function finds the visible area of the CCD array for the camera dev. This area is specified in terms of a upper-left point and a lower-right point. The upper-left x-coordinate is placed in ul x, the upper-left y-coordinate is placed in ul y, the lower-right x-coordinate is placed in lr x, the lower-right y-coordinate is placed in lr y.

FLI Get Visible Area.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Grab Frame.vi

This VI grabs an entire frame from the camera. The frame size depends on the image area set before exposure. This function uses FLI Grab Row.vi to grab each row, and builds the 2D array representing the frame data.

FLI Grab Frame.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI Module.vi

FLI Module.vi

FLI Grab Row.vi

FLI Grab Row.vi

 


FLI Grab Row.vi

Grab a row of an image. This function grabs the next available row of the image from camera device dev. The row of width width is placed in the buffer pointed to by buff. The size of the buffer pointed to by buff must take into account the bit depth of the image, meaning the buffer size must be at least width bytes for an 8-bit image, and at least 2*width for a 16-bit image.

FLI Grab Row.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Grab Video Frame.vi

LIBFLIAPI FLIGrabVideoFrame(flidev_t dev, void *buff, size_t size);

FLI Grab Video Frame.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Home Device.vi

LIBFLIAPI FLIHomeDevice(flidev_t dev);

FLI Home Device.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Home Focuser.vi

Home focuser dev. The home position is closed as far as mechanically possiable.

FLI Home Focuser.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI List First.vi

Obtains the first device in the list. Use this function to get the first domain, filename and name from the list of attached FLI devices created using the function FLICreateList(). Use FLIListNext() to obtain more found devices.

FLI List First.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI List Next.vi

Obtains the next device in the list. Use this function to get the next domain, filename and name from the list of attached FLI devices created using the function FLICreateList().

FLI List Next.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI List.vi

List available devices. This function returns a pointer to a NULL terminated list of device names. The pointer should be freed later with FLIFreeList(). Each device name in the returned list includes the filename needed by FLIOpen(), a separating semicolon, followed by the model name or user assigned device name.

FLI List.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Lock Device.vi

Lock a specified device. This function establishes an exclusive lock (mutex) on the given device to prevent access to the device by any other function or process.

FLI Lock Device.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Open.vi

Get a handle to an FLI device. This function requires the filename and domain of the requested device. The domain encodes the device type (ex. camera) and the connection type (ex. USB). Domains are specified as integers and can be constructed as hexadecimal values by logical ORing the following masks as necessary for your device:

Connection Type:
#define FLIDOMAIN_NONE (0x00)
#define FLIDOMAIN_PARALLEL_PORT (0x01)
#define FLIDOMAIN_USB (0x02)
#define FLIDOMAIN_SERIAL (0x03)
#define FLIDOMAIN_INET (0x04)
#define FLIDOMAIN_SERIAL_19200 (0x05)
#define FLIDOMAIN_SERIAL_1200 (0x06)

Device Type:
#define FLIDEVICE_NONE (0x000)
#define FLIDEVICE_CAMERA (0x100)
#define FLIDEVICE_FILTERWHEEL (0x200)
#define FLIDEVICE_FOCUSER (0x300)
#define FLIDEVICE_HS_FILTERWHEEL (0x0400)
#define FLIDEVICE_RAW (0x0f00)
#define FLIDEVICE_ENUMERATE_BY_CONNECTION (0x8000)

For example, a USB camera would use domain 0x102 and a USB filter wheel would use domain 0x202. These are taken directly from the libfli.h file included with the driver. You may reference it for further details if necessary, but the above definitions should be sufficient to connect to any FLI device.

Valid device filenames can be obtained using the FLIList() function, however they are typically enumerated. For example, if you only have one camera the device name is likely flipro0. If you only have one filter wheel the device name is likely flifil0. An application may use any number of handles associated with the same physical device. When doing so, it is important to lock the appropriate device to ensure that multiple accesses to the same device do not occur during critical operations.

FLI Open.vi

SubVIs

FLI Simulation Mode Operations.ctl

FLI Simulation Mode Operations.ctl

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI H and V Bin Functional Global.vi

FLI H and V Bin Functional Global.vi

 


FLI Read IO Port.vi

Read the I/O port of a given camera. This function reads the I/O port on camera dev and places the value in the location pointed to by ioportset.

FLI Read IO Port.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Read Temperature.vi

Retreive temperature from the FLI focuser dev. Valid channels are FLI TEMPERATURE INTERNAL and FLI TEMPERATURE EXTERNAL.

FLI Read Temperature.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Read User EEPROM.vi

LIBFLIAPI FLIReadUserEEPROM(flidev_t dev, long loc, long address, long length, void *rbuf);

FLI Read User EEPROM.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Active Wheel.vi

LIBFLIAPI FLISetActiveWheel(flidev_t dev, long wheel);

FLI Set Active Wheel.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Bit Depth.vi

Set the gray-scale bit depth for a given camera. This function sets the gray-scale bit depth of camera dev to bitdepth. The bitdepth parameter is either FLI MODE 8BIT for 8-bit mode or FLI MODE 16BIT for 16-bit mode. Many cameras do not support this mode.

FLI Set Bit Depth.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Camera Mode.vi

LIBFLIAPI FLISetCameraMode(flidev_t dev, flimode_t mode_index);

FLI Set Camera Mode.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set DAC.vi

LIBFLIAPI FLISetDAC(flidev_t dev, unsigned long dacset);

FLI Set DAC.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Debug Level.vi

Enable debugging of API operations and communications. Use this function in combination with FLIDebug to assist in diagnosing problems that may be encountered during programming.

The "host" input is the path to your debug file. Use a "level" of 7 to turn debugging on, and 0 to turn debugging off. Alternatively, when using Microsoft Windows operating systems, creating an empty file C:\FLIDBG.TXT will override this option. All debug output will then be directed to this file.

FLI Set Debug Level.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Exposure Time.vi

Set the exposure time for a camera. This function sets the exposure time for the camera dev to exptime msec.

FLI Set Exposure Time.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Fan Speed.vi

LIBFLIAPI FLISetFanSpeed(flidev_t dev, long fan_speed);

FLI Set Fan Speed.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Filter Pos.vi

Set the filter wheel position of a given device. Use this function to set the filter wheel position of dev to filter.

FLI Set Filter Pos.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Frame Type.vi

Set the frame type for a given camera. This function sets the frame type for camera dev to frametype. The frametype parameter is either FLI FRAME TYPE NORMAL for a normal frame where the shutter opens or FLI FRAME TYPE DARK for a dark frame where the shutter remains closed.

FLI Set Frame Type.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set H Bin.vi

Set the horizontal bin factor for a given camera. This function sets the horizontal bin factor for the camera dev to hbin. The valid range of the hbin parameter is from 1 to 16.

FLI Set H Bin.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI H and V Bin Functional Global.vi

FLI H and V Bin Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Image Area.vi

Set the image area for a given camera. This function sets the image area for camera dev to an area specified in terms of a upper-left point and a lower-right point. The upper-left x-coordinate is ul x, the upper-left y-coordinate is ul y, the lower-right xcoordinate is lr x, and the lower-right y-coordinate is lr y. Note that the given lowerright coordinate must take into account the horizontal and vertical bin factor settings, but the upper-left coordinate is absolute. In other words, the lower-right coordinate used to set the image area is a virtual point (lr0x, lr0y) determined by:

lr0x = ulx+(lrx-ulx)/hbin

lr0y = uly+(lry-uly)/vbin

Where (lr0x, lr0y ) is the coordinate to pass to the FLISetImageArea function, (ulx, uly) and (lrx, lry) are the absolute coordinates of the desired image area, hbin is the horizontal bin factor, and vbin is the vertical bin factor.

FLI Set Image Area.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set N Flushes.vi

Set the number of flushes for a given camera. This function sets the number of times the CCD array is flushed by the FLIExposeFrame before exposing a frame. The valid range of the nflushes parameter is from 0 to 16. Some FLI cameras support background flushing. Background flushing continuously flushes the CCD eliminating the need for pre-exposure flushing.

FLI Set N Flushes.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set TDI.vi

LIBFLIAPI FLISetTDI(flidev_t dev, flitdirate_t tdi_rate, flitdiflags_t flags);

FLI Set TDI.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Temperature.vi

Set the temperature of a given camera. This function sets the temperature of the CCD camera dev to temperature degrees Celsius. The valid range of the temperature parameter is from -55 C to 45 C.

FLI Set Temperature.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set V Bin.vi

Set the vertical bin factor for a given camera. This function sets the vertical bin factor for the camera dev to vbin. The valid range of the vbin parameter is from 1 to 16.

FLI Set V Bin.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI H and V Bin Functional Global.vi

FLI H and V Bin Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Set Vertical Table Entry.vi

LIBFLIAPI FLISetVerticalTableEntry(flidev_t dev, long index, long height, long bin, long mode);

FLI Set Vertical Table Entry.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Start Video Mode.vi

LIBFLIAPI FLIStartVideoMode(flidev_t dev);

FLI Start Video Mode.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Step Motor Async.vi

Step the filter wheel or focuser motor of a given device. Use this function to move the focuser or filter wheel dev by an amount steps. This function is non-blocking.

FLI Step Motor Async.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Step Motor.vi

Step the filter wheel or focuser motor of a given device. Use this function to move the focuser or filter wheel dev by an amount steps.

FLI Step Motor.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Stop Video Mode.vi

LIBFLIAPI FLIStopVideoMode(flidev_t dev);

FLI Stop Video Mode.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Trigger Exposure.vi

LIBFLIAPI FLITriggerExposure(flidev_t dev);

FLI Trigger Exposure.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Unlock Device.vi

Unlock a specified device. This function releases a previously established exclusive lock (mutex) on the given device to allow access to the device by any other function or process.

FLI Unlock Device.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Usb Bulk IO.vi

LIBFLIAPI FLIUsbBulkIO(flidev_t dev, int ep, void *buf, long *len);

FLI Usb Bulk IO.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Wait for Exposure.vi

This VI waits for an exposure to complete. It provides a string reference input which will update the corresponding string with the exposure time remaining. Updates occur at the rate given by "poll rate (ms)", specified in milliseconds (ms).s

FLI Wait for Exposure.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI Module.vi

FLI Module.vi

FLI Get Exposure Status.vi

FLI Get Exposure Status.vi

 


FLI Wait for Temperature.vi

This VI waits for the camera to get within "stop tolerance" of "set temperature" and provides a string reference input to update the corresponding string with the current camera temperature. Updates occur at the rate given by "poll rate (ms)" specified in milliseconds (ms).

FLI Wait for Temperature.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

FLI Module.vi

FLI Module.vi

FLI Get Temperature.vi

FLI Get Temperature.vi

 


FLI Write IO Port.vi

Write to the I/O port of a given camera. This function writes the value ioportset to the I/O port on camera dev.

FLI Write IO Port.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi

 


FLI Write User EEPROM.vi

LIBFLIAPI FLIWriteUserEEPROM(flidev_t dev, long loc, long address, long length, void *wbuf);

FLI Write User EEPROM.vi

SubVIs

FLI Simulation Mode Functional Global.vi

FLI Simulation Mode Functional Global.vi

Error Converter (ErrCode or Status).vi

Error Converter (ErrCode or Status).vi