cmtscan.h

Go to the documentation of this file.

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

#ifndef _SCANPORTS_H_2006_06_09
#define _SCANPORTS_H_2006_06_09

#ifndef _CMT_MONOLITHIC
#       include "xsens_list.hpp"
#endif

namespace xsens {

/*! \brief Scan COM ports for connected Xsens devices.

        The cmtScanPorts function will scan registered Xsens USB converters and serial COM ports
        for connected Xsens devices. If the baudrate parameter is 0 (default), it will try to
        connect at all supported baud rates, starting with the most common 115k2, 460k8 and 
        58k6. If the baudrate parameter is non-zero, only the specified baudrate is tried.
        Any detected devices are returned in the ports list, which is sorted by port nr.
        
*/
bool cmtScanPorts(List<CmtPortInfo>& ports, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);

/*! \brief Scan a single COM port for connected Xsens devices.

        The cmtScanPort function will scan a single port for connected Xsens devices. If the
        baudrate parameter is 0 (default), it will try to connect at all supported baud 
        rates, starting with the most common 115k2, 460k8 and 58k6. If the baudrate parameter
        is non-zero, only the specified baud rate is tried. Any detected devices are returned
        in the portInfo parameter.
        
*/
bool cmtScanPort(CmtPortInfo& portInfo, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);

//! Set to true from another thread to abort any scan currently in progress.
extern bool abortScan;

} // end of xsens namespace

#endif  // _SCANPORTS_H_2006_06_09