3.3.0.0R11
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules

Macros

#define LTRX_SCAN_ENCR_FLAGS__CCMP   0x02
 CCMP encryption protocol. More...
 
#define LTRX_SCAN_ENCR_FLAGS__TKIP   0x04
 TKIP encryption protocol. More...
 
#define LTRX_SCAN_ENCR_FLAGS__WEP   0x01
 WEP security level. More...
 
#define LTRX_SCAN_SECURITY_SUITE__OPEN   0x00
 Open security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WEP   0x01
 WEP security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WPA   0x02
 WPA security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WPA2   0x04
 WPA2 security protocol. More...
 

Functions

bool ltrx_scan_begin (uint32_t scanMutexWaitMsec)
 Start network scan. More...
 
void ltrx_scan_collect (const char *optSsid)
 Scan for specified network. More...
 
void ltrx_scan_end (void)
 End network scan. More...
 
struct ltrx_scan_resultltrx_scan_get (unsigned int readoutIndex)
 Get scan result. More...
 

Detailed Description

Via the Scan API, an application can scan the wireless network and examine the scan responses.

Macro Definition Documentation

#define LTRX_SCAN_ENCR_FLAGS__CCMP   0x02

CCMP encryption protocol.

CCMP encryption protocol

#define LTRX_SCAN_ENCR_FLAGS__TKIP   0x04

TKIP encryption protocol.

TKIP encryption protocol

#define LTRX_SCAN_ENCR_FLAGS__WEP   0x01

WEP security level.

WEP security level

#define LTRX_SCAN_SECURITY_SUITE__OPEN   0x00

Open security protocol.

Open security protocol

#define LTRX_SCAN_SECURITY_SUITE__WEP   0x01

WEP security protocol.

WEP security protocol

#define LTRX_SCAN_SECURITY_SUITE__WPA   0x02

WPA security protocol.

WPA security protocol

#define LTRX_SCAN_SECURITY_SUITE__WPA2   0x04

WPA2 security protocol.

WPA2 security protocol

Function Documentation

bool ltrx_scan_begin ( uint32_t  scanMutexWaitMsec)

Start network scan.

Prepare mutex to perfrom network scan

Parameters
[in]scanMutexWaitMsecScan timeout value. Use TIME_WAIT_FOREVER to wait indefinitely
void ltrx_scan_collect ( const char *  optSsid)

Scan for specified network.

Scan for the network ssid, if specified. Perform a broadcast scan if ssid is not specified

Parameters
[in]optSsidOptional SSID, NULL = broadcast scan
void ltrx_scan_end ( void  )

End network scan.

Signal scan mutex

struct ltrx_scan_result* ltrx_scan_get ( unsigned int  readoutIndex)

Get scan result.

Loop thru scan results and get the network with specified index.

Parameters
[in]readoutIndexNetwork index