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

Functions

wiced_result_t wiced_stop_ap (void)
 
wiced_result_t wiced_wifi_get_ap_client_rssi (int32_t *rssi, const wiced_mac_t *client_mac_addr)
 
wiced_result_t wiced_wifi_get_ap_info (wiced_bss_info_t *ap_info, wiced_security_t *security)
 
wiced_result_t wiced_wifi_get_associated_client_list (void *client_list_buffer, uint16_t buffer_length)
 
wiced_bool_t wiced_wifi_is_sta_link_up (void)
 
wiced_result_t wiced_wifi_register_softap_event_handler (wiced_wifi_softap_event_handler_t softap_event_handler)
 
wiced_result_t wiced_wifi_start_ap_with_custom_ie (wiced_ssid_t *ssid, wiced_security_t security, const char *key, uint8_t channel, const wiced_custom_ie_info_t *ie)
 
wiced_result_t wiced_wifi_unregister_softap_event_handler (void)
 
wwd_result_t wwd_wifi_ap_init (wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, uint8_t channel)
 
wwd_result_t wwd_wifi_ap_up (void)
 
wwd_result_t wwd_wifi_start_ap (wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, uint8_t channel)
 
wwd_result_t wwd_wifi_stop_ap (void)
 

Detailed Description

WICED Wi-Fi functions for Starting/Stopping SoftAP

WICED Wi-Fi functions for Starting/Stopping SoftAP

Function Documentation

◆ wiced_stop_ap()

wiced_result_t wiced_stop_ap ( void )
extern

Stop soft AP

Returns
wiced_result_t

◆ wiced_wifi_get_ap_client_rssi()

wiced_result_t wiced_wifi_get_ap_client_rssi ( int32_t * rssi,
const wiced_mac_t * client_mac_addr )
extern

Gets rssi information about the AP's client, as selected by mac address

Note
Only applicable if STA (client) interface is associated to an AP
Parameters
[out]rssi: Pointer to RSSI (received signal strength)
[in]security: Pointer to Client MAC address
Returns
wiced_result_t

◆ wiced_wifi_get_ap_info()

wiced_result_t wiced_wifi_get_ap_info ( wiced_bss_info_t * ap_info,
wiced_security_t * security )
extern

Gets information about the AP the client interface is currently associated to

Note
Only applicable if STA (client) interface is associated to an AP
Parameters
[out]ap_info: Pointer to structure that will be populated with AP information
[out]security: Pointer to structure that will be populated with AP security type
Returns
wiced_result_t

◆ wiced_wifi_get_associated_client_list()

wiced_result_t wiced_wifi_get_associated_client_list ( void * client_list_buffer,
uint16_t buffer_length )
extern

Gets information about associated clients.

Note
Only applicable if softAP interface is up
Parameters
[out]client_list_buffer: pointer to a buffer that will be populated with a variable length structure defined by wiced_maclist_t
[in]buffer_length: length of the buffer
Returns
wiced_result_t

◆ wiced_wifi_is_sta_link_up()

wiced_bool_t wiced_wifi_is_sta_link_up ( void )
extern

Return WICED_TRUE if the STA interface has reported a link up event (due to 802.11 association) with no corresponding link down yet.

Returns
wiced_bool_t

◆ wiced_wifi_register_softap_event_handler()

wiced_result_t wiced_wifi_register_softap_event_handler ( wiced_wifi_softap_event_handler_t softap_event_handler)
extern

Register soft AP event handler

Parameters
[in]softap_event_handler: A function pointer to the event handler
Returns
wiced_result_t

◆ wiced_wifi_start_ap_with_custom_ie()

wiced_result_t wiced_wifi_start_ap_with_custom_ie ( wiced_ssid_t * ssid,
wiced_security_t security,
const char * key,
uint8_t channel,
const wiced_custom_ie_info_t * ie )
extern

Start soft AP with custom IE

Parameters
[in]AP'sssid
[in]securitytype
[in]securitykey
[in]chanel
[in]customIE
Returns
wiced_result_t

start soft AP with custom IE

Parameters
[in]AP'sssid
[in]securitytype
[in]securitykey
[in]chanel
[in]customIE
Returns
wiced_result_t

◆ wiced_wifi_unregister_softap_event_handler()

wiced_result_t wiced_wifi_unregister_softap_event_handler ( void )
extern

Unregister soft AP event handler

Returns
wiced_result_t

◆ wwd_wifi_ap_init()

wwd_result_t wwd_wifi_ap_init ( wiced_ssid_t * ssid,
wiced_security_t auth_type,
const uint8_t * security_key,
uint8_t key_length,
uint8_t channel )
extern

Setup SoftAP

Parameters
[in]ssid: A null terminated string containing the SSID name of the network to start
[in]auth_type: Authentication type:
  • WICED_SECURITY_OPEN - Open Security
  • WICED_SECURITY_WPA_TKIP_PSK - WPA Security
  • WICED_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher
  • WICED_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers
  • WEP security is NOT IMPLEMENTED. It is NOT SECURE!
[in]security_key: A byte array containing the cleartext security key for the network
[in]key_length: The length of the security_key in bytes.
[in]channel: 802.11 channel number
Returns
wwd_result_t

◆ wwd_wifi_ap_up()

wwd_result_t wwd_wifi_ap_up ( void )
extern

start SoftAP

Parameters
[in]none
Returns
wwd_result_t

◆ wwd_wifi_start_ap()

wwd_result_t wwd_wifi_start_ap ( wiced_ssid_t * ssid,
wiced_security_t auth_type,
const uint8_t * security_key,
uint8_t key_length,
uint8_t channel )
extern

Starts an infrastructure WiFi network

Warning
If a STA interface is active when this function is called, the softAP will
start on the same channel as the STA. It will NOT use the channel provided!
Parameters
[in]ssid: A null terminated string containing the SSID name of the network to join
[in]auth_type: Authentication type:
  • WICED_SECURITY_OPEN - Open Security
  • WICED_SECURITY_WPA_TKIP_PSK - WPA Security
  • WICED_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher
  • WICED_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers
  • WEP security is NOT IMPLEMENTED. It is NOT SECURE!
[in]security_key: A byte array containing the cleartext security key for the network
[in]key_length: The length of the security_key in bytes.
[in]channel: 802.11 channel number
Returns
WWD_SUCCESS : if successfully creates an AP Error code : if an error occurred

Starts an infrastructure WiFi network

Parameters
ssid: A null terminated string containing the SSID name of the network to join
auth_type: Authentication type:
  • WICED_SECURITY_OPEN - Open Security
  • WICED_SECURITY_WPA_TKIP_PSK - WPA Security
  • WICED_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher
  • WICED_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers
  • WEP security is currently unimplemented due to lack of security
security_key: A byte array containing the cleartext security key for the network
key_length: The length of the security_key in bytes.
channel: 802.11 Channel number
Returns
WWD_SUCCESS : if successfully creates an AP Error code : if an error occurred

◆ wwd_wifi_stop_ap()

wwd_result_t wwd_wifi_stop_ap ( void )
extern

Stops an existing infrastructure WiFi network

Returns
WWD_SUCCESS : if the AP is successfully stopped or if the AP has not yet been brought up Error code : if an error occurred