org.eclipse.kura.usb

Class UsbModemDevice

java.lang.Object

org.eclipse.kura.usb.AbstractUsbDevice

org.eclipse.kura.usb.UsbModemDevice

All Implemented Interfaces:

ModemDevice, UsbDevice

@ProviderType
public class UsbModemDevice
extends AbstractUsbDevice
implements ModemDevice

Representation of USB modem devices

Constructor Summary

Constructors

Constructor and Description
UsbModemDevice(AbstractUsbDevice usbDevice)
UsbModemDevice(java.lang.String vendorId, java.lang.String productId, java.lang.String manufacturerName, java.lang.String productName, java.lang.String usbBusNumber, java.lang.String usbDevicePath)

Method Summary

Modifier and Type	Method and Description
void	addBlockDev(java.lang.String blockDev) Adds a block device identified by its name.
void	addTtyDev(java.lang.String ttyDev) Deprecated. this method is deprecated in favor of addTtyDev(String ttyDev, Integer interfaceNumber)
void	addTtyDev(java.lang.String ttyDev, java.lang.Integer interfaceNumber) Adds a tty device identified by its name and USB interface number (bInterfaceNumber).
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getBlockDevs()
java.util.List<java.lang.String>	getSerialPorts() The list of serial ports available on the device
java.util.List<java.lang.String>	getTtyDevs() Return a list of tty devices, sorted in a way to facilitate the client code identifying dedicated devices, e.g.
int	hashCode()
boolean	removeBlockDev(java.lang.String blockDev) Remove a block device form the list.
boolean	removeTtyDev(java.lang.String ttyDev) Remove a tty device form the list.
java.lang.String	toString()

Methods inherited from class org.eclipse.kura.usb.AbstractUsbDevice

getManufacturerName, getProductId, getProductName, getUsbBusNumber, getUsbDevicePath, getUsbPort, getVendorId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.kura.net.modem.ModemDevice

getManufacturerName, getProductName

Constructor Detail

UsbModemDevice

public UsbModemDevice(java.lang.String vendorId,
                      java.lang.String productId,
                      java.lang.String manufacturerName,
                      java.lang.String productName,
                      java.lang.String usbBusNumber,
                      java.lang.String usbDevicePath)

UsbModemDevice

public UsbModemDevice(AbstractUsbDevice usbDevice)

Method Detail

getSerialPorts

public java.util.List<java.lang.String> getSerialPorts()

Description copied from interface: ModemDevice

The list of serial ports available on the device

Specified by:

getSerialPorts in interface ModemDevice

Returns:

a list of serial ports names

getTtyDevs

public java.util.List<java.lang.String> getTtyDevs()

Return a list of tty devices, sorted in a way to facilitate the client code identifying dedicated devices, e.g. for AT commands, PPP link or NMEA sentences, based on their position in the list. Originally, only the tty name was used for the comparison. This proved to be wrong as a tty name does reliably identify the USB interface number (bInterfaceNumber) of the tty device. To preserve the API contract, the tty devices can be added specifying the USB interface number and this will be used to sort the list.

Returns:

sorted list of tty devices

getBlockDevs

public java.util.List<java.lang.String> getBlockDevs()

Returns:

sorted list of block devices

addTtyDev

public void addTtyDev(java.lang.String ttyDev,
                      java.lang.Integer interfaceNumber)

Adds a tty device identified by its name and USB interface number (bInterfaceNumber). The devices will be sorted by the interface number. If this is missing, the name will be used.

Parameters:

ttyDev - the name of the tty device

interfaceNumber - the number of the interface as described by the bInterfaceNumber property

Since:

1.4

addTtyDev

@Deprecated
public void addTtyDev(java.lang.String ttyDev)

Deprecated. this method is deprecated in favor of addTtyDev(String ttyDev, Integer interfaceNumber)

addBlockDev

public void addBlockDev(java.lang.String blockDev)

Adds a block device identified by its name. The block devices will be sorted by the name.

Parameters:

blockDev - the name of the block device

removeTtyDev

public boolean removeTtyDev(java.lang.String ttyDev)

Remove a tty device form the list.

Parameters:

ttyDev - the name of the tty device

Returns:

true if the list contained the specified device

removeBlockDev

public boolean removeBlockDev(java.lang.String blockDev)

Remove a block device form the list.

Parameters:

blockDev - the name of the block device

Returns:

true if the list contained the specified device

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractUsbDevice

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractUsbDevice

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object