org.lsst.ccs.drivers.ccob

Class CCOBCommands

java.lang.Object

org.lsst.ccs.drivers.ccob.CCOBCommands

All Implemented Interfaces:

CCOBInterface

public class CCOBCommands
extends Object
implements CCOBInterface

Adds convenience commands on top of the driver implementation.

Author:

CCS

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.ccob.CCOBInterface

CCOBInterface.LED

Constructor Summary

Constructors

Constructor and Description
CCOBCommands(CCOBInterface driver)

Method Summary

Modifier and Type	Method and Description
void	close()
String	date() The date of compilation of the firmware
String	device() Identify the device type
double	getAdcPhotoDiode() Return photodiode ADC values
CCOBDataRead	getAdcValues() Return housekeeping ADC values.
double	getBoardTemperature()
double	getLed1Temperature()
double	getLed2Temperature()
double	getLedCurrent()
double	getLedRefVoltage()
double	getLedVoltage()
double	getSphereTemperature()
void	init() Initializes the interface, should be called before anything else
void	ledOn(int led, int on) Turn one of the 4 onboard LED on or off
String	manu() Manufacturer/developer info from the firmware
String	misc() Additional firmware details
boolean	pollEnd() Check to see if the exposure has finished
void	pulse() Set the mode to pulsed, timed by setExposureTime
boolean	readButton(int Button) Reads the state of one of the 5 buttons
void	selectLed(CCOBInterface.LED led) Select which LED will be turned on (by startExposure, pulseLED etc)
void	setDriver(CCOBInterface driver)
void	setExposureTime(double time) Duration for use in pulsed mode
void	setLedCurrent(double current) Sets the current (for all LEDs)
void	shutter() Set the mode to shutter (unlimited time, remember to stop it)
void	startExposure() Turn on the LED based on exposure time and LED current
void	stop() Closes the interface, should be called at end or before you restart a cycle
String	version() The version of the firmware

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.drivers.ccob.CCOBInterface

selectLED, setLEDCurrent

Constructor Detail

CCOBCommands

public CCOBCommands(CCOBInterface driver)

Method Detail

setDriver

public void setDriver(CCOBInterface driver)

close

@Command(description="Close connection")
public void close()
                                                    throws IOException,
                                                           org.lsst.ccs.drivers.commons.DriverException

Throws:

IOException

org.lsst.ccs.drivers.commons.DriverException

init

@Command(description="Open connection and initialize CCOB")
public void init()
                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Initializes the interface, should be called before anything else

Specified by:

init in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the initialization fails

stop

@Command(description="Stop CCOB and close connection")
public void stop()
                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Closes the interface, should be called at end or before you restart a cycle

Specified by:

stop in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

version

@Command(description="Get version string")
public String version()
                                                          throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

The version of the firmware

Specified by:

version in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

date

@Command(description="Get date string")
public String date()
                                                    throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

The date of compilation of the firmware

Specified by:

date in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

misc

@Command(description="Get miscellaneous string")
public String misc()
                                                             throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Additional firmware details

Specified by:

misc in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

manu

@Command(description="Get manufacturer string")
public String manu()
                                                            throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Manufacturer/developer info from the firmware

Specified by:

manu in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

device

@Command(description="Get device string")
public String device()
                                                        throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Identify the device type

Specified by:

device in interface CCOBInterface

Returns:

The name of the device

Throws:

org.lsst.ccs.drivers.commons.DriverException

selectLed

@Command(description="Select the LED")
public void selectLed(@Argument(name="led",description="LED name")
                                                             CCOBInterface.LED led)
                                                      throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Select which LED will be turned on (by startExposure, pulseLED etc)

Specified by:

selectLed in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLedCurrent

@Command(description="Set the LED current")
public void setLedCurrent(@Argument(description="LED current (amps)")
                                                                      double current)
                                                               throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Sets the current (for all LEDs)

Specified by:

setLedCurrent in interface CCOBInterface

Parameters:

current - Current, in range 0-0.273 (Amps)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setExposureTime

@Command(description="Set the exposure time")
public void setExposureTime(@Argument(description="Exposure time (secs)")
                                                                          double time)
                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Duration for use in pulsed mode

Specified by:

setExposureTime in interface CCOBInterface

Parameters:

time - Exposure time (undefined units) (0-65535)

Throws:

org.lsst.ccs.drivers.commons.DriverException

pulse

@Command(description="Set pulse mode")
public void pulse()
                                                  throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Set the mode to pulsed, timed by setExposureTime

Specified by:

pulse in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

shutter

@Command(description="Set shutter mode")
public void shutter()
                                                      throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Set the mode to shutter (unlimited time, remember to stop it)

Specified by:

shutter in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

startExposure

@Command(description="Start exposure")
public void startExposure()
                                                          throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Turn on the LED based on exposure time and LED current

Specified by:

startExposure in interface CCOBInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

pollEnd

@Command(description="Poll for end of exposure")
public boolean pollEnd()
                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Check to see if the exposure has finished

Specified by:

pollEnd in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAdcValues

@Command(description="Read ADC values")
public CCOBDataRead getAdcValues()
                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Return housekeeping ADC values. Some are latched on specific moments

Specified by:

getAdcValues in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAdcPhotoDiode

@Command(description="Read photodiode voltage")
public double getAdcPhotoDiode()
                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Return photodiode ADC values

Specified by:

getAdcPhotoDiode in interface CCOBInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLedCurrent

@Command(description="Read LED current")
public double getLedCurrent()
                                                              throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLedVoltage

@Command(description="Read LED voltage")
public double getLedVoltage()
                                                              throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLedRefVoltage

@Command(description="Read LED reference voltage")
public double getLedRefVoltage()
                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSphereTemperature

@Command(description="Read sphere temperature")
public double getSphereTemperature()
                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getBoardTemperature

@Command(description="Read board temperature")
public double getBoardTemperature()
                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLed1Temperature

@Command(description="Read LED temperature 1")
public double getLed1Temperature()
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLed2Temperature

@Command(description="Read LED temperature 2")
public double getLed2Temperature()
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

ledOn

@Command(description="Set board LED state")
public void ledOn(@Argument(description="LED number (1 - 4)")
                                                              int led,
                                                              @Argument(description="LED state (1 = on, 0 = off)")
                                                              int on)
                                                       throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Turn one of the 4 onboard LED on or off

Specified by:

ledOn in interface CCOBInterface

Parameters:

led - LED number

on - On state

Throws:

org.lsst.ccs.drivers.commons.DriverException

readButton

@Command(description="Get button state")
public boolean readButton(@Argument(description="Button number (0 - 4)")
                                                                   int Button)
                                                            throws org.lsst.ccs.drivers.commons.DriverException

Description copied from interface: CCOBInterface

Reads the state of one of the 5 buttons

Specified by:

readButton in interface CCOBInterface

Parameters:

Button - Button number

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException