Wi-Fi Connection Manager Library
Typedefs

General Description

Typedefs

typedef uint8_t cy_wcm_ssid_t[CY_WCM_MAX_SSID_LEN+1]
 SSID name (AP name in null-terminated string format).
 
typedef uint8_t cy_wcm_mac_t[CY_WCM_MAC_ADDR_LEN]
 Unique 6-byte MAC address represented in network byte order.
 
typedef uint8_t cy_wcm_passphrase_t[CY_WCM_MAX_PASSPHRASE_LEN+1]
 Passphrase in null-terminated string format.
 
typedef void(* cy_wcm_scan_result_callback_t) (cy_wcm_scan_result_t *result_ptr, void *user_data, cy_wcm_scan_status_t status)
 Wi-Fi scan result callback function pointer type. More...
 
typedef void(* cy_wcm_event_callback_t) (cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
 WCM event callback function pointer type; events are invoked when the WHD posts events to WCM. More...
 

Typedef Documentation

◆ cy_wcm_scan_result_callback_t

typedef void(* cy_wcm_scan_result_callback_t) (cy_wcm_scan_result_t *result_ptr, void *user_data, cy_wcm_scan_status_t status)

Wi-Fi scan result callback function pointer type.

Parameters
[in]result_ptr: A pointer to the scan result; the scan result will be freed once the callback function returns from the application. There will not be any scan result when the scan status is CY_WCM_SCAN_COMPLETE. For more details on content of result_ptr, see cy_wcm_scan_result_t.
[in]user_data: User-provided data.
[in]status: Status of the scan process. CY_WCM_SCAN_COMPLETE : Indicates the scan is completed. In this case, the result_ptr will not contain any results. CY_WCM_SCAN_INCOMPLETE : Indicates the scan is in progress. In this case, result_ptr contains one of the scan result.

Note: The callback function will be executed in the context of the WCM.

◆ cy_wcm_event_callback_t

typedef void(* cy_wcm_event_callback_t) (cy_wcm_event_t event, cy_wcm_event_data_t *event_data)

WCM event callback function pointer type; events are invoked when the WHD posts events to WCM.

Parameters
[in]event: WCM events.
[in]event_data: A pointer to the event data. The event data will be freed once the callback returns from the application.

Note: The callback function will be executed in the context of the WCM.