org.lsst.ccs.drivers.lighthouse

Class LighthouseDriver

java.lang.Object

org.lsst.ccs.drivers.lighthouse.LighthouseDriver

public class LighthouseDriver
extends Object

Shell command driver. Driver methods are annotated for use by CCS command dictionary and shell system. Exceptions are passed through to next level where either subsystem or shell code handles them.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
LighthouseDriver() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearRecords() Clears all records from the device's internal data set.
void	close() Closes the device.
void	ftdiOpen(String ftdiID, boolean debug) Opens the device on an FTDI USB-serial cable.
void	getRecords() Prints to stdout the device's internal data set using the default encoding.
void	getRecords(String filename) Saves the device's internal data set as ASCII text.
void	netOpen(String hostname, int portNo, boolean debug) Opens the device on a network socket.
void	serialOpen(String portName, boolean debug) Opens the device on a serial port.
void	startRecording() Starts the device, appending all future records to its internal data set.
void	stopRecording() Stops the device so that it no longer updates its internal data set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LighthouseDriver

public LighthouseDriver()
                 throws org.lsst.ccs.drivers.commons.DriverException

Constructor.

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

serialOpen

@Command(description="Opens the device on a serial port.")
public void serialOpen(@Argument(description="The serial port name, for example /dev/ttyUSB0.")
                                                                                  String portName,
                                                                                  @Argument(description="When true, activates debug logging.",defaultValue="false")
                                                                                  boolean debug)
                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Opens the device on a serial port. Creates suitable implementations of the interfaces Transport and Hardware.

Parameters:

portName - The serial port name, for example /dev/ttyUSB0.

debug - If true enables debug-level logging of device command traffic.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all errors.

ftdiOpen

@Command(description="Opens the device on an FTDI USB-serial cable.")
public void ftdiOpen(@Argument(description="The serial no. of the cable, preceded by a hostname and a colon if it\'s a remote cable.")
                                                                                           String ftdiID,
                                                                                           @Argument(description="When true, activates debug logging.",defaultValue="false")
                                                                                           boolean debug)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Opens the device on an FTDI USB-serial cable. Creates suitable implementations of the interfaces Transport and Hardware.

Parameters:

ftdiID - The serial no. of the FTDI device to use, preceded by a hostname and a colon if remote. Examples: XXXXX or foo:XXXXX.

debug - If true enables debug-level logging of device command traffic.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all errors.

netOpen

@Command(description="Opens the device on a network socket.")
public void netOpen(@Argument(description="The remote host\'s name or IP address.")
                                                                                  String hostname,
                                                                                  @Argument(description="The number of the port to connect to.")
                                                                                  int portNo,
                                                                                  @Argument(description="When true, activates debug logging.",defaultValue="false")
                                                                                  boolean debug)
                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Opens the device on a network socket. Creates suitable implementations of the interfaces Transport and Hardware.

Parameters:

hostname - The remote host's name or IP address.

portNo - The number of the port to connect to.

debug - If true enables debug-level logging of device command traffic.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all errors.

close

@Command(name="close",
         description="Closes link used to communicate with the counter.")
public void close()
                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Closes the device.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all errors.

stopRecording

@Command(name="stopRecording",
         description="Stops the counter so that it no longer updates its internal data set.")
public void stopRecording()
                                                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Stops the device so that it no longer updates its internal data set. Has no effect if recording is already stopped.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all errors.

startRecording

@Command(name="startRecording",
         description="Starts the counter, appending all future records to its internal data set.")
public void startRecording()
                                                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Starts the device, appending all future records to its internal data set. Has no effect if the device is already active.

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearRecords

@Command(name="clearRecords",
         description="Clears all readings from the counter\'s internal data set.")
public void clearRecords()
                                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Clears all records from the device's internal data set. Recording must first be stopped.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRecords

@Command(name="getRecords",
         description="Saves the counter\'s buffered data set as ASCII text.")
public void getRecords(@Argument(description="The name of the file in which to save")
                                                                                                                                 String filename)
                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Saves the device's internal data set as ASCII text. The internal data set remains unchanged. Recording must first be stopped.

Parameters:

filename - The name of a file to receive the data.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all checked exceptions.

 begin record
     start     yyyy-mm-ddThh24:mm:ssZ
     duration  xxxxx seconds
     location  B84_123
     status    laser! sampler!
     channel 10.0   counter      12230 particles
     channel  2.5   counter      14 particles
     channel temp   temperature  39.1 Celsius
     channel hum    relhumidity  1.0 percent
 end record
 

getRecords

@Command(name="getRecords",
         description="Prints to stdout the counter\'s buffered data set using the default encoding.")
public void getRecords()
                                                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Prints to stdout the device's internal data set using the default encoding. The internal data set remains unchanged. Recording must first be stopped.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for all checked exceptions.

See Also:

getRecords(java.lang.String)