XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Functions

This module handles the WLAN services (Personal WPA2 and Enterprise WPA2 connection). More...

+ Collaboration diagram for WLAN:

Files

file  WLAN.h
 
file  XDK_WLAN.h
 

Data Structures

struct  WLAN_Setup_S
 Structure to represent the WLAN setup features. More...
 

Typedefs

typedef struct WLAN_Setup_S WLAN_Setup_T
 Typedef to represent the WLAN setup feature. More...
 

Functions

Retcode_T WLAN_ConvertIPAddressToString (uint32_t ipAddress, char *string)
 
Retcode_T WLAN_Disable (void)
 This will disable the WLAN. More...
 
Retcode_T WLAN_Enable (void)
 This will enable the WLAN. More...
 
WlanNetworkConnect_Callback_T WLAN_GetConnectionCallbackHandle (void)
 
Retcode_T WLAN_IsIpChanged (bool *ipChangeStatus, uint32_t *newIp)
 This will validate if the WLAN IP configuration changed since WLAN_Enable. More...
 
Retcode_T WLAN_Reconnect (void)
 This will reconnect to the specified network if it is available. More...
 
Retcode_T WLAN_Setup (WLAN_Setup_T *setup)
 This will setup the WLAN. More...
 

Detailed Description

This module handles the WLAN service private implementation.


Data Structure Documentation

struct WLAN_Setup_S

Data Fields

uint32_t DnsAddr
 
uint32_t GwAddr
 
uint32_t IpAddr
 
bool IsEnterprise
 
bool IsHostPgmEnabled
 
bool IsStatic
 
uint32_t Mask
 
const char * Password
 
const char * SSID
 
const char * Username
 

Field Documentation

uint32_t DnsAddr

DNS address. Unused if IsStatic is disabled.

uint32_t GwAddr

Gateway address. Unused if IsStatic is disabled.

uint32_t IpAddr

IP address. Unused if IsStatic is disabled.

bool IsEnterprise

Boolean representing if it is Enterprise WPA2 connection (If disabled Personal WPA2 connection is done)

bool IsHostPgmEnabled

Boolean representing if dummy certificate is to be flashed for Enterprise WPA2 connection. Unused if IsEnterprise is disabled.

bool IsStatic

Boolean representing if it is static IPv4 setting (If disabled then DHCP is done)

uint32_t Mask

Mask for the IP address. Unused if IsStatic is disabled.

const char* Password

Pointer to the WLAN password

const char* SSID

Pointer to the WLAN SSID

const char* Username

Pointer to the WLAN username. Unused if IsEnterprise is disabled.

Typedef Documentation

typedef struct WLAN_Setup_S WLAN_Setup_T

Function Documentation

Retcode_T WLAN_ConvertIPAddressToString ( uint32_t  ipAddress,
char *  string 
)

This will converts a given uint32_t IP address to a null-terminated string, and stores the result in the given buffer.

Parameters
[in]ipAddressThe IP address to be converted.
in/out]string A valid pointer to the buffer which the IP string should be written to. The given buffer must be larger than the maximal length of the IP string presentation by at least 1 (for the null-character). The written string will be NULL terminated. This must have a buffer size greater than 15U bytes.
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T WLAN_Disable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This will disconnect from the WLAN network.
Retcode_T WLAN_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • If setup->IsHostPgmEnabled was enabled at the time of WLAN_Setup, then WLAN chip programming for dummy certificate will be enabled (programmed) as well.
  • WLAN_Setup must have been successful prior.
  • This is a blocking call and will connect to the WLAN network.
  • Do not call this API more than once.

+ Here is the caller graph for this function:

WlanNetworkConnect_Callback_T WLAN_GetConnectionCallbackHandle ( void  )
Retcode_T WLAN_IsIpChanged ( bool *  ipChangeStatus,
uint32_t *  newIp 
)
Parameters
in/out]ipChangeStatus Boolean if the IP changed
in/out]newIp new IP if *ipChangeStatus is true
Returns
RETCODE_OK on success, or an error code otherwise.
Note

+ Here is the caller graph for this function:

Retcode_T WLAN_Reconnect ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T WLAN_Setup ( WLAN_Setup_T setup)
Parameters
[in]setupPointer to the WLAN setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • If setup->IsHostPgmEnabled is enabled, then WLAN chip programming for dummy certificate will be setup as well.
  • This must be the first API to be called if WLAN feature is to be used.
  • Do not call this API more than once.

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8