Difference between revisions of "Component: FTDI (FTD2XX) (Third Party)"

Latest revision as of 13:13, 7 February 2023

Author	Matrix Ltd
Version	1.0
Category	Third Party

FTDI (FTD2XX) component

Simulation only interface to allow communications with a FTDI USB 232 IC connected to the system. For more details refer to the D2XX_Programmers_Guide from FTDI.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_ftd2xx_232.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_ftd2xx_232.fcsx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

FT_Close

	FT_Close
Close an open device.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_ClrDtr

	FT_ClrDtr
This function clears the Data Terminal Ready (DTR) control signal.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_ClrRts

	FT_ClrRts
This function clears the Request To Send (RTS) control signal.
- LONG	Handle
Handle of the device.
- VOID	Return

FT_CreateDeviceInfoList

	FT_CreateDeviceInfoList
This function builds a device information list and returns the number of D2XX devices connected to the system. The list contains information about both unopen and open devices.
- LONG	DevCount
Unsigned long array used to store the number of devices connected
- BYTE	Return

FT_GetDeviceInfoDetail

	FT_GetDeviceInfoDetail
This function returns an entry from the device information list.
- ULONG	Index
Index of the entry in the device info list.
- ULONG	Flags
Pointer to unsigned long to store the flag value.
- ULONG	Type
Pointer to unsigned long to store device type.
- ULONG	ID
Pointer to unsigned long to store device ID.
- ULONG	LocID
Pointer to unsigned long to store the device location ID.
- BYTE	SerNum
Pointer to buffer to store device serial number as a null terminated string
- BYTE	Descript
Pointer to buffer to store device description as a null-terminated string
- LONG	TempHandle
Pointer to a variable of type FT_HANDLE where the handle will be stored
- BYTE	Return

FT_GetModemStatus

	FT_GetModemStatus
Gets the modem status and line status from the device.
- LONG	Handle
Handle of the device.
- LONG	ModemStatus
Pointer to a variable of type DWORD which receives the modem status and line status from the device.
- BYTE	Return

FT_GetQueueStatus

	FT_GetQueueStatus
Gets the number of bytes in the receive queue.
- LONG	Handle
Handle of the device.
- LONG	RxQueueLength
Pointer to a variable of type DWORD which receives the number of bytes in the receive queue.
- BYTE	Return

FT_GetStatus

	FT_GetStatus
Gets the device status including number of characters in the receive queue, number of characters in the transmit queue, and the current event status.
- LONG	Handle
Handle of the device.
- LONG	RxQueueLength
Pointer to a variable of type DWORD which receives the number of characters in the receive queue.
- LONG	TxQueueLength
Pointer to a variable of type DWORD which receives the number of characters in the transmit queue.
- LONG	EventStatus
Pointer to a variable of type DWORD which receives the current state of the event status.
- BYTE	Return

FT_Open

	FT_Open
Open the device and return a handle which will be used for subsequent accesses.
- INT	Device
Index of the device to open. Indices are 0 based.
- LONG	ft_Handle
Pointer to a variable of type FT_HANDLE where the handle will be stored. This handle must be used to access the device.
- BYTE	Return

FT_Purge

	FT_Purge
This function purges receive and transmit buffers in the device.
- LONG	Handle
Handle of the device.
- LONG	Mask
Used to determine which buffer to purge, 1=Rx / 2=Tx / 3=Both
- BYTE	Return

FT_Read

	FT_Read
Read data from the device.
- LONG	Handle
Handle of the device.
- BYTE	Buffer
Pointer to the buffer that receives the data from the device.
- ULONG	Bytes
Number of bytes to be read from the device.
- ULONG	Count
Pointer to a variable of type DWORD which receives the number of bytes read from the device.
- BYTE	Return

FT_ResetDevice

	FT_ResetDevice
This function sends a reset command to the device.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_SetBaudRate

	FT_SetBaudRate
This function sets the baud rate for the device.
- LONG	Handle
Handle of the device.
- ULONG	BaudRate
Baud rate.
- BYTE	Return

FT_SetBitMode

	FT_SetBitMode
Enables different chip modes.
- LONG	Handle
Handle of the device.
- BYTE	Mask
Required value for bit mode mask. This sets up which bits are inputs and outputs. A bit value of 0 sets the corresponding pin to an input, a bit value of 1 sets the corresponding pin to an output.
- BYTE	Mode
0=Reset / 1=AsyncBB / 2=MPSSE / 4=SyncBB / 8=MCUHost / 16=FastOpto / 32=CBUS / 64=SyncFIFO
- BYTE	Return

FT_SetBreakOff

	FT_SetBreakOff
Resets the BREAK condition for the device.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_SetBreakOn

	FT_SetBreakOn
Sets the BREAK condition for the device.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_SetChars

	FT_SetChars
This function sets the special characters for the device.
- LONG	Handle
Handle of the device.
- BYTE	EventCh
Event character.
- BYTE	EventChEn
0 if event character disabled, non-zero otherwise.
- BYTE	ErrorCh
Error character.
- BYTE	ErrorChEn
0 if error character disabled, non-zero otherwise.
- BYTE	Return

FT_SetDataCharacteristics

	FT_SetDataCharacteristics
This function sets the data characteristics for the device.
- LONG	Handle
Handle of the device.
- BYTE	WordLength
Number of bits per word - Must be 7 or 8
- BYTE	StopBits
Number of stop bits - Must be 1 or 2
- BYTE	Parity
Parity 0=None / 1=Odd / 2=Even / 3=Mark / 4=Space
- BYTE	Return

FT_SetDivisor

	FT_SetDivisor
This function sets the baud rate for the device. It is used to set non-standard baud rates.
- LONG	Handle
Handle of the device.
- UINT	Divisor
Divisor.
- BYTE	Return

FT_SetDtr

	FT_SetDtr
This function sets the Data Terminal Ready (DTR) control signal.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_SetFlowControl

	FT_SetFlowControl
This function sets the flow control for the device.
- LONG	Handle
Handle of the device.
- UINT	FlowControl
Flow setting 0=None, 0x0100=RTS/CTS, 0x0200=DTR/DSR, 0x0400=XON/XOFF
- BYTE	Xon
Character used to signal Xon. Only used if flow control is Xon/Xoff
- BYTE	Xoff
Character used to signal Xoff. Only used if flow control is Xon/Xoff
- BYTE	Return

FT_SetRts

	FT_SetRts
This function sets the Request To Send (RTS) control signal.
- LONG	Handle
Handle of the device.
- BYTE	Return

FT_SetTimeouts

	FT_SetTimeouts
This function sets the read and write timeouts for the device.
- LONG	Handle
Handle of the device.
- LONG	ReadTimeout
Read timeout in milliseconds.
- LONG	WriteTimeout
Write timeout in milliseconds.
- BYTE	Return

FT_Write

	FT_Write
Write data to the device.
- LONG	Handle
Handle of the device.
- BYTE	Buffer
Pointer to the buffer that contains the data to be written to the device.
- ULONG	Bytes
Number of bytes to write to the device.
- ULONG	Count
Pointer to a variable of type DWORD which receives the number of bytes written to the device.
- BYTE	Return

ScanFor232

	ScanFor232
Scans for a FTDI D2XX device, returnes true if at least one device was found.
- BOOL	Return

Property reference

	Properties
	Label
A text label for the component's panel component.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_ftd2xx_232.fcsx FC_Comp_Source_ftd2xx_232.fcsx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ftd2xx_232.fcsx FC_Comp_Source_ftd2xx_232.fcsx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ftd2xx_232.fcsx FC_Comp_Source_ftd2xx_232.fcsx]
 ==Detailed description==
@@ Line 38: / Line 50: @@
 ==Examples==
@@ Line 57: / Line 79: @@
-==Downloadable macro reference==
+==Macro reference==
+===FT_Close===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetStatus'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Close'''
 |-
-| colspan="2" | Gets the device status including number of characters in the receive queue, number of characters in the transmit queue, and the current event status. &nbsp;
+| colspan="2" | Close an open device.&nbsp;
 |-
 |-
@@ Line 72: / Line 105: @@
 | colspan="2" | Handle of the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | RxQueueLength
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===FT_ClrDtr===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the number of characters in the receive queue.&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_ClrDtr'''
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| colspan="2" | This function clears the Data Terminal Ready (DTR) control signal.&nbsp;
-| width="90%" | TxQueueLength
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the number of characters in the transmit queue.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | EventStatus
+| width="90%" | Handle
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the current state of the event status.&nbsp;
+| colspan="2" | Handle of the device.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 92: / Line 129: @@
+===FT_ClrRts===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 110: / Line 148: @@
+===FT_CreateDeviceInfoList===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Write'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_CreateDeviceInfoList'''
 |-
-| colspan="2" | Write data to the device. &nbsp;
+| colspan="2" | This function builds a device information list and returns the number of D2XX devices connected to the system. The list contains information about both unopen and open devices. &nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Handle
+| width="90%" | DevCount
+|-
+| colspan="2" | Unsigned long array used to store the number of devices connected&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===FT_GetDeviceInfoDetail===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Handle of the device.&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetDeviceInfoDetail'''
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| colspan="2" | This function returns an entry from the device information list.&nbsp;
-| width="90%" | Buffer
 |-
-| colspan="2" | Pointer to the buffer that contains the data to be written to the device.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Bytes
+| width="90%" | Index
 |-
-| colspan="2" | Number of bytes to write to the device.&nbsp;
+| colspan="2" | Index of the entry in the device info list.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Count
+| width="90%" | Flags
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes written to the device.&nbsp;
+| colspan="2" | Pointer to unsigned long to store the flag value.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Type
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Pointer to unsigned long to store device type.&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Read'''
 |-
-| colspan="2" | Read data from the device. &nbsp;
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | ID
 |-
+| colspan="2" | Pointer to unsigned long to store device ID.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Handle
+| width="90%" | LocID
 |-
-| colspan="2" | Handle of the device.&nbsp;
+| colspan="2" | Pointer to unsigned long to store the device location ID.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Buffer
+| width="90%" | SerNum
 |-
-| colspan="2" | Pointer to the buffer that receives the data from the device.&nbsp;
+| colspan="2" | Pointer to buffer to store device serial number as a null terminated string&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Bytes
+| width="90%" | Descript
 |-
-| colspan="2" | Number of bytes to be read from the device.&nbsp;
+| colspan="2" | Pointer to buffer to store device description as a null-terminated string&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Count
+| width="90%" | TempHandle
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes read from the device.&nbsp;
+| colspan="2" | Pointer to a variable of type FT_HANDLE where the handle will be stored&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 176: / Line 221: @@
+===FT_GetModemStatus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetFlowControl'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetModemStatus'''
 |-
-| colspan="2" | This function sets the flow control for the device.&nbsp;
+| colspan="2" | Gets the modem status and line status from the device. &nbsp;
 |-
 |-
@@ Line 189: / Line 235: @@
 | colspan="2" | Handle of the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | FlowControl
+| width="90%" | ModemStatus
 |-
-| colspan="2" | Flow setting 0=None, 0x0100=RTS/CTS, 0x0200=DTR/DSR, 0x0400=XON/XOFF&nbsp;
+| colspan="2" | Pointer to a variable of type DWORD which receives the modem status and line status from the device.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Xon
-|-
-| colspan="2" | Character used to signal Xon. Only used if flow control is Xon/Xoff&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Xoff
-|-
-| colspan="2" | Character used to signal Xoff. Only used if flow control is Xon/Xoff&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 209: / Line 245: @@
+===FT_GetQueueStatus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetModemStatus'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetQueueStatus'''
 |-
-| colspan="2" | Gets the modem status and line status from the device. &nbsp;
+| colspan="2" | Gets the number of bytes in the receive queue.&nbsp;
 |-
 |-
@@ Line 223: / Line 260: @@
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | ModemStatus
+| width="90%" | RxQueueLength
 |-
-| colspan="2" | Pointer to a variable of type DWORD which receives the modem status and line status from the device.&nbsp;
+| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes in the receive queue.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 232: / Line 269: @@
+===FT_GetStatus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBreakOn'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetStatus'''
 |-
-| colspan="2" | Sets the BREAK condition for the device. &nbsp;
+| colspan="2" | Gets the device status including number of characters in the receive queue, number of characters in the transmit queue, and the current event status. &nbsp;
 |-
 |-
@@ Line 244: / Line 282: @@
 |-
 | colspan="2" | Handle of the device.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | RxQueueLength
+|-
+| colspan="2" | Pointer to a variable of type DWORD which receives the number of characters in the receive queue.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | TxQueueLength
+|-
+| colspan="2" | Pointer to a variable of type DWORD which receives the number of characters in the transmit queue.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | EventStatus
+|-
+| colspan="2" | Pointer to a variable of type DWORD which receives the current state of the event status.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 250: / Line 303: @@
+===FT_Open===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_CreateDeviceInfoList'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Open'''
+|-
+| colspan="2" | Open the device and return a handle which will be used for subsequent accesses.&nbsp;
+|-
 |-
-| colspan="2" | This function builds a device information list and returns the number of D2XX devices connected to the system. The list contains information about both unopen and open devices. &nbsp;
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" | Device
 |-
+| colspan="2" | Index of the device to open.  Indices are 0 based.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | DevCount
+| width="90%" | ft_Handle
 |-
-| colspan="2" | Unsigned long array used to store the number of devices connected&nbsp;
+| colspan="2" | Pointer to a variable of type FT_HANDLE where the handle will be stored.  This handle must be used to access the device.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 268: / Line 327: @@
+===FT_Purge===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetTimeouts'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Purge'''
 |-
-| colspan="2" | This function sets the read and write timeouts for the device.&nbsp;
+| colspan="2" | This function purges receive and transmit buffers in the device.&nbsp;
 |-
 |-
@@ Line 282: / Line 342: @@
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | ReadTimeout
+| width="90%" | Mask
 |-
-| colspan="2" | Read timeout in milliseconds.&nbsp;
+| colspan="2" | Used to determine which buffer to purge, 1=Rx / 2=Tx / 3=Both&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | WriteTimeout
-|-
-| colspan="2" | Write timeout in milliseconds.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 296: / Line 351: @@
+===FT_Read===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBitMode'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Read'''
 |-
-| colspan="2" | Enables different chip modes.&nbsp;
+| colspan="2" | Read data from the device. &nbsp;
 |-
 |-
@@ Line 310: / Line 366: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Mask
+| width="90%" | Buffer
+|-
+| colspan="2" | Pointer to the buffer that receives the data from the device.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Bytes
 |-
-| colspan="2" | Required value for bit mode mask. This sets up which bits are  inputs and outputs.  A bit value of 0 sets the corresponding pin to  an input, a bit value of 1 sets the corresponding pin to an output.&nbsp;
+| colspan="2" | Number of bytes to be read from the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Mode
+| width="90%" | Count
 |-
-| colspan="2" | 0=Reset / 1=AsyncBB / 2=MPSSE / 4=SyncBB / 8=MCUHost / 16=FastOpto / 32=CBUS / 64=SyncFIFO&nbsp;
+| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes read from the device.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 324: / Line 385: @@
+===FT_ResetDevice===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetRts'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_ResetDevice'''
 |-
-| colspan="2" | This function sets the Request To Send (RTS) control signal.&nbsp;
+| colspan="2" | This function sends a reset command to the device. &nbsp;
 |-
 |-
@@ Line 342: / Line 404: @@
+===FT_SetBaudRate===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetDeviceInfoDetail'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBaudRate'''
 |-
-| colspan="2" | This function returns an entry from the device information list.&nbsp;
+| colspan="2" | This function sets the baud rate for the device. &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Index
+| width="90%" | Handle
 |-
-| colspan="2" | Index of the entry in the device info list.&nbsp;
+| colspan="2" | Handle of the device.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Flags
+| width="90%" | BaudRate
 |-
-| colspan="2" | Pointer to unsigned long to store the flag value.&nbsp;
+| colspan="2" | Baud rate.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Type
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===FT_SetBitMode===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Pointer to unsigned long to store device type.&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBitMode'''
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| colspan="2" | Enables different chip modes.&nbsp;
-| width="90%" | ID
 |-
-| colspan="2" | Pointer to unsigned long to store device ID.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | LocID
+| width="90%" | Handle
 |-
-| colspan="2" | Pointer to unsigned long to store the device location ID.&nbsp;
+| colspan="2" | Handle of the device.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SerNum
+| width="90%" | Mask
 |-
-| colspan="2" | Pointer to buffer to store device serial number as a null terminated string&nbsp;
+| colspan="2" | Required value for bit mode mask. This sets up which bits are  inputs and outputs.  A bit value of 0 sets the corresponding pin to  an input, a bit value of 1 sets the corresponding pin to an output.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Descript
+| width="90%" | Mode
 |-
-| colspan="2" | Pointer to buffer to store device description as a null-terminated string&nbsp;
+| colspan="2" | 0=Reset / 1=AsyncBB / 2=MPSSE / 4=SyncBB / 8=MCUHost / 16=FastOpto / 32=CBUS / 64=SyncFIFO&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | TempHandle
-|-
-| colspan="2" | Pointer to a variable of type FT_HANDLE where the handle will be stored&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 395: / Line 457: @@
+===FT_SetBreakOff===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Close'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBreakOff'''
 |-
-| colspan="2" | Close an open device.&nbsp;
+| colspan="2" | Resets the BREAK condition for the device. &nbsp;
 |-
 |-
@@ Line 413: / Line 476: @@
+===FT_SetBreakOn===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_ClrDtr'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBreakOn'''
 |-
-| colspan="2" | This function clears the Data Terminal Ready (DTR) control signal.&nbsp;
+| colspan="2" | Sets the BREAK condition for the device. &nbsp;
 |-
 |-
@@ Line 431: / Line 495: @@
+===FT_SetChars===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Purge'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetChars'''
 |-
-| colspan="2" | This function purges receive and transmit buffers in the device.&nbsp;
+| colspan="2" | This function sets the special characters for the device.&nbsp;
 |-
 |-
@@ Line 444: / Line 509: @@
 | colspan="2" | Handle of the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Mask
+| width="90%" | EventCh
 |-
-| colspan="2" | Used to determine which buffer to purge, 1=Rx / 2=Tx / 3=Both&nbsp;
+| colspan="2" | Event character.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | EventChEn
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | 0 if event character disabled, non-zero otherwise.&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_GetQueueStatus'''
 |-
-| colspan="2" | Gets the number of bytes in the receive queue.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | ErrorCh
 |-
+| colspan="2" | Error character.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Handle
+| width="90%" | ErrorChEn
 |-
-| colspan="2" | Handle of the device.&nbsp;
+| colspan="2" | 0 if error character disabled, non-zero otherwise.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | RxQueueLength
-|-
-| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes in the receive queue.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 477: / Line 534: @@
+===FT_SetDataCharacteristics===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 510: / Line 568: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===FT_SetDivisor===
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBreakOff'''
-|-
-| colspan="2" | Resets the BREAK condition for the device. &nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Handle
-|-
-| colspan="2" | Handle of the device.&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 551: / Line 592: @@
+===FT_SetDtr===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetBaudRate'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetDtr'''
 |-
-| colspan="2" | This function sets the baud rate for the device. &nbsp;
+| colspan="2" | This function sets the Data Terminal Ready (DTR) control signal.&nbsp;
 |-
 |-
@@ Line 563: / Line 605: @@
 |-
 | colspan="2" | Handle of the device.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | BaudRate
-|-
-| colspan="2" | Baud rate.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 574: / Line 611: @@
+===FT_SetFlowControl===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetDtr'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetFlowControl'''
 |-
-| colspan="2" | This function sets the Data Terminal Ready (DTR) control signal.&nbsp;
+| colspan="2" | This function sets the flow control for the device.&nbsp;
 |-
 |-
@@ Line 586: / Line 624: @@
 |-
 | colspan="2" | Handle of the device.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | FlowControl
+|-
+| colspan="2" | Flow setting 0=None, 0x0100=RTS/CTS, 0x0200=DTR/DSR, 0x0400=XON/XOFF&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Xon
+|-
+| colspan="2" | Character used to signal Xon. Only used if flow control is Xon/Xoff&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Xoff
+|-
+| colspan="2" | Character used to signal Xoff. Only used if flow control is Xon/Xoff&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 592: / Line 645: @@
+===FT_SetRts===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Open'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetRts'''
 |-
-| colspan="2" | Open the device and return a handle which will be used for subsequent accesses.&nbsp;
+| colspan="2" | This function sets the Request To Send (RTS) control signal.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Device
 |-
-| colspan="2" | Index of the device to open.  Indices are 0 based.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | ft_Handle
+| width="90%" | Handle
 |-
-| colspan="2" | Pointer to a variable of type FT_HANDLE where the handle will be stored.  This handle must be used to access the device.&nbsp;
+| colspan="2" | Handle of the device.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 615: / Line 664: @@
+===FT_SetTimeouts===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanFor232'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetTimeouts'''
 |-
-| colspan="2" | Scans for a FTDI D2XX device, returnes true if at least one device was found.&nbsp;
+| colspan="2" | This function sets the read and write timeouts for the device.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Handle
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Handle of the device.&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_ResetDevice'''
 |-
-| colspan="2" | This function sends a reset command to the device. &nbsp;
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | ReadTimeout
 |-
+| colspan="2" | Read timeout in milliseconds.&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Handle
+| width="90%" | WriteTimeout
 |-
-| colspan="2" | Handle of the device.&nbsp;
+| colspan="2" | Write timeout in milliseconds.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 646: / Line 693: @@
+===FT_Write===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_SetChars'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FT_Write'''
 |-
-| colspan="2" | This function sets the special characters for the device.&nbsp;
+| colspan="2" | Write data to the device. &nbsp;
 |-
 |-
@@ Line 660: / Line 708: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | EventCh
+| width="90%" | Buffer
 |-
-| colspan="2" | Event character.&nbsp;
+| colspan="2" | Pointer to the buffer that contains the data to be written to the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | EventChEn
+| width="90%" | Bytes
 |-
-| colspan="2" | 0 if event character disabled, non-zero otherwise.&nbsp;
+| colspan="2" | Number of bytes to write to the device.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | ErrorCh
+| width="90%" | Count
 |-
-| colspan="2" | Error character.&nbsp;
+| colspan="2" | Pointer to a variable of type DWORD which receives the number of bytes written to the device.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ErrorChEn
-|-
-| colspan="2" | 0 if error character disabled, non-zero otherwise.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 684: / Line 727: @@
+===ScanFor232===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanFor232'''
+|-
+| colspan="2" | Scans for a FTDI D2XX device, returnes true if at least one device was found.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}