Constants#
This section provides a reference to Wi-Fi API constants.
Note
The macros in this section are fixed and are not user configurable.
Modules#
Boot Configuration Feature Bitmaps
Enumerations#
Enumeration for Wi-Fi security types.
Enumeration for Wi-Fi encryption methods.
Enumeration for Wi-Fi Transition Disable Indication (TDI).
Enumeration for Wi-Fi Credential Types.
Enumeration of Wi-Fi antenna selections.
Enumeration of Wi-Fi interface indices.
Enumeration of Wi-Fi interfaces.
Enumeration of de-authentication reasons from an access point.
Enumeration of Wi-Fi regulatory regions.
Wi-Fi rate protocols.
Wi-Fi scan types.
Enumeration of Wi-Fi transfer rates.
Enumeration of Wi-Fi Basic Service Set (BSS) types.
Enumeration of Wi-Fi radio bands.
Enumeration of Wi-Fi bandwidth options.
Option flags for Wi-Fi client interfaces.
Enumeration of listen interval time units.
Enumeration of Wi-Fi WPS (Wi-Fi Protected Setup) modes.
Enumeration of Wi-Fi event groups.
Enumeration of Wi-Fi events.
Enumeration defining actions related to Target Wake Time (TWT).
Enumeration of Wi-Fi data rates.
Enumeration of Wi-Fi TX test modes.
Enumeration of High Throughput (HT) capabilities.
Enumeration of multicast filter command types.
Option flags for EAP (Extensible Authentication Protocol) client interfaces.
Band mode.
Guidance for Region code Mapping for Different Countries | Country | Country Code | Max power (Based on Regulatory domain) | Frequency Range (Based on Regulatory Domain) | Suggested Region Code Mapping | |:-------------—|:-----------—|:---------------------------------------—|:------------------------------------------—|:---------------------------—| | Korea | KR | 23 dBm | 2400 - 2483.5 | SL_WIFI_REGION_KR | | | Hong Kong | HK | 36 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Singapore | SG | 200 mW (23 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Malaysia | MY | 500 mW (27 dBm) | 2402 - 2482 | SL_WIFI_REGION_EU | | | Australia | AU | 4000 mW (36 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Taiwan | TW | 30 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Thailand | TH | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Mexico | MX | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Vietnam | VN | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Indonesia | ID | 500mW (27 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | China | CN | 20 dBm | 2400 - 2483.5 | SL_WIFI_REGION_CN |.
Wi-Fi VAP ID.
Keepalive types.
Macros#
Maximum number of Access Points are scanned in response to a normal scan request.
Defines the maximum length of a Wi-Fi SSID.
Maximum number of clients supported when module is running in Access Point mode.
Maximum length of the Wi-Fi Pre-Shared Key (PSK) credential.
Maximum length of the Wi-Fi Pairwise Master Key (PMK) credential.
Maximum length of the key in WEP security.
Maximum number of keys supported for WEP security.
Maximum length of the username in enterprise security.
Maximum length of the password in enterprise security.
Maximum length of the certificate key in enterprise security.
Select Internal Antenna for Wi-Fi.
Select External Antenna for Wi-Fi.
Macro to get the default Wi-Fi interface.
Maximum interval for Wi-Fi roaming trigger in milliseconds.
Macro to enable Auto Channel Selection (ACS).
Macro to define the default channel bitmap for scanning.
Macro to check for null pointers in API inputs.
Macro to check for invalid Wi-Fi interfaces in API inputs.
Wi-Fi transceiver default channel.
Wi-Fi transceiver default TX power.
Wi-Fi transceiver default retransmit count.
Wi-Fi transceiver default BE cwmin contention param value.
Wi-Fi transceiver default BE cwmax contention param value.
Wi-Fi transceiver default BE aifsn contention param value.
Wi-Fi transceiver default BK cwmin contention param value.
Wi-Fi transceiver default BK cwmax contention param value.
Wi-Fi transceiver default BK aifsn contention param value.
Wi-Fi transceiver default VI cwmin contention param value.
Wi-Fi transceiver default VI cwmax contention param value.
Wi-Fi transceiver default VI aifsn contention param value.
Wi-Fi transceiver default VO cwmin contention param value.
Wi-Fi transceiver default VO cwmax contention param value.
Wi-Fi transceiver default VO aifsn contention param value.
Enumeration Documentation#
sl_wifi_security_t#
sl_wifi_security_t
Enumeration for Wi-Fi security types.
Note
WPA3 Transition security type is not currently supported while running as an Access Point (AP).
To enable any WPA3 mode, the bit represented by the macro SL_WIFI_EXT_FEAT_IEEE_80211W must be set in the ext_custom_feature_bit_map.
| 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 that supports both WPA and WPA2. |
| SL_WIFI_WPA3 | Wi-Fi WPA3 security type. |
| SL_WIFI_WPA3_TRANSITION | Wi-Fi WPA3 Transition security type (not currently supported in AP mode) |
| SL_WIFI_WPA3_ENTERPRISE | Wi-Fi WPA3 enterprise security type. |
| SL_WIFI_WPA3_TRANSITION_ENTERPRISE | Wi-Fi WPA3 Transition enterprise security type. |
| SL_WIFI_SECURITY_UNKNOWN | Wi-Fi Unknown Security type. |
sl_wifi_encryption_t#
sl_wifi_encryption_t
Enumeration for Wi-Fi encryption methods.
Note
Some encryption types are not currently supported in station (STA) mode.
If encryption type is configured anything other than SL_WIFI_DEFAULT_ENCRYPTION, then make sure the AP (third party) supports the configured encryption type. If not, there might be a possibility of getting join failure due to the encryption type mismatch between AP (third party) and STA.
If the encryption type is set to SL_WIFI_PEAP_MSCHAPV2_ENCRYPTION, then the eap_method is determined by the macro SL_EAP_PEAP_METHOD defined in components/protocol/wifi/si91x/sl_wifi.c.
PEAP can accept any of the following three values:
PEAP: The EAP server may bypass Phase2 authentication (less secure).
PEAPSAFE1: If a client certificate (private_key/client_cert) is not used and TLS session resumption is not used, then Phase2 authentication is mandatory.
PEAPSAFE2: Requires Phase2 authentication in all cases (most secure).
Possible values for the macro SL_EAP_PEAP_METHOD are "PEAP"(default), "PEAPSAFE1", and "PEAPSAFE2".
| Enumerator | |
|---|---|
| SL_WIFI_DEFAULT_ENCRYPTION | Default Wi-Fi encryption. |
| SL_WIFI_NO_ENCRYPTION | Wi-Fi with no Encryption (not currently supported in STA mode) |
| SL_WIFI_WEP_ENCRYPTION | Wi-Fi with WEP Encryption (not currently supported in STA mode) |
| SL_WIFI_TKIP_ENCRYPTION | Wi-Fi with TKIP Encryption (not currently supported in STA mode) |
| 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_EAP_LEAP_ENCRYPTION | Wi-Fi with Enterprise LEAP Encryption. |
sl_wifi_tdi_t#
sl_wifi_tdi_t
Enumeration for Wi-Fi Transition Disable Indication (TDI).
Note
TDI is supported only in WPA3 (Personal or Personal Transition) security in Access Point (AP) mode.
| Enumerator | |
|---|---|
| SL_WIFI_TDI_NONE | Allows stations to transition within AP network. |
| SL_WIFI_TDI_SAE | Disallows stations from transitioning within the AP network and only allows connections with WPA3-SAE security mode. |
sl_wifi_credential_type_t#
sl_wifi_credential_type_t
Enumeration for Wi-Fi Credential Types.
| Enumerator | |
|---|---|
| SL_WIFI_PSK_CREDENTIAL | Wi-Fi Personal Credential. |
| SL_WIFI_PMK_CREDENTIAL | Wi-Fi Pairwise Master Key. |
| SL_WIFI_WEP_CREDENTIAL | Wi-Fi WEP Credential. |
| SL_WIFI_EAP_CREDENTIAL | Wi-Fi Enterprise Client Credential. |
| SL_WIFI_USER_CREDENTIAL | Wi-Fi User Credential. |
sl_wifi_antenna_t#
sl_wifi_antenna_t
Enumeration of Wi-Fi antenna selections.
Note
Only the internal antenna is currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_ANTENNA_1 | Wi-Fi Radio Antenna 1 (not currently supported) |
| SL_WIFI_ANTENNA_2 | Wi-Fi Radio Antenna 2 (not currently supported) |
| SL_WIFI_ANTENNA_AUTO | Wi-Fi Radio Antenna Auto Selection (not currently supported) |
| SL_WIFI_ANTENNA_EXTERNAL | Wi-Fi Radio External Antenna (not currently supported) |
| SL_WIFI_ANTENNA_INTERNAL | Wi-Fi Radio Internal Antenna. |
sl_wifi_interface_index_t#
sl_wifi_interface_index_t
Enumeration of Wi-Fi interface indices.
Note
5 GHz interfaces are not currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_CLIENT_2_4GHZ_INTERFACE_INDEX | Wi-Fi client on 2.4 GHz interface. |
| SL_WIFI_AP_2_4GHZ_INTERFACE_INDEX | Wi-Fi access point on 2.4 GHz interface. |
| SL_WIFI_CLIENT_5GHZ_INTERFACE_INDEX | Wi-Fi client on 5 GHz interface (Supported in Series-3) |
| SL_WIFI_AP_5GHZ_INTERFACE_INDEX | Wi-Fi access point on 5 GHz interface (Supported in Series-3) |
| SL_WIFI_TRANSCEIVER_INTERFACE_INDEX | Wi-Fi Transceiver Mode. |
| SL_WIFI_CLIENT_DUAL_INTERFACE_INDEX | Wi-Fi client on Dual interface (Supported in Series-3) |
| SL_WIFI_AP_DUAL_INTERFACE_INDEX | Wi-Fi access point on Dual interface (Supported in Series-3) |
| SL_WIFI_MAX_INTERFACE_INDEX | Used for internally by SDK. |
sl_wifi_interface_t#
sl_wifi_interface_t
Enumeration of Wi-Fi interfaces.
Note
5 GHz radio interfaces are not currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_INVALID_INTERFACE | Invalid interface. |
| SL_WIFI_CLIENT_INTERFACE | Wi-Fi client interface. |
| SL_WIFI_AP_INTERFACE | Wi-Fi access point interface. |
| SL_WIFI_2_4GHZ_INTERFACE | 2.4 GHz radio interface |
| SL_WIFI_5GHZ_INTERFACE | 5 GHz radio interface |
| SL_WIFI_DUAL_INTERFACE | Dual radio interface. |
| SL_WIFI_TRANSCEIVER_INTERFACE | Wi-Fi Transceiver mode interface. |
| SL_WIFI_CLIENT_2_4GHZ_INTERFACE | Wi-Fi client interface on 2.4 GHz radio. |
| SL_WIFI_AP_2_4GHZ_INTERFACE | Wi-Fi access point interface on 2.4 GHz radio. |
| SL_WIFI_CLIENT_5GHZ_INTERFACE | Wi-Fi client interface on 5 GHz radio. |
| SL_WIFI_AP_5GHZ_INTERFACE | Wi-Fi access point interface on 5 GHz radio. |
| SL_WIFI_CLIENT_DUAL_INTERFACE | Wi-Fi client interface on Dual radio. |
| SL_WIFI_AP_DUAL_INTERFACE | Wi-Fi access point interface on Dual 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
Enumeration of Wi-Fi regulatory regions.
Note
Australia and France regions are not currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_REGION_AUSTRALIA | Wi-Fi Region Australia (not currently supported) |
| SL_WIFI_REGION_FRANCE | Wi-Fi Region France (not currently supported) |
| 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.
802.11ac not currently supported.
| 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) (not currently supported) |
| 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 broadcast probe responses. |
| SL_WIFI_SCAN_TYPE_EXTENDED | Extended Active scan. Transmit probe requests and listen for responses to get more than SL_WIFI_MAX_SCANNED_AP number of results. |
| SL_WIFI_SCAN_TYPE_PROHIBITED_CHANNELS | Scan channels prohibited by regulatory region. |
| SL_WIFI_SCAN_TYPE_ADV_SCAN | Advanced scan: Scan for Access Points while the module is in connected state. |
sl_wifi_rate_t#
sl_wifi_rate_t
Enumeration of 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 for 802.11b. |
| SL_WIFI_RATE_11B_MIN | Wi-Fi Minimum transfer rate for 802.11b. |
| SL_WIFI_RATE_11B_2 | Wi-Fi 2 Mbps transfer rate for 802.11b. |
| SL_WIFI_RATE_11B_5_5 | Wi-Fi 5.5 Mbps transfer rate for 802.11b. |
| SL_WIFI_RATE_11B_11 | Wi-Fi 11 Mbps transfer rate for 802.11b. |
| SL_WIFI_RATE_11B_MAX | Wi-Fi Maximum transfer rate for 802.11b. |
| SL_WIFI_RATE_11G_6 | Wi-Fi 6 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_MIN | Wi-Fi Minimum transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_9 | Wi-Fi 9 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_12 | Wi-Fi 12 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_18 | Wi-Fi 18 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_24 | Wi-Fi 24 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_36 | Wi-Fi 36 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_48 | Wi-Fi 48 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_54 | Wi-Fi 54 Mbps transfer rate for 802.11g. |
| SL_WIFI_RATE_11G_MAX | Wi-Fi Maximum transfer rate for 802.11g. |
| SL_WIFI_RATE_11N_MCS0 | Wi-Fi MCS index 0 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MIN | Wi-Fi Minimum transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS1 | Wi-Fi MCS index 1 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS2 | Wi-Fi MCS index 2 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS3 | Wi-Fi MCS index 3 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS4 | Wi-Fi MCS index 4 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS5 | Wi-Fi MCS index 5 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS6 | Wi-Fi MCS index 6 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MCS7 | Wi-Fi MCS index 7 transfer rate for 802.11n. |
| SL_WIFI_RATE_11N_MAX | Wi-Fi Maximum transfer rate for 802.11n. |
| SL_WIFI_RATE_11AX_MCS0 | Wi-Fi MCS index 0 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MIN | Wi-Fi Minimum transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS1 | Wi-Fi MCS index 1 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS2 | Wi-Fi MCS index 2 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS3 | Wi-Fi MCS index 3 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS4 | Wi-Fi MCS index 4 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS5 | Wi-Fi MCS index 5 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS6 | Wi-Fi MCS index 6 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MCS7 | Wi-Fi MCS index 7 transfer rate for 802.11ax. |
| SL_WIFI_RATE_11AX_MAX | Wi-Fi Maximum transfer rate for 802.11ax. |
| SL_WIFI_RATE_INVALID | Wi-Fi Invalid transfer rate. |
sl_wifi_bss_type_t#
sl_wifi_bss_type_t
Enumeration of Wi-Fi Basic Service Set (BSS) types.
| Enumerator | |
|---|---|
| SL_WIFI_BSS_TYPE_INFRASTRUCTURE | Infrastructure BSS: Standard Wi-Fi Infrastructure network with an access point. |
| SL_WIFI_BSS_TYPE_ADHOC | Ad-hoc BSS: Peer-to-peer Wi-Fi network without an access point. (Currently not supported) |
| SL_WIFI_BSS_TYPE_ANY | Any Wi-Fi BSS type. (Currently not supported) |
| SL_WIFI_BSS_TYPE_UNKNOWN | Unknown Wi-Fi BSS type. |
sl_wifi_band_t#
sl_wifi_band_t
Enumeration of Wi-Fi radio bands.
Note
Only the 2.4 GHz band is currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_AUTO_BAND | Wi-Fi Band Auto. |
| SL_WIFI_BAND_900MHZ | Wi-Fi Band 900 MHz (not currently supported) |
| SL_WIFI_BAND_2_4GHZ | Wi-Fi Band 2.4 GHz. |
| SL_WIFI_BAND_5GHZ | Wi-Fi Band 5 GHz (Supported in Series-3) |
| SL_WIFI_BAND_DUAL | Wi-Fi Band Dual (Supported in Series-3) |
| SL_WIFI_BAND_6GHZ | Wi-Fi Band 6 GHz (not currently supported) |
| SL_WIFI_BAND_60GHZ | Wi-Fi Band 60 GHz (not currently supported) |
sl_wifi_bandwidth_t#
sl_wifi_bandwidth_t
Enumeration of Wi-Fi bandwidth options.
Note
Only 20 MHz bandwidth is currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_AUTO_BANDWIDTH | Wi-Fi Bandwidth Auto. |
| SL_WIFI_BANDWIDTH_10MHz | Wi-Fi Bandwidth 10 MHz (not currently supported) |
| SL_WIFI_BANDWIDTH_20MHz | Wi-Fi Bandwidth 20 MHz. |
| SL_WIFI_BANDWIDTH_40MHz | Wi-Fi Bandwidth 40 MHz (not currently supported) |
| SL_WIFI_BANDWIDTH_80MHz | Wi-Fi Bandwidth 80 MHz (not currently supported) |
| SL_WIFI_BANDWIDTH_160MHz | Wi-Fi Bandwidth 160 MHz (not currently supported) |
sl_wifi_client_flag_t#
sl_wifi_client_flag_t
Option flags for Wi-Fi 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 without Channel Switch Announcement (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 Access Point (AP) interfaces.
| Enumerator | |
|---|---|
| SL_WIFI_HIDDEN_SSID | Hide the SSID of the AP. |
sl_wifi_listen_interval_time_unit_t#
sl_wifi_listen_interval_time_unit_t
Enumeration of 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 Delivery Traffic Indication Message (DTIM) periods. |
sl_wifi_wps_mode_t#
sl_wifi_wps_mode_t
Enumeration of Wi-Fi WPS (Wi-Fi Protected Setup) modes.
| Enumerator | |
|---|---|
| SL_WIFI_WPS_PIN_MODE | WPS pin mode: Requires a PIN to be entered on the client device. |
| SL_WIFI_WPS_PUSH_BUTTON_MODE | WPS push button mode: Requires the user to press a physical or virtual button on both the AP and the client device. |
sl_wifi_event_group_t#
sl_wifi_event_group_t
Enumeration of Wi-Fi event groups.
| Enumerator | |
|---|---|
| SL_WIFI_SCAN_RESULT_EVENTS | Event group for Wi-Fi scan results. |
| SL_WIFI_JOIN_EVENTS | Event group for Wi-Fi join status. |
| SL_WIFI_RX_PACKET_EVENTS | Event group for Wi-Fi received packet. This feature is not supported in current release. |
| SL_WIFI_COMMAND_RESPONSE_EVENTS | Event group for Wi-Fi command response. This feature is not supported in current release. |
| SL_WIFI_STATS_RESPONSE_EVENTS | Event group for Wi-Fi statistics response. |
| SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS | Event group for Wi-Fi OTA firmware update status via HTTP. |
| SL_WIFI_NETWORK_DOWN_EVENTS | Event group for Wi-Fi network down. This feature is not supported in current release. |
| SL_WIFI_NETWORK_UP_EVENTS | Event group for Wi-Fi network up. This feature is not supported in current release. |
| SL_WIFI_CLIENT_CONNECTED_EVENTS | Event group for Wi-Fi client connected status. |
| SL_WIFI_TWT_RESPONSE_EVENTS | Event group for Wi-Fi TWT response. |
| SL_WIFI_CLIENT_DISCONNECTED_EVENTS | Event group for Wi-Fi client disconnection status. |
| SL_WIFI_TRANSCEIVER_EVENTS | Event group for Wi-Fi transceiver events. |
| SL_WIFI_EVENT_GROUP_COUNT | Event group for Wi-Fi maximum default group count. Used internally by SDK. |
| SL_WIFI_EVENT_FAIL_INDICATION_EVENTS | Event group for Wi-Fi fail indication. |
sl_wifi_event_t#
sl_wifi_event_t
Enumeration of Wi-Fi events.
Note
Each event group has a matching event.
Each event group may be a source of multiple different events.
| Enumerator | |
|---|---|
| SL_WIFI_SCAN_RESULT_EVENT | Event for Wi-Fi scan result. Data would be type of sl_wifi_scan_result_t. |
| SL_WIFI_JOIN_EVENT | Event for Wi-Fi join status. Data would be of type string. |
| SL_WIFI_RX_PACKET_EVENT | Event for Wi-Fi received packet. This feature is not supported in current release. |
| SL_WIFI_COMMAND_RESPONSE_EVENT | Event for Wi-Fi command response. This feature is not supported in current release. |
| SL_WIFI_STATS_RESPONSE_EVENT | Event for Wi-Fi statistics response. Data would be NULL. |
| SL_WIFI_HTTP_OTA_FW_UPDATE_EVENT | Event for Wi-Fi OTA firmware update status via HTTP. Data would be NULL. |
| SL_WIFI_NETWORK_DOWN_EVENT | Event for Wi-Fi network down. This feature is not supported in current release. |
| SL_WIFI_NETWORK_UP_EVENT | Event for Wi-Fi network up. This feature is not supported in current release. |
| SL_WIFI_CLIENT_CONNECTED_EVENT | Event for Wi-Fi client connected status in Access Point Mode. Data would be of type sl_mac_address_t. |
| SL_WIFI_TWT_RESPONSE_EVENT | Event for Wi-Fi TWT response in WiFi Client mode. Data would be NULL. |
| SL_WIFI_CLIENT_DISCONNECTED_EVENT | Event for Wi-Fi client disconnection status in Access Point Mode. Data would of type sl_mac_address_t. |
| SL_WIFI_TRANSCEIVER_EVENT | Event for Wi-Fi transceiver TX/RX events in WiFi Client mode. |
| SL_WIFI_TWT_UNSOLICITED_SESSION_SUCCESS_EVENT | Event for TWT unsolicited session success. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_AP_REJECTED_EVENT | Event for TWT AP rejection. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_OUT_OF_TOLERANCE_EVENT | Event for TWT out of tolerance. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_RESPONSE_NOT_MATCHED_EVENT | Event for TWT response not matched. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_UNSUPPORTED_RESPONSE_EVENT | Event for TWT unsupported response. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_TEARDOWN_SUCCESS_EVENT | Event for TWT teardown success. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_AP_TEARDOWN_SUCCESS_EVENT | Event for TWT AP teardown success. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_FAIL_MAX_RETRIES_REACHED_EVENT | Event for TWT maximum retries reached. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_INACTIVE_DUE_TO_ROAMING_EVENT | Event for TWT inactive due to roaming. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_INACTIVE_DUE_TO_DISCONNECT_EVENT | Event for TWT inactive due to disconnect. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_INACTIVE_NO_AP_SUPPORT_EVENT | Event for TWT inactive due to no AP support. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_RESCHEDULE_TWT_SUCCESS_EVENT | Event for TWT suspend resume success. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_INFO_FRAME_EXCHANGE_FAILED_EVENT | Event for TWT info frame exchange failure. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_TWT_EVENTS_END | Event for TWT event end. Data would be of type sl_wifi_twt_response_t. |
| SL_WIFI_STATS_EVENT | Event for Wi-Fi statistics. This feature is not supported in current release. |
| SL_WIFI_STATS_ASYNC_EVENT | Event for Wi-Fi asynchronous statistics. Data would be of type sl_wifi_async_stats_response_t |
| SL_WIFI_STATS_ADVANCE_EVENT | Event for Wi-Fi advance statistics. Data would be of type sl_wifi_advanced_stats_response_t |
| SL_WIFI_STATS_TEST_MODE_EVENT | Event for Wi-Fi test mode statistics. This feature is not supported in current release. |
| SL_WIFI_STATS_MODULE_STATE_EVENT | Event for Wi-Fi module state statistics. Data would be of type sl_wifi_module_state_stats_response_t |
| SL_WIFI_TRANSCEIVER_RX_DATA_RECEIVE_CB | |
| SL_WIFI_TRANSCEIVER_TX_DATA_STATUS_CB | |
| SL_WIFI_EVENT_FAIL_INDICATION | Event for Wi-Fi event failure indication. |
| SL_WIFI_INVALID_EVENT | Invalid Wi-Fi event. Data would be NULL. |
sl_wifi_reschedule_twt_action_t#
sl_wifi_reschedule_twt_action_t
Enumeration defining actions related to Target Wake Time (TWT).
| Enumerator | |
|---|---|
| SL_WIFI_SUSPEND_INDEFINITELY | Suspend TWT indefinitely, effectively disabling TWT functionality until explicitly resumed. |
| SL_WIFI_SUSPEND_FOR_DURATION | Suspend TWT for a specified duration, after which it can automatically resume. |
| SL_WIFI_RESUME_IMMEDIATELY | Resume TWT immediately, allowing devices to continue adhering to TWT schedules. |
sl_wifi_data_rate_t#
sl_wifi_data_rate_t
Enumeration of Wi-Fi data rates.
| Enumerator | |
|---|---|
| SL_WIFI_DATA_RATE_1 | Wi-Fi 1 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_2 | Wi-Fi 2 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_5_5 | Wi-Fi 5.5 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_11 | Wi-Fi 11 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_6 | Wi-Fi 6 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_9 | Wi-Fi 9 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_12 | Wi-Fi 12 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_18 | Wi-Fi 18 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_24 | Wi-Fi 24 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_36 | Wi-Fi 36 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_48 | Wif-Fi 48 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_54 | Wi-Fi 54 Mbps transfer rate. |
| SL_WIFI_DATA_RATE_MCS0 | Wi-Fi MCS index 0 transfer rate. |
| SL_WIFI_DATA_RATE_MCS1 | Wi-Fi MCS index 1 transfer rate. |
| SL_WIFI_DATA_RATE_MCS2 | Wi-Fi MCS index 2 transfer rate. |
| SL_WIFI_DATA_RATE_MCS3 | Wi-Fi MCS index 3 transfer rate. |
| SL_WIFI_DATA_RATE_MCS4 | Wi-Fi MCS index 4 transfer rate. |
| SL_WIFI_DATA_RATE_MCS5 | Wi-Fi MCS index 5 transfer rate. |
| SL_WIFI_DATA_RATE_MCS6 | Wi-Fi MCS index 6 transfer rate. |
| SL_WIFI_DATA_RATE_MCS7 | Wi-Fi MCS index 7 transfer rate. |
| SL_WIFI_DATA_RATE_MCS7_SG | |
sl_wifi_tx_test_mode_t#
sl_wifi_tx_test_mode_t
Enumeration of Wi-Fi TX test modes.
| Enumerator | |
|---|---|
| SL_WIFI_TEST_BURST_MODE | Burst Mode. |
| SL_WIFI_TEST_CONTINOUS_MODE | Continuous Mode. |
| SL_WIFI_TEST_CONTINOUS_WAVE_MODE | CW Mode. |
| SL_WIFI_TEST_CONTINOUS_WAVE_MODE_OFF_CENTER_LOW | CW Mode center frequency - 2.5 MHZ Mode. |
| SL_WIFI_TEST_CONTINOUS_WAVE_MODE_OFF_CENTER_HIGH | CW Mode center frequency + 5 MHZ Mode. |
sl_wifi_high_throughput_capability_types_t#
sl_wifi_high_throughput_capability_types_t
Enumeration of High Throughput (HT) capabilities.
| Enumerator | |
|---|---|
| SL_WIFI_HT_CAPS_NUM_RX_STBC | Number of RX Space-Time Block Coding (STBC) streams supported. |
| SL_WIFI_HT_CAPS_SHORT_GI_20MHZ | Support for Short Guard Interval (GI) in 20 MHz channels. |
| SL_WIFI_HT_CAPS_GREENFIELD_EN | Support for Greenfield mode, which improves efficiency by eliminating legacy preambles. |
| SL_WIFI_HT_CAPS_SUPPORT_CH_WIDTH | Support for wider channel bandwidths. |
sl_wifi_multicast_filter_command_t#
sl_wifi_multicast_filter_command_t
Enumeration of multicast filter command types.
| Enumerator | |
|---|---|
| SL_WIFI_MULTICAST_MAC_ADD_BIT | To set particular bit in multicast bitmap. |
| SL_WIFI_MULTICAST_MAC_CLEAR_BIT | To reset particular bit in multicast bitmap. |
| SL_WIFI_MULTICAST_MAC_CLEAR_ALL | To clear all the bits in multicast bitmap. |
| SL_WIFI_MULTICAST_MAC_SET_ALL | To set all the bits in multicast bitmap. |
sl_wifi_eap_client_flag_t#
sl_wifi_eap_client_flag_t
Option flags for EAP (Extensible Authentication Protocol) client interfaces.
| Enumerator | |
|---|---|
| SL_WIFI_EAP_ENABLE_OKC | Wi-Fi EAP Client flag to enable Opportunistic Key Caching (OKC) |
| SL_WIFI_EAP_ENABLE_PEAP_CA | Wi-Fi EAP Client flag to enable CA certificate requirement for PEAP connection. |
| SL_WIFI_EAP_DHE_RSA_AES256_SHA256 | Wi-Fi EAP Client flag to use DHE-RSA-AES256-SHA256 Cipher for EAP connection. |
| SL_WIFI_EAP_DHE_RSA_AES128_SHA256 | Wi-Fi EAP Client flag to use DHE-RSA-AES128-SHA256 Cipher for EAP connection. |
| SL_WIFI_EAP_DHE_RSA_AES256_SHA | Wi-Fi EAP Client flag to use DHE-RSA-AES256-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_DHE_RSA_AES128_SHA | Wi-Fi EAP Client flag to use DHE-RSA-AES128-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_AES256_SHA256 | Wi-Fi EAP Client flag to use AES256-SHA256 Cipher for EAP connection. |
| SL_WIFI_EAP_AES128_SHA256 | Wi-Fi EAP Client flag to use AES128-SHA256 Cipher for EAP connection. |
| SL_WIFI_EAP_AES256_SHA | Wi-Fi EAP Client flag to use AES256-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_AES128_SHA | Wi-Fi EAP Client flag to use AES128-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_RC4_SHA | Wi-Fi EAP Client flag to use RC4-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_DES_CBC3_SHA | Wi-Fi EAP Client flag to use DES-CBC3-SHA Cipher for EAP connection. |
| SL_WIFI_EAP_RC4_MD5 | Wi-Fi EAP Client flag to use RC4-MD5 Cipher for EAP connection. |
sl_wifi_band_mode_t#
sl_wifi_band_mode_t
Band mode.
Note
Only 2.4 GHz is currently supported.
| Enumerator | |
|---|---|
| SL_WIFI_BAND_MODE_2_4GHZ | 2.4 GHz Wi-Fi band |
| SL_WIFI_BAND_MODE_5GHZ | 5 GHz Wi-Fi band (not currently supported) |
| SL_WIFI_DUAL_BAND_MODE | Both 2.4 GHz and 5 GHZ WiFi band (not currently supported) |
sl_wifi_region_code_t#
sl_wifi_region_code_t
Guidance for Region code Mapping for Different Countries | Country | Country Code | Max power (Based on Regulatory domain) | Frequency Range (Based on Regulatory Domain) | Suggested Region Code Mapping | |:-------------—|:-----------—|:---------------------------------------—|:------------------------------------------—|:---------------------------—| | Korea | KR | 23 dBm | 2400 - 2483.5 | SL_WIFI_REGION_KR | | | Hong Kong | HK | 36 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Singapore | SG | 200 mW (23 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Malaysia | MY | 500 mW (27 dBm) | 2402 - 2482 | SL_WIFI_REGION_EU | | | Australia | AU | 4000 mW (36 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Taiwan | TW | 30 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | Thailand | TH | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Mexico | MX | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Vietnam | VN | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU | | | Indonesia | ID | 500mW (27 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU | | | China | CN | 20 dBm | 2400 - 2483.5 | SL_WIFI_REGION_CN |.
| Enumerator | |
|---|---|
| SL_WIFI_DEFAULT_REGION | Factory default region. |
| SL_WIFI_REGION_US | United States. |
| SL_WIFI_REGION_EU | European Union. |
| SL_WIFI_REGION_JP | Japan. |
| SL_WIFI_REGION_WORLD_DOMAIN | Worldwide domain. |
| SL_WIFI_REGION_KR | Korea. |
| SL_WIFI_REGION_SG | Singapore (not currently supported) |
| SL_WIFI_REGION_CN | China. |
| SL_WIFI_IGNORE_REGION | Do not update region code during initialization. |
sl_wifi_vap_id_t#
sl_wifi_vap_id_t
Wi-Fi VAP ID.
| Enumerator | |
|---|---|
| SL_WIFI_CLIENT_VAP_ID | Wi-Fi Client VAP ID. |
| SL_WIFI_AP_VAP_ID | Wi-Fi Access point VAP ID. |
| SL_WIFI_CLIENT_VAP_ID_1 | Wi-Fi Client 1 VAP ID. |
| SL_WIFI_AP_VAP_ID_1 | Wi-Fi Access point 1 VAP ID. |
sl_wifi_ap_keepalive_type_t#
sl_wifi_ap_keepalive_type_t
Keepalive types.
| Enumerator | |
|---|---|
| SL_WIFI_AP_KEEP_ALIVE_DISABLE | Disable keepalive functionality. |
| SL_WIFI_AP_DEAUTH_BASED_KEEP_ALIVE | AP performs keepalive functionality based on the RX packets received from its stations. |
| SL_WIFI_AP_NULL_BASED_KEEP_ALIVE | AP performs keepalive functionality by sending a NULL DATA packet to the station. |