ttyUSB.hpp

Go to the documentation of this file.

/** \file ttyUSB.hpp
 * \author Jared R. Males
 * \brief Find the details for USB serial devices
 * 
 * \ingroup tty_files
 *
 */

#ifndef tty_ttyUSB_hpp
#define tty_ttyUSB_hpp

#include <libudev.h>

#include <string>

#include <mx/ioutils/fileUtils.hpp>

#include "ttyErrors.hpp"


namespace MagAOX
{
namespace tty
{

///Get the ttyUSB device name
/**
  * \returns TTY_E_NOERROR on success
  * \returns TTY_E_NODEVNAMES if no device names found in sys
  * \returns TTY_E_UDEVNEWFAILED if initializing libudev failed.
  * \returns TTY_E_DEVNOTFOUND if no matching device found.
  * 
  * \ingroup tty 
  */
inline
int ttyUSBDevName( std::string & devName,       ///< [out] the /dev/ttyUSBX device name.
                   const std::string & vendor,  ///< [in] the 4-digit vendor identifier.
                   const std::string & product, ///< [in] the 4-digit product identifier.
                   const std::string & serial   ///< [in] the serial number.  Can be "".
                 )
{
   std::vector<std::string> devNames;

   devName = "";
   devNames = mx::ioutils::getFileNames("/sys/class/tty/", "ttyUSB", "", "");

   if(devNames.size() == 0) return TTY_E_NODEVNAMES;

   struct udev *udev;


   /* Create the udev object */
   udev = udev_new();
   if (!udev) return TTY_E_UDEVNEWFAILED;

   for(size_t i=0; i< devNames.size(); ++i)
   {
      struct udev_device *dev;

      dev = udev_device_new_from_syspath(udev, devNames[i].c_str());

      if(!dev) continue;

      dev = udev_device_get_parent_with_subsystem_devtype( dev, "usb", "usb_device");

      if (!dev) continue;

      const char * idVendor = udev_device_get_sysattr_value( dev, "idVendor" );

      if(idVendor == nullptr) continue;
      if( strcmp( idVendor, vendor.c_str()) != 0) continue;

      const char * idProduct = udev_device_get_sysattr_value( dev, "idProduct" );

      if(idProduct == nullptr) continue;
      if( strcmp( idProduct, product.c_str()) != 0) continue;

      const char * dserial = udev_device_get_sysattr_value( dev, "serial" );

      if(dserial == nullptr)
      {
         if( serial != "") continue;
      }
      else if( strcmp( dserial, serial.c_str()) != 0 ) continue;

      //If we make it through all comparisons we found it!
      boost::filesystem::path p(devNames[i]);
      devName = "/dev/" + p.filename().string();
      return TTY_E_NOERROR;
   }

   devName = "";
   return TTY_E_DEVNOTFOUND;
}

} //namespace tty
} //namespace MagAOX

#endif //tty_ttyUSB_hpp