Apac.Ftdi.Ftdi Class Reference

Classes
class	FtdiDevice
	Construct for sharing information about FTDI devices. More...
class	FtdiException
	A simple exception wrapper used to signal call failure. More...
class	FtdiResponse

Public Types
enum class	FT_STATUS : uint {   OK = 0 , INVALID_HANDLE = 1 , DEVICE_NOT_FOUND = 2 , DEVICE_NOT_OPENED = 3 ,   IO_ERROR = 4 , INSUFFICIENT_RESOURCES = 5 , INVALID_PARAMETER = 6 , INVALID_BAUD_RATE = 7 ,   DEVICE_NOT_OPENED_FOR_ERASE = 8 , DEVICE_NOT_OPENED_FOR_WRITE = 9 , FAILED_TO_WRITE_DEVICE = 10 , EEPROM_READ_FAILED = 11 ,   EEPROM_WRITE_FAILED = 12 , EEPROM_ERASE_FAILED = 13 , EEPROM_NOT_PRESENT = 14 , EEPROM_NOT_PROGRAMMED = 15 ,   INVALID_ARGS = 16 , NOT_SUPPORTED = 17 , OTHER_ERROR = 18 }
enum class	FT_OPEN_MODE : uint { OPEN_BY_SERIAL_NUMBER = 1 , OPEN_BY_DESCRIPTION = 2 , OPEN_BY_LOCATION = 4 }
	Used with FT_OpenEx to determine how to open the port to the device More...
enum class	FT_DEVICE_TYPE {   _232BM = 0 , _232AM = 1 , _100AX = 2 , UNKNOWN = 3 ,   _2232C = 4 , _232R = 5 , _2232H = 6 , _4232H = 7 ,   _232H = 8 , X_SERIES = 9 }
enum class	FT_PURGE : uint { RX = 0x01 , TX = 0x02 }
enum class	FT_DRIVER_TYPE : uint { D2XX = 0 , VCP = 1 }

Static Public Member Functions
static FtdiDevice[]	ListFtdiDevices (string descriptionMatch)
	Provides a list of FTDI-enabled devices that are connected to the computer and have the given description , including with details about their identities and states. More...
static FtdiDevice[]	ListAllFtdiDevices ()
	Provides a list of FTDI-enabled devices that are connected to the computer, including with details about their identities and states. More...
static string	GetStringFromBuffer (byte[] buffer)
	Gets a string from a byte array as organized by the FTDI standard. More...
static int	GetIntFromBytes (byte[] bytes)
	Gets a signed 32-bit integer from a byte array as organized by the FTDI standard. More...
static uint	GetUIntFromBytes (byte[] bytes)
	Gets an unsigned 32-bit integer from a byte array as organized by the FTDI standard. More...
static ulong	GetULongFromBytes (byte[] bytes)
	Gets an unsigned 64-bit integer from a byte array as organized by the FTDI standard. More...

Static Public Attributes
const uint	FT_FLAGS_OPENED = 0x00000001
const uint	FT_FLAGS_HIGHSPEED = 0x00000002

Member Enumeration Documentation

FT_OPEN_MODE

enum Apac.Ftdi.Ftdi.FT_OPEN_MODE : uint

strong

Used with FT_OpenEx to determine how to open the port to the device

Member Function Documentation

GetIntFromBytes()

static int Apac.Ftdi.Ftdi.GetIntFromBytes ( byte[]  bytes )

inlinestatic

Gets a signed 32-bit integer from a byte array as organized by the FTDI standard.

Parameters

bytes

The byte array.

Returns

Returns a signed 32-bit integer.

GetStringFromBuffer()

static string Apac.Ftdi.Ftdi.GetStringFromBuffer ( byte[]  buffer )

inlinestatic

Gets a string from a byte array as organized by the FTDI standard.

Parameters

buffer

The byte buffer.

Returns

Returns a 32-bit integer.

GetUIntFromBytes()

static uint Apac.Ftdi.Ftdi.GetUIntFromBytes ( byte[]  bytes )

inlinestatic

Gets an unsigned 32-bit integer from a byte array as organized by the FTDI standard.

Parameters

bytes

Returns

Returns an unsigned 32-bit integer.

GetULongFromBytes()

static ulong Apac.Ftdi.Ftdi.GetULongFromBytes ( byte[]  bytes )

inlinestatic

Gets an unsigned 64-bit integer from a byte array as organized by the FTDI standard.

Parameters

bytes

Returns

Returns an unsigned 64-bit integer.

ListAllFtdiDevices()

static FtdiDevice [] Apac.Ftdi.Ftdi.ListAllFtdiDevices ( )

inlinestatic

Provides a list of FTDI-enabled devices that are connected to the computer, including with details about their identities and states.

Returns

Returns FtdiDevice[] containing all connected devices. If no devices are connected, the array will be empty.

ListFtdiDevices()

static FtdiDevice [] Apac.Ftdi.Ftdi.ListFtdiDevices ( string  descriptionMatch )

inlinestatic

Provides a list of FTDI-enabled devices that are connected to the computer and have the given description , including with details about their identities and states.

Parameters

descriptionMatch

The value to match in the description of the device.

Returns

Returns FtdiDevice[] containing all connected devices with a matching description. If no devices are connected that match, the array will be empty.

---

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

• /var/lib/jenkins/workspace/apac/APAC/Apac.Ftdi/FtdiIntf.cs