org.lsst.ccs.drivers.thorlabs

Class TestSC10

java.lang.Object

org.lsst.ccs.drivers.thorlabs.TestSC10

public class TestSC10
extends Object

Program to test the Thorlabs SC10 shutter driver

Constructor Summary

Constructors

Constructor and Description
TestSC10() Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Closes connection
String	listOpModes() List codes for operating modes
void	loadFromProm() Load those settings stored in EEPROM
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 shutter.
String	readMode() Read and decode the settings for operation and trigger modes
String	readSCpos() Read shutter position.
void	saveSettings() Save (some?) settings to non-volatile flash memory
void	saveToProm() Save some settings to EEPROM (trig mode, open and closed durations, probably operating mode)
void	setClosedDuration(int value) Set duration of shutter closed in ms (relevant to REPEAT and AUTO modes)
void	setDataRate(int value) Set baud rate
void	setDebug(boolean mode) Set debug mode on or off
void	setOpenDuration(int value) Set duration of shutter open in ms (relevant to SINGLE, REPEAT and AUTO modes)
void	setOpMode(int value) Set operating mode (five choices).
void	setOutputTrig(int value) Set meaning of external TTL trigger output
void	setRepeatCount(int value) Set repeat count for REPEAT operating mode.
void	setTrigMode(int value) Set trigger mode (internal or external)
String	timestamp() Determines current time
void	toggleEnable() Command to toggle "enable".

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSC10

public TestSC10()

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 shutter. Loops over all read commands and returns them in a table format (Raw responses, no decoding; for latter, see additional Read methods.) 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.

readSCpos

@Command(name="readSCpos",
         description="Read shutter position, <0|1> = <open|closed>")
public String readSCpos()
                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Read shutter position.

Returns:

String showing whether shutter is open (0) or closed (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMode

@Command(name="readMode",
         description="Decode operation and trigger modes")
public String readMode()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Read and decode the settings for operation and trigger modes

Returns:

String showing decoded modes

Throws:

org.lsst.ccs.drivers.commons.DriverException

listOpModes

@Command(name="listOpModes",
         description="List option codes for operating modes")
public String listOpModes()

List codes for operating modes

Returns:

List of numerical codes for operating modes

setTrigMode

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

Set trigger mode (internal or external)

Parameters:

Mode - <0|1> for

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOpMode

@Command(name="setOpMode",
         description="Set operating mode")
public void setOpMode(@Argument(name="<1|2|3|4|5>",description="operating mode (issue listOpModes for meanings)")
                                                                                            int value)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Set operating mode (five choices). This and trigger mode together define the shutter operation.

Parameters:

Mode - (1 to 5); use listOpModes command to see choices

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutputTrig

@Command(name="setOutputTrig",
         description="Set trigger mode")
public void setOutputTrig(@Argument(name="<0|1>",description="trigger output follows <shutter|controller>")
                                                                                                  int value)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Set meaning of external TTL trigger output

Parameters:

Mode - <0|1> for output follows output>

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRepeatCount

@Command(name="setRepeatCount",
         description="Set count for repeat mode")
public void setRepeatCount(@Argument(name="1-99 repeats",description="in REPEAT mode")
                                                                                                             int value)
                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Set repeat count for REPEAT operating mode.

Parameters:

Repeats, - 1 to 99

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOpenDuration

@Command(name="setOpenDuration",
         description="Set shutter-open duration")
public void setOpenDuration(@Argument(name="1-999999 ms",description="shutter-open duration if SINGLE, REPEAT, AUTO")
                                                                                                               int value)
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Set duration of shutter open in ms (relevant to SINGLE, REPEAT and AUTO modes)

Parameters:

Six - digits or fewer

Throws:

org.lsst.ccs.drivers.commons.DriverException

setClosedDuration

@Command(name="setClosedDuration",
         description="Set shutter-closed duration")
public void setClosedDuration(@Argument(name="1-999999 ms",description="shutter-closed duration if REPEAT or AUTO mode")
                                                                                                                     int value)
                                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Set duration of shutter closed in ms (relevant to REPEAT and AUTO modes)

Parameters:

Six - digits or fewer

Throws:

org.lsst.ccs.drivers.commons.DriverException

toggleEnable

@Command(name="toggleEnable",
         description="Initiate an internal trig or enable external trig")
public void toggleEnable()
                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Command to toggle "enable". In the internal trigger mode, "enable" either directly controls the opening and closing of the shutter (manual operating mode) or initiates a sequence of operations. In the external trigger mode, "enable" enables that trigger.

Parameters:

Position - to move to (1 to maximum)

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 some settings to non-volatile flash memory")
public void saveSettings()
                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Save (some?) settings to non-volatile flash memory

Throws:

org.lsst.ccs.drivers.commons.DriverException

saveToProm

@Command(name="saveToProm",
         description="Save some settings to EEPROM")
public void saveToProm()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Save some settings to EEPROM (trig mode, open and closed durations, probably operating mode)

Throws:

org.lsst.ccs.drivers.commons.DriverException

loadFromProm

@Command(name="loadFromProm",
         description="Load settings stored in EEPROM")
public void loadFromProm()
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Load those settings stored in EEPROM

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