Package gda.device

Interface Serial

All Superinterfaces:

CharReadableDev, CharWriteableDev, Configurable, Device, Findable, gda.observable.IObservable

All Known Implementing Classes:

DummySerialDevice, SerialBase, SerialComm

public interface Serial
extends Device, CharReadableDev, CharWriteableDev

An interface for a distributed Serial (RS232) class

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BAUDRATE_0	Baud rate = 0
static final int	BAUDRATE_110	Baud rate = 110
static final int	BAUDRATE_115200	Baud rate = 115200
static final int	BAUDRATE_1200	Baud rate = 1200
static final int	BAUDRATE_128000	Baud rate = 128000
static final int	BAUDRATE_134	Baud rate = 134
static final int	BAUDRATE_14400	Baud rate = 14400
static final int	BAUDRATE_150	Baud rate = 1500
static final int	BAUDRATE_1800	Baud rate = 1800
static final int	BAUDRATE_19200	Baud rate = 19200
static final int	BAUDRATE_200	Baud rate = 200
static final int	BAUDRATE_2000	Baud rate = 2000
static final int	BAUDRATE_2400	Baud rate = 2400
static final int	BAUDRATE_256000	Baud rate = 256000
static final int	BAUDRATE_300	Baud rate = 300
static final int	BAUDRATE_3600	Baud rate = 3600
static final int	BAUDRATE_38400	Baud rate = 38400
static final int	BAUDRATE_4800	Baud rate = 4800
static final int	BAUDRATE_50	Baud rate = 50
static final int	BAUDRATE_56000	Baud rate = 56000
static final int	BAUDRATE_57600	Baud rate = 57600
static final int	BAUDRATE_600	Baud rate = 600
static final int	BAUDRATE_7200	Baud rate = 7200
static final int	BAUDRATE_75	Baud rate = 75
static final int	BAUDRATE_9600	Baud rate = 9600
static final int	BYTESIZE_5	Number of data bits = 5
static final int	BYTESIZE_6	Number of data bits = 6
static final int	BYTESIZE_7	Number of data bits = 7
static final int	BYTESIZE_8	Number of data bits = 8
static final String	FLOWCONTROL_NONE	No flow control
static final String	FLOWCONTROL_RTSCTS	rts cts flow control
static final String	FLOWCONTROL_XONXOFF	xon xoff flow control
static final String	PARITY_EVEN	Parity = even parity
static final String	PARITY_MARK	Parity = mark parity
static final String	PARITY_NONE	Parity = no parity
static final String	PARITY_ODD	Parity = odd parity
static final String	PARITY_SPACE	Parity = space parity
static final int	STOPBITS_1	Number of stop bits = 1
static final int	STOPBITS_1_5	Number of stop bits = 1.5
static final int	STOPBITS_2	Number of stop bits = 2

Method Summary

Modifier and Type	Method	Description
void	close()	Close serial connection
int	getReadTimeout()	Gets the timeout value for single character reads
void	setBaudRate(int baudRate)	Sets the baud rate to the required value
void	setByteSize(int byteSize)	Sets the number of data bits to the required value
void	setFlowControl(String flowControl)	Sets the flow control
void	setParity(String parity)	Sets the parity to the required value
void	setStopBits(int stopBits)	Sets the number of stop bits to the required value

Methods inherited from interface gda.device.CharReadableDev

flush, readChar, setReadTimeout

Methods inherited from interface gda.device.CharWriteableDev

writeChar

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Field Details

BYTESIZE_5

static final int BYTESIZE_5

Number of data bits = 5

See Also:

• Constant Field Values

BYTESIZE_6

static final int BYTESIZE_6

Number of data bits = 6

See Also:

• Constant Field Values

BYTESIZE_7

static final int BYTESIZE_7

Number of data bits = 7

See Also:

• Constant Field Values

BYTESIZE_8

static final int BYTESIZE_8

Number of data bits = 8

See Also:

• Constant Field Values

BAUDRATE_0

static final int BAUDRATE_0

Baud rate = 0

See Also:

• Constant Field Values

BAUDRATE_50

static final int BAUDRATE_50

Baud rate = 50

See Also:

• Constant Field Values

BAUDRATE_75

static final int BAUDRATE_75

Baud rate = 75

See Also:

• Constant Field Values

BAUDRATE_110

static final int BAUDRATE_110

Baud rate = 110

See Also:

• Constant Field Values

BAUDRATE_134

static final int BAUDRATE_134

Baud rate = 134

See Also:

• Constant Field Values

BAUDRATE_150

static final int BAUDRATE_150

Baud rate = 1500

See Also:

• Constant Field Values

BAUDRATE_200

static final int BAUDRATE_200

Baud rate = 200

See Also:

• Constant Field Values

BAUDRATE_300

static final int BAUDRATE_300

Baud rate = 300

See Also:

• Constant Field Values

BAUDRATE_600

static final int BAUDRATE_600

Baud rate = 600

See Also:

• Constant Field Values

BAUDRATE_1200

static final int BAUDRATE_1200

Baud rate = 1200

See Also:

• Constant Field Values

BAUDRATE_1800

static final int BAUDRATE_1800

Baud rate = 1800

See Also:

• Constant Field Values

BAUDRATE_2000

static final int BAUDRATE_2000

Baud rate = 2000

See Also:

• Constant Field Values

BAUDRATE_2400

static final int BAUDRATE_2400

Baud rate = 2400

See Also:

• Constant Field Values

BAUDRATE_3600

static final int BAUDRATE_3600

Baud rate = 3600

See Also:

• Constant Field Values

BAUDRATE_4800

static final int BAUDRATE_4800

Baud rate = 4800

See Also:

• Constant Field Values

BAUDRATE_7200

static final int BAUDRATE_7200

Baud rate = 7200

See Also:

• Constant Field Values

BAUDRATE_9600

static final int BAUDRATE_9600

Baud rate = 9600

See Also:

• Constant Field Values

BAUDRATE_14400

static final int BAUDRATE_14400

Baud rate = 14400

See Also:

• Constant Field Values

BAUDRATE_19200

static final int BAUDRATE_19200

Baud rate = 19200

See Also:

• Constant Field Values

BAUDRATE_38400

static final int BAUDRATE_38400

Baud rate = 38400

See Also:

• Constant Field Values

BAUDRATE_56000

static final int BAUDRATE_56000

Baud rate = 56000

See Also:

• Constant Field Values

BAUDRATE_57600

static final int BAUDRATE_57600

Baud rate = 57600

See Also:

• Constant Field Values

BAUDRATE_115200

static final int BAUDRATE_115200

Baud rate = 115200

See Also:

• Constant Field Values

BAUDRATE_128000

static final int BAUDRATE_128000

Baud rate = 128000

See Also:

• Constant Field Values

BAUDRATE_256000

static final int BAUDRATE_256000

Baud rate = 256000

See Also:

• Constant Field Values

STOPBITS_1

static final int STOPBITS_1

Number of stop bits = 1

See Also:

• Constant Field Values

STOPBITS_2

static final int STOPBITS_2

Number of stop bits = 2

See Also:

• Constant Field Values

STOPBITS_1_5

static final int STOPBITS_1_5

Number of stop bits = 1.5

See Also:

• Constant Field Values

PARITY_NONE

static final String PARITY_NONE

Parity = no parity

See Also:

• Constant Field Values

PARITY_ODD

static final String PARITY_ODD

Parity = odd parity

See Also:

• Constant Field Values

PARITY_EVEN

static final String PARITY_EVEN

Parity = even parity

See Also:

• Constant Field Values

PARITY_MARK

static final String PARITY_MARK

Parity = mark parity

See Also:

• Constant Field Values

PARITY_SPACE

static final String PARITY_SPACE

Parity = space parity

See Also:

• Constant Field Values

FLOWCONTROL_NONE

static final String FLOWCONTROL_NONE

No flow control

See Also:

• Constant Field Values

FLOWCONTROL_XONXOFF

static final String FLOWCONTROL_XONXOFF

xon xoff flow control

See Also:

• Constant Field Values

FLOWCONTROL_RTSCTS

static final String FLOWCONTROL_RTSCTS

rts cts flow control

See Also:

• Constant Field Values

Method Details

setBaudRate

void setBaudRate(int baudRate)
          throws DeviceException

Sets the baud rate to the required value

Parameters:

baudRate - number of bits/second

Throws:

DeviceException

setByteSize

void setByteSize(int byteSize)
          throws DeviceException

Sets the number of data bits to the required value

Parameters:

byteSize - number of data bits

Throws:

DeviceException

setParity

void setParity(String parity)
        throws DeviceException

Sets the parity to the required value

Parameters:

parity - type of parity

Throws:

DeviceException

setStopBits

void setStopBits(int stopBits)
          throws DeviceException

Sets the number of stop bits to the required value

Parameters:

stopBits - number of stop bits

Throws:

DeviceException

getReadTimeout

int getReadTimeout()
            throws DeviceException

Gets the timeout value for single character reads

Returns:

the timeout in milliseconds

Throws:

DeviceException

close

void close()
    throws DeviceException

Close serial connection

Specified by:

close in interface Device

Throws:

DeviceException

setFlowControl

void setFlowControl(String flowControl)
             throws DeviceException

Sets the flow control

Parameters:

flowControl -

Throws:

DeviceException