org.lsst.ccs.drivers.thorlabs

Class TestFW

java.lang.Object

org.lsst.ccs.drivers.thorlabs.TestFW

public class TestFW
extends Object

Program to test the Thorlabs filter wheel driver.

Constructor Summary

Constructors

Constructor and Description
TestFW() Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Closes connection
void	open(String ident) Opens connection to a device using default baud rate
void	open(String ident, int baudRate) Opens connection to a device
String	readAll() Read all settings and data from filter wheel.
String	readFWpos() Read filter wheel position.
void	saveSettings() Save settings for next power-up
void	setDataRate(int value) Set baud rate
void	setDebug(boolean mode) Set debug mode on or off
void	setFWsize(int value) Set total number of positions
void	setPosition(int value) Command to move filter wheel
void	setSensorMode(int value) Set sensor mode for idle FW ("inactive" may avoid stray light)
void	setSpeed(int value) Set filter wheel speed
void	setTrigMode(int value) Set usage of trigger connector
String	timestamp() Determines current time

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestFW

public TestFW()

Constructor

Method Detail

timestamp

@Command(name="timestamp",
         description="Prints current time")
public String timestamp()

Determines current time

Returns:

current time as a String

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="ident",description="Identification")
                                                                                         String ident,
                                                                                         @Argument(name="baudRate",description="Baud rate, 9600 or 115200")
                                                                                         int baudRate)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device

Parameters:

ident - The identification (serial port name)

baudRate - BAUD rate (9600 or 115200)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="ident",description="Identification")
                                                                                         String ident)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device using default baud rate

Parameters:

ident - The identification (serial port name)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

@Command(name="close",
         description="Closes connection to device")
public void close()
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Closes connection

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(name="readAll",
         description="Read all controller settings and data")
public String readAll()

Read all settings and data from filter wheel. Loops over all read commands and returns them in a table format. All DriverExceptions are caught; if one occurs, the data field is replaced by the text (String) associated with the exception.

Returns:

String reporting all data read and exceptions.

readFWpos

@Command(name="readFWpos",
         description="Read filter wheel position")
public String readFWpos()
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Read filter wheel position.

Returns:

String showing filter wheel position

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

setPosition

@Command(name="setPosition",
         description="Set filter wheel positions")
public void setPosition(@Argument(name="<int>",description="New position, 1 to maximum")
                                                                                                        int value)
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Command to move filter wheel

Parameters:

Position - to move to (1 to maximum)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFWsize

@Command(name="setFWsize",
         description="Set number of FW positions")
public void setFWsize(@Argument(name=" <6|12>",description="Number of filter wheel positions")
                                                                                                    int value)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Set total number of positions

Parameters:

Total - number of positions for physical FW (6 or 12)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTrigMode

@Command(name="setTrigMode",
         description="Set usage of trigger connector")
public void setTrigMode(@Argument(name=" <0|1>",description="trigger connector mode <input|output>")
                                                                                                            int value)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Set usage of trigger connector

Parameters:

0 - for input, 1 for output (signal when move is complete)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSpeed

@Command(name="setSpeed",
         description="Set filter wheel speed")
public void setSpeed(@Argument(name=" <0|1>",description="filter wheel speed <low|high>")
                                                                                              int value)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Set filter wheel speed

Parameters:

0 - for slow speed, 1 for high speed

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSensorMode

@Command(name="setSensorMode",
         description="Set sensor mode for idle FW")
public void setSensorMode(@Argument(name=" <0|1>",description="sensor mode <inactive|active> if FW idle")
                                                                                                             int value)
                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Set sensor mode for idle FW ("inactive" may avoid stray light)

Parameters:

0 - (inactive) or 1 (active)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDataRate

@Command(name="setDataRate",
         description="Set baud rate.  Danger: last-resort reset only!")
public void setDataRate(@Argument(name=" <0|1>",description="baud rate <9600|115200>")
                                                                                                                             int value)
                                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Set baud rate

Parameters:

0 - (9600) or 1 (115200)

Throws:

org.lsst.ccs.drivers.commons.DriverException

saveSettings

@Command(name="saveSettings",
         description="Save settings for next power-up")
public void saveSettings()
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Save settings for next power-up

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

@Command(name="setDebug",
         description="set debug mode <true|false>")
public void setDebug(@Argument(name="<true|false>",description="debug mode")
                                                                                                   boolean mode)

Set debug mode on or off