Main MRPT website > C++ reference
MRPT logo
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
mrpt::hwdrivers::CServoeNeck Class Referenceabstract

Detailed Description

A USB-interface for a custom "robotic neck" designed at MAPIR lab.

Definition at line 24 of file CServoeNeck.h.

#include <mrpt/hwdrivers/CServoeNeck.h>

Inheritance diagram for mrpt::hwdrivers::CServoeNeck:
Inheritance graph
[legend]

Public Types

enum  TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 }
 Used in CStream::Seek. More...
 

Public Member Functions

 CServoeNeck ()
 
 ~CServoeNeck ()
 
bool queryFirmwareVersion (std::string &out_firmwareVersion)
 Gets the firmware version of the eNeck board. More...
 
bool getCurrentAngle (double &angle, const uint8_t servo=0)
 Gets the current angle of the servo (in radians within (-pi,pi)) More...
 
bool setAngle (double angle, const uint8_t servo=0, bool fast=false)
 Turns the servo up to the specified angle (in radians in the range -pi,pi, other values will be saturated to the maximum or the mininum) More...
 
bool setAngleAndSpeed (double angle, const uint8_t servo, const uint8_t speed)
 Turns the servo up to the specified angle (in radians in the range -pi,pi, other values will be saturated to the maximum or the mininum) More...
 
bool setAngleWithFilter (double angle, const uint8_t servo=0, bool fast=false)
 Turns the servo up to the specified angle (in radians in the range -pi,pi) filtered by average with the last N specified angles. More...
 
bool disableServo (const uint8_t servo=0)
 Disables the servo so the neck will be loose. More...
 
bool enableServo (const uint8_t servo=0)
 Enables the servo so the neck will be tight. More...
 
bool center (const uint8_t servo=0)
 Centers the servo at zero position. More...
 
double getTruncateFactor ()
 Gets the truncate factor of the turn. More...
 
void setTruncateFactor (const double factor)
 Gets the truncate factor of the turn. More...
 
void setNumberOfPreviousAngles (const unsigned int number)
 Gets the truncate factor of the turn. More...
 
unsigned int getNumberOfPreviousAngles ()
 Gets the truncate factor of the turn. More...
 
void setOffsets (float offset0, float offset1, float offset2)
 Load the Offset values for each servo. More...
 
bool isOpen ()
 Checks whether the chip has been successfully open. More...
 
void OpenBySerialNumber (const std::string &serialNumber)
 Open by device serial number. More...
 
void OpenByDescription (const std::string &description)
 Open by device description. More...
 
void Close ()
 Close the USB device. More...
 
void ResetDevice ()
 Reset the USB device. More...
 
void Purge ()
 Purge the I/O buffers. More...
 
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. More...
 
void SetTimeouts (unsigned long dwReadTimeout_ms, unsigned long dwWriteTimeout_ms)
 Change read & write timeouts, in milliseconds. More...
 
void ListAllDevices (TFTDIDeviceList &outList)
 Generates a list with all FTDI devices connected right now. More...
 
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. More...
 
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. More...
 
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). More...
 
virtual uint64_t Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning)=0
 Introduces a pure virtual method for moving to a specified position in the streamed resource. More...
 
size_t ReadBuffer (void *Buffer, size_t Count)
 Reads a block of bytes from the stream into Buffer. More...
 
template<typename T >
size_t ReadBufferFixEndianness (T *ptr, size_t ElementCount)
 Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. More...
 
void WriteBuffer (const void *Buffer, size_t Count)
 Writes a block of bytes to the stream from Buffer. More...
 
template<typename T >
void WriteBufferFixEndianness (const T *ptr, size_t ElementCount)
 Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). More...
 
size_t CopyFrom (CStream *Source, size_t Count)
 Copies a specified number of bytes from one stream to another. More...
 
void WriteObject (const CSerializable *o)
 Writes an object to the stream. More...
 
CSerializablePtr ReadObject ()
 Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. More...
 
void ReadObject (CSerializable *existingObj)
 Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. More...
 
CStreamoperator<< (const CSerializablePtr &pObj)
 Write an object to a stream in the binary MRPT format. More...
 
CStreamoperator<< (const CSerializable &obj)
 Write an object to a stream in the binary MRPT format. More...
 
CStreamoperator>> (CSerializablePtr &pObj)
 
CStreamoperator>> (CSerializable &obj)
 
virtual int printf (const char *fmt,...) MRPT_printf_format_check(2
 Writes a string to the stream in a textual form. More...
 
template<typename T >
virtual int void printf_vector (const char *fmt, const std::vector< T > &V)
 Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element. More...
 
void sendMessage (const utils::CMessage &msg)
 Send a message to the device. More...
 
bool receiveMessage (utils::CMessage &msg)
 Tries to receive a message from the device. More...
 
bool getline (std::string &out_str)
 Reads from the stream until a '
' character is found ('' characters are ignored). More...
 

Protected Member Functions

bool setRegisterValue (const uint16_t value, const uint8_t servo=0, bool fast=false)
 
bool setRegisterValueAndSpeed (const uint16_t value, const uint8_t servo, const uint16_t speed)
 
bool getRegisterValue (uint16_t &value, const uint8_t servo=0)
 
size_t Read (void *Buffer, size_t Count)
 Introduces a pure virtual method responsible for reading from the stream. More...
 
size_t Write (const void *Buffer, size_t Count)
 Introduces a pure virtual method responsible for writing to the stream. More...
 
uint64_t Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning)
 This virtual method does nothing in this class. More...
 
uint64_t getTotalBytesCount ()
 This virtual method does nothing in this class. More...
 
uint64_t getPosition ()
 This virtual method does nothing in this class. More...
 
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: More...
 

Protected Attributes

std::string m_usbSerialNumber
 A copy of the device serial number (to open the USB FTDI chip). More...
 
double m_MaxValue
 The value set in the ICR register within the ATMEGA16 controller. More...
 
double m_TruncateFactor
 The range of turn of the servo will be truncated to "+-m_truncate_factor*(pi/2)". More...
 
std::deque< double > m_PrevAngles
 A vector containing the last N angles which where passed to the servo (for averaging) More...
 
unsigned int m_NumPrevAngles
 Number of previous angles to store for averaging. More...
 
std::vector< float > m_offsets
 The offset used for each servo. More...
 
mrpt::utils::circular_buffer< uint8_t > m_readBuffer
 Used in Read. More...
 
void * m_ftdi_context
 

Private Member Functions

unsigned int angle2RegValue (const double angle)
 Converts from a decimal angle (in radians) to the corresponding register value for the ATMEGA16 controller (for inner use only). More...
 
double regValue2angle (const uint16_t value)
 Converts from a certain value of the ATMEGA16 PWM register to the corresponding decimal angle (for inner use only). More...
 
bool checkConnectionAndConnect ()
 Tries to connect to the USB device (if disconnected). More...
 

Member Enumeration Documentation

◆ TSeekOrigin

Used in CStream::Seek.

Enumerator
sFromBeginning 
sFromCurrent 
sFromEnd 

Definition at line 41 of file CStream.h.

Constructor & Destructor Documentation

◆ CServoeNeck()

mrpt::hwdrivers::CServoeNeck::CServoeNeck ( )

◆ ~CServoeNeck()

mrpt::hwdrivers::CServoeNeck::~CServoeNeck ( )

Member Function Documentation

◆ angle2RegValue()

unsigned int mrpt::hwdrivers::CServoeNeck::angle2RegValue ( const double  angle)
private

Converts from a decimal angle (in radians) to the corresponding register value for the ATMEGA16 controller (for inner use only).

Parameters
Theangle to convert.
Returns
The value of the register to send.

◆ center()

bool mrpt::hwdrivers::CServoeNeck::center ( const uint8_t  servo = 0)

Centers the servo at zero position.

◆ checkConnectionAndConnect()

bool mrpt::hwdrivers::CServoeNeck::checkConnectionAndConnect ( )
private

Tries to connect to the USB device (if disconnected).

Returns
True on connection OK, false on error.

◆ Close()

void mrpt::hwdrivers::CInterfaceFTDI::Close ( )
inherited

Close the USB device.

◆ CopyFrom()

size_t mrpt::utils::CStream::CopyFrom ( CStream Source,
size_t  Count 
)
inherited

Copies a specified number of bytes from one stream to another.

◆ disableServo()

bool mrpt::hwdrivers::CServoeNeck::disableServo ( const uint8_t  servo = 0)

Disables the servo so the neck will be loose.

Parameters
Servothe id of the servo to move (in our ATMEGA16, from 0 to 2).
Returns
Whether or not the procedure succeded.

◆ enableServo()

bool mrpt::hwdrivers::CServoeNeck::enableServo ( const uint8_t  servo = 0)

Enables the servo so the neck will be tight.

Parameters
Servothe id of the servo to move (in our ATMEGA16, from 0 to 2).
Returns
Whether or not the procedure succeded.

◆ ftdi_read()

void mrpt::hwdrivers::CInterfaceFTDI::ftdi_read ( void *  lpvBuffer,
unsigned long  dwBuffSize,
unsigned long *  lpdwBytesRead 
)
protectedinherited

◆ ftdi_write()

void mrpt::hwdrivers::CInterfaceFTDI::ftdi_write ( const void *  lpvBuffer,
unsigned long  dwBuffSize,
unsigned long *  lpdwBytes 
)
protectedinherited

◆ getCurrentAngle()

bool mrpt::hwdrivers::CServoeNeck::getCurrentAngle ( double &  angle,
const uint8_t  servo = 0 
)

Gets the current angle of the servo (in radians within (-pi,pi))

Parameters
Angle[OUT] The current angle.
Servo[IN] The id of the servo (in our ATMEGA16, from 0 to 2).
Returns
Whether or not the procedure succeded.

◆ getline()

bool mrpt::utils::CStream::getline ( std::string &  out_str)
inherited

Reads from the stream until a '
' character is found ('' characters are ignored).

Returns
false on EOF or any other read error.

◆ getNumberOfPreviousAngles()

unsigned int mrpt::hwdrivers::CServoeNeck::getNumberOfPreviousAngles ( )
inline

Gets the truncate factor of the turn.

Definition at line 97 of file CServoeNeck.h.

◆ getPosition()

uint64_t mrpt::hwdrivers::CInterfaceFTDI::getPosition ( )
protectedvirtualinherited

This virtual method does nothing in this class.

Implements mrpt::utils::CStream.

◆ getRegisterValue()

bool mrpt::hwdrivers::CServoeNeck::getRegisterValue ( uint16_t &  value,
const uint8_t  servo = 0 
)
protected

◆ getTotalBytesCount()

uint64_t mrpt::hwdrivers::CInterfaceFTDI::getTotalBytesCount ( )
protectedvirtualinherited

This virtual method does nothing in this class.

Implements mrpt::utils::CStream.

◆ getTruncateFactor()

double mrpt::hwdrivers::CServoeNeck::getTruncateFactor ( )
inline

Gets the truncate factor of the turn.

Definition at line 85 of file CServoeNeck.h.

◆ isOpen()

bool mrpt::hwdrivers::CInterfaceFTDI::isOpen ( )
inherited

Checks whether the chip has been successfully open.

See also
OpenBySerialNumber, OpenByDescription

◆ ListAllDevices()

void mrpt::hwdrivers::CInterfaceFTDI::ListAllDevices ( TFTDIDeviceList outList)
inherited

Generates a list with all FTDI devices connected right now.

◆ OpenByDescription()

void mrpt::hwdrivers::CInterfaceFTDI::OpenByDescription ( const std::string &  description)
inherited

Open by device description.

◆ OpenBySerialNumber()

void mrpt::hwdrivers::CInterfaceFTDI::OpenBySerialNumber ( const std::string &  serialNumber)
inherited

Open by device serial number.

◆ operator<<() [1/2]

CStream& mrpt::utils::CStream::operator<< ( const CSerializablePtr pObj)
inherited

Write an object to a stream in the binary MRPT format.

◆ operator<<() [2/2]

CStream& mrpt::utils::CStream::operator<< ( const CSerializable obj)
inherited

Write an object to a stream in the binary MRPT format.

◆ operator>>() [1/2]

CStream& mrpt::utils::CStream::operator>> ( CSerializablePtr pObj)
inherited

◆ operator>>() [2/2]

CStream& mrpt::utils::CStream::operator>> ( CSerializable obj)
inherited

◆ printf()

virtual int mrpt::utils::CStream::printf ( const char *  fmt,
  ... 
)
virtualinherited

◆ printf_vector()

template<typename T >
virtual int void mrpt::utils::CStream::printf_vector ( const char *  fmt,
const std::vector< T > &  V 
)
inlineinherited

Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element.

Definition at line 200 of file CStream.h.

◆ Purge()

void mrpt::hwdrivers::CInterfaceFTDI::Purge ( )
inherited

Purge the I/O buffers.

◆ queryFirmwareVersion()

bool mrpt::hwdrivers::CServoeNeck::queryFirmwareVersion ( std::string &  out_firmwareVersion)

Gets the firmware version of the eNeck board.

Parameters
out_firmwareVersion[OUTPUT] A string containing the firmware version.
Returns
Whether or not the procedure succeded.

◆ Read()

size_t mrpt::hwdrivers::CInterfaceFTDI::Read ( void *  Buffer,
size_t  Count 
)
protectedvirtualinherited

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.

◆ ReadBuffer()

size_t mrpt::utils::CStream::ReadBuffer ( void *  Buffer,
size_t  Count 
)
inherited

Reads a block of bytes from the stream into Buffer.

Exceptions
std::exceptionOn any error, or if ZERO bytes are read.
Returns
The amound of bytes actually read.
Note
This method is endianness-dependent.
See also
ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,

◆ ReadBufferFixEndianness()

template<typename T >
size_t mrpt::utils::CStream::ReadBufferFixEndianness ( T *  ptr,
size_t  ElementCount 
)
inlineinherited

Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture.

Parameters
ElementCountThe number of elements (not bytes) to read.
ptrA pointer to the first output element in an array (or std::vector<>, etc...).
Returns
The amound of bytes (not elements) actually read (under error situations, the last element may be invalid if the data stream abruptly ends). Example of usage:
uint32_t N;
s >> N;
vector<float> vec(N);
if (N)
s.ReadBufferFixEndianness<float>(&vec[0],N);
Exceptions
std::exceptionOn any error, or if ZERO bytes are read.
See also
ReadBufferFixEndianness, ReadBuffer

Definition at line 90 of file CStream.h.

References mrpt::mrpt::utils::reverseBytesInPlace().

Referenced by mrpt::math::operator>>().

◆ ReadBufferImmediate()

virtual size_t mrpt::hwdrivers::CInterfaceFTDI::ReadBufferImmediate ( void *  Buffer,
size_t  Count 
)
virtualinherited

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().

Exceptions
std::exceptionOn any error, or if ZERO bytes are read.

Reimplemented from mrpt::utils::CStream.

◆ ReadObject() [1/2]

CSerializablePtr mrpt::utils::CStream::ReadObject ( )
inherited

Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object.

Exceptions
std::exceptionOn I/O error or undefined class.
mrpt::utils::CExceptionEOFOn an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead.

Referenced by mrpt::math::operator>>().

◆ ReadObject() [2/2]

void mrpt::utils::CStream::ReadObject ( CSerializable existingObj)
inherited

Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in.

Exceptions
std::exceptionOn I/O error or different class found.
mrpt::utils::CExceptionEOFOn an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead.

◆ ReadSync()

size_t mrpt::hwdrivers::CInterfaceFTDI::ReadSync ( void *  Buffer,
size_t  Count 
)
inlineinherited

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 125 of file CInterfaceFTDI.h.

◆ receiveMessage()

bool mrpt::utils::CStream::receiveMessage ( utils::CMessage msg)
inherited

Tries to receive a message from the device.

Exceptions
std::exceptionOn communication errors
Returns
True if successful, false if there is no new data from the device (but communications seem to work fine)
See also
The frame format is described in sendMessage()

◆ recursive_fill_list_devices()

void mrpt::hwdrivers::CInterfaceFTDI::recursive_fill_list_devices ( void *  usb_device_structure,
TFTDIDeviceList outList 
)
protectedinherited

Process recursively a USB device and its children:

◆ regValue2angle()

double mrpt::hwdrivers::CServoeNeck::regValue2angle ( const uint16_t  value)
private

Converts from a certain value of the ATMEGA16 PWM register to the corresponding decimal angle (for inner use only).

Parameters
Thevalue to convert.
Returns
The corresponding angle.

◆ ResetDevice()

void mrpt::hwdrivers::CInterfaceFTDI::ResetDevice ( )
inherited

Reset the USB device.

◆ Seek() [1/2]

virtual uint64_t mrpt::utils::CStream::Seek ( uint64_t  Offset,
CStream::TSeekOrigin  Origin = sFromBeginning 
)
pure virtualinherited

Introduces a pure virtual method for moving to a specified position in the streamed resource.

he Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:

  • sFromBeginning (Default) Offset is from the beginning of the resource. Seek moves to the position Offset. Offset must be >= 0.
  • sFromCurrent Offset is from the current position in the resource. Seek moves to Position + Offset.
  • sFromEnd Offset is from the end of the resource. Offset must be <= 0 to indicate a number of bytes before the end of the file.
    Returns
    Seek returns the new value of the Position property.

Implemented in mrpt::utils::CClientTCPSocket, mrpt::utils::CFileStream, mrpt::utils::CFileGZInputStream, mrpt::utils::CMemoryStream, mrpt::utils::CFileOutputStream, mrpt::utils::CFileInputStream, and mrpt::utils::CStdOutStream.

◆ Seek() [2/2]

uint64_t mrpt::hwdrivers::CInterfaceFTDI::Seek ( uint64_t  Offset,
CStream::TSeekOrigin  Origin = sFromBeginning 
)
protectedinherited

This virtual method does nothing in this class.

◆ sendMessage()

void mrpt::utils::CStream::sendMessage ( const utils::CMessage msg)
inherited

Send a message to the device.

Note that only the low byte from the "type" field will be used.

For frames of size < 255 the frame format is an array of bytes in this order:

<START_FLAG> <HEADER> <LENGTH> <BODY> <END_FLAG>
<START_FLAG> = 0x69
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 4

For frames of size > 255 the frame format is an array of bytes in this order:

<START_FLAG> <HEADER> <HIBYTE(LENGTH)> <LOBYTE(LENGTH)> <BODY> <END_FLAG>
<START_FLAG> = 0x79
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 5
Exceptions
std::exceptionOn communication errors

◆ setAngle()

bool mrpt::hwdrivers::CServoeNeck::setAngle ( double  angle,
const uint8_t  servo = 0,
bool  fast = false 
)

Turns the servo up to the specified angle (in radians in the range -pi,pi, other values will be saturated to the maximum or the mininum)

Parameters
Anglethe desired angle to turn.
Servothe id of the servo to move (in our ATMEGA16, from 0 to 2).
Fastindicates if the servo must reach the angle at maximum speed
Returns
Whether or not the procedure succeded.

◆ setAngleAndSpeed()

bool mrpt::hwdrivers::CServoeNeck::setAngleAndSpeed ( double  angle,
const uint8_t  servo,
const uint8_t  speed 
)

Turns the servo up to the specified angle (in radians in the range -pi,pi, other values will be saturated to the maximum or the mininum)

Parameters
Anglethe desired angle to turn.
Servothe id of the servo to move (in our ATMEGA16, from 0 to 2).
Speedindicates the speed of the servo
Returns
Whether or not the procedure succeded.

◆ setAngleWithFilter()

bool mrpt::hwdrivers::CServoeNeck::setAngleWithFilter ( double  angle,
const uint8_t  servo = 0,
bool  fast = false 
)

Turns the servo up to the specified angle (in radians in the range -pi,pi) filtered by average with the last N specified angles.

Parameters
Anglethe new desired angle to turn.
Servothe id of the servo to move (in our ATMEGA16, from 0 to 2).
Fastindicates if the servo must reach the angle at maximum speed
Returns
Whether or not the procedure succeded.

◆ SetLatencyTimer()

void mrpt::hwdrivers::CInterfaceFTDI::SetLatencyTimer ( unsigned char  latency_ms)
inherited

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.

◆ setNumberOfPreviousAngles()

void mrpt::hwdrivers::CServoeNeck::setNumberOfPreviousAngles ( const unsigned int  number)
inline

Gets the truncate factor of the turn.

Definition at line 93 of file CServoeNeck.h.

◆ setOffsets()

void mrpt::hwdrivers::CServoeNeck::setOffsets ( float  offset0,
float  offset1,
float  offset2 
)

Load the Offset values for each servo.

◆ setRegisterValue()

bool mrpt::hwdrivers::CServoeNeck::setRegisterValue ( const uint16_t  value,
const uint8_t  servo = 0,
bool  fast = false 
)
protected

◆ setRegisterValueAndSpeed()

bool mrpt::hwdrivers::CServoeNeck::setRegisterValueAndSpeed ( const uint16_t  value,
const uint8_t  servo,
const uint16_t  speed 
)
protected

◆ SetTimeouts()

void mrpt::hwdrivers::CInterfaceFTDI::SetTimeouts ( unsigned long  dwReadTimeout_ms,
unsigned long  dwWriteTimeout_ms 
)
inherited

Change read & write timeouts, in milliseconds.

◆ setTruncateFactor()

void mrpt::hwdrivers::CServoeNeck::setTruncateFactor ( const double  factor)
inline

Gets the truncate factor of the turn.

Definition at line 89 of file CServoeNeck.h.

References ASSERT_.

◆ Write()

size_t mrpt::hwdrivers::CInterfaceFTDI::Write ( const void *  Buffer,
size_t  Count 
)
protectedvirtualinherited

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.

◆ WriteBuffer()

void mrpt::utils::CStream::WriteBuffer ( const void *  Buffer,
size_t  Count 
)
inherited

Writes a block of bytes to the stream from Buffer.

Exceptions
std::exceptionOn any error
See also
Important, see: WriteBufferFixEndianness
Note
This method is endianness-dependent.

◆ WriteBufferFixEndianness()

template<typename T >
void mrpt::utils::CStream::WriteBufferFixEndianness ( const T *  ptr,
size_t  ElementCount 
)
inlineinherited

Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness).

Parameters
ElementCountThe number of elements (not bytes) to write.
ptrA pointer to the first input element in an array (or std::vector<>, etc...). Example of usage:
vector<float> vec = ...
uint32_t N = vec.size();
s << N
if (N)
s.WriteBufferFixEndianness<float>(&vec[0],N);
Exceptions
std::exceptionOn any error
See also
WriteBuffer

Definition at line 134 of file CStream.h.

◆ WriteObject()

void mrpt::utils::CStream::WriteObject ( const CSerializable o)
inherited

Writes an object to the stream.

◆ WriteSync()

size_t mrpt::hwdrivers::CInterfaceFTDI::WriteSync ( const void *  Buffer,
size_t  Count 
)
inlineinherited

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 132 of file CInterfaceFTDI.h.

Member Data Documentation

◆ m_ftdi_context

void* mrpt::hwdrivers::CInterfaceFTDI::m_ftdi_context
protectedinherited

Definition at line 226 of file CInterfaceFTDI.h.

◆ m_MaxValue

double mrpt::hwdrivers::CServoeNeck::m_MaxValue
protected

The value set in the ICR register within the ATMEGA16 controller.

Definition at line 105 of file CServoeNeck.h.

◆ m_NumPrevAngles

unsigned int mrpt::hwdrivers::CServoeNeck::m_NumPrevAngles
protected

Number of previous angles to store for averaging.

Definition at line 108 of file CServoeNeck.h.

◆ m_offsets

std::vector<float> mrpt::hwdrivers::CServoeNeck::m_offsets
protected

The offset used for each servo.

Definition at line 109 of file CServoeNeck.h.

◆ m_PrevAngles

std::deque<double> mrpt::hwdrivers::CServoeNeck::m_PrevAngles
protected

A vector containing the last N angles which where passed to the servo (for averaging)

Definition at line 107 of file CServoeNeck.h.

◆ m_readBuffer

mrpt::utils::circular_buffer<uint8_t> mrpt::hwdrivers::CInterfaceFTDI::m_readBuffer
protectedinherited

Used in Read.

Definition at line 149 of file CInterfaceFTDI.h.

◆ m_TruncateFactor

double mrpt::hwdrivers::CServoeNeck::m_TruncateFactor
protected

The range of turn of the servo will be truncated to "+-m_truncate_factor*(pi/2)".

Definition at line 106 of file CServoeNeck.h.

◆ m_usbSerialNumber

std::string mrpt::hwdrivers::CServoeNeck::m_usbSerialNumber
protected

A copy of the device serial number (to open the USB FTDI chip).

Definition at line 104 of file CServoeNeck.h.




Page generated by Doxygen 1.8.14 for MRPT 1.1.0 SVN: at lun oct 28 00:54:49 CET 2019 Hosted on:
SourceForge.net Logo