xsscanner.h File Reference

#include "xscontrollerconfig.h"
#include <xstypes/xsbaud.h>

Include dependency graph for xsscanner.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	XsScanLogCallbackFunc) (struct XsString const *)
	Defines the callback type that can be supplied to XsScanner_setScanLogCallback. More...

Functions
XDA_DLL_API void	XsScanner_abortScan (void)
XDA_DLL_API void	XsScanner_enumerateBluetoothDevices (struct XsPortInfoArray *ports)
XDA_DLL_API void	XsScanner_enumerateNetworkDevices (struct XsPortInfoArray *ports)
XDA_DLL_API void	XsScanner_enumerateSerialPorts (struct XsPortInfoArray *ports, int ignoreNonXsensDevices)
	List all serial ports without scanning. More...
XDA_DLL_API void	XsScanner_enumerateUsbDevices (struct XsPortInfoArray *ports)
XDA_DLL_API void	XsScanner_filterResponsiveDevices (struct XsPortInfoArray *ports, XsBaudRate baudrate, int singleScanTimeout, int detectRs485)
XDA_DLL_API int	XsScanner_scanPort (struct XsPortInfo *port, XsBaudRate baudrate, int singleScanTimeout, int detectRs485)
XDA_DLL_API void	XsScanner_scanPorts (struct XsPortInfoArray *ports, XsBaudRate baudrate, int singleScanTimeout, int ignoreNonXsensDevices, int detectRs485)
XDA_DLL_API void	XsScanner_scanUsbHub (struct XsUsbHubInfo *hub, const struct XsPortInfo *port)
XDA_DLL_API void	XsScanner_setScanLogCallback (XsScanLogCallbackFunc cb)
	Set a callback function for scan log progress and problem reporting. More...

Typedef Documentation

XsScanLogCallbackFunc

typedef void(* XsScanLogCallbackFunc) (struct XsString const *)

Defines the callback type that can be supplied to XsScanner_setScanLogCallback.

Definition at line 91 of file xsscanner.h.

Function Documentation

XsScanner_abortScan()

XDA_DLL_API void XsScanner_abortScan ( void  )

related

XsScanner_enumerateBluetoothDevices()

XDA_DLL_API void XsScanner_enumerateBluetoothDevices

(

struct XsPortInfoArray *

ports

)

Definition at line 251 of file xsscanner.cpp.

XsScanner_enumerateNetworkDevices()

XDA_DLL_API void XsScanner_enumerateNetworkDevices

(

struct XsPortInfoArray *

ports

)

Definition at line 237 of file xsscanner.cpp.

XsScanner_enumerateSerialPorts()

XDA_DLL_API 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_enumerateUsbDevices()

XDA_DLL_API void XsScanner_enumerateUsbDevices ( struct XsPortInfoArray *  ports )

related

XsScanner_filterResponsiveDevices()

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

related

XsScanner_scanPort()

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

related

XsScanner_scanPorts()

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

related

XsScanner_scanUsbHub()

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

XsScanner_setScanLogCallback()

XDA_DLL_API 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.