org.lsst.ccs.subsystem.ccob.thin

Class Commands

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.ccob.thin.Commands

All Implemented Interfaces:

org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener, org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

public class Commands
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener, org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

Defines the names and other properties of the commands accepted by the subsystem. Delegates execution of the commands to the component we're using to implement the Controller interface. That will be either FakeController if the run mode is simulation, otherwise it will be RealController.

Author:

tether

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand, org.lsst.ccs.Agent.ShutdownResult

Field Summary

Fields inherited from class org.lsst.ccs.Agent

AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, jvmShutdown, logBusHandler, stateService, treeComponentInitialized

Constructor Summary

Constructors

Constructor and Description
Commands()

Method Summary

Modifier and Type	Method and Description
void	aimAgainUB()
void	aimAgainXY()
void	changeAxisEnable(org.lsst.ccs.subsystem.motorplatform.bus.ChangeAxisEnable cmd)
void	changeOutputLine(org.lsst.ccs.subsystem.motorplatform.bus.ChangeOutputLine cmd)
void	clearAllFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAllFaults cmd)
void	clearAxisFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAxisFaults cmd)
void	clearCapture(org.lsst.ccs.subsystem.motorplatform.bus.ClearCapture cmd)
void	clearFaults()
void	diodeOff()
void	diodeOn()
String	diodeStatus()
void	disable(String axisName)
void	disableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.DisableAllAxes cmd)
void	enable(String axisName)
void	enableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.EnableAllAxes cmd)
double	getDiodeAttenuation()
String	getLastReply()
String	getTarget()
void	home(String axisName)
void	homeAxis(org.lsst.ccs.subsystem.motorplatform.bus.HomeAxis cmd)
void	hyperCloseFastShutter()
void	hyperCloseMainShutter()
void	hyperKillLamp()
void	hyperLightLamp()
void	hyperOpenFastShutter()
void	hyperOpenMainShutter()
void	hyperRemoveFilter(String gratingName)
void	hyperSetWavelength(String wavelength)
void	hyperStartFastExposure(int millis)
String	hyperStatus()
double	illuminateThenRead(int millis)
void	moveAxisAbsolute(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisAbsolute cmd)
void	moveAxisRelative(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisRelative cmd)
void	moveBy(String axisName, double positionChange, double speed)
void	moveTo(String axisName, double newPosition, double speed)
double	picoGetRange()
double	picoReadCurrent()
void	picoSetRange(int range)
void	picoSetTime(double millis)
String	picoStatus()
double	readThenIlluminate(int millis)
void	sendAxisStatus(org.lsst.ccs.subsystem.motorplatform.bus.SendAxisStatus cmd)
void	sendConfiguration(org.lsst.ccs.subsystem.motorplatform.bus.SendConfiguration cmd)
void	sendControllerStatus(org.lsst.ccs.subsystem.motorplatform.bus.SendControllerStatus cmd)
void	setTargetHere()
void	setTargetTo(double x, double y)
void	setupCapture(org.lsst.ccs.subsystem.motorplatform.bus.SetupCapture cmd)
String	status(String controllerName)
void	stopAll()
void	stopAllMotion(org.lsst.ccs.subsystem.motorplatform.bus.StopAllMotion cmd)

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getNumberCommandThreads, ping, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCCSVersions, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getDistributionInfo, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, helper, initAgent, initLogBusHandler, isInEngineeringMode, populateComponentLookup, preInit, preStart, printComponentNodeTree, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, shutdownAgent, shutdownAgent, startAgent, vetoTransitionToNormalMode

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.ServiceLifecycle

afterBuild, afterInit, afterStart, preBuild, preShutdown

Constructor Detail

Commands

public Commands()

Method Detail

getLastReply

@Command(type=QUERY,
         level=0,
         description="(text) Returns the last reply from the TB server.")
public String getLastReply()

moveAxisRelative

@Command(level=0,
         description="(code) Relative motion of one axis.")
public void moveAxisRelative(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisRelative cmd)

Specified by:

moveAxisRelative in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

moveBy

@Command(level=0,
         description="(text) Relative motion: moveBy axisName positionChange speed")
public void moveBy(String axisName,
                                                                                                                          double positionChange,
                                                                                                                          double speed)

Specified by:

moveBy in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

moveAxisAbsolute

@Command(level=0,
         description="(code) Absolute motion of one axis.")
public void moveAxisAbsolute(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisAbsolute cmd)

Specified by:

moveAxisAbsolute in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

moveTo

@Command(level=0,
         description="(text) Absolute motion: moveTo axisName newPosition speed")
public void moveTo(String axisName,
                                                                                                                       double newPosition,
                                                                                                                       double speed)

Specified by:

moveTo in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

sendAxisStatus

@Command(type=QUERY,
         level=0,
         description="(code) Send ASAP on the status bus an AxisStatus message for the given axis.")
public void sendAxisStatus(org.lsst.ccs.subsystem.motorplatform.bus.SendAxisStatus cmd)

Specified by:

sendAxisStatus in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

sendConfiguration

@Command(type=QUERY,
         level=0,
         description="(code) Send ASAP on the status bus a PlatformConfig message describing the hardware.")
public void sendConfiguration(org.lsst.ccs.subsystem.motorplatform.bus.SendConfiguration cmd)

Specified by:

sendConfiguration in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

sendControllerStatus

@Command(type=QUERY,
         level=0,
         description="(code) Send ASAP on the status bus a ControllerStatus message.")
public void sendControllerStatus(org.lsst.ccs.subsystem.motorplatform.bus.SendControllerStatus cmd)

Specified by:

sendControllerStatus in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

stopAllMotion

@Command(level=0,
         description="(code) Stop any motion in progress.")
public void stopAllMotion(org.lsst.ccs.subsystem.motorplatform.bus.StopAllMotion cmd)

Specified by:

stopAllMotion in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

stopAll

@Command(level=0,
         description="(text) Stop any motion in progress. No arguments.")
public void stopAll()

Specified by:

stopAll in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

status

@Command(type=QUERY,
         level=0,
         description="(text) Gets a text report on the status of a hardware controller.")
public String status(@Argument(description="The controller name. One of XY, UB, P, H, K or SUMMARY. Case is ignored.")
                                                                                                                                                      String controllerName)

Specified by:

status in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

changeAxisEnable

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void changeAxisEnable(org.lsst.ccs.subsystem.motorplatform.bus.ChangeAxisEnable cmd)

Specified by:

changeAxisEnable in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

changeOutputLine

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void changeOutputLine(org.lsst.ccs.subsystem.motorplatform.bus.ChangeOutputLine cmd)

Specified by:

changeOutputLine in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

clearAllFaults

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void clearAllFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAllFaults cmd)

Specified by:

clearAllFaults in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

clearAxisFaults

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void clearAxisFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAxisFaults cmd)

Specified by:

clearAxisFaults in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

clearCapture

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void clearCapture(org.lsst.ccs.subsystem.motorplatform.bus.ClearCapture cmd)

Specified by:

clearCapture in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

enableAllAxes

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void enableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.EnableAllAxes cmd)

Specified by:

enableAllAxes in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

disableAllAxes

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void disableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.DisableAllAxes cmd)

Specified by:

disableAllAxes in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

homeAxis

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void homeAxis(org.lsst.ccs.subsystem.motorplatform.bus.HomeAxis cmd)

Specified by:

homeAxis in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

setupCapture

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void setupCapture(org.lsst.ccs.subsystem.motorplatform.bus.SetupCapture cmd)

Specified by:

setupCapture in interface org.lsst.ccs.subsystem.motorplatform.bus.MotorCommandListener

clearFaults

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void clearFaults()

Specified by:

clearFaults in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

enable

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void enable(String axisName)

Specified by:

enable in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

disable

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void disable(String axisName)

Specified by:

disable in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

home

@Command(level=0,
         autoAck=false,
         description="Not supported for thin-beam CCOB.")
public void home(String axisName)

Specified by:

home in interface org.lsst.ccs.subsystem.motorplatform.bus.ShellCommandListener

diodeOn

@Command(level=0,
         description="(text) Turns on the photodiode.")
public void diodeOn()

diodeOff

@Command(level=0,
         description="(text) Turns off the photodiode.")
public void diodeOff()

diodeStatus

@Command(level=0,
         description="(text) Gets the current photodiode status.")
public String diodeStatus()

picoStatus

@Command(level=0,
         description="(text) Gets the current pico-ammeter status.")
public String picoStatus()

picoReadCurrent

@Command(level=0,
         description="(text) Returns the pico-ammeter current in A.")
public double picoReadCurrent()

picoSetTime

@Command(level=0,
         description="(text) Sets the pico-ammeter integration time.")
public void picoSetTime(@Argument(description="The integration time in ms.")
                                                                                                                 double millis)

picoSetRange

@Command(level=0,
         description="(text) Sets the expected current range for the pico-ammeter.")
public void picoSetRange(@Argument(description="The range index: -1 (auto-range) or 0 to 7 inclusive.")
                                                                                                                                int range)

picoGetRange

@Command(level=0,
         description="(text) Gets the range setting in amps for the pico-ammeter.")
public double picoGetRange()

hyperSetWavelength

@Command(level=0,
         description="(text) Sets the light source wavelength.")
public void hyperSetWavelength(@Argument(description="Either a wavelength in nanometers or a color name like UVA or FIR. Case is ignored.")
                                                                                                                  String wavelength)

hyperOpenFastShutter

@Command(level=0,
         description="(text) Opens the high-speed shutter and leaves it open.")
public void hyperOpenFastShutter()

hyperCloseFastShutter

@Command(level=0,
         description="(text) Closes the high-speed shutter and leaves it closed.")
public void hyperCloseFastShutter()

hyperStartFastExposure

@Command(level=0,
         description="(text) Opens the high-speed shutter, starts a timer then returns. The shutter will close when the timer expires but this command will not wait for that to happen.")
public void hyperStartFastExposure(@Argument(description="The number of milliseconds to keep the shutter open.")
                                                                                                                                                                                                                                                int millis)

hyperOpenMainShutter

@Command(level=0,
         description="(text) Opens the slow (main) shutter and leaves it open.")
public void hyperOpenMainShutter()

hyperCloseMainShutter

@Command(level=0,
         description="(text) Closes the slow (main) shutter and leaves it closed.")
public void hyperCloseMainShutter()

hyperLightLamp

@Command(level=0,
         description="(text) Turns on the light source and leaves it on.")
public void hyperLightLamp()

hyperKillLamp

@Command(level=0,
         description="(text) Turns off the light source and leaves it off.")
public void hyperKillLamp()

hyperRemoveFilter

@Command(level=0,
         description="(text) Removes the filter and moves to the zero-order position of one of the gratings.")
public void hyperRemoveFilter(@Argument(description="The name of the grating, A or B. case is ignored.")
                                                                                                                                                               String gratingName)

hyperStatus

@Command(level=0,
         description="(text) Returns a status report for the hyperchromator.")
public String hyperStatus()

illuminateThenRead

@Command(level=0,
         description="(text) Starts the pico-ammeter reading after opening the high-speed shutter. Returns the reading in amps. Preferred over readThenIlluminate().")
public double illuminateThenRead(@Argument(description="The pico-ammeter integration time, and the high-speed shutter time to be open, in ms.")
                                                                                                                                                                                                                          int millis)

readThenIlluminate

@Command(level=0,
         description="(text) Starts the pico-ammeter reading before opening the high-speed shutter. The pico-ammeter range and integration time must have been previously set. Auto-ranging not allowed. Returns the reading in amps. May have sync problems.")
public double readThenIlluminate(@Argument(description="The time to keep the high-speed shutter open, in ms.")
                                                                                                                                                                                                                                                                                                                   int millis)

getDiodeAttenuation

@Command(level=0,
         description="(text) Gets the diode repsonse attenuation for the current wavelength setting of the hyperchromator (200-11nm only).")
public double getDiodeAttenuation()

getTarget

@Command(level=0,
         description="(text) Displays information about the current target.")
public String getTarget()

setTargetTo

@Command(level=0,
         description="(text) Sets the target to the given sensor plane XY coordinates.")
public void setTargetTo(@Argument(description="The desired sensor plane X coordinate, in mm.")
                                                                                                                                   double x,
                                                                                                                                   @Argument(description="The desired sensor plane Y coordinate, in mm.")
                                                                                                                                   double y)

setTargetHere

@Command(level=0,
         description="(text) Sets the target to the current sensor plane coordinates.")
public void setTargetHere()

aimAgainXY

@Command(level=0,
         description="(text) Move in XY to aim at current target after a change in UB.")
public void aimAgainXY()

aimAgainUB

@Command(level=0,
         description="(text) Move in UB to aim at current target after a change in XY.")
public void aimAgainUB()