com.ftdi.d3xx

Class FTD3XX

java.lang.Object

com.ftdi.d3xx.FTD3XX

public class FTD3XX
extends java.lang.Object

FTDI D3XX class library for USB Superspeed devices, such as the FT60X series.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FTD3XX.ChipConfiguration Contains information of the configurable parameters for the D3XX device
static class	FTD3XX.ConfigurationDescriptor Contains information of the USB configuration descriptor for the D3XX device.
static class	FTD3XX.Constants Contains constants for the D3XX devices.
static class	FTD3XX.DeviceDescriptor Contains information of the USB device descriptor for the D3XX device.
static class	FTD3XX.DeviceInfo Contains information of the user-configured device used to differentiate among multiple connected D3XX devices
static interface	FTD3XX.INotificationCallback Interface for setting notification callback
static class	FTD3XX.InterfaceDescriptor Contains information of the USB interface descriptor for the D3XX device.
static class	FTD3XX.PipeInformation Contains information of the USB endpoint descriptor for the D3XX device.
static class	FTD3XX.SetupPacket Contains information used for the control transfer sent to the D3XX device

Constructor Summary

Constructors

Constructor and Description
FTD3XX(android.content.Context context) Instantiates a FTD3XX class

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

FTD3XX

public FTD3XX(android.content.Context context)

Instantiates a FTD3XX class

Parameters:

context - Context of the activity or application

Method Detail

CreateDeviceInfoList

public int CreateDeviceInfoList()

Builds a device information list and returns the number of D3XX devices connected to the system. The list contains information about connected D3XX devices. The list can be retrieved using GetDeviceInfoList().

Returns:

The number of connected devices

GetDeviceInfoList

public final java.util.ArrayList<FTD3XX.DeviceInfo> GetDeviceInfoList()

Returns a device information list of connected devices. This function should only be called after calling CreateDeviceInfoList.

Returns:

The list of devices connected to the Android device

GetLibraryVersion

public long GetLibraryVersion()

Get the version number of this class library.

Returns:

The version number

Open

public boolean Open()

Open the first device detected by the system.

Returns:

The status of the operation

OpenByIndex

public boolean OpenByIndex(int index)

Open the device located at index 0 of list of connected devices returned by GetDeviceInfoList.

Parameters:

index - of the device from the list of connected devices

Returns:

The status of the operation

OpenBySerialNumber

public boolean OpenBySerialNumber(java.lang.String serialNumber)

Open the device with the specified serial number from the list of connected devices returned by GetDeviceInfoList.

Parameters:

serialNumber - of the device from the list of connected devices

Returns:

The status of the operation

OpenByDescription

public boolean OpenByDescription(java.lang.String productName)

Open the device with the specified product description from the list of connected devices returned by GetDeviceInfoList.

Parameters:

productName - of the device from the list of connected devices

Returns:

The status of the operation

OpenByLocation

public boolean OpenByLocation(java.lang.String locationId)

Open the device with the specified location id from the list of connected devices returned by GetDeviceInfoList.

Parameters:

locationId - of the device from the list of connected devices

Returns:

The status of the operation

Close

public void Close()

Close the handle of the opened device.

IsOpen

public boolean IsOpen()

Checks if a handle to a device is open.

Returns:

The status of the operation

GetDeviceInfo

public final FTD3XX.DeviceInfo GetDeviceInfo()

Get the DeviceInfo structure of the opened device.

Returns:

The DeviceInfo of the opened device

IsUsbDevice

public boolean IsUsbDevice(android.hardware.usb.UsbDevice device)

Checks if the same device is currently opened. This is used for hotplugging detection.

Parameters:

device - UsbDevice structure to compare

Returns:

The status of the operation

GetUsbDevice

public android.hardware.usb.UsbDevice GetUsbDevice()

Gets the UsbDevice object corresponding to the device opened. This is exposed for extensibility purposes.

Returns:

The UsbDevice object of the connected device

GetDeviceDescriptor

public final FTD3XX.DeviceDescriptor GetDeviceDescriptor()

Get device descriptor.

Returns:

the device descriptor

GetConfigurationDescriptor

public final FTD3XX.ConfigurationDescriptor GetConfigurationDescriptor()

Get configuration descriptor.

Returns:

the configuration descriptor

GetInterfaceDescriptor

public final FTD3XX.InterfaceDescriptor GetInterfaceDescriptor(int index)

Get interface descriptor.

Parameters:

index - the index

Returns:

the interface descriptor

GetPipeInformation

public final FTD3XX.PipeInformation GetPipeInformation(int interfaceIndex,
                                                       int pipeIndex)

Get pipe information.

Parameters:

interfaceIndex - the interface index

pipeIndex - the pipe index

Returns:

the pipe information

GetRawDescriptors

public int GetRawDescriptors(byte[] buffer)

Get raw descriptors

Parameters:

buffer - buffer to contain the raw descriptors

Returns:

the number of bytes copied. if buffer is null, then it describes the number of bytes available.

GetFirmwareVersion

public int GetFirmwareVersion()

Get firmware version.

Returns:

the version number

GetChipConfiguration

public FTD3XX.ChipConfiguration GetChipConfiguration()

Get the configurable parameters of the device.

Returns:

A ChipConfiguration object

SetChipConfiguration

public boolean SetChipConfiguration(FTD3XX.ChipConfiguration cfg)

Set the configurable parameters of the device. To allow multiple devices to be connected, customers are required to update the String Descriptors (Manufacturer, Product Description, Serial Number).

Parameters:

cfg - The desired configurable values. If cfg is null, the device will reset the configurables to default values.

Returns:

The status of the operation

EnableGPIO

public boolean EnableGPIO(int mask,
                          int dir)

Configures pin into GPIO mode and configure direction.

Parameters:

mask - Bitmask for the GPIOs to configure

dir - Controls the direction of GPIOs: 0 for input, 1 for output

Returns:

The status of the operation

WriteGPIO

public boolean WriteGPIO(int mask,
                         int data)

Sets the status of the GPIOs.

Parameters:

mask - Bitmask to select the bits that are to be written

data - Data to write the GPIO status: 1 is for high, 0 is for low

Returns:

The status of the operation

ReadGPIO

public int ReadGPIO()

Returns the status of the GPIOs.

Returns:

Bitflag that contains the status of the GPIOs

SetGPIOPull

public boolean SetGPIOPull(int mask,
                           int pull)

Set gpio pull.

Parameters:

mask - Bitmask to select the bits that are to be written

pull - Data to write the GPIO status: 1 is for high, 0 is for low

Returns:

The status of the operation

SetStreamPipe

public boolean SetStreamPipe(int pipe,
                             int size)

Sets streaming protocol transfer for specified pipes. This is for applications that transfer (write or read) a fixed size of data to or from the device.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

size - Sets the fixed size of data to be transferred to or from the device

Returns:

The status of the operation

ClearStreamPipe

public boolean ClearStreamPipe(int pipe)

Clears streaming protocol transfer for specified pipes.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

Returns:

The status of the operation

WritePipe

public int WritePipe(int pipe,
                     byte[] buffer,
                     int length)

Write data to pipe using Android Host API bulkTransfer(). If data length is greater than ANDROID_USB_MAX_BUFFER_SIZE, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer that contains the data to transfer

length - The number of bytes to transfer

Returns:

The status of the operation

ReadPipe

public int ReadPipe(int pipe,
                    byte[] buffer,
                    int length)

Read data from pipe using Android Host API bulkTransfer(). If data length is greater than ANDROID_USB_MAX_BUFFER_SIZE, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer to contain the data to transfer

length - The number of bytes to transfer

Returns:

The status of the operation

WritePipe

public int WritePipe(int pipe,
                     byte[] buffer,
                     int length,
                     int timeoutMS)

Write data to pipe using Android Host API bulkTransfer(). If data length is greater than ANDROID_USB_MAX_BUFFER_SIZE, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer that contains the data to transfer

length - The number of bytes to transfer

timeoutMS - Timeout in milliseconds

Returns:

The status of the operation

ReadPipe

public int ReadPipe(int pipe,
                    byte[] buffer,
                    int length,
                    int timeoutMS)

Read data from pipe using Android Host API bulkTransfer(). If data length is greater than ANDROID_USB_MAX_BUFFER_SIZE, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer to contain the data to transfer

length - The number of bytes to transfer

timeoutMS - Timeout in milliseconds

Returns:

The status of the operation

WritePipe

public int WritePipe(int pipe,
                     byte[] buffer,
                     int offset,
                     int length,
                     int timeoutMS)

Write data to pipe using Android Host API bulkTransfer(). If data length is greater than ANDROID_USB_MAX_BUFFER_SIZE, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer that contains the data to transfer

offset - Offset to the buffer

length - The number of bytes to transfer

timeoutMS - Timeout in milliseconds

Returns:

The status of the operation

ReadPipe

public int ReadPipe(int pipe,
                    byte[] buffer,
                    int offset,
                    int length,
                    int timeoutMS)

Read data from pipe using Android Host API bulkTransfer(). If data length is greater than 16384, Android Host API asynchronous UsbRequest class is used.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

buffer - Buffer to contain the data to transfer

offset - Offset to the buffer

length - The number of bytes to transfer

timeoutMS - Timeout in milliseconds

Returns:

The status of the operation

AbortPipe

public boolean AbortPipe(int pipe)

Aborts all of the pending transfers for a pipe.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

Returns:

The status of the operation

FlushPipe

public boolean FlushPipe(int pipe)

Discards any data that is cached in an IN pipe.

Parameters:

pipe - An 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

Returns:

The status of the operation

ResetDevice

public boolean ResetDevice()

Resets the device. This function causes the device to be re-enumerated by the host.

Returns:

The status of the operation

ControlTransfer

public boolean ControlTransfer(FTD3XX.SetupPacket setupPacket,
                               byte[] buffer)

Transmits control data over the default control endpoint. This function is exposed for future extensibility purposes.

Parameters:

setupPacket - The USB setup packet

buffer - Buffer to contain the data to transfer

Returns:

The status of the operation

ControlTransfer

public boolean ControlTransfer(FTD3XX.SetupPacket setupPacket,
                               byte[] buffer,
                               int offset)

Transmits control data over the default control endpoint. This function is exposed for future extensibility purposes.

Parameters:

setupPacket - The USB setup packet

buffer - Buffer to contain the data to transfer

offset - Offset to the buffer

Returns:

The status of the operation

SetNotificationCallback

public boolean SetNotificationCallback(FTD3XX.INotificationCallback callback)

Sets a receive notification callback function which will be called. when data is available for IN endpoints where no read requests are currently ongoing. To use this function, notification feature must be enabled in chip configuration.

Parameters:

callback - Callback interface to be called when notification is received

Returns:

The status of the operation

ClearNotificationCallback

public void ClearNotificationCallback()

Clears the notification callback set SetNotificationCallback.

Skip navigation links

• Package
• Class
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method

Modifier and Type	Method and Description
boolean	AbortPipe(int pipe) Aborts all of the pending transfers for a pipe.
void	ClearNotificationCallback() Clears the notification callback set SetNotificationCallback.
boolean	ClearStreamPipe(int pipe) Clears streaming protocol transfer for specified pipes.
void	Close() Close the handle of the opened device.
boolean	ControlTransfer(FTD3XX.SetupPacket setupPacket, byte[] buffer) Transmits control data over the default control endpoint.
boolean	ControlTransfer(FTD3XX.SetupPacket setupPacket, byte[] buffer, int offset) Transmits control data over the default control endpoint.
int	CreateDeviceInfoList() Builds a device information list and returns the number of D3XX devices connected to the system.
boolean	EnableGPIO(int mask, int dir) Configures pin into GPIO mode and configure direction.
boolean	FlushPipe(int pipe) Discards any data that is cached in an IN pipe.
FTD3XX.ChipConfiguration	GetChipConfiguration() Get the configurable parameters of the device.
FTD3XX.ConfigurationDescriptor	GetConfigurationDescriptor() Get configuration descriptor.
FTD3XX.DeviceDescriptor	GetDeviceDescriptor() Get device descriptor.
FTD3XX.DeviceInfo	GetDeviceInfo() Get the DeviceInfo structure of the opened device.
java.util.ArrayList<FTD3XX.DeviceInfo>	GetDeviceInfoList() Returns a device information list of connected devices.
int	GetFirmwareVersion() Get firmware version.
FTD3XX.InterfaceDescriptor	GetInterfaceDescriptor(int index) Get interface descriptor.
long	GetLibraryVersion() Get the version number of this class library.
FTD3XX.PipeInformation	GetPipeInformation(int interfaceIndex, int pipeIndex) Get pipe information.
int	GetRawDescriptors(byte[] buffer) Get raw descriptors
android.hardware.usb.UsbDevice	GetUsbDevice() Gets the UsbDevice object corresponding to the device opened.
boolean	IsOpen() Checks if a handle to a device is open.
boolean	IsUsbDevice(android.hardware.usb.UsbDevice device) Checks if the same device is currently opened.
boolean	Open() Open the first device detected by the system.
boolean	OpenByDescription(java.lang.String productName) Open the device with the specified product description from the list of connected devices returned by GetDeviceInfoList.
boolean	OpenByIndex(int index) Open the device located at index 0 of list of connected devices returned by GetDeviceInfoList.
boolean	OpenByLocation(java.lang.String locationId) Open the device with the specified location id from the list of connected devices returned by GetDeviceInfoList.
boolean	OpenBySerialNumber(java.lang.String serialNumber) Open the device with the specified serial number from the list of connected devices returned by GetDeviceInfoList.
int	ReadGPIO() Returns the status of the GPIOs.
int	ReadPipe(int pipe, byte[] buffer, int length) Read data from pipe using Android Host API bulkTransfer().
int	ReadPipe(int pipe, byte[] buffer, int length, int timeoutMS) Read data from pipe using Android Host API bulkTransfer().
int	ReadPipe(int pipe, byte[] buffer, int offset, int length, int timeoutMS) Read data from pipe using Android Host API bulkTransfer().
boolean	ResetDevice() Resets the device.
boolean	SetChipConfiguration(FTD3XX.ChipConfiguration cfg) Set the configurable parameters of the device.
boolean	SetGPIOPull(int mask, int pull) Set gpio pull.
boolean	SetNotificationCallback(FTD3XX.INotificationCallback callback) Sets a receive notification callback function which will be called.
boolean	SetStreamPipe(int pipe, int size) Sets streaming protocol transfer for specified pipes.
boolean	WriteGPIO(int mask, int data) Sets the status of the GPIOs.
int	WritePipe(int pipe, byte[] buffer, int length) Write data to pipe using Android Host API bulkTransfer().
int	WritePipe(int pipe, byte[] buffer, int length, int timeoutMS) Write data to pipe using Android Host API bulkTransfer().
int	WritePipe(int pipe, byte[] buffer, int offset, int length, int timeoutMS) Write data to pipe using Android Host API bulkTransfer().