5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches

Functions

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

Detailed Description

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

Function Documentation

◆ ltrx_scan_begin()

bool ltrx_scan_begin ( uint32_t scanMutexWaitMsec)

Start network scan.

Prepare mutex to perfrom network scan

Return values
trueSuccess.
falseFailed.
Parameters
[in]scanMutexWaitMsecScan timeout value. Use TIME_WAIT_FOREVER to wait indefinitely

◆ ltrx_scan_collect()

void ltrx_scan_collect ( const char * optSsid,
const uint16_t * optChannelList )

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
[in]optChannelListOptional list of channels to scan, NULL = scan all channels

◆ ltrx_scan_end()

void ltrx_scan_end ( void )

End network scan.

Signal scan mutex

◆ ltrx_scan_get()

struct ltrx_scan_result * ltrx_scan_get ( unsigned int readoutIndex)

Get scan result.

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

Returns
Scan results.
Parameters
[in]readoutIndexNetwork index