Struct libftd2xx::Ft232h

pub struct Ft232h { /* fields omitted */ }

FT232H device.

Example

Converting from an unknown FTDI device.

use libftd2xx::{Ft232h, Ftdi};
use std::convert::TryInto;

let ft232h: Ft232h = Ftdi::new()?.try_into()?;

Implementations

impl Ft232h

pub unsafe fn with_serial_number_unchecked(
    serial_number: &str
) -> Result<Ft232h, FtStatus>

Open a Ft4232h device and initialize the handle.

Safety

This is unchecked meaning a device type check will not be performed. Methods that require this specific device type may fail in unexpected ways if the wrong device is used.

Example

use libftd2xx::Ft232h;

let mut ft = unsafe { Ft232h::with_serial_number_unchecked("FT5AVX6B")? };

pub fn with_serial_number(
    serial_number: &str
) -> Result<Ft232h, DeviceTypeError>

Open a Ft232h device and initialize the handle.

Example

use libftd2xx::Ft232h;

Ft232h::with_serial_number("FT59UO4C")?;

pub fn with_description(description: &str) -> Result<Ft232h, DeviceTypeError>

Open a Ft232h device by its device description.

Example

use libftd2xx::Ft232h;

Ft232h::with_description("Hello")?;

Trait Implementations

impl Debug for Ft232h

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FtdiCommon for Ft232h

const DEVICE_TYPE: DeviceType

FTDI device type.

fn handle(&mut self) -> FT_HANDLE

Get the FTDI device handle.

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

Identify device type.

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<usize, FtStatus>

Read data from the device, returning the number of bytes read.

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

Read data from the device.

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

Write data to the device.

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

Write data to the device, returning how many bytes were written.

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 com_port_number(&mut self) -> Result<Option<u32>, FtStatus>

This is supported on Windows only.

Get the COM port associated with a device.

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

This is supported on Windows only.

Send a reset command to the port.

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

This is supported on Windows only.

Send a cycle command to the USB port.

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 FtdiEeprom<ft_eeprom_232h, Eeprom232h> for Ft232h

fn eeprom_read(&mut self) -> Result<(Eeprom, EepromStrings), FtStatus>

Read from the FTD2XX device EEPROM.

fn eeprom_program(
    &mut self,
    eeprom: Eeprom,
    strings: EepromStrings
) -> Result<(), FtStatus>

Program the FTD2XX EEPROM.

impl FtdiMpsse for Ft232h

fn set_clock(&mut self, frequency: u32) -> Result<(), TimeoutError>

Set the clock frequency.

fn initialize_mpsse(
    &mut self,
    settings: &MpsseSettings
) -> Result<(), TimeoutError>

Initialize the MPSSE.

fn initialize_mpsse_default(&mut self) -> Result<(), TimeoutError>

Initializes the MPSSE to default settings.

fn synchronize_mpsse(&mut self) -> Result<(), TimeoutError>

Synchronize the MPSSE port with the application.

fn enable_loopback(&mut self) -> Result<(), TimeoutError>

Enable the MPSSE loopback state.

fn disable_loopback(&mut self) -> Result<(), TimeoutError>

Disable the MPSSE loopback state.

fn set_gpio_lower(
    &mut self,
    state: u8,
    direction: u8
) -> Result<(), TimeoutError>

Set the pin direction and state of the lower byte (0-7) GPIO pins on the MPSSE interface.

fn gpio_lower(&mut self) -> Result<u8, TimeoutError>

Get the pin state state of the lower byte (0-7) GPIO pins on the MPSSE interface.

fn set_gpio_upper(
    &mut self,
    state: u8,
    direction: u8
) -> Result<(), TimeoutError>

Set the pin direction and state of the upper byte (8-15) GPIO pins on the MPSSE interface.

fn gpio_upper(&mut self) -> Result<u8, TimeoutError>

Get the pin state state of the upper byte (8-15) GPIO pins on the MPSSE interface.

fn clock_data_out(
    &mut self,
    mode: ClockDataOut,
    data: &[u8]
) -> Result<(), TimeoutError>

Clock data out.

fn clock_data_in(
    &mut self,
    mode: ClockDataIn,
    data: &mut [u8]
) -> Result<(), TimeoutError>

Clock data in.

fn clock_data(
    &mut self,
    mode: ClockData,
    data: &mut [u8]
) -> Result<(), TimeoutError>

Clock data in and out at the same time.

impl Ftx232hMpsse for Ft232h

fn enable_3phase_data_clocking(&mut self) -> Result<(), TimeoutError>

Enable 3 phase data clocking.

fn disable_3phase_data_clocking(&mut self) -> Result<(), TimeoutError>

Disable 3 phase data clocking.

impl TryFrom<Ftdi> for Ft232h

type Error = DeviceTypeError

The type returned in the event of a conversion error.

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

Performs the conversion.