Network Services
[WiFi Middleware]

Function Documentation

alp_status_t alp_wifi_ap_get_mac_address ( AlpWifiContext * wifi_context,

char * ap_mac_address

)

Retrieve the MAC address of the remote access point
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] ap_mac_address MAC address of the remote access point (must not be NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_connect_ap ( AlpWifiContext * wifi_context,

const AlpWifiAccessPoint * ap,

bool ui_required

)

Connect Wifi to a specific access point
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[in] ap the access point or network you want to connect(must be not NULL). At least essid and security must be precised. Unknown field must be set to 0 or NULL.

[in] ui_required true for displaying a progress during connection

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

Remarks:
if you don't know the MAC Address, i.e. for hidden networks, set the mac_address field of the ap to an empty string(first character set to '').

alp_status_t alp_wifi_disconnect ( AlpWifiContext * wifi_context )

Disconnect Wifi
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

Remarks:
An error is returned if Wifi is not connected

void alp_wifi_favorite_clear_details ( AlpWifiFavoriteNetwork * favorite_details )

Free details of a favorite network
Parameters:

[out] favorite_details details on the network

static alp_status_t alp_wifi_favorite_connect ( AlpWifiContext * wifi_context,

const char * favorite_name,

bool ui_required

) [inline, static]

Connect a favorite network
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[in] favorite_name name of the network to connect

[in] ui_required true for displaying a progress during connection

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_favorite_connect_id ( AlpWifiContext * wifi_context,

uint32_t favorite_id,

bool ui_required

)

Connect a favorite network
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[in] favorite_id ID of the network to connect

[in] ui_required true for displaying a progress during connection

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

static alp_status_t alp_wifi_favorite_delete ( const char * favorite_name ) [inline, static]

Delete the favorite network
Parameters:

[in] favorite_name name of the favorite network to delete (must not be NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_favorite_delete_id ( uint32_t favorite_id )

Delete the favorite network
Parameters:

[in] favorite_id ID of the favorite network to delete (must not be NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

void alp_wifi_favorite_free_list ( char ** name_list,

unsigned char count

)

Free details of a favorite network
Parameters:

[out] favorite_details details on the network

alp_status_t alp_wifi_favorite_get_details ( const char * favorite_name,

AlpWifiFavoriteNetwork * favorite_details

)

Retrieve all details on a favorite network
Parameters:

[in] favorite_name name of the favorite network to delete (must not be NULL)

[out] favorite_details details on the network (must not be NULL, freed with alp_wifi_favorite_free_details())

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_favorite_get_list ( char *** name_list,

unsigned char * count

)

Retrieve the list of favorite network
Parameters:

[out] name_list list of favorite networks (must not be NULL, must be freed with alp_wifi_favorite_free_list())

[out] count number of elements in the list (must not be NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

static alp_status_t alp_wifi_favorite_update ( const char * favorite_name,

char * essid,

unsigned short security,

const AlpWifiSecureParameter * secure_parameter

) [inline, static]

update the favorite network
Parameters:

[in] favorite_name name of the favorite network to edit (must not be NULL)

[in] essid ESSID of the network

[in] security security level (see ALP_WIFI_SECURITY_MODE_XXX)

[in] secure_parameter the associated secure parameter (or NULL if no security)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

Remarks:
for a secure parameter type ALP_WIFI_SECURE_PARAMETER_TYPE_PRE_SHARED_KEY and value NULL, the key is not updated in the database

alp_status_t alp_wifi_favorite_update_id ( uint32_t favorite_id,

char * essid,

unsigned short security,

const AlpWifiSecureParameter * secure_parameter

)

update the favorite network
Parameters:

[in] favorite_id ID of the favorite network to edit

[in] essid ESSID of the network

[in] security security level (see ALP_WIFI_SECURITY_MODE_XXX)

[in] secure_parameter the associated secure parameter (or NULL if no security)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

Remarks:
for a secure parameter type ALP_WIFI_SECURE_PARAMETER_TYPE_PRE_SHARED_KEY and value NULL, the key is not updated in the database

alp_status_t alp_wifi_get_connected_access_point ( AlpWifiContext * wifi_context,

AlpWifiAccessPoint * ap

)

Retrieve the Wifi connected access point
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] ap Access point information (must be not NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_get_connected_favorite_id ( AlpWifiContext * wifi_context,

uint32_t * favorite_id

)

Retrieve the ID of the connected favorite network
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] favorite_id ID of the connected network (must not be NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_get_ip_address ( AlpWifiContext * wifi_context,

char * ip

)

Retrieve the IP address of the Wifi connection
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] ip IP address of the Wifi connection (with a size at least ALP_WIFI_IP_ADDRESS_SIZE)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_is_connected ( AlpWifiContext * wifi_context,

bool * is_connected

)

Check if the Wifi is connected or not
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] is_connected pointer on the state, true for YES (must be not NULL)

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

alp_status_t alp_wifi_network_status_get ( AlpWifiContext * wifi_context,

uint8_t * status

)

Retrieve the Wifi network status
Parameters:

[in,out] wifi_context an open Wifi context (must be not NULL)

[out] status pointer on the state (must be not NULL) see ALP_CNC_STATE_XXX from the Connection Manager

Returns:
ALP_STATUS_WIFI_NO_ERROR or an error code if any

Generated on Wed Jul 30 07:06:44 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Functions
alp_status_t	alp_wifi_ap_get_mac_address (AlpWifiContext wifi_context, char ap_mac_address)
alp_status_t	alp_wifi_connect_ap (AlpWifiContext wifi_context, const AlpWifiAccessPoint ap, bool ui_required)
alp_status_t	alp_wifi_disconnect (AlpWifiContext *wifi_context)
void	alp_wifi_favorite_clear_details (AlpWifiFavoriteNetwork *favorite_details)
static alp_status_t	alp_wifi_favorite_connect (AlpWifiContext wifi_context, const char favorite_name, bool ui_required)
alp_status_t	alp_wifi_favorite_connect_id (AlpWifiContext *wifi_context, uint32_t favorite_id, bool ui_required)
static alp_status_t	alp_wifi_favorite_delete (const char *favorite_name)
alp_status_t	alp_wifi_favorite_delete_id (uint32_t favorite_id)
void	alp_wifi_favorite_free_list (char **name_list, unsigned char count)
alp_status_t	alp_wifi_favorite_get_details (const char favorite_name, AlpWifiFavoriteNetwork favorite_details)
alp_status_t	alp_wifi_favorite_get_list (char **name_list, unsigned char count)
static alp_status_t	alp_wifi_favorite_update (const char favorite_name, char essid, unsigned short security, const AlpWifiSecureParameter *secure_parameter)
alp_status_t	alp_wifi_favorite_update_id (uint32_t favorite_id, char essid, unsigned short security, const AlpWifiSecureParameter secure_parameter)
alp_status_t	alp_wifi_get_connected_access_point (AlpWifiContext wifi_context, AlpWifiAccessPoint ap)
alp_status_t	alp_wifi_get_connected_favorite_id (AlpWifiContext wifi_context, uint32_t favorite_id)
alp_status_t	alp_wifi_get_ip_address (AlpWifiContext wifi_context, char ip)
alp_status_t	alp_wifi_is_connected (AlpWifiContext wifi_context, bool is_connected)
alp_status_t	alp_wifi_network_status_get (AlpWifiContext wifi_context, uint8_t status)

Network Services [WiFi Middleware]

Functions

Function Documentation

Network Services
[WiFi Middleware]