AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Ftdi.Ftdi.FtdiDevice Class Reference

Construct for sharing information about FTDI devices. More...

Inheritance diagram for Apac.Ftdi.Ftdi.FtdiDevice:
Apac.Dlp.IO20

Public Member Functions

 FtdiDevice (IntPtr handle, uint id, uint flags, FT_DEVICE_TYPE deviceType, uint locationId, string serialNumber, string description)
 
FT_STATUS SetTimeouts (uint readTimeoutMs, uint writeTimeoutMs)
 
FT_STATUS SetLatencyTimer (byte ms)
 
FT_STATUS Open ()
 Transitions the communications with the device to an open state. More...
 
FT_STATUS Close ()
 
FT_STATUS Write (byte[] command)
 
FtdiResponse Read (uint bytesToRead, int retryCount)
 
FtdiResponse ReadUsingQueue (uint bytesToRead, int queueCheckDelay)
 
FT_STATUS Purge (FT_PURGE flags)
 
override string ToString ()
 

Properties

IntPtr Handle [get]
 
uint Id [get]
 
uint LocationId [get]
 
uint Flags [get]
 
FT_DEVICE_TYPE DeviceType [get]
 
string SerialNumber [get]
 
string Description [get, set]
 
byte LatencyTimer [get, set]
 
uint UsbTimeout [get, set]
 
uint ReadErrorResetTrigger [get, set]
 Gets or sets the read error reset trigger, which determines how many consecutive read errors are allowed before a connection reset is tried. More...
 
uint ReadErrors [get, set]
 Gets or sets the current number of read errors. More...
 
bool IsOpen [get]
 Determines if the device is open or not based on Flags. More...
 
bool IsHighSpeedUsb [get]
 Determines if the device is high-speed USB (true) or full-speed USB (false). More...
 

Detailed Description

Construct for sharing information about FTDI devices.

Member Function Documentation

◆ Open()

FT_STATUS Apac.Ftdi.Ftdi.FtdiDevice.Open ( )
inline

Transitions the communications with the device to an open state.

Parameters
handle

Property Documentation

◆ IsHighSpeedUsb

bool Apac.Ftdi.Ftdi.FtdiDevice.IsHighSpeedUsb
get

Determines if the device is high-speed USB (true) or full-speed USB (false).

◆ IsOpen

bool Apac.Ftdi.Ftdi.FtdiDevice.IsOpen
get

Determines if the device is open or not based on Flags.

◆ ReadErrorResetTrigger

uint Apac.Ftdi.Ftdi.FtdiDevice.ReadErrorResetTrigger
getset

Gets or sets the read error reset trigger, which determines how many consecutive read errors are allowed before a connection reset is tried.

The read error reset trigger.

◆ ReadErrors

uint Apac.Ftdi.Ftdi.FtdiDevice.ReadErrors
getset

Gets or sets the current number of read errors.

The read errors.


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