xsscanner.cpp File Reference

#include "xsscanner.h"
#include "scanner.h"
#include "enumerateusbdevices.h"

Include dependency graph for xsscanner.cpp:

Go to the source code of this file.

Functions
void	XsScanner_enumerateBluetoothDevices (XsPortInfoArray *ports)
void	XsScanner_enumerateNetworkDevices (XsPortInfoArray *ports)
void	XsScanner_enumerateSerialPorts (XsPortInfoArray *ports, int ignoreNonXsensDevices)
	List all serial ports without scanning. More...
int	XsScanner_scanPort_int (XsPortInfo *port, XsBaudRate baudrate, int singleScanTimeout, int detectRs485)
	Scan a single port for Xsens devices. More...
void	XsScanner_scanPorts_int (XsPortInfoArray *ports, XsBaudRate baudrate, int singleScanTimeout, int ignoreNonXsensDevices, int detectRs485)
	Scan all ports for Xsens devices. More...
void	XsScanner_setScanLogCallback (XsScanLogCallbackFunc cb)
	Set a callback function for scan log progress and problem reporting. More...

Function Documentation

XsScanner_enumerateBluetoothDevices()

void XsScanner_enumerateBluetoothDevices

(

XsPortInfoArray *

ports

)

Definition at line 251 of file xsscanner.cpp.

XsScanner_enumerateNetworkDevices()

void XsScanner_enumerateNetworkDevices

(

XsPortInfoArray *

ports

)

Definition at line 237 of file xsscanner.cpp.

XsScanner_enumerateSerialPorts()

void XsScanner_enumerateSerialPorts	(	XsPortInfoArray *	ports,
		int	ignoreNonXsensDevices
	)

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 165 of file xsscanner.cpp.

XsScanner_scanPort_int()

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

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 92 of file xsscanner.cpp.

XsScanner_scanPorts_int()

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

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 74 of file xsscanner.cpp.

XsScanner_setScanLogCallback()

void XsScanner_setScanLogCallback

(

XsScanLogCallbackFunc

cb

)

Set a callback function for scan log progress and problem reporting.

When set, any scan will use the provided callback function to report progress and failures. Normal operation is not affected, so all return values for the scan functions remain valid.

Parameters

cb	The callback function to use. When set to NULL, no callbacks will be generated.

Definition at line 131 of file xsscanner.cpp.