org.lsst.ccs.drivers.keyence

Class KeyenceG5001

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.keyence.KeyenceG5001

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class KeyenceG5001
extends org.lsst.ccs.drivers.ascii.Ascii

General access the KeyenceG5001 device using its ASCII command interface. The lower-level methods defined by the Ascii class are available in addition to the methods defined here.

Author:

saxton, tether, Homer Neal

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ascii.Ascii.DataBits, org.lsst.ccs.drivers.ascii.Ascii.FlowCtrl, org.lsst.ccs.drivers.ascii.Ascii.Option, org.lsst.ccs.drivers.ascii.Ascii.Parity, org.lsst.ccs.drivers.ascii.Ascii.StopBits, org.lsst.ccs.drivers.ascii.Ascii.Terminator

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.commons.DriverConstants

org.lsst.ccs.drivers.commons.DriverConstants.ConnType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BAUD
static String	DEFAULT_DEV

Constructor Summary

Constructors

Constructor and Description
KeyenceG5001() Constructor.

Method Summary

Modifier and Type	Method and Description
void	commmode() Sets communications mode.
void	genmode() Sets general mode.
int	getmeasmode(int ikey) Gets the measurement mode for a sensor.
int	getmindispunit(int ikey) Gets minimum display units for a sensor.
int	getnsamps() Gets the number of samples to be averaged.
void	laser(boolean laserstate) Sets the KeyenceG5001 laser state by switching to general mode (lasers on) or comm mode (off).
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int baud, int dChar) Opens a connection to the device; device state is unchanged.
double[]	readDistance() Gets the KeyenceG5001 measurement for all heads.
double	readDistance(int ikey) Gets the KeyenceG5001 measurement for a head.
String	readKey(String command) Like writeKey(java.lang.String) but returns the response stripped of the the echoed command and comma at the beginning.
void	setmeasmode(int ikey, int mode) Sets the measurement mode for a sensor.
void	setmindispunit(int dspu) Sets minimum display units for both sensors.
void	setmindispunit(int ikey, int dspu) Sets the minimum display units for a sensor, that is, the unit of measure and the precision displayed for that unit.
void	setnsamps(int cycle) Sets the number of samples to be averaged (as implied by cycle time).
void	writeKey(String command) Writes a command, reads the response and checks whether it's an error response.

Methods inherited from class org.lsst.ccs.drivers.ascii.Ascii

close, closeSilent, flush, getConnTimeout, getTimeout, isDropEcho, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setConnTimeout, setConnTimeout, setDefaultBaud, setDefaultParm, setDefaultPort, setMultidrop, setOptions, setResponseTerm, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BAUD

public static final int DEFAULT_BAUD

See Also:

Constant Field Values

DEFAULT_DEV

public static final String DEFAULT_DEV

See Also:

Constant Field Values

Constructor Detail

KeyenceG5001

public KeyenceG5001()

Constructor. Disallows using the device over the network.

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident,
                 int baud,
                 int dChar)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device; device state is unchanged. The device is left closed() if an exception is thrown.

Overrides:

open in class org.lsst.ccs.drivers.ascii.Ascii

Parameters:

type - The enumerated type of connection to make

ident - The device identifier

baud - The baud rate: use 0 for the default of 38400.

dChar - The encoded data characteristics: always set to 0

Throws:

org.lsst.ccs.drivers.commons.DriverException - upon I/O error.

laser

public void laser(boolean laserstate)
           throws org.lsst.ccs.drivers.commons.DriverException

Sets the KeyenceG5001 laser state by switching to general mode (lasers on) or comm mode (off).

Parameters:

laserstate - Whether laser is turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

commmode

public void commmode()
              throws org.lsst.ccs.drivers.commons.DriverException

Sets communications mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

genmode

public void genmode()
             throws org.lsst.ccs.drivers.commons.DriverException

Sets general mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

setnsamps

public void setnsamps(int cycle)
               throws org.lsst.ccs.drivers.commons.DriverException

Sets the number of samples to be averaged (as implied by cycle time).

Parameters:

cycle - Cycle time: 0: 2.55 us, 1: 5 us, 2: 10 us, 3: 20 us, 4: 50 us, 5: 100 us, 6:200 us, 7: 500 us, 8: 1000 us

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

getnsamps

public int getnsamps()
              throws org.lsst.ccs.drivers.commons.DriverException

Gets the number of samples to be averaged.

Returns:

The sample count.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

setmeasmode

public void setmeasmode(int ikey,
                        int mode)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the measurement mode for a sensor.

Parameters:

ikey - The sensor number

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

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

getmeasmode

public int getmeasmode(int ikey)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the measurement mode for a sensor.

Parameters:

ikey - The sensor number

Returns:

The measurement mode

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

setmindispunit

public void setmindispunit(int ikey,
                           int dspu)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the minimum display units for a sensor, that is, the unit of measure and the precision displayed for that unit.

Parameters:

ikey - The sensor number

dspu - The units: 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

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

getmindispunit

public int getmindispunit(int ikey)
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets minimum display units for a sensor.

Parameters:

ikey - The sensor number

Returns:

The display units.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

See Also:

setmindispunit(int, int)

setmindispunit

public void setmindispunit(int dspu)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets minimum display units for both sensors.

Parameters:

dspu - The display units.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

See Also:

setmindispunit(int, int)

readDistance

public double readDistance(int ikey)
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the KeyenceG5001 measurement for a head.

Parameters:

ikey - The head number

Returns:

The measured value

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

readDistance

public double[] readDistance()
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the KeyenceG5001 measurement for all heads.

Returns:

The array of values.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

writeKey

public void writeKey(String command)
              throws org.lsst.ccs.drivers.commons.DriverException

Writes a command, reads the response and checks whether it's an error response.

Parameters:

command - The command to write.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.

readKey

public String readKey(String command)
               throws org.lsst.ccs.drivers.commons.DriverException

Like writeKey(java.lang.String) but returns the response stripped of the the echoed command and comma at the beginning.

Parameters:

command - The command to write.

Returns:

The command response string.

Throws:

org.lsst.ccs.drivers.commons.DriverException - on I/O error or an error response from the device.