Network Profiles#
Functions#
Store a network profile for a given interface.
Retrieve a stored network profile for a given interface.
Delete a stored network profile for a given interface.
Function Documentation#
sl_net_set_profile#
sl_status_t sl_net_set_profile (sl_net_interface_t interface, sl_net_profile_id_t id, const sl_net_profile_t * profile)
Store a network profile for a given interface.
[in] | interface | Interface identified by sl_net_interface_t. |
[in] | id | Profile storage index / identifier of type sl_net_profile_id_t. |
[in] | profile | Pointer to profile data of type sl_net_profile_t. |
This function stores the network profile data such as WIFI Credentials and Network Credentials for the specified interface. The profile can be used later to bring the interface up with the stored settings.
The user can use the id to store multiple profiles for the same interface and pass the id to different APIs.
Pre-conditions:
sl_net_init should be called before this API.
Returns
sl_status_t. See Status Codes and Additional Status Codes for details.
192
of file components/service/network_manager/inc/sl_net.h
sl_net_get_profile#
sl_status_t sl_net_get_profile (sl_net_interface_t interface, sl_net_profile_id_t id, sl_net_profile_t * profile)
Retrieve a stored network profile for a given interface.
[in] | interface | Interface identified by sl_net_interface_t. |
[in] | id | Profile storage index / identifier of type sl_net_profile_id_t. |
[out] | profile | Pointer to sl_net_profile_t object that will store the retrieved profile data. |
This function retrieves the network profile data for the specified interface and profile ID. The retrieved profile data is stored in the provided profile object.
Pre-conditions:
sl_net_init should be called before this API.
Returns
sl_status_t. See Status Codes and Additional Status Codes for details.
218
of file components/service/network_manager/inc/sl_net.h
sl_net_delete_profile#
sl_status_t sl_net_delete_profile (sl_net_interface_t interface, sl_net_profile_id_t id)
Delete a stored network profile for a given interface.
[in] | interface | Interface identified by sl_net_interface_t. |
[in] | id | Profile storage index / identifier of type sl_net_profile_id_t. |
This function deletes the network profile data for the specified interface and profile ID. Once deleted, the profile cannot be used to bring the interface up.
Pre-conditions:
sl_net_init should be called before this API.
Returns
sl_status_t. See Status Codes and Additional Status Codes for details.
240
of file components/service/network_manager/inc/sl_net.h