Constants#
This section provides a reference to Wi-Fi API constants.
Enumerations#
Wi-Fi security.
Wi-Fi encryption method.
Wi-Fi Credential.
Wi-Fi antenna selections.
Wi-Fi interface index enumeration.
Wi-Fi interface enumeration.
Enumeration of de-authentication reasons from an access point.
W-Fi regulatory region.
Wi-Fi rate protocols.
Wi-Fi scan types.
Wi-Fi transfer rates.
Wi-Fi BSS type.
Wi-Fi radio band.
Option flags for client interfaces.
Listen interval time units.
Wi-Fi event group.
Wi-Fi events Note that each event group has a matching event Each event group may be a source of multiple different events.
Macros#
Max number of Access points that can be scanned.
Max number of stations when module is running in access point mode.
Max Length of Wi-Fi PSK credential.
Max Length of Wi-Fi PMK credential.
Max length of Key in WEP security.
Max number of keys for WEP security.
Max Length of User Name in enterprise security.
Max Length of password in enterprise security.
Select Internal Antenna for Wi-Fi.
Select External Antenna for Wi-Fi.
Default Wi-Fi interface macro.
Max Wi-Fi roaming trigger interval.
Low Transmit Power Threshold for Wi-Fi.
Medium Transmit Power Threshold for Wi-Fi.
Auto detect channel.
API input checks.
Enumeration Documentation#
sl_wifi_security_t#
sl_wifi_security_t
Wi-Fi security.
| Enumerator | |
|---|---|
| SL_WIFI_OPEN | Wi-Fi Open security type. |
| SL_WIFI_WPA | Wi-Fi WPA security type. |
| SL_WIFI_WPA2 | Wi-Fi WPA2 security type. |
| SL_WIFI_WEP | Wi-Fi WEP security type. |
| SL_WIFI_WPA_ENTERPRISE | Wi-Fi WPA Enterprise security type. |
| SL_WIFI_WPA2_ENTERPRISE | Wi-Fi WPA2 Enterprise security type. |
| SL_WIFI_WPA_WPA2_MIXED | Wi-Fi WPA/WPA2 Mixed security type. |
| SL_WIFI_WPA3 | Wi-Fi WPA3 security type. |
| SL_WIFI_WPA3_TRANSITION | Wi-Fi WPA3 Transition security type. |
| SL_WIFI_SECURITY_UNKNOWN | WiFi Unknown Security type. |
sl_wifi_encryption_t#
sl_wifi_encryption_t
Wi-Fi encryption method.
| Enumerator | |
|---|---|
| SL_WIFI_NO_ENCRYPTION | Wi-Fi with No Encryption. |
| SL_WIFI_WEP_ENCRYPTION | Wi-Fi with WEP Encryption. |
| SL_WIFI_TKIP_ENCRYPTION | Wi-Fi with TKIP Encryption. |
| SL_WIFI_CCMP_ENCRYPTION | Wi-Fi with CCMP Encryption. |
| SL_WIFI_EAP_TLS_ENCRYPTION | Wi-Fi with Enterprise TLS Encryption. |
| SL_WIFI_EAP_TTLS_ENCRYPTION | Wi-Fi with Enterprise TTLS Encryption. |
| SL_WIFI_EAP_FAST_ENCRYPTION | Wi-Fi with Enterprise FAST Encryption. |
| SL_WIFI_PEAP_MSCHAPV2_ENCRYPTION | Wi-Fi with Enterprise PEAP Encryption. |
sl_wifi_credential_type_t#
sl_wifi_credential_type_t
Wi-Fi Credential.
| Enumerator | |
|---|---|
| SL_WIFI_CRED_PSK | Wi-Fi Personal Credential. |
| SL_WIFI_CRED_PMK | Wi-Fi Pairwise master key. |
| SL_WIFI_CRED_WEP | Wi-Fi WEP Credential. |
| SL_WIFI_CRED_EAP | Wi-Fi Enterprise client Credential. |
sl_wifi_antenna_t#
sl_wifi_antenna_t
Wi-Fi antenna selections.
| Enumerator | |
|---|---|
| SL_WIFI_ANTENNA_1 | Wi-Fi Radio Antenna 1. |
| SL_WIFI_ANTENNA_2 | Wi-Fi Radio Antenna 2. |
| SL_WIFI_ANTENNA_AUTO | Wi-Fi Radio Antenna Auto Selection. |
| SL_WIFI_ANTENNA_EXTERNAL | Wi-Fi Radio External Antenna. |
| SL_WIFI_ANTENNA_INTERNAL | Wi-Fi Radio Internal Antenna. |
sl_wifi_interface_index_t#
sl_wifi_interface_index_t
Wi-Fi interface index enumeration.
| Enumerator | |
|---|---|
| SL_WIFI_CLIENT_2_4GHZ_INTERFACE_INDEX | Wi-Fi client on 2.4GHz interface. |
| SL_WIFI_AP_2_4GHZ_INTERFACE_INDEX | Wi-Fi access point on 2.4GHz interface. |
| SL_WIFI_CLIENT_5GHZ_INTERFACE_INDEX | Wi-Fi client on 5GHz interface. |
| SL_WIFI_AP_5GHZ_INTERFACE_INDEX | Wi-Fi access point on 5GHz interface. |
| SL_WIFI_MAX_INTERFACE_INDEX | |
sl_wifi_interface_t#
sl_wifi_interface_t
Wi-Fi interface enumeration.
| Enumerator | |
|---|---|
| SL_WIFI_INVALID_INTERFACE | Invalid interface. |
| SL_WIFI_CLIENT_INTERFACE | (1 << 0) Wi-Fi client interface |
| SL_WIFI_AP_INTERFACE | (1 << 1) Wi-Fi access point interface |
| SL_WIFI_2_4GHZ_INTERFACE | (1 << 2) 2.4GHz radio interface |
| SL_WIFI_5GHZ_INTERFACE | (1 << 3) 5GHz radio interface |
| SL_WIFI_CLIENT_2_4GHZ_INTERFACE | Wi-Fi client interface on 2.4GHz radio. |
| SL_WIFI_AP_2_4GHZ_INTERFACE | Wi-Fi access point interface on 2.4GHz radio. |
| SL_WIFI_CLIENT_5GHZ_INTERFACE | Wi-Fi client interface on 5GHz radio. |
| SL_WIFI_AP_5GHZ_INTERFACE | Wi-Fi access point interface on 5GHz radio. |
| SL_WIFI_ALL_INTERFACES | All available Wi-Fi interfaces. |
sl_wifi_deauth_reason_t#
sl_wifi_deauth_reason_t
Enumeration of de-authentication reasons from an access point.
| Enumerator | |
|---|---|
| SL_WIFI_DEAUTH | De-Authentication from radius server. |
| SL_WIFI_DEAUTH_UNSPECIFIED | Unspecified de-authentication reason. |
sl_wifi_regulatory_region_t#
sl_wifi_regulatory_region_t
W-Fi regulatory region.
| Enumerator | |
|---|---|
| SL_WIFI_REGION_AUSTRALIA | Wi-Fi Region Australia. |
| SL_WIFI_REGION_FRANCE | Wi-Fi Region France. |
| SL_WIFI_REGION_EUROPEAN_UNION | Wi-Fi Region European Union. |
| SL_WIFI_REGION_JAPAN | Wi-Fi Region Japan. |
| SL_WIFI_REGION_UNITED_STATES | Wi-Fi Region United States. |
sl_wifi_rate_protocol_t#
sl_wifi_rate_protocol_t
Wi-Fi rate protocols.
Note
Recommended value for default behavior is SL_WIFI_RATE_PROTOCOL_AUTO
| Enumerator | |
|---|---|
| SL_WIFI_RATE_PROTOCOL_B_ONLY | 802.11b rates only (rates go here) |
| SL_WIFI_RATE_PROTOCOL_G_ONLY | 802.11g rates only (rates go here) |
| SL_WIFI_RATE_PROTOCOL_N_ONLY | 802.11n rates only (rates go here) |
| SL_WIFI_RATE_PROTOCOL_AC_ONLY | 802.11ac rates only (rates go here) |
| SL_WIFI_RATE_PROTOCOL_AX_ONLY | 802.11ax rates only (rates go here) |
| SL_WIFI_RATE_PROTOCOL_AUTO | Automatic rate selection. |
sl_wifi_scan_type_t#
sl_wifi_scan_type_t
Wi-Fi scan types.
| Enumerator | |
|---|---|
| SL_WIFI_SCAN_TYPE_ACTIVE | Active scan. Transmit probe requests and listen for responses. |
| SL_WIFI_SCAN_TYPE_PASSIVE | Passive scan. No active transmissions, listen for AP beacons and probe responses. |
| SL_WIFI_SCAN_TYPE_PROHIBITED_CHANNELS | Scan channels prohibited by regulatory region. |
| SL_WIFI_SCAN_TYPE_ADV_SCAN | Adv_scan is for scan Access Points, when module is in connected state. |
sl_wifi_rate_t#
sl_wifi_rate_t
Wi-Fi transfer rates.
| Enumerator | |
|---|---|
| SL_WIFI_AUTO_RATE | Wi-Fi Auto transfer rate. |
| SL_WIFI_RATE_11B_1 | Wi-Fi 1 Mbps transfer rate. |
| SL_WIFI_RATE_11B_MIN | Wi-Fi 11B Minimum transfer rate. |
| SL_WIFI_RATE_11B_2 | Wi-Fi 2 Mbps transfer rate. |
| SL_WIFI_RATE_11B_5_5 | Wi-Fi 5.5 Mbps transfer rate. |
| SL_WIFI_RATE_11B_11 | Wi-Fi 11 Mbps transfer rate. |
| SL_WIFI_RATE_11B_MAX | Wi-Fi 11B Maximum transfer rate. |
| SL_WIFI_RATE_11G_6 | Wi-Fi 6 Mbps transfer rate. |
| SL_WIFI_RATE_11G_MIN | Wi-Fi 11G Minimum transfer rate. |
| SL_WIFI_RATE_11G_9 | Wi-Fi 9 Mbps transfer rate. |
| SL_WIFI_RATE_11G_12 | Wi-Fi 12 Mbps transfer rate. |
| SL_WIFI_RATE_11G_18 | Wi-Fi 18 Mbps transfer rate. |
| SL_WIFI_RATE_11G_24 | Wi-Fi 24 Mbps transfer rate. |
| SL_WIFI_RATE_11G_36 | Wi-Fi 36 Mbps transfer rate. |
| SL_WIFI_RATE_11G_48 | Wi-Fi 48 Mbps transfer rate. |
| SL_WIFI_RATE_11G_54 | Wi-Fi 54 Mbps transfer rate. |
| SL_WIFI_RATE_11G_MAX | Wi-Fi 11G Maximum transfer rate. |
| SL_WIFI_RATE_11N_MCS0 | Wi-Fi 11N MCS index 0 transfer rate. |
| SL_WIFI_RATE_11N_MIN | Wi-Fi 11N Minimum transfer rate. |
| SL_WIFI_RATE_11N_MCS1 | Wi-Fi 11N MCS index 1 transfer rate. |
| SL_WIFI_RATE_11N_MCS2 | Wi-Fi 11N MCS index 2 transfer rate. |
| SL_WIFI_RATE_11N_MCS3 | Wi-Fi 11N MCS index 3 transfer rate. |
| SL_WIFI_RATE_11N_MCS4 | Wi-Fi 11N MCS index 4 transfer rate. |
| SL_WIFI_RATE_11N_MCS5 | Wi-Fi 11N MCS index 5 transfer rate. |
| SL_WIFI_RATE_11N_MCS6 | Wi-Fi 11N MCS index 6 transfer rate. |
| SL_WIFI_RATE_11N_MCS7 | Wi-Fi 11N MCS index 7 transfer rate. |
| SL_WIFI_RATE_11N_MAX | Wi-Fi 11N Maximum transfer rate. |
| SL_WIFI_RATE_11AX_MCS0 | Wi-Fi 11AX MCS index 0 transfer rate. |
| SL_WIFI_RATE_11AX_MIN | Wi-Fi 11AX Minimum transfer rate. |
| SL_WIFI_RATE_11AX_MCS1 | Wi-Fi 11AX MCS index 1 transfer rate. |
| SL_WIFI_RATE_11AX_MCS2 | Wi-Fi 11AX MCS index 2 transfer rate. |
| SL_WIFI_RATE_11AX_MCS3 | Wi-Fi 11AX MCS index 3 transfer rate. |
| SL_WIFI_RATE_11AX_MCS4 | Wi-Fi 11AX MCS index 4 transfer rate. |
| SL_WIFI_RATE_11AX_MCS5 | Wi-Fi 11AX MCS index 5 transfer rate. |
| SL_WIFI_RATE_11AX_MCS6 | Wi-Fi 11AX MCS index 6 transfer rate. |
| SL_WIFI_RATE_11AX_MCS7 | Wi-Fi 11AX MCS index 7 transfer rate. |
| SL_WIFI_RATE_11AX_MAX | Wi-Fi 11AX Maximum transfer rate. |
| SL_WIFI_RATE_INVALID | Wi-Fi Invalid transfer rate. |
sl_wifi_bss_type_t#
sl_wifi_bss_type_t
Wi-Fi BSS type.
| Enumerator | |
|---|---|
| SL_WIFI_BSS_TYPE_INFRASTRUCTURE | Wi-Fi BSS Type Infrastructure. |
| SL_WIFI_BSS_TYPE_ADHOC | Wi-Fi BSS Type ADHOC. |
| SL_WIFI_BSS_TYPE_ANY | Wi-Fi BSS Type ANY. |
| SL_WIFI_BSS_TYPE_UNKNOWN | Wi-Fi BSS Type Unknown. |
sl_wifi_band_t#
sl_wifi_band_t
Wi-Fi radio band.
| Enumerator | |
|---|---|
| SL_WIFI_AUTO_BAND | Wi-Fi Band Auto. |
| SL_WIFI_BAND_900MHZ | Wi-Fi Band 900Mhz. |
| SL_WIFI_BAND_2_4GHZ | Wi-Fi Band 2.4Ghz. |
| SL_WIFI_BAND_5GHZ | Wi-Fi Band 5Ghz. |
| SL_WIFI_BAND_6GHZ | Wi-Fi Band 6Ghz. |
| SL_WIFI_BAND_60GHZ | Wi-Fi Band 60Ghz. |
sl_wifi_bandwidth_t#
sl_wifi_bandwidth_t
| Enumerator | |
|---|---|
| SL_WIFI_AUTO_BANDWIDTH | Wi-Fi Bandwidth Auto. |
| SL_WIFI_BANDWIDTH_10MHz | Wi-Fi Bandwidth 10Mhz. |
| SL_WIFI_BANDWIDTH_20MHz | Wi-Fi Bandwidth 20Mhz. |
| SL_WIFI_BANDWIDTH_40MHz | Wi-Fi Bandwidth 40Mhz. |
| SL_WIFI_BANDWIDTH_80MHz | Wi-Fi Bandwidth 80Mhz. |
| SL_WIFI_BANDWIDTH_160MHz | Wi-Fi Bandwidth 160Mhz. |
sl_wifi_client_flag_t#
sl_wifi_client_flag_t
Option flags for client interfaces.
| Enumerator | |
|---|---|
| SL_WIFI_NO_JOIN_OPTION | Wi-Fi Client Join with no flags. |
| SL_WIFI_JOIN_WITH_NO_CSA | Wi-Fi Client Join with no CSA. |
| SL_WIFI_JOIN_WITH_SCAN | Wi-Fi Client Join with Scan. |
sl_wifi_ap_flag_t#
sl_wifi_ap_flag_t
Option flags for AP interfaces.
| Enumerator | |
|---|---|
| SL_WIFI_HIDDEN_SSID | Hide SSID of the AP. |
sl_wifi_listen_interval_time_unit_t#
sl_wifi_listen_interval_time_unit_t
Listen interval time units.
| Enumerator | |
|---|---|
| SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_BEACON | Time units specified in beacon periods. |
| SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_DTIM | Time units specified in DTIM periods. |
sl_wifi_wps_mode_t#
sl_wifi_wps_mode_t
Wi-Fi WPS mode.
| Enumerator | |
|---|---|
| SL_WIFI_WPS_PIN_MODE | WPS pin mode. |
| SL_WIFI_WPS_PUSH_BUTTON_MODE | WPS push button mode. |
sl_wifi_event_group_t#
sl_wifi_event_group_t
Wi-Fi event group.
| Enumerator | |
|---|---|
| SL_WIFI_SCAN_RESULT_EVENTS | SL_WIFI_SCAN_RESULT_EVENTS. |
| SL_WIFI_JOIN_EVENTS | SL_WIFI_JOIN_EVENTS. |
| SL_WIFI_RX_PACKET_EVENTS | SL_WIFI_RX_PACKET_EVENTS. |
| SL_WIFI_COMMAND_RESPONSE_EVENTS | SL_WIFI_COMMAND_RESPONSE_EVENTS. |
| SL_WIFI_STATS_RESPONSE_EVENTS | SL_WIFI_STATS_RESPONSE_EVENTS. |
| SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS | SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS. |
| SL_WIFI_NETWORK_DOWN_EVENTS | SL_WIFI_NETWORK_DOWN_EVENTS. |
| SL_WIFI_NETWORK_UP_EVENTS | SL_WIFI_NETWORK_UP_EVENTS. |
| SL_WIFI_CLIENT_CONNECTED_EVENTS | SL_WIFI_CLIENT_CONNECTED_EVENTS. |
| SL_WIFI_TWT_RESPONSE_EVENTS | SL_WIFI_TWT_RESPONSE_EVENTS. |
| SL_WIFI_CLIENT_DISCONNECTED_EVENTS | SL_WIFI_CLIENT_DISCONNECTED_EVENTS. |
| SL_WIFI_EVENT_GROUP_COUNT | SL_WIFI_EVENT_GROUP_COUNT. |
| SL_WIFI_EVENT_FAIL_INDICATION_EVENTS | SL_WIFI_EVENT_FAIL_INDICATION_EVENTS. |
sl_wifi_event_t#
sl_wifi_event_t
Wi-Fi events Note that each event group has a matching event Each event group may be a source of multiple different events.
| Enumerator | |
|---|---|
| SL_WIFI_SCAN_RESULT_EVENT | SL_WIFI_SCAN_RESULT_EVENT. |
| SL_WIFI_JOIN_EVENT | SL_WIFI_JOIN_EVENT. |
| SL_WIFI_RX_PACKET_EVENT | SL_WIFI_RX_PACKET_EVENT. |
| SL_WIFI_COMMAND_RESPONSE_EVENT | SL_WIFI_COMMAND_RESPONSE_EVENT. |
| SL_WIFI_STATS_RESPONSE_EVENT | SL_WIFI_STATS_RESPONSE_EVENT. |
| SL_WIFI_HTTP_OTA_FW_UPDATE_EVENT | SL_WIFI_HTTP_OTA_FW_UPDATE_EVENT. |
| SL_WIFI_NETWORK_DOWN_EVENT | SL_WIFI_NETWORK_DOWN_EVENT. |
| SL_WIFI_NETWORK_UP_EVENT | SL_WIFI_NETWORK_UP_EVENT. |
| SL_WIFI_CLIENT_CONNECTED_EVENT | SL_WIFI_CLIENT_CONNECTED_EVENT. |
| SL_WIFI_TWT_RESPONSE_EVENT | SL_WIFI_TWT_RESPONSE_EVENT. |
| SL_WIFI_CLIENT_DISCONNECTED_EVENT | SL_WIFI_CLIENT_DISCONNECTED_EVENT. |
| SL_WIFI_TWT_UNSOLICITED_SESSION_SUCCESS_EVENT | SL_WIFI_TWT_UNSOLICITED_SESSION_SUCCESS_EVENT. |
| SL_WIFI_TWT_AP_REJECTED_EVENT | SL_WIFI_TWT_AP_REJECTED_EVENT. |
| SL_WIFI_TWT_OUT_OF_TOLERANCE_EVENT | SL_WIFI_TWT_OUT_OF_TOLERANCE_EVENT. |
| SL_WIFI_TWT_RESPONSE_NOT_MATCHED_EVENT | SL_WIFI_TWT_RESPONSE_NOT_MATCHED_EVENT. |
| SL_WIFI_TWT_UNSUPPORTED_RESPONSE_EVENT | SL_WIFI_TWT_UNSUPPORTED_RESPONSE_EVENT. |
| SL_WIFI_TWT_TEARDOWN_SUCCESS_EVENT | SL_WIFI_TWT_TEARDOWN_SUCCESS_EVENT. |
| SL_WIFI_TWT_AP_TEARDOWN_SUCCESS_EVENT | SL_WIFI_TWT_AP_TEARDOWN_SUCCESS_EVENT. |
| SL_WIFI_TWT_FAIL_MAX_RETRIES_REACHED_EVENT | SL_WIFI_TWT_FAIL_MAX_RETRIES_REACHED_EVENT. |
| SL_WIFI_TWT_INACTIVE_DUE_TO_ROAMING_EVENT | SL_WIFI_TWT_INACTIVE_DUE_TO_ROAMING_EVENT. |
| SL_WIFI_TWT_INACTIVE_DUE_TO_DISCONNECT_EVENT | SL_WIFI_TWT_INACTIVE_DUE_TO_DISCONNECT_EVENT. |
| SL_WIFI_TWT_INACTIVE_NO_AP_SUPPORT_EVENT | SL_WIFI_TWT_INACTIVE_NO_AP_SUPPORT_EVENT. |
| SL_WIFI_STATS_EVENT | SL_WIFI_STATS_EVENT. |
| SL_WIFI_STATS_AYSNC_EVENT | SL_WIFI_STATS_AYSNC_EVENT. |
| SL_WIFI_STATS_ADVANCE_EVENT | SL_WIFI_STATS_ADVANCE_EVENT. |
| SL_WIFI_STATS_TEST_MODE_EVENT | SL_WIFI_STATS_TEST_MODE_EVENT. |
| SL_WIFI_STATS_MODULE_STATE_EVENT | SL_WIFI_STATS_MODULE_STATE_EVENT. |
| SL_WIFI_EVENT_FAIL_INDICATION | SL_WIFI_EVENT_FAIL_INDICATION. |
| SL_WIFI_INVALID_EVENT | |
sl_wifi_operational_mode_t#
sl_wifi_operational_mode_t
| Enumerator | |
|---|---|
| CLIENT_MODE | WiFi Client mode. |
| AP_MODE | WiFi Access point mode. |