Struct libftd2xx::Ftdi

pub struct Ftdi { /* fields omitted */ }

Generic FTDI device.

This structure can be used for all FTDI devices. A device-specific structure is only necessary to access the EEPROM traits for that device.

Implementations

impl Ftdi

pub fn new() -> Result<Ftdi, FtStatus>

Open the first device on the system.

This is equivalent to calling with_index with an index of 0.

This function cannot be used to open a specific device. Ordering of devices on a system is not guaranteed to remain constant. Calling this function multiple times may result in a different device each time when there is more than one device connected to the system. Use with_serial_number to open a specific device.

Example

use libftd2xx::Ftdi;

Ftdi::new()?;

pub fn with_index(index: i32) -> Result<Ftdi, FtStatus>

Open the device by an arbitrary index and initialize the handle.

This function can open multiple devices, but it cannot be used to open a specific device. Ordering of devices on a system is not guaranteed to remain constant. Calling this function multiple times with the same index may result in a different device each time when there is more than one device connected to the system. Use with_serial_number to open a specific device.

Example

use libftd2xx::Ftdi;

Ftdi::with_index(0)?;

pub fn with_serial_number(serial_number: &str) -> Result<Ftdi, FtStatus>

Open the device by its serial number and initialize the handle.

Example

use libftd2xx::Ftdi;

Ftdi::with_serial_number("FT59UO4C")?;

pub fn with_description(description: &str) -> Result<Ftdi, FtStatus>

Open the device by its device description.

Example

use libftd2xx::Ftdi;

Ftdi::with_description("Hello")?;

Trait Implementations

impl FtdiCommon for Ftdi

const DEVICE_TYPE: DeviceType

FTDI device type.

fn handle(&mut self) -> FT_HANDLE

Get the FTDI device handle.

fn device_info(&mut self) -> Result<DeviceInfo, FtStatus>

Get device information for an open device.

fn driver_version(&mut self) -> Result<Version, FtStatus>

Returns the D2XX driver version number.

fn reset(&mut self) -> Result<(), FtStatus>

This function sends a reset command to the device.

fn set_usb_parameters(&mut self, in_transfer_size: u32) -> Result<(), FtStatus>

Set the USB request transfer size.

fn set_chars(
    &mut self,
    event_char: u8,
    event_enable: bool,
    error_char: u8,
    error_enable: bool
) -> Result<(), FtStatus>

This function sets the special characters for the device.

fn set_timeouts(
    &mut self,
    read_timeout: Duration,
    write_timeout: Duration
) -> Result<(), FtStatus>

This function sets the read and write timeouts for the device.

fn set_deadman_timeout(&mut self, timeout: Duration) -> Result<(), FtStatus>

This method allows the maximum time in milliseconds that a USB request can remain outstandingto be set.

fn set_latency_timer(&mut self, timer: Duration) -> Result<(), FtStatus>

Set the latency timer value.

fn latency_timer(&mut self) -> Result<Duration, FtStatus>

Get the current value of the latency timer.

fn set_flow_control_none(&mut self) -> Result<(), FtStatus>

This function disables flow control for the device.

fn set_flow_control_rts_cts(&mut self) -> Result<(), FtStatus>

This function sets RTS/CTS flow control for the device.

fn set_flow_control_dtr_dsr(&mut self) -> Result<(), FtStatus>

This function sets DTS/DSR flow control for the device.

fn set_flow_control_xon_xoff(
    &mut self,
    xon: u8,
    xoff: u8
) -> Result<(), FtStatus>

This function sets XON/XOFF flow control for the device.

fn set_baud_rate(&mut self, baud_rate: u32) -> Result<(), FtStatus>

Set the baud rate for the device.

fn set_data_characteristics(
    &mut self,
    bits_per_word: BitsPerWord,
    stop_bits: StopBits,
    parity: Parity
) -> Result<(), FtStatus>

Set the data characteristics for the device.

fn set_dtr(&mut self) -> Result<(), FtStatus>

Set the Data Terminal Ready (DTR) control signal.

fn clear_dtr(&mut self) -> Result<(), FtStatus>

Clear the Data Terminal Ready (DTR) control signal.

fn set_rts(&mut self) -> Result<(), FtStatus>

Set the Request to Send (RTS) control signal.

fn clear_rts(&mut self) -> Result<(), FtStatus>

Clear the Request to Send (RTS) control signal.

fn set_bit_mode(&mut self, mask: u8, mode: BitMode) -> Result<(), FtStatus>

Enables different chip modes.

fn bit_mode(&mut self) -> Result<u8, FtStatus>

Get the instantaneous value of the data bus.

fn set_break_on(&mut self) -> Result<(), FtStatus>

Sets the BREAK condition for the device.

fn set_break_off(&mut self) -> Result<(), FtStatus>

Resets the BREAK condition for the device.

fn queue_status(&mut self) -> Result<usize, FtStatus>

Gets the number of bytes in the receive queue.

fn status(&mut self) -> Result<DeviceStatus, FtStatus>

Gets the device status including number of characters in the receive queue, number of characters in the transmit queue, and the current event status.

fn read(&mut self, buf: &mut [u8]) -> Result<(), TimeoutError>

Read data from the device.

fn write(&mut self, buf: &[u8]) -> Result<(), TimeoutError>

Write data to the device.

fn purge_tx(&mut self) -> Result<(), FtStatus>

This function purges the transmit buffers in the device.

fn purge_rx(&mut self) -> Result<(), FtStatus>

This function purges the receive buffers in the device.

fn purge_all(&mut self) -> Result<(), FtStatus>

This function purges the transmit and receive buffers in the device.

fn close(&mut self) -> Result<(), FtStatus>

Close an open device.

fn modem_status(&mut self) -> Result<ModemStatus, FtStatus>

Gets the modem status and line status from the device.

fn eeprom_word_read(&mut self, offset: u32) -> Result<u16, FtStatus>

Read a value from an EEPROM location.

fn eeprom_word_write(&mut self, offset: u32, value: u16) -> Result<(), FtStatus>

Writes a value to an EEPROM location.

fn eeprom_erase(&mut self) -> Result<(), FtStatus>

Erases the entire contents of the EEPROM, including the user area.

fn eeprom_user_size(&mut self) -> Result<usize, FtStatus>

Get the available size of the EEPROM user area in bytes.

fn eeprom_user_read(&mut self, buf: &mut [u8]) -> Result<usize, FtStatus>

Read the contents of the EEPROM user area.

fn eeprom_user_write(&mut self, buf: &[u8]) -> Result<(), FtStatus>

Write to the EEPROM user area.

impl<'_> TryFrom<&'_ mut Ftdi> for Ft232h

type Error = DeviceTypeError

The type returned in the event of a conversion error.

fn try_from(ft: &mut Ftdi) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ mut Ftdi> for Ft4232h

type Error = DeviceTypeError

The type returned in the event of a conversion error.

fn try_from(ft: &mut Ftdi) -> Result<Self, Self::Error>

Performs the conversion.