org.lsst.ccs.subsystem.metrology

Class KeyenceG5001Device

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Device

org.lsst.ccs.subsystem.metrology.KeyenceG5001Device

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, KeyenceDevice, org.lsst.ccs.UsesSubsystem

public class KeyenceG5001Device
extends org.lsst.ccs.subsystem.monitor.Device
implements KeyenceDevice

KeyenceG5001 device class for the metrology subsystem * @author: Homer Neal **************************************************************************

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.monitor.Device

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, online

Constructor Summary

Constructors

Constructor and Description
KeyenceG5001Device() Constructor * **************************************************************************
KeyenceG5001Device(String host, int port) KeyenceG5001Device constructor - put KeyenceG5001 in initial subsystem state

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
void	commmode() communications mode **************************************************************************
protected void	configure(org.lsst.ccs.subsystem.monitor.Monitor mon) Performs configuration.
void	genmode() general mode **************************************************************************
int	getcycles() return the sampling cycle setting being used for the displacement measurements **************************************************************************
String	getError() get errors **************************************************************************
double[]	getLast_read()
int	getmeasmode() return the sensing mode **************************************************************************
int	getState()
String	getVersion() gets version of the Ensemble controller * **************************************************************************
protected void	initChannel(int chan, int type, int subtype) Initializes a channel.
protected void	initialize() Initializes the device **************************************************************************
void	laser(boolean laserstate) laser on/off **************************************************************************
double	read(int ikey) read the distance from the Keyence head **************************************************************************
double[]	readAll() read the distance from the Keyence head **************************************************************************
protected double	readChannel(int chan, int type) Reads a channel.
void	reset() reset **************************************************************************
void	setcycles(int cycles) set the sampling cycle mode to be used for the displacement measurements **************************************************************************
void	setmeasmode(int mode) set the sensing mode 0: Normal, 1: Translucent object, 2: Transparent object, 3: Transparent object 2, 4: Semi opaque **************************************************************************
void	setmindispunit(int dspu) set the minimum display unit **************************************************************************
void	setState(int istate)

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device

addChannel, addConfigValues, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, disable, dropChannel, enable, getConfigValues, getFullName, getOutputLines, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannelGroup, readChannelNow, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

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

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

init, postStart, shutdownNow, start

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Constructor Detail

KeyenceG5001Device

public KeyenceG5001Device(String host,
                          int port)
                   throws org.lsst.ccs.drivers.commons.DriverException

KeyenceG5001Device constructor - put KeyenceG5001 in initial subsystem state

Parameters:

host - device address

port - port or baud * * @param runBias CCD bias voltage while running

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

KeyenceG5001Device

public KeyenceG5001Device()

Constructor * **************************************************************************

Method Detail

configure

protected void configure(org.lsst.ccs.subsystem.monitor.Monitor mon)

Performs configuration.

Overrides:

configure in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

mon - **************************************************************************

close

protected void close()

Closes the connection. * **************************************************************************

Specified by:

close in class org.lsst.ccs.subsystem.monitor.Device

initialize

protected void initialize()

Initializes the device **************************************************************************

Specified by:

initialize in class org.lsst.ccs.subsystem.monitor.Device

getVersion

@Command(description="return controller version")
public String getVersion()
                                                                    throws org.lsst.ccs.drivers.commons.DriverException

gets version of the Ensemble controller * **************************************************************************

Specified by:

getVersion in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(name="read",
         description="get keyence head measurement")
public double read(@Argument(name="ikey",description="keyence head number")
                                                                                              int ikey)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

read the distance from the Keyence head **************************************************************************

Specified by:

read in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

getcycles

@Command(name="getcycles",
         description="get sampling cycle setting")
public int getcycles()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

return the sampling cycle setting being used for the displacement measurements **************************************************************************

Specified by:

getcycles in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

setcycles

@Command(name="setcycles",
         description="set number of cycles")
public void setcycles(@Argument(name="cycles",description="sampling cycle mode")
                                                                                              int cycles)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

set the sampling cycle mode to be used for the displacement measurements **************************************************************************

Specified by:

setcycles in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

getmeasmode

@Command(name="getmeasmode",
         description="get mode")
public int getmeasmode()
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

return the sensing mode **************************************************************************

Specified by:

getmeasmode in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

setmeasmode

@Command(name="setmeasmode",
         description="set mode")
public void setmeasmode(@Argument(name="mode",description="mode number")
                                                                                      int mode)
                                                                               throws org.lsst.ccs.drivers.commons.DriverException

set the sensing mode 0: Normal, 1: Translucent object, 2: Transparent object, 3: Transparent object 2, 4: Semi opaque **************************************************************************

Specified by:

setmeasmode in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

setmindispunit

@Command(name="setmindispunit",
         description="set mode")
public void setmindispunit(@Argument(name="dspu",description="(0: 0.01 mm, 1: 0.001 mm, 2: 0.0001 mm, 3: 0.00001 mm, 4: 0.1 um, 5: 0.01 um, 6: 0.001 um)")
                                                                                            int dspu)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

set the minimum display unit **************************************************************************

Specified by:

setmindispunit in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(name="readAll",
         description="get keyence head measurement")
public double[] readAll()
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

read the distance from the Keyence head **************************************************************************

Specified by:

readAll in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

commmode

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

communications mode **************************************************************************

Specified by:

commmode in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

genmode

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

general mode **************************************************************************

Specified by:

genmode in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

getError

@Command(description="returns any axis fault messages")
public String getError()
                                                                        throws org.lsst.ccs.drivers.commons.DriverException

get errors **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

@Command(description="clears all fault mesdsages")
public void reset()
                                                              throws org.lsst.ccs.drivers.commons.DriverException

reset **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

laser

@Command(description="sets lasers on/off")
public void laser(@Argument(name="laserstate",description="false for laser off / true for on")
                                                             boolean laserstate)
                                                      throws org.lsst.ccs.drivers.commons.DriverException

laser on/off **************************************************************************

Specified by:

laser in interface KeyenceDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity. * **************************************************************************

Overrides:

checkChannel in class org.lsst.ccs.subsystem.monitor.Device

Throws:

Exception

initChannel

protected void initChannel(int chan,
                           int type,
                           int subtype)

Initializes a channel. * **************************************************************************

Overrides:

initChannel in class org.lsst.ccs.subsystem.monitor.Device

readChannel

protected double readChannel(int chan,
                             int type)

Reads a channel. * **************************************************************************

Overrides:

readChannel in class org.lsst.ccs.subsystem.monitor.Device

getLast_read

public double[] getLast_read()

Specified by:

getLast_read in interface KeyenceDevice

setState

@Command(name="setstate",
         description="set KeyenceG5001 device status")
public void setState(int istate)

getState

@Command(name="getstate",
         description="get KeyenceG5001 device status")
public int getState()