kernel.serial_ports.SerialPort Interface Reference

Inheritance diagram for kernel.serial_ports.SerialPort:

Public Member Functions
PortCommunicator	getCommunicator ()
void	open () throws PortInUseException
void	close ()
boolean	isPortOpen ()
PortConfiguration	getConfig ()
void	setConfig (PortConfiguration newConfig) throws UnsupportedCommOperationException

Detailed Description

Describes what a serial port can do

Definition at line 9 of file SerialPort.java.

Member Function Documentation

void kernel.serial_ports.SerialPort.close

(

)

close the port and release it to the world

PortCommunicator kernel.serial_ports.SerialPort.getCommunicator

(

)

Returns

The stream wrapper used to obtain the input and output streams for the pot

PortConfiguration kernel.serial_ports.SerialPort.getConfig

(

)

Returns

The configuration parameters of the port

boolean kernel.serial_ports.SerialPort.isPortOpen

(

)

Returns

true if the port is open, else false

void kernel.serial_ports.SerialPort.open

(

)

throws PortInUseException

Open the port

void kernel.serial_ports.SerialPort.setConfig

(

PortConfiguration

newConfig

)

throws UnsupportedCommOperationException

Set the configuration to a new value

Parameters

newConfig

a data structure representing the new values to be set

Exceptions

UnsupportedCommOperationException

if it cannot be done

---

The documentation for this interface was generated from the following file:

• SerialPort.java