org.openpnp.machine.reference.driver

Class SerialPortCommunications

java.lang.Object

org.openpnp.machine.reference.driver.ReferenceDriverCommunications

org.openpnp.machine.reference.driver.SerialPortCommunications

public class SerialPortCommunications
extends ReferenceDriverCommunications

A class for SerialPort Communications. Includes functions for connecting, disconnecting, reading and sending lines.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerialPortCommunications.DataBits
static class	SerialPortCommunications.FlowControl
static class	SerialPortCommunications.Parity
static class	SerialPortCommunications.StopBits

Nested classes/interfaces inherited from class org.openpnp.machine.reference.driver.ReferenceDriverCommunications

ReferenceDriverCommunications.LineEndingType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	baud
protected SerialPortCommunications.DataBits	dataBits
protected SerialPortCommunications.FlowControl	flowControl
protected java.lang.String	name
protected SerialPortCommunications.Parity	parity
protected java.lang.String	portName
protected boolean	setDtr
protected boolean	setRts
protected SerialPortCommunications.StopBits	stopBits

Fields inherited from class org.openpnp.machine.reference.driver.ReferenceDriverCommunications

lineEndingType

Constructor Summary

Constructors

Constructor and Description
SerialPortCommunications()

Method Summary

Modifier and Type	Method and Description
void	connect()
void	disconnect()
int	getBaud()
java.lang.String	getConnectionName()
SerialPortCommunications.DataBits	getDataBits()
SerialPortCommunications.FlowControl	getFlowControl()
SerialPortCommunications.Parity	getParity()
java.lang.String	getPortName()
static java.lang.String[]	getPortNames() Returns an array of Strings containing the names of serial ports present on the system
SerialPortCommunications.StopBits	getStopBits()
boolean	isSetDtr()
boolean	isSetRts()
int	read()
void	setBaud(int baud)
void	setDataBits(SerialPortCommunications.DataBits dataBits)
void	setFlowControl(SerialPortCommunications.FlowControl flowControl)
void	setParity(SerialPortCommunications.Parity parity)
void	setPortName(java.lang.String portName)
void	setSetDtr(boolean setDtr)
void	setSetRts(boolean setRts)
void	setStopBits(SerialPortCommunications.StopBits stopBits)
void	writeBytes(byte[] data)

Methods inherited from class org.openpnp.machine.reference.driver.ReferenceDriverCommunications

getGcodeServer, getLineEndingType, readLine, readUntil, setLineEndingType, write, writeLine

Methods inherited from class java.lang.Object

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

Field Detail

portName

protected java.lang.String portName

baud

protected int baud

flowControl

protected SerialPortCommunications.FlowControl flowControl

dataBits

protected SerialPortCommunications.DataBits dataBits

stopBits

protected SerialPortCommunications.StopBits stopBits

parity

protected SerialPortCommunications.Parity parity

setDtr

protected boolean setDtr

setRts

protected boolean setRts

name

protected java.lang.String name

Constructor Detail

SerialPortCommunications

public SerialPortCommunications()

Method Detail

connect

public void connect()
             throws java.lang.Exception

Specified by:

connect in class ReferenceDriverCommunications

Throws:

java.lang.Exception

disconnect

public void disconnect()
                throws java.lang.Exception

Specified by:

disconnect in class ReferenceDriverCommunications

Throws:

java.lang.Exception

getPortNames

public static java.lang.String[] getPortNames()

Returns an array of Strings containing the names of serial ports present on the system

Returns:

array of Strings of serial port names

read

public int read()
         throws java.util.concurrent.TimeoutException,
                java.io.IOException

Specified by:

read in class ReferenceDriverCommunications

Throws:

java.util.concurrent.TimeoutException

java.io.IOException

writeBytes

public void writeBytes(byte[] data)
                throws java.io.IOException

Specified by:

writeBytes in class ReferenceDriverCommunications

Throws:

java.io.IOException

getConnectionName

public java.lang.String getConnectionName()

Specified by:

getConnectionName in class ReferenceDriverCommunications

getPortName

public java.lang.String getPortName()

setPortName

public void setPortName(java.lang.String portName)

getBaud

public int getBaud()

setBaud

public void setBaud(int baud)

getFlowControl

public SerialPortCommunications.FlowControl getFlowControl()

setFlowControl

public void setFlowControl(SerialPortCommunications.FlowControl flowControl)

getDataBits

public SerialPortCommunications.DataBits getDataBits()

setDataBits

public void setDataBits(SerialPortCommunications.DataBits dataBits)

getStopBits

public SerialPortCommunications.StopBits getStopBits()

setStopBits

public void setStopBits(SerialPortCommunications.StopBits stopBits)

getParity

public SerialPortCommunications.Parity getParity()

setParity

public void setParity(SerialPortCommunications.Parity parity)

isSetDtr

public boolean isSetDtr()

setSetDtr

public void setSetDtr(boolean setDtr)

isSetRts

public boolean isSetRts()

setSetRts

public void setSetRts(boolean setRts)