org.lsst.ccs.drivers.ccob

Interface CCOBInterface

All Known Implementing Classes:

CCOBCommands, CcobJNI, CCOBSim, CCOBSocketDriver, CCOBUsb

public interface CCOBInterface

A high-level interface to the CCOB designed to be implementable using either sockets or JNI or UsbLib

Author:

CCS

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CCOBInterface.LED

Method Summary

Modifier and Type	Method and Description
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)
default void	selectLED(CCOBInterface.LED led) Deprecated.
void	setExposureTime(double time) Duration for use in pulsed mode
void	setLedCurrent(double current) Sets the current (for all LEDs)
default void	setLEDCurrent(double current) Deprecated.
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

Method Detail

init

void init()
   throws org.lsst.ccs.drivers.commons.DriverException

Initializes the interface, should be called before anything else

Throws:

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

stop

void stop()
   throws org.lsst.ccs.drivers.commons.DriverException

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

version

String version()
        throws org.lsst.ccs.drivers.commons.DriverException

The version of the firmware

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

date

String date()
     throws org.lsst.ccs.drivers.commons.DriverException

The date of compilation of the firmware

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

misc

String misc()
     throws org.lsst.ccs.drivers.commons.DriverException

Additional firmware details

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

manu

String manu()
     throws org.lsst.ccs.drivers.commons.DriverException

Manufacturer/developer info from the firmware

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

device

String device()
       throws org.lsst.ccs.drivers.commons.DriverException

Identify the device type

Returns:

The name of the device

Throws:

org.lsst.ccs.drivers.commons.DriverException

selectLed

void selectLed(CCOBInterface.LED led)
        throws org.lsst.ccs.drivers.commons.DriverException

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

Parameters:

led -

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLedCurrent

void setLedCurrent(double current)
            throws org.lsst.ccs.drivers.commons.DriverException

Sets the current (for all LEDs)

Parameters:

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setExposureTime

void setExposureTime(double time)
              throws org.lsst.ccs.drivers.commons.DriverException

Duration for use in pulsed mode

Parameters:

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

pulse

void pulse()
    throws org.lsst.ccs.drivers.commons.DriverException

Set the mode to pulsed, timed by setExposureTime

Throws:

org.lsst.ccs.drivers.commons.DriverException

shutter

void shutter()
      throws org.lsst.ccs.drivers.commons.DriverException

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

startExposure

void startExposure()
            throws org.lsst.ccs.drivers.commons.DriverException

Turn on the LED based on exposure time and LED current

Throws:

org.lsst.ccs.drivers.commons.DriverException

pollEnd

boolean pollEnd()
         throws org.lsst.ccs.drivers.commons.DriverException

Check to see if the exposure has finished

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAdcValues

CCOBDataRead getAdcValues()
                   throws org.lsst.ccs.drivers.commons.DriverException

Return housekeeping ADC values. Some are latched on specific moments

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAdcPhotoDiode

double getAdcPhotoDiode()
                 throws org.lsst.ccs.drivers.commons.DriverException

Return photodiode ADC values

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

ledOn

void ledOn(int led,
           int on)
    throws org.lsst.ccs.drivers.commons.DriverException

Turn one of the 4 onboard LED on or off

Parameters:

led - LED number

on - On state

Throws:

org.lsst.ccs.drivers.commons.DriverException

readButton

boolean readButton(int button)
            throws org.lsst.ccs.drivers.commons.DriverException

Reads the state of one of the 5 buttons

Parameters:

button - Button number

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

selectLED

@Deprecated
default void selectLED(CCOBInterface.LED led)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLEDCurrent

@Deprecated
default void setLEDCurrent(double current)
                                throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException