CRoboticHeadInterface.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */

#pragma once

#include <mrpt/comms/CInterfaceFTDI.h>
#include <mrpt/config/CConfigFileBase.h>
#include <mrpt/math/CMatrixDynamic.h>
#include <mrpt/obs/CObservationRange.h>
#include <mrpt/serialization/CMessage.h>
#include <mrpt/system/COutputLogger.h>

namespace mrpt::hwdrivers
{
/**   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...)
 *
 *  \code
 *  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
 *  \endcode
 * \ingroup mrpt_hwdrivers_grp
 */
class CRoboticHeadInterface : public mrpt::system::COutputLogger
{
   private:
    mrpt::comms::CInterfaceFTDI m_usbConnection;
    mrpt::serialization::CMessage msg;
    std::string m_serialNumber;
    std::vector<int32_t> gain;
    int head_yaw, head_pitch;

    // bool checkControllerIsConnected();

   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 config::CConfigFileBase
     * and
     * derived classes)
     *  See hwdrivers::CSonarSRF10 for the possible parameters
     */
    void loadConfig_sensorSpecific(
        const mrpt::config::CConfigFileBase* configSource,
        const std::string& iniSection);

   public:
    /** Constructor
     */
    CRoboticHeadInterface();

    /** Destructor
     */
    ~CRoboticHeadInterface() override = default;
    /** Changes the serial number of the device to open
     */
    void setDeviceSerialNumber(const std::string& deviceSerialNumber)
    {
        m_serialNumber = deviceSerialNumber;
    }

    /** Read the gain for the amplifier of the ear "channel", where channel is
     * 0, 1 or 2.
     */
    void GetGain(int& _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!!!
     */
    bool SetGain(int& new_gain, int& channel);

    /** This function return the angle where last sound where detected. This
     * angle is related to the robot pose, NOT head pose.
     * \code
     * angle > 0deg --> Sound detected in the left
     * angle = 0deg --> Sound detected in front of the head
     * angle < 0deg --> Sound detected in the right
     * \endcode
     */
    void GetSoundLocation(int& ang);

    /** Debug only!!! This function return the last 500 acquired samples for
     * each sound channel.
     *
     */
    void Get3SoundBuffer(mrpt::math::CMatrixDynamic<int>& buf);

    /** Move the head in:
       \code
      * elevation = 'yaw' degrees
      * orientation = 'pitch' degrees
      * \endcode
      */
    void SetHeadPose(int& yaw, int& pitch);

};  // End of class

}  // namespace mrpt::hwdrivers