Smart_Connection

This section introduces MediaTek Smart Connection APIs including details on how to use the APIs, enums, structures and functions. More...

Overview

This section introduces MediaTek Smart Connection APIs including details on how to use the APIs, enums, structures and functions.

How to use these APIs

• Connecting to the target AP with Smart Connection
  
  • Step 1. Define a wifi_smart_connection_callback_t callback function to process a Smart Connection event.
  • Step 2. Call wifi_smart_connection_init() to apply for required resources. Note: The predefined callback, such as, the smtcn_evt_handler(), should be passed to the wifi_smart_connection_init().
  • Step 3. Call wifi_smart_connection_start() to start the Smart Connection.
  • Step 4. Call wifi_smart_connection_get_result() to get the SSID and the password, when receiving WIFI_SMART_CONNECTION_EVENT_INFO_COLLECTED event.
  • Step 5. Connect to the target AP.
  • Step 6: Call wifi_smart_connection_stop() to exit the Smart Connection. Or call wifi_smart_connection_deinit() if the connection is succesffuly established.
  • sample code:

     void smtcn_evt_handler(wifi_smart_connection_event_t event, void *data)
     {
         uint8_t passwd[WIFI_LENGTH_PASSPHRASE + 1] = {0}; 
         uint8_t ssid[WIFI_MAX_LENGTH_OF_SSID + 1] = {0};
         uint8_t ssid_len = 0;
         uint8_t passwd_len = 0;
    
         switch (event)
         {
             case WIFI_SMART_CONNECTION_EVENT_CHANNEL_LOCKED:
                 //Report the locked channel.
                 break;
             case WIFI_SMART_CONNECTION_EVENT_TIMEOUT:
                 //Report the timeout to the upper layers.
                 break;
             case WIFI_SMART_CONNECTION_EVENT_INFO_COLLECTED:
                 //Save the received information and connect to the target AP, and then call #wifi_smart_connection_deinit() to release the resources.
                 wifi_smart_connection_get_result(ssid, &ssid_len, passwd, &passwd_len, NULL, NULL);
                 mtk_scan_connect_ap(ssid, passwd);
                 wifi_smart_connection_deinit();
                 break;
         }
     }
    
     int32_t mtk_smart_connect(void)
     {
         if(wifi_smart_connection_init(NULL, 0, smtcn_evt_handler) < 0){
             return -1;
         }
    
         wifi_smart_connection_start(0);
         return 0;
    }
    
    int32_t mtk_smart_stop(void)
    {
        wifi_smart_connection_stop();
        return 0;
    }

Typedefs
typedef void(*	wifi_smart_connection_callback_t) (wifi_smart_connection_event_t event, void *data)
	This callback function should be registered through the wifi_smart_connection_init(), and will be called when a Smart Connection event is received. More...

Functions
wifi_smart_connection_status_t	wifi_smart_connection_init (const uint8_t *key, const uint8_t key_length, wifi_smart_connection_callback_t callback)
	This function registers a callback function to establish the Smart Connection. More...
void	wifi_smart_connection_deinit (void)
	This function de-initializes the Smart Connection and releases the resources. More...
wifi_smart_connection_status_t	wifi_smart_connection_start (uint16_t timeout_seconds)
	This function starts the Smart Connection. More...
wifi_smart_connection_status_t	wifi_smart_connection_get_result (uint8_t *ssid, uint8_t *ssid_length, uint8_t *password, uint8_t *password_length, uint8_t *tlv_data, uint8_t *tlv_data_length)
	This function gets the Smart Connection result. More...
wifi_smart_connection_status_t	wifi_smart_connection_stop (void)
	This function is called to inform smart connection task of exiting flag and then the task will automatically release the resources. More...

Modules
	Enum

Typedef Documentation

typedef void(* wifi_smart_connection_callback_t) (wifi_smart_connection_event_t event, void *data)

This callback function should be registered through the wifi_smart_connection_init(), and will be called when a Smart Connection event is received.

Parameters

[in]	event	is the Smart Connection event.
[in]	data	is the reserved data.

Returns

None

Function Documentation

void wifi_smart_connection_deinit

(

void

)

This function de-initializes the Smart Connection and releases the resources.

Returns

None

wifi_smart_connection_status_t wifi_smart_connection_get_result	(	uint8_t *	ssid,
		uint8_t *	ssid_length,
		uint8_t *	password,
		uint8_t *	password_length,
		uint8_t *	tlv_data,
		uint8_t *	tlv_data_length
	)

This function gets the Smart Connection result.

Call it once WIFI_SMART_CONNECTION_EVENT_INFO_COLLECTED is finished, or it will return an error.

Parameters

[out]	ssid	is a pointer to the memory where the SSID is stored.
[out]	ssid_length	is a pointer to the memory where the length of SSID is stored.
[out]	password	is a pointer to the memory where the password is stored.
[out]	password_length	is a pointer to the memory where the length of password length is stored.
[out]	tlv_data	is a pointer to the memory where the tlv data is stored.
[out]	tlv_data_length	is a pointer to the memory where the length of tlv data is stored.

Returns

WIFI_SMART_CONNECTION_OK, if the operation completed successfully.

wifi_smart_connection_status_t wifi_smart_connection_init	(	const uint8_t *	key,
		const uint8_t	key_length,
		wifi_smart_connection_callback_t	callback
	)

This function registers a callback function to establish the Smart Connection.

Parameters

[in]	key	is the user-defined security key, to decrypt the information received through the Smart Connection.
[in]	key_length	is the length of the security key.
[in]	callback	is a user-defined callback to handle the Smart Connection events.

Returns

WIFI_SMART_CONNECTION_OK, if the operation completed successfully.

wifi_smart_connection_status_t wifi_smart_connection_start

(

uint16_t

timeout_seconds

)

This function starts the Smart Connection.

It should be called after wifi_smart_connection_init() for pre-allocated resources.

Parameters

[in]

timeout_seconds

is a user-defined timeout value in seconds. It implies smart connection failed once timeout is reached. if timeout_seconds == 0, will never time out

Returns

WIFI_SMART_CONNECTION_OK, if the operation completed successfully.

wifi_smart_connection_status_t wifi_smart_connection_stop

(

void

)

This function is called to inform smart connection task of exiting flag and then the task will automatically release the resources.

Returns

WIFI_SMART_CONNECTION_OK, if the operation completed successfully.