org.lsst.ccs.subsystem.teststand

Class ThorlabsFWDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.teststand.ThorlabsFWDevice

All Implemented Interfaces:

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

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

Interfaces with driver for Thorlabs filter wheel (either the six-position model 102C or the twelve-position model 212C) Changes in position are published as state transitions. Initial version identifies filters only by position, not by properties.

Author:

Al Eisner

Field Summary

Fields

Modifier and Type	Field and Description
protected String	devcId
protected List<String>	filterNames
protected Integer	fwsize
protected Boolean	sensorMode
protected Boolean	speedMode
protected org.lsst.ccs.services.AgentStateService	stateService

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

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
ThorlabsFWDevice()

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.
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
String	listFilters() Command to list filter names by position
String	readAll() Read all settings and data from filter wheel Loops over all read commands and returns them in a table format.
protected double	readChannel(int hwChan, int type) Reads a channel.
String	readFWPos() Read filter-wheel position
void	setNamedPosition(String posName) Command to move filter wheel with position selected by name (published as State change)
void	setPosition(int value) Command to move filter wheel (published as State change)
void	setSensorMode(Boolean mode) Select sensor mode when filter wheel is idle
void	setSpeedMode(Boolean mode) Select speed for filter wheel motion

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

addChannel, addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getName, getOutputLines, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelNow, readSensors, 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

checkStarted, 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 String devcId

fwsize

@ConfigurationParameter(isFinal=true,
                        description="6 or 12 for filter-wheel size")
protected Integer fwsize

filterNames

@ConfigurationParameter(isFinal=true,
                        description="List of filter names")
protected List<String> filterNames

speedMode

@ConfigurationParameter(description="<false|true> for <low|high> speed of motion")
protected Boolean speedMode

sensorMode

@ConfigurationParameter(description="<false|true> for sensors <inactive|active> when wheel idle")
protected Boolean sensorMode

Constructor Detail

ThorlabsFWDevice

public ThorlabsFWDevice()

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

setSpeedMode

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

Select speed for filter wheel motion

Parameters:

mode - True for high-speed, false for low-speed

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSensorMode

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

Select sensor mode when filter wheel is idle

Parameters:

mode - True for active, false for inactive

Throws:

org.lsst.ccs.drivers.commons.DriverException

listFilters

@Command(type=QUERY,
         name="listFilters",
         description="List filter names by position")
public String listFilters()

Command to list filter names by position

Returns:

List of filter names

setPosition

@Command(type=ACTION,
         name="setPosition",
         description="Set filter wheel position")
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 (published as State change)

Parameters:

Position - to move to (1 to maximum)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setNamedPosition

@Command(type=ACTION,
         name="setNamedPosition",
         description="Set filter wheel to named position")
public void setNamedPosition(@Argument(name="<String>",description="Name of new position")
                                                                                                                                                String posName)
                                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Command to move filter wheel with position selected by name (published as State change)

Parameters:

Name - of selected filter

Throws:

org.lsst.ccs.drivers.commons.DriverException

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

readFWPos

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

Read filter-wheel position

Returns:

String indicating filter position

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(type=QUERY,
         name="readAll",
         description="Read all filter-wheel 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.