Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
mrpt::hwdrivers::CRoboticHeadInterface Class Reference

Detailed Description

This "software driver" implements the communication protocol for interfacing a Robotic Head Board through a custom USB RS-422 interface board.

In this class the "bind" is ignored since it is designed for USB connections only, thus it internally generate the required object for simplicity of use. The default serial number is "OREJA001"

Warning: Avoid defining an object of this class in a global scope if you want to catch all potential exceptions during the constructors (like USB interface DLL not found, etc...)

PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
-------------------------------------------------------
[supplied_section_name]
HEAD_serialNumber=OREJA001
HEAD_gain=127,127,127
HEAD_yaw=0 // initial yaw value
HEAD_pitch=0 // initial tilt

Definition at line 46 of file CRoboticHeadInterface.h.

#include <mrpt/hwdrivers/CRoboticHeadInterface.h>

Inheritance diagram for mrpt::hwdrivers::CRoboticHeadInterface:
Inheritance graph

Public Member Functions

 CRoboticHeadInterface ()
 Constructor.
 
 ~CRoboticHeadInterface ()
 Destructor.
 
void setDeviceSerialNumber (const std::string &deviceSerialNumber)
 Changes the serial number of the device to open.
 
void GetGain (int &_gain, int &channel)
 Read the gain for the amplifier of the ear "channel", where channel is 0, 1 or 2.
 
bool SetGain (int &new_gain, int &channel)
 Set the gain for the amplifier each ear.
 
void GetSoundLocation (int &ang)
 This function return the angle where last sound where detected.
 
void Get3SoundBuffer (mrpt::math::CMatrixTemplate< int > &buf)
 Debug only!!! This function return the last 500 acquired samples for each sound channel.
 
void SetHeadPose (int &yaw, int &pitch)
 Move the head in:
 

Static Public Member Functions

static void printf_debug (const char *frmt,...)
 Sends a formated text to "debugOut" if not NULL, or to cout otherwise.
 

Protected Member Functions

void loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase *configSource, const std::string &iniSection)
 Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see utils::CConfigFileBase and derived classes) See hwdrivers::CSonarSRF10 for the possible parameters.
 

Private Member Functions

bool checkControllerIsConnected ()
 

Private Attributes

CInterfaceFTDIMessages m_usbConnection
 
utils::CMessage msg
 
std::string m_serialNumber
 
std::vector< int32_tgain
 
int head_yaw
 
int head_pitch
 

Constructor & Destructor Documentation

◆ CRoboticHeadInterface()

mrpt::hwdrivers::CRoboticHeadInterface::CRoboticHeadInterface ( )

Constructor.

◆ ~CRoboticHeadInterface()

mrpt::hwdrivers::CRoboticHeadInterface::~CRoboticHeadInterface ( )
inline

Destructor.

Definition at line 72 of file CRoboticHeadInterface.h.

Member Function Documentation

◆ checkControllerIsConnected()

bool mrpt::hwdrivers::CRoboticHeadInterface::checkControllerIsConnected ( )
private

◆ Get3SoundBuffer()

void mrpt::hwdrivers::CRoboticHeadInterface::Get3SoundBuffer ( mrpt::math::CMatrixTemplate< int > &  buf)

Debug only!!! This function return the last 500 acquired samples for each sound channel.

◆ GetGain()

void mrpt::hwdrivers::CRoboticHeadInterface::GetGain ( int &  _gain,
int &  channel 
)

Read the gain for the amplifier of the ear "channel", where channel is 0, 1 or 2.

◆ GetSoundLocation()

void mrpt::hwdrivers::CRoboticHeadInterface::GetSoundLocation ( int &  ang)

This function return the angle where last sound where detected.

This angle is related to the robot pose, NOT head pose.

angle > 0deg --> Sound detected in the left
angle = 0deg --> Sound detected in front of the head
angle < 0deg --> Sound detected in the right

◆ loadConfig_sensorSpecific()

void mrpt::hwdrivers::CRoboticHeadInterface::loadConfig_sensorSpecific ( const mrpt::utils::CConfigFileBase configSource,
const std::string &  iniSection 
)
protected

Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see utils::CConfigFileBase and derived classes) See hwdrivers::CSonarSRF10 for the possible parameters.

◆ printf_debug()

static void mrpt::utils::CDebugOutputCapable::printf_debug ( const char *  frmt,
  ... 
)
staticinherited

Sends a formated text to "debugOut" if not NULL, or to cout otherwise.

Referenced by mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute().

◆ setDeviceSerialNumber()

void mrpt::hwdrivers::CRoboticHeadInterface::setDeviceSerialNumber ( const std::string &  deviceSerialNumber)
inline

Changes the serial number of the device to open.

Definition at line 76 of file CRoboticHeadInterface.h.

◆ SetGain()

bool mrpt::hwdrivers::CRoboticHeadInterface::SetGain ( int &  new_gain,
int &  channel 
)

Set the gain for the amplifier each ear.

The value range is [0x00(min) .. 0x7F(max)]. The value 0x80 set the resistor in high impedance state, DON'T USE IT!!!

◆ SetHeadPose()

void mrpt::hwdrivers::CRoboticHeadInterface::SetHeadPose ( int &  yaw,
int &  pitch 
)

Move the head in:

elevation = 'yaw' degrees
orientation = 'pitch' degrees

Member Data Documentation

◆ gain

std::vector<int32_t> mrpt::hwdrivers::CRoboticHeadInterface::gain
private

Definition at line 52 of file CRoboticHeadInterface.h.

◆ head_pitch

int mrpt::hwdrivers::CRoboticHeadInterface::head_pitch
private

Definition at line 53 of file CRoboticHeadInterface.h.

◆ head_yaw

int mrpt::hwdrivers::CRoboticHeadInterface::head_yaw
private

Definition at line 53 of file CRoboticHeadInterface.h.

◆ m_serialNumber

std::string mrpt::hwdrivers::CRoboticHeadInterface::m_serialNumber
private

Definition at line 51 of file CRoboticHeadInterface.h.

◆ m_usbConnection

CInterfaceFTDIMessages mrpt::hwdrivers::CRoboticHeadInterface::m_usbConnection
private

Definition at line 49 of file CRoboticHeadInterface.h.

◆ msg

utils::CMessage mrpt::hwdrivers::CRoboticHeadInterface::msg
private

Definition at line 50 of file CRoboticHeadInterface.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Fri Jan 20 02:28:26 UTC 2023