org.lsst.ccs.subsystem.teststand

Class ThorlabsSC10Device

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.teststand.ThorlabsSC10Device

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle

public class ThorlabsSC10Device
extends org.lsst.ccs.monitor.Device

Interfaces with driver for Thorlabs SC10 shutter controller

Author:

Al Eisner

Field Summary

Fields

Modifier and Type	Field and Description
protected String	devcId
protected Boolean	outputMode
protected org.lsst.ccs.services.AgentStateService	stateService

Fields inherited from class org.lsst.ccs.monitor.Device

alertOfflineId, alertService, configService, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, path, s

Constructor Summary

Constructors

Constructor and Description
ThorlabsSC10Device()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String chName, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
void	closeShutter() Command to close shutter
void	exposure(Duration duration) Command to open shutter for a specified time interval
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
boolean	isShutterClosed() Check whether shutter is closed or open
void	openShutter() Command to open shutter
String	readAll() Read all settings and data from shutter controller Loops over all read commands and returns them in a table format.
protected double	readChannel(int hwChan, int type) Reads a channel.
void	setOutputMode(Boolean mode) Select mode for output signal
void	waitForClosed() Command to wait for shutter to close after an exposure.

Methods inherited from class org.lsst.ccs.monitor.Device

addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getGroupForChannel, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelGroup, readChannelNow, setDisabled, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.HardwareController

checkStopped

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

stateService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.AgentStateService stateService

devcId

@ConfigurationParameter(isFinal=true,
                        description="port Id")
protected volatile String devcId

outputMode

@ConfigurationParameter(isFinal=true,
                        description="<false|true> for output open/closed line to follow <shutter|controller> ")
protected volatile Boolean outputMode

Constructor Detail

ThorlabsSC10Device

public ThorlabsSC10Device()

Method Detail

initDevice

protected void initDevice()

Performs basic initialization. Verify that all ConfigurationParameters are set.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Performs full initialization.

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

isShutterClosed

public boolean isShutterClosed()
                        throws org.lsst.ccs.drivers.commons.DriverException

Check whether shutter is closed or open

Returns:

for shutter throws DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutputMode

@ConfigurationParameterChanger(propertyName="outputMode")
public void setOutputMode(Boolean mode)
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Select mode for output signal

Parameters:

mode - for signal to follow

Throws:

org.lsst.ccs.drivers.commons.DriverException

openShutter

@Command(type=ACTION,
         name="openShutter",
         description="Open shutter",
         autoAck=false)
public void openShutter()
                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Command to open shutter

Throws:

org.lsst.ccs.drivers.commons.DriverException

closeShutter

@Command(type=ACTION,
         name="closeShutter",
         description="Close shutter",
         autoAck=false)
public void closeShutter()
                                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Command to close shutter

Throws:

org.lsst.ccs.drivers.commons.DriverException

exposure

@Command(type=ACTION,
         name="exposure",
         description="Open shutter for specified time interval (ms)")
public void exposure(@Argument(name="<Duration>",description="exposure duration")
                                                                                                                                           Duration duration)
                                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException,
                                                                                                                                           TimeoutException

Command to open shutter for a specified time interval

Parameters:

duration - Open-duration as a Duration object

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

waitForClosed

@Command(type=ACTION,
         name="waitForClosed",
         description="Returns when shutter is closed after exposure",
         autoAck=false)
public void waitForClosed()
                                                                                                                                                                      throws TimeoutException

Command to wait for shutter to close after an exposure. It assumes that the exposure() method has waited for shutter to open. Throws TimeoutException if wait exceeds duration by > 1 second

Throws:

TimeoutException

checkChannel

protected int[] checkChannel(String chName,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

chName - The channel name

hwChan - The hardware channel number

type - The channel type string

subtype - The channel subtype string

Returns:

A two-element array containing the encoded type [0] and subtype [1] values.

Throws:

Exception - if any errors found in the parameters.

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The read value

readAll

@Command(type=QUERY,
         name="readAll",
         description="Read all filter-wheel controller settings and data")
public String readAll()

Read all settings and data from shutter controller 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.