A definition of a CStream actually representing a USB connection to a FTDI chip.
This class implements the communication with FT245BM / FT245RL chips. Using this class makes a program to depend on:
If there is any error during the communications (or loading the Windows DLL), a std::exception will be raised.
To write bulk data, use CStream::ReadBuffer and CStream::WriteBuffer. See also the derived classes for higher level communication: CInterfaceFTDIMessages
Warning: Avoid defining an object of this class in a global scope if you want to catch all potential exceptions during the constructors (like DLL not found, etc...)
VERSIONS:
Definition at line 90 of file CInterfaceFTDI.h.
#include <mrpt/hwdrivers/CInterfaceFTDI.h>
Public Member Functions | |
CInterfaceFTDI () | |
Constructor, which loads driver interface (the DLL under Windows). | |
virtual | ~CInterfaceFTDI () |
Destructor, which closes the connection with the chip and unloads the driver interface. | |
CInterfaceFTDI (const CInterfaceFTDI &o) | |
This object cannot be copied. | |
CInterfaceFTDI & | operator= (const CInterfaceFTDI &o) |
This object cannot be copied. | |
bool | isOpen () |
Checks whether the chip has been successfully open. | |
void | OpenBySerialNumber (const std::string &serialNumber) |
Open by device serial number. | |
void | OpenByDescription (const std::string &description) |
Open by device description. | |
void | Close () |
Close the USB device. | |
void | ResetDevice () |
Reset the USB device. | |
void | Purge () |
Purge the I/O buffers. | |
void | SetLatencyTimer (unsigned char latency_ms) |
Change the latency timer (in milliseconds) implemented on the FTDI chip: for a few ms, data is not sent to the PC waiting for possible more data, to save USB trafic. | |
void | SetTimeouts (unsigned long dwReadTimeout_ms, unsigned long dwWriteTimeout_ms) |
Change read & write timeouts, in milliseconds. | |
void | ListAllDevices (TFTDIDeviceList &outList) |
Generates a list with all FTDI devices connected right now. | |
size_t | ReadSync (void *Buffer, size_t Count) |
Tries to read, raising no exception if not all the bytes are available, but raising one if there is some communication error. | |
size_t | WriteSync (const void *Buffer, size_t Count) |
Tries to write, raising no exception if not all the bytes are available, but raising one if there is some communication error. | |
virtual size_t | ReadBufferImmediate (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream). | |
Protected Member Functions | |
size_t | Read (void *Buffer, size_t Count) |
Introduces a pure virtual method responsible for reading from the stream. | |
size_t | Write (const void *Buffer, size_t Count) |
Introduces a pure virtual method responsible for writing to the stream. | |
uint64_t | Seek (long Offset, CStream::TSeekOrigin Origin=sFromBeginning) |
This virtual method does nothing in this class. | |
uint64_t | getTotalBytesCount () |
This virtual method does nothing in this class. | |
uint64_t | getPosition () |
This virtual method does nothing in this class. | |
void | ftdi_read (void *lpvBuffer, unsigned long dwBuffSize, unsigned long *lpdwBytesRead) |
void | ftdi_write (const void *lpvBuffer, unsigned long dwBuffSize, unsigned long *lpdwBytes) |
void | recursive_fill_list_devices (void *usb_device_structure, TFTDIDeviceList &outList) |
Process recursively a USB device and its children: | |
Protected Attributes | |
mrpt::utils::circular_buffer < uint8_t > | m_readBuffer |
Used in Read. | |
void * | m_ftdi_context |
mrpt::hwdrivers::CInterfaceFTDI::CInterfaceFTDI | ( | ) |
Constructor, which loads driver interface (the DLL under Windows).
virtual mrpt::hwdrivers::CInterfaceFTDI::~CInterfaceFTDI | ( | ) | [virtual] |
Destructor, which closes the connection with the chip and unloads the driver interface.
mrpt::hwdrivers::CInterfaceFTDI::CInterfaceFTDI | ( | const CInterfaceFTDI & | o | ) |
This object cannot be copied.
void mrpt::hwdrivers::CInterfaceFTDI::Close | ( | ) |
Close the USB device.
void mrpt::hwdrivers::CInterfaceFTDI::ftdi_read | ( | void * | lpvBuffer, |
unsigned long | dwBuffSize, | ||
unsigned long * | lpdwBytesRead | ||
) | [protected] |
void mrpt::hwdrivers::CInterfaceFTDI::ftdi_write | ( | const void * | lpvBuffer, |
unsigned long | dwBuffSize, | ||
unsigned long * | lpdwBytes | ||
) | [protected] |
uint64_t mrpt::hwdrivers::CInterfaceFTDI::getPosition | ( | ) | [protected, virtual] |
This virtual method does nothing in this class.
Implements mrpt::utils::CStream.
uint64_t mrpt::hwdrivers::CInterfaceFTDI::getTotalBytesCount | ( | ) | [protected, virtual] |
This virtual method does nothing in this class.
Implements mrpt::utils::CStream.
bool mrpt::hwdrivers::CInterfaceFTDI::isOpen | ( | ) |
Checks whether the chip has been successfully open.
void mrpt::hwdrivers::CInterfaceFTDI::ListAllDevices | ( | TFTDIDeviceList & | outList | ) |
Generates a list with all FTDI devices connected right now.
void mrpt::hwdrivers::CInterfaceFTDI::OpenByDescription | ( | const std::string & | description | ) |
Open by device description.
void mrpt::hwdrivers::CInterfaceFTDI::OpenBySerialNumber | ( | const std::string & | serialNumber | ) |
Open by device serial number.
CInterfaceFTDI& mrpt::hwdrivers::CInterfaceFTDI::operator= | ( | const CInterfaceFTDI & | o | ) |
This object cannot be copied.
void mrpt::hwdrivers::CInterfaceFTDI::Purge | ( | ) |
Purge the I/O buffers.
size_t mrpt::hwdrivers::CInterfaceFTDI::Read | ( | void * | Buffer, |
size_t | Count | ||
) | [protected, virtual] |
Introduces a pure virtual method responsible for reading from the stream.
It integrates a cache buffer to speed-up sequences of many, small readings.
Implements mrpt::utils::CStream.
virtual size_t mrpt::hwdrivers::CInterfaceFTDI::ReadBufferImmediate | ( | void * | Buffer, |
size_t | Count | ||
) | [virtual] |
Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream).
In this class this method actually behaves as expected and does not fallback to ReadBuffer().
std::exception | On any error, or if ZERO bytes are read. |
Reimplemented from mrpt::utils::CStream.
size_t mrpt::hwdrivers::CInterfaceFTDI::ReadSync | ( | void * | Buffer, |
size_t | Count | ||
) | [inline] |
Tries to read, raising no exception if not all the bytes are available, but raising one if there is some communication error.
Definition at line 142 of file CInterfaceFTDI.h.
void mrpt::hwdrivers::CInterfaceFTDI::recursive_fill_list_devices | ( | void * | usb_device_structure, |
TFTDIDeviceList & | outList | ||
) | [protected] |
Process recursively a USB device and its children:
void mrpt::hwdrivers::CInterfaceFTDI::ResetDevice | ( | ) |
Reset the USB device.
uint64_t mrpt::hwdrivers::CInterfaceFTDI::Seek | ( | long | Offset, |
CStream::TSeekOrigin | Origin = sFromBeginning |
||
) | [protected, virtual] |
This virtual method does nothing in this class.
Implements mrpt::utils::CStream.
void mrpt::hwdrivers::CInterfaceFTDI::SetLatencyTimer | ( | unsigned char | latency_ms | ) |
Change the latency timer (in milliseconds) implemented on the FTDI chip: for a few ms, data is not sent to the PC waiting for possible more data, to save USB trafic.
void mrpt::hwdrivers::CInterfaceFTDI::SetTimeouts | ( | unsigned long | dwReadTimeout_ms, |
unsigned long | dwWriteTimeout_ms | ||
) |
Change read & write timeouts, in milliseconds.
size_t mrpt::hwdrivers::CInterfaceFTDI::Write | ( | const void * | Buffer, |
size_t | Count | ||
) | [protected, virtual] |
Introduces a pure virtual method responsible for writing to the stream.
Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.
Implements mrpt::utils::CStream.
size_t mrpt::hwdrivers::CInterfaceFTDI::WriteSync | ( | const void * | Buffer, |
size_t | Count | ||
) | [inline] |
Tries to write, raising no exception if not all the bytes are available, but raising one if there is some communication error.
Definition at line 149 of file CInterfaceFTDI.h.
void* mrpt::hwdrivers::CInterfaceFTDI::m_ftdi_context [protected] |
Definition at line 243 of file CInterfaceFTDI.h.
mrpt::utils::circular_buffer<uint8_t> mrpt::hwdrivers::CInterfaceFTDI::m_readBuffer [protected] |
Used in Read.
Definition at line 166 of file CInterfaceFTDI.h.
Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011 |