Main MRPT website > C++ reference for MRPT 1.5.6
cmtscan.h
Go to the documentation of this file.
1 /* +---------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | http://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file |
6  | See: http://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See details in http://www.mrpt.org/License |
8  +---------------------------------------------------------------------------+ */
9 
10 #ifndef _SCANPORTS_H_2006_06_09
11 #define _SCANPORTS_H_2006_06_09
12 
13 #ifndef _CMT_MONOLITHIC
14 # include "xsens_list.hpp"
15 #endif
16 
17 namespace xsens {
18 
19 /*! \brief Scan COM ports for connected Xsens devices.
20 
21  The cmtScanPorts function will scan registered Xsens USB converters and serial COM ports
22  for connected Xsens devices. If the baudrate parameter is 0 (default), it will try to
23  connect at all supported baud rates, starting with the most common 115k2, 460k8 and
24  58k6. If the baudrate parameter is non-zero, only the specified baudrate is tried.
25  Any detected devices are returned in the ports list, which is sorted by port nr.
26 
27 */
28 bool cmtScanPorts(List<CmtPortInfo>& ports, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);
29 
30 /*! \brief Scan a single COM port for connected Xsens devices.
31 
32  The cmtScanPort function will scan a single port for connected Xsens devices. If the
33  baudrate parameter is 0 (default), it will try to connect at all supported baud
34  rates, starting with the most common 115k2, 460k8 and 58k6. If the baudrate parameter
35  is non-zero, only the specified baud rate is tried. Any detected devices are returned
36  in the portInfo parameter.
37 
38 */
39 bool cmtScanPort(CmtPortInfo& portInfo, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);
40 
41 //! Set to true from another thread to abort any scan currently in progress.
42 extern bool abortScan;
43 
44 } // end of xsens namespace
45 
46 #endif // _SCANPORTS_H_2006_06_09
bool abortScan
Set to true from another thread to abort any scan currently in progress.
Definition: cmtscan.cpp:58
Structure for storing information about a serial port.
Definition: cmtdef.h:1097
bool cmtScanPort(CmtPortInfo &portInfo, uint32_t baud, uint32_t singleScanTimeout, uint32_t scanTries)
Scan a single COM port for connected Xsens devices.
Definition: cmtscan.cpp:60
The namespace of all Xsens software since 2006.
Definition: cmt1.cpp:92
bool cmtScanPorts(List< CmtPortInfo > &ports, uint32_t baudrate, uint32_t singleScanTimeout, uint32_t scanTries)
Scan COM ports for connected Xsens devices.
Definition: cmtscan.cpp:122
unsigned __int32 uint32_t
Definition: rptypes.h:49



Page generated by Doxygen 1.8.14 for MRPT 1.5.6 Git: 4c65e8431 Tue Apr 24 08:18:17 2018 +0200 at lun oct 28 01:35:26 CET 2019