com.moppyandroid.main.service

Class MoppyUsbManager

java.lang.Object

com.moppyandroid.main.service.MoppyUsbManager

public class MoppyUsbManager
extends Object

Manages the USB serial connections to Moppy devices and provides information about them.

Constructor Summary

Constructors

Constructor and Description
MoppyUsbManager(StatusBus statusBus, Context context) Creates a MoppyUsbManager, using the specified bus to alert consumers to device change events.

Method Summary

Modifier and Type	Method and Description
void	closeAllBridges() Closes all open connections, logging and discarding any generated IOExceptions.
void	closeBridge(String bridgeIdentifier) Closes a specified network bridge using its serial port path (e.g.
void	connectBridge(String bridgeIdentifier) Connects to a specified network bridge using its serial port path (e.g.
List<String>	getConnectedIdentifiers() Retrieves the list of the identifiers for all connected bridges
UsbDevice	getDeviceInfo(String identifier) Uses the identifier of a device to get the associated UsbDevice, which should only be used to find information about the device.
ArrayList<UsbDevice>	getDeviceInfoForAll() Retrieves the associated UsbDevice instance for all devices, which should only be used to find information about the device.
List<String>	getDevices() Retrieves the list of bridge identifiers that are available for connection.
int	getNumberConnected() Retrieves the number of connected bridges.
NetworkBridge<Object>	getPrimaryBridge() Retrieves the MultiBridge this MoppyUsbManager manages.
boolean	isConnected(String bridgeIdentifier) Checks if a specific bridge is connected using its serial port path (e.g.
void	refreshDeviceList() Refreshes the list of bridge identifiers with connected devices guaranteed to remain.

Methods inherited from class java.lang.Object

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

Constructor Detail

MoppyUsbManager

public MoppyUsbManager(StatusBus statusBus,
                       Context context)

Creates a MoppyUsbManager, using the specified bus to alert consumers to device change events.

Parameters:

statusBus - the bus used to communicate with status consumers

Method Detail

connectBridge

public void connectBridge(String bridgeIdentifier)
                   throws IOException

Connects to a specified network bridge using its serial port path (e.g. /dev/bus/usb/001/002). Potentially throws BridgeSerial.UnableToObtainDeviceException.

Parameters:

bridgeIdentifier - the identifier of the bridge to connect

Throws:

IOException - if unable to create the bridge

closeBridge

public void closeBridge(String bridgeIdentifier)
                 throws IOException

Closes a specified network bridge using its serial port path (e.g. /dev/bus/usb/001/002). The IOException is informational and can be ignored without any side effects.

Parameters:

bridgeIdentifier - the identifier of the bridge to close

Throws:

IOException - if unable to send the close message to the device

closeAllBridges

public void closeAllBridges()

Closes all open connections, logging and discarding any generated IOExceptions.

isConnected

public boolean isConnected(String bridgeIdentifier)

Checks if a specific bridge is connected using its serial port path (e.g. /dev/bus/usb/001/002).

Parameters:

bridgeIdentifier - the identifier of the bridge to check connection status

refreshDeviceList

public void refreshDeviceList()

Refreshes the list of bridge identifiers with connected devices guaranteed to remain.

getPrimaryBridge

public NetworkBridge<Object> getPrimaryBridge()

Retrieves the MultiBridge this MoppyUsbManager manages. Needed for registering this MoppyUsbManager to receive messages from a MoppyMIDIReceiverSender.

Returns:

the managed MultiBridge

getDevices

public List<String> getDevices()

Retrieves the list of bridge identifiers that are available for connection. The list used by connectBridge(String) is updated automatically upon device plugging/unplugging, however the list returned here is not. This list can be updated with refreshDeviceList().

Returns:

the cached bridge identifiers

getNumberConnected

public int getNumberConnected()

Retrieves the number of connected bridges.

Returns:

the number of bridges

getConnectedIdentifiers

public List<String> getConnectedIdentifiers()

Retrieves the list of the identifiers for all connected bridges

Returns:

the connect bridge identifiers

getDeviceInfo

public UsbDevice getDeviceInfo(String identifier)

Uses the identifier of a device to get the associated UsbDevice, which should only be used to find information about the device. Attempting to connect to the device may hamper MoppyUsbManager operation.

Parameters:

identifier - the identifier of the device to find information on

Returns:

null if not found, otherwise the associated UsbDevice

getDeviceInfoForAll

public ArrayList<UsbDevice> getDeviceInfoForAll()

Retrieves the associated UsbDevice instance for all devices, which should only be used to find information about the device. ArrayList returned rather than List because it implements Serializable.

Returns:

an ArrayList<UsbDevice> containing all available devices

See Also:

getDeviceInfo(String)