org.lsst.ccs.subsystem.metrology

Class KeyenceG5001Device

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.metrology.KeyenceG5001Device

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, KeyenceDevice

Direct Known Subclasses:

KeyenceG5001DeviceSim

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

KeyenceG5001 device class for the metrology subsystem

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failedToInitialize
protected boolean	isconnected
protected MetrologyState.pwrstates	kstate
protected double[]	lastRead

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

disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
KeyenceG5001Device()

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() Sets communications mode
void	genmode() Sets general mode
int	getcycles() Gets the sampling cycle setting being used for the displacement measurements
String	getError() Gets errors
double[]	getLastRead()
int	getmeasmode(int ikey) Gets the sensing mode.
int	getState()
protected void	initDevice() Initializes the Device instance
protected void	initialize() Initializes the device
String	keyenceChat(String command) Generic write operation followed by a read.
void	laser(boolean laserstate) Turns laser on/off
double	read(int ikey) Reads the distance from the Keyence head
double[]	readAll() Reads the distances from the Keyence heads
protected double	readChannel(int chan, int type) Reads a channel.
void	setcycles(int cycles) Sets the sampling cycle mode to be used for the displacement measurements
void	setmeasmode(int ikey, int mode) Sets the sensing mode.
void	setmindispunit(int dspu) Sets the minimum display unit.
void	setState(int istate)

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

addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getName, getOutputLines, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, 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.subsystem.metrology.KeyenceDevice

getLast_read

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

checkStopped

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

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

kstate

protected MetrologyState.pwrstates kstate

failedToInitialize

protected boolean failedToInitialize

isconnected

protected boolean isconnected

lastRead

protected double[] lastRead

Constructor Detail

KeyenceG5001Device

public KeyenceG5001Device()

Method Detail

initDevice

protected void initDevice()

Initializes the Device instance

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Initializes the device

Specified by:

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

close

protected void close()

Closes the connection.

Specified by:

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

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

Parameters:

name -

hwChan -

type -

subtype -

Returns:

Encoded type & subtype

Throws:

Exception

readChannel

protected double readChannel(int chan,
                             int type)

Reads a channel.

Overrides:

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

Parameters:

chan -

type -

Returns:

The channel value

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

Reads the distance from the Keyence head

Specified by:

read in interface KeyenceDevice

Parameters:

ikey -

Returns:

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

Gets the sampling cycle setting being used for the displacement measurements

Specified by:

getcycles in interface KeyenceDevice

Returns:

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

Sets the sampling cycle mode to be used for the displacement measurements

Specified by:

setcycles in interface KeyenceDevice

Parameters:

cycles -

Throws:

org.lsst.ccs.drivers.commons.DriverException

getmeasmode

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

Gets the sensing mode.

Specified by:

getmeasmode in interface KeyenceDevice

Parameters:

ikey -

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

setmeasmode

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

Sets the sensing mode.

Specified by:

setmeasmode in interface KeyenceDevice

Parameters:

ikey -

mode - 0: Normal, 1: Translucent object, 2: Transparent object, 3: Transparent object 2, 4: Semi opaque

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

Sets the minimum display unit.

Specified by:

setmindispunit in interface KeyenceDevice

Parameters:

dspu -

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

Reads the distances from the Keyence heads

Specified by:

readAll in interface KeyenceDevice

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

commmode

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

Sets 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

Sets 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

Gets errors

Specified by:

getError in interface KeyenceDevice

Returns:

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

Turns laser on/off

Specified by:

laser in interface KeyenceDevice

Parameters:

laserstate -

Throws:

org.lsst.ccs.drivers.commons.DriverException

keyenceChat

@Command(description="generic write",
         level=10)
public String keyenceChat(@Argument(name="command",description="The raw Keyence command")
                                                                                   String command)
                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Generic write operation followed by a read.

Parameters:

command -

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLastRead

public double[] getLastRead()

Specified by:

getLastRead 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()