org.lsst.ccs.drivers.ccob

Class CCOBSocketDriver

java.lang.Object

org.lsst.ccs.drivers.ccob.CCOBSocketDriver

All Implemented Interfaces:

Closeable, AutoCloseable, CCOBInterface

public class CCOBSocketDriver
extends Object
implements CCOBInterface, Closeable

An implementation of the CCOB driver which uses sockets to communicate with a CCOBServer

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
CCOBSocketDriver(String host, int port)

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

CCOBSocketDriver

public CCOBSocketDriver(String host,
                        int port)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

init

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

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

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

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

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

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

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

public void selectLed(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

public void setLedCurrent(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

public void setExposureTime(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

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

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

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

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

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

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

ledOn

public void ledOn(int Led,
                  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

public boolean readButton(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