XsScanner Class Reference

Provides static functionality for scanning for Xsens devices. More...

Related Functions
(Note that these are not member functions.)
void	XsScanner_abortScan (void)
	Abort the currently running port scan(s) More...
void	XsScanner_enumerateSerialPorts_int (XsPortInfoArray *ports, int ignoreNonXsensDevices)
	List all serial ports without scanning. More...
void	XsScanner_enumerateUsbDevices (XsPortInfoArray *ports)
	List all compatible USB ports without scanning. More...
void	XsScanner_filterResponsiveDevices (XsPortInfoArray *ports, XsBaudRate baudrate, int singleScanTimeout, int detectRs485)
	Scan the supplied ports for Xsens devices. More...
int	XsScanner_scanPort (XsPortInfo *port, XsBaudRate baudrate, int singleScanTimeout, int detectRs485)
	Scan a single port for Xsens devices. More...
void	XsScanner_scanPorts (XsPortInfoArray *ports, XsBaudRate baudrate, int singleScanTimeout, int ignoreNonXsensDevices, int detectRs485)
	Scan all ports for Xsens devices. More...
void	XsScanner_scanUsbHub (XsUsbHubInfo *hub, const XsPortInfo *port)
	Determine the USB hub that port is attached to. More...

Detailed Description

Provides static functionality for scanning for Xsens devices.

Friends And Related Function Documentation

XsScanner_abortScan()

void XsScanner_abortScan ( void  )

related

Abort the currently running port scan(s)

Definition at line 268 of file xsscanner.cpp.

XsScanner_enumerateSerialPorts_int()

void XsScanner_enumerateSerialPorts_int ( XsPortInfoArray *  ports, int  ignoreNonXsensDevices  )

related

List all serial ports without scanning.

Parameters

[out]	ports	The list of detected ports.
[in]	ignoreNonXsensDevices	When non-zero (the default), only Xsens ports are returned.

Definition at line 107 of file xsscanner.cpp.

XsScanner_enumerateUsbDevices()

void XsScanner_enumerateUsbDevices ( XsPortInfoArray *  ports )

related

List all compatible USB ports without scanning.

Parameters

[out]

ports

The list of detected ports.

Definition at line 204 of file xsscanner.cpp.

XsScanner_filterResponsiveDevices()

void XsScanner_filterResponsiveDevices ( XsPortInfoArray *  ports, XsBaudRate  baudrate, int  singleScanTimeout, int  detectRs485  )

related

Scan the supplied ports for Xsens devices.

Parameters

[in,out]	ports	The list of ports to scan. Unresponsive devices will be removed from the list.
[in]	baudrate	The baudrate to scan at. When set to XBR_Invalid, all known baudrates are scanned.
[in]	singleScanTimeout	The timeout of a scan of a single port at a single baud rate in ms.
[in]	detectRs485	Enable more extended scan to detect rs485 devices

Definition at line 178 of file xsscanner.cpp.

XsScanner_scanPort()

int XsScanner_scanPort ( XsPortInfo *  port, XsBaudRate  baudrate, int  singleScanTimeout, int  detectRs485  )

related

Scan a single port for Xsens devices.

Parameters

[in,out]	port	The name of the port to scan should be in this parameter, the other contents will be filled by the function.
[in]	baudrate	The baudrate to scan at. When set to XBR_Invalid, all known baudrates are scanned.
[in]	singleScanTimeout	The timeout of a scan at a single baud rate in ms.
[in]	detectRs485	Enable more extended scan to detect rs485 devices

Returns

true if a device was found, false otherwise

Definition at line 158 of file xsscanner.cpp.

XsScanner_scanPorts()

void XsScanner_scanPorts ( XsPortInfoArray *  ports, XsBaudRate  baudrate, int  singleScanTimeout, int  ignoreNonXsensDevices, int  detectRs485  )

related

Scan all ports for Xsens devices.

Parameters

[out]	ports	The list of detected ports.
[in]	baudrate	The baudrate to scan at. When set to XBR_Invalid, all known baudrates are scanned.
[in]	singleScanTimeout	The timeout of a scan of a single port at a single baud rate in ms.
[in]	ignoreNonXsensDevices	When non-zero (the default), only Xsens devices are returned. Otherwise other devices that comply with the Xsens message protocol will also be returned.
[in]	detectRs485	Enable more extended scan to detect rs485 devices

Definition at line 144 of file xsscanner.cpp.

XsScanner_scanUsbHub()

void XsScanner_scanUsbHub ( XsUsbHubInfo *  hub, const XsPortInfo *  port  )

related

Determine the USB hub that port is attached to.

Parameters

[out]	hub	The identifier of the hub that port is attached to.
[in]	port	The port for which to determine the USB hub.

Definition at line 225 of file xsscanner.cpp.

---

The documentation for this class was generated from the following file:

• xsscanner.cpp