Applibs wificonfig.h
Header: #include <applibs/wificonfig.h>
The Applibs wificonfig header contains functions and types that manage Wi-Fi network configurations on a device.
Note
To use these functions, define WIFICONFIG_STRUCTS_VERSION with the structure version you're using. Currently, the only valid version is 1 (define WIFICONFIG_STRUCTS_VERSION 1). Thereafter, you can use the friendly names of the WifiConfig_ structures, which start with WifiConfig_.
Application manifest requirements
You can only call these functions if your application has the WifiConfig capability in the application manifest. The EnterpriseWifiConfig capability is also required if the application manages any settings for an EAP-TLS network.
Thread safety
These functions are not thread safe.
Concepts and samples
- Connect Azure Sphere to Wi-Fi
- Sample: Wi-Fi
- Sample: BLE-based Wi-Fi setup and device control reference solution
Functions
| Function | Description |
|---|---|
| WifiConfig_AddNetwork | Adds a Wi-Fi network to the device and returns the ID of the network. |
| WifiConfig_AddDuplicateNetwork | Adds a new network that is a duplicate of an existing network. |
| WifiConfig_ForgetAllNetworks | Removes all stored Wi-Fi networks from the device. Disconnects the device from any connected network. |
| WifiConfig_ForgetNetwork | Obsolete: This function is obsolete. Use WifiConfig_ForgetNetworkById instead. |
| WifiConfig_ForgetNetworkById | Removes a Wi-Fi network from the device. |
| WiFiConfig_GetClientCertStoreIdentifier | Gets the identifier of the stored client certificate for a network. |
| WiFiConfig_GetClientIdentity | Gets the client identity of the network. |
| WifiConfig_GetConnectedNetworkId | Gets the ID of the currently connected network. |
| WifiConfig_GetCurrentNetwork | Gets a Wi-Fi network that is connected to the device. |
| WifiConfig_GetNetworkDiagnostics | Gets information about the most recent network failure. |
| WifiConfig_GetNetworkIdByConfigName | Gets the network ID for the network configuration with the given name. |
| WiFiConfig_GetRootCACertStoreIdentifier | Gets the identifier of the stored Root CA certificate for a network. |
| WifiConfig_GetScannedNetworks | Gets the Wi-Fi networks found by the last scan operation. |
| WifiConfig_GetStoredNetworkCount | Gets the number of stored Wi-Fi networks on the device. |
| WifiConfig_GetStoredNetworks | Retrieves all stored Wi-Fi networks on the device. |
| WifiConfig_PersistConfig | Writes the current network configuration to nonvolatile storage so it persists over a device reboot. |
| WifiConfig_ReloadConfig | Reloads a Wi-Fi configuration. |
| WiFiConfig_SetClientCertStoreIdentifier | Sets the identifier for the stored client certificate for a network. |
| WiFiConfig_SetClientIdentity | Sets the client identity for a network. |
| WifiConfig_SetConfigName | Sets name for a network configuration. The name can be used as a convenient handle to identify a network configuration. |
| WifiConfig_SetNetworkEnabled | Enables or disables a Wi-Fi network configuration. |
| WifiConfig_SetPSK | Sets the pre-shared key (PSK) for a Wi-Fi network. |
| WiFiConfig_SetRootCACertStoreIdentifier | Sets the identifier for the stored Root CA certificate for a network. |
| WifiConfig_SetSecurityType | Sets the security type for a Wi-Fi network. |
| WifiConfig_SetSsid | Sets the SSID for a Wi-Fi network. |
| WifiConfig_SetTargetedScanEnabled | Enables or disables targeted scanning for a network. |
| WifiConfig_StoreOpenNetwork | Obsolete: This function is obsolete. Use WifiConfig_AddNetwork instead. |
| WifiConfig_StoreWpa2Network | Obsolete: This function is obsolete. Use WifiConfig_AddNetwork instead. |
| WifiConfig_TriggerScanAndGetScannedNetworkCount | Starts a scan to find all available Wi-Fi networks. |
Structs
| Struct | Description |
|---|---|
| WifiConfig_ClientIdentify | The client identity associated with a network.. |
| WifiConfig_ConnectedNetwork | The properties of a connected Wi-Fi network, which represent a 802.11 Basic Service Set (BSS). |
| WifiConfig_NetworkDiagnostics | Information about the most recent failure to connect to a network. |
| WifiConfig_ScannedNetwork | The properties of a scanned Wi-Fi network, which represent a 802.11 BSS. |
| WifiConfig_StoredNetwork | The properties of a stored Wi-Fi network, which represent a 802.11 BSS. |
Enums
| Enum | Description |
|---|---|
| WifiConfig_Security | The security key setting for a Wi-Fi network. |
Typedefs
| Typedef | Description |
|---|---|
| WifiConfig_Security_Type | Specifies the type of the security settings values for the WifiConfig_Security enum. |