com.moppy.core.comms.bridge

Class BridgeSerial

java.lang.Object

com.moppy.core.comms.bridge.NetworkBridge<Integer>

com.moppy.core.comms.bridge.BridgeSerial

All Implemented Interfaces:

NetworkMessageConsumer, Closeable, AutoCloseable

public class BridgeSerial
extends NetworkBridge<Integer>

A Serial connection for Moppy devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BridgeSerial.UnableToObtainDeviceException Runtime exception thrown if the requested USB device could not be opened

Constructor Summary

Constructors

Constructor and Description
BridgeSerial(String serialPortName) Constructs a BridgeSerial object to communicate on a specific port.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this BridgeSerial connection.
void	connect()
void	connect(Integer newBaudRate)
Integer	currentConnectionOption()
static List<String>	getAvailableSerials()
List<Integer>	getConnectionOptions()
String	getNetworkIdentifier()
static void	init(Context context) Assigns static variables.
boolean	isConnected()
void	sendMessage(MoppyMessage messageToSend)

Methods inherited from class com.moppy.core.comms.bridge.NetworkBridge

acceptNetworkMessage, deregisterMessageReceiver, registerMessageReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeSerial

public BridgeSerial(String serialPortName)

Constructs a BridgeSerial object to communicate on a specific port.

Parameters:

serialPortName - the port to communicate on

Throws:

IllegalArgumentException - if the specified device doesn't exist

BridgeSerial.UnableToObtainDeviceException - if the serial port representing the specified device could not be obtained

Method Detail

init

public static void init(Context context)

Assigns static variables. Must be called before use of BridgeSerial objects.

Parameters:

context - the context used to retrieve Android system resources

getAvailableSerials

public static List<String> getAvailableSerials()

connect

public void connect(Integer newBaudRate)
             throws IOException

Specified by:

connect in class NetworkBridge<Integer>

Throws:

IOException

connect

public void connect()
             throws IOException

Specified by:

connect in class NetworkBridge<Integer>

Throws:

IOException

sendMessage

public void sendMessage(MoppyMessage messageToSend)
                 throws IOException

Specified by:

sendMessage in class NetworkBridge<Integer>

Throws:

IOException

close

public void close()
           throws IOException

Closes this BridgeSerial connection. Unlike the original MoppyLib implementation, renders this BridgeSerial inoperable

Throws:

IOException - if unable to write the SYS_STOP message

BridgeSerial.UnableToObtainDeviceException - if the serial port could not be recreated after closing communication

getNetworkIdentifier

public String getNetworkIdentifier()

Specified by:

getNetworkIdentifier in class NetworkBridge<Integer>

isConnected

public boolean isConnected()

Specified by:

isConnected in class NetworkBridge<Integer>

getConnectionOptions

public List<Integer> getConnectionOptions()

Specified by:

getConnectionOptions in class NetworkBridge<Integer>

currentConnectionOption

public Integer currentConnectionOption()

Specified by:

currentConnectionOption in class NetworkBridge<Integer>