|
idfxx 1.0.0
Modern C++23 components for ESP-IDF
|
WiFi type definitions and free function API. More...
#include <idfxx/cpu>#include <idfxx/error>#include <idfxx/event>#include <idfxx/flags>#include <idfxx/mac>#include <idfxx/netif>#include <array>#include <cstdint>#include <optional>#include <soc/soc_caps.h>#include <span>#include <string>#include <string_view>#include <vector>#include "sdkconfig.h"Go to the source code of this file.
Classes | |
| class | idfxx::wifi::error_category |
| Error category for WiFi errors. More... | |
| struct | idfxx::wifi::he_ap_info |
| HE (High Efficiency) AP information. More... | |
| struct | idfxx::wifi::country_config |
| WiFi country configuration. More... | |
| struct | idfxx::wifi::ap_record |
| Information about a discovered access point. More... | |
| struct | idfxx::wifi::sta_info |
| Information about a station connected to the soft-AP. More... | |
| struct | idfxx::wifi::ftm_report_entry |
| Single FTM report measurement entry. More... | |
| struct | idfxx::wifi::init_config |
| Configuration for WiFi initialization. More... | |
| struct | idfxx::wifi::pmf_config |
| Protected Management Frame (PMF) configuration. More... | |
| struct | idfxx::wifi::sta_config |
| Configuration for WiFi station mode. More... | |
| struct | idfxx::wifi::ap_config |
| Configuration for WiFi access point mode. More... | |
| struct | idfxx::wifi::scan_config |
| Configuration for a WiFi scan operation. More... | |
| struct | idfxx::wifi::scan_default_params |
| Default scan timing parameters. More... | |
| struct | idfxx::wifi::protocols_config |
| Protocol configuration for dual-band operation. More... | |
| struct | idfxx::wifi::bandwidths_config |
| Bandwidth configuration for dual-band operation. More... | |
| struct | idfxx::wifi::channel_info |
| WiFi channel information. More... | |
| struct | idfxx::wifi::ftm_initiator_config |
| FTM initiator session configuration. More... | |
| struct | idfxx::wifi::csi_config |
| CSI (Channel State Information) configuration. More... | |
| struct | idfxx::wifi::connected_event_data |
| Information about a successful station connection. More... | |
| struct | idfxx::wifi::disconnected_event_data |
| Information about a station disconnection. More... | |
| struct | idfxx::wifi::scan_done_event_data |
| Information about a completed scan. More... | |
| struct | idfxx::wifi::authmode_change_event_data |
| Information about an authentication mode change. More... | |
| struct | idfxx::wifi::ap_sta_connected_event_data |
| Information about a station connecting to the soft-AP. More... | |
| struct | idfxx::wifi::ap_sta_disconnected_event_data |
| Information about a station disconnecting from the soft-AP. More... | |
| struct | idfxx::wifi::ap_probe_req_event_data |
| Information about a probe request received by the soft-AP. More... | |
| struct | idfxx::wifi::bss_rssi_low_event_data |
| Information about BSS RSSI dropping below threshold. More... | |
| struct | idfxx::wifi::home_channel_change_event_data |
| Information about a home channel change. More... | |
| struct | idfxx::wifi::ftm_report_event_data |
| Information about an FTM report. More... | |
Namespaces | |
| namespace | idfxx |
| namespace | idfxx::wifi |
Functions | |
| void | idfxx::wifi::init (const init_config &cfg={}) |
| Initializes the WiFi subsystem. | |
| void | idfxx::wifi::deinit () |
| Deinitializes the WiFi subsystem and frees resources. | |
| void | idfxx::wifi::start () |
| Starts the WiFi subsystem. | |
| void | idfxx::wifi::stop () |
| Stops the WiFi subsystem. | |
| void | idfxx::wifi::restore () |
| Restores WiFi stack persistent settings to defaults. | |
| result< void > | idfxx::wifi::try_init (const init_config &cfg={}) |
| Initializes the WiFi subsystem. | |
| result< void > | idfxx::wifi::try_deinit () |
| Deinitializes the WiFi subsystem and frees resources. | |
| result< void > | idfxx::wifi::try_start () |
| Starts the WiFi subsystem. | |
| result< void > | idfxx::wifi::try_stop () |
| Stops the WiFi subsystem. | |
| result< void > | idfxx::wifi::try_restore () |
| Restores WiFi stack persistent settings to defaults. | |
| void | idfxx::wifi::set_roles (flags< role > roles) |
| Sets the active WiFi roles. | |
| flags< role > | idfxx::wifi::get_roles () |
| Gets the currently active WiFi roles. | |
| result< void > | idfxx::wifi::try_set_roles (flags< role > roles) |
| Sets the active WiFi roles. | |
| result< flags< role > > | idfxx::wifi::try_get_roles () |
| Gets the currently active WiFi roles. | |
| void | idfxx::wifi::set_sta_config (const sta_config &cfg) |
| Sets the WiFi station configuration. | |
| sta_config | idfxx::wifi::get_sta_config () |
| Gets the current WiFi station configuration. | |
| result< void > | idfxx::wifi::try_set_sta_config (const sta_config &cfg) |
| Sets the WiFi station configuration. | |
| result< sta_config > | idfxx::wifi::try_get_sta_config () |
| Gets the current WiFi station configuration. | |
| void | idfxx::wifi::set_ap_config (const ap_config &cfg) |
| Sets the WiFi access point configuration. | |
| ap_config | idfxx::wifi::get_ap_config () |
| Gets the current WiFi access point configuration. | |
| void | idfxx::wifi::deauth_sta (uint16_t aid) |
| Deauthenticates a station from the soft-AP. | |
| std::vector< sta_info > | idfxx::wifi::get_sta_list () |
| Gets the list of stations connected to the soft-AP. | |
| uint16_t | idfxx::wifi::ap_get_sta_aid (mac_address mac) |
| Gets the association ID for a station connected to the soft-AP. | |
| result< void > | idfxx::wifi::try_set_ap_config (const ap_config &cfg) |
| Sets the WiFi access point configuration. | |
| result< ap_config > | idfxx::wifi::try_get_ap_config () |
| Gets the current WiFi access point configuration. | |
| result< void > | idfxx::wifi::try_deauth_sta (uint16_t aid) |
| Deauthenticates a station from the soft-AP. | |
| result< std::vector< sta_info > > | idfxx::wifi::try_get_sta_list () |
| Gets the list of stations connected to the soft-AP. | |
| result< uint16_t > | idfxx::wifi::try_ap_get_sta_aid (mac_address mac) |
| Gets the association ID for a station connected to the soft-AP. | |
| void | idfxx::wifi::connect () |
| Connects to the configured access point. | |
| void | idfxx::wifi::disconnect () |
| Disconnects from the current access point. | |
| void | idfxx::wifi::clear_fast_connect () |
| Clears the fast-connect data stored in memory. | |
| uint16_t | idfxx::wifi::sta_get_aid () |
| Gets the association ID assigned by the AP in station mode. | |
| enum phy_mode | idfxx::wifi::get_negotiated_phymode () |
| Gets the PHY mode negotiated with the connected AP. | |
| result< void > | idfxx::wifi::try_connect () |
| Connects to the configured access point. | |
| result< void > | idfxx::wifi::try_disconnect () |
| Disconnects from the current access point. | |
| result< void > | idfxx::wifi::try_clear_fast_connect () |
| Clears the fast-connect data stored in memory. | |
| result< uint16_t > | idfxx::wifi::try_sta_get_aid () |
| Gets the association ID assigned by the AP in station mode. | |
| result< enum phy_mode > | idfxx::wifi::try_get_negotiated_phymode () |
| Gets the PHY mode negotiated with the connected AP. | |
| std::vector< ap_record > | idfxx::wifi::scan (const scan_config &cfg={}) |
| Performs a blocking scan for access points. | |
| void | idfxx::wifi::scan_start (const scan_config &cfg={}) |
| Starts a non-blocking scan for access points. | |
| std::vector< ap_record > | idfxx::wifi::scan_get_results () |
| Retrieves results from a completed scan. | |
| void | idfxx::wifi::scan_stop () |
| Stops an in-progress scan. | |
| uint16_t | idfxx::wifi::scan_get_ap_num () |
| Gets the number of APs found in the last scan. | |
| void | idfxx::wifi::clear_ap_list () |
| Clears the AP list stored from a previous scan. | |
| void | idfxx::wifi::set_scan_parameters (const scan_default_params ¶ms) |
| Sets the default scan timing parameters. | |
| scan_default_params | idfxx::wifi::get_scan_parameters () |
| Gets the current default scan timing parameters. | |
| result< std::vector< ap_record > > | idfxx::wifi::try_scan (const scan_config &cfg={}) |
| Performs a blocking scan for access points. | |
| result< void > | idfxx::wifi::try_scan_start (const scan_config &cfg={}) |
| Starts a non-blocking scan for access points. | |
| result< std::vector< ap_record > > | idfxx::wifi::try_scan_get_results () |
| Retrieves results from a completed scan. | |
| result< void > | idfxx::wifi::try_scan_stop () |
| Stops an in-progress scan. | |
| result< uint16_t > | idfxx::wifi::try_scan_get_ap_num () |
| Gets the number of APs found in the last scan. | |
| result< void > | idfxx::wifi::try_clear_ap_list () |
| Clears the AP list stored from a previous scan. | |
| result< void > | idfxx::wifi::try_set_scan_parameters (const scan_default_params ¶ms) |
| Sets the default scan timing parameters. | |
| result< scan_default_params > | idfxx::wifi::try_get_scan_parameters () |
| Gets the current default scan timing parameters. | |
| void | idfxx::wifi::set_power_save (enum power_save ps) |
| Sets the power save mode. | |
| enum power_save | idfxx::wifi::get_power_save () |
| Gets the current power save mode. | |
| result< void > | idfxx::wifi::try_set_power_save (enum power_save ps) |
| Sets the power save mode. | |
| result< enum power_save > | idfxx::wifi::try_get_power_save () |
| Gets the current power save mode. | |
| void | idfxx::wifi::set_bandwidth (enum role iface, enum bandwidth bw) |
| Sets the channel bandwidth for the specified interface. | |
| enum bandwidth | idfxx::wifi::get_bandwidth (enum role iface) |
| Gets the current channel bandwidth for the specified interface. | |
| void | idfxx::wifi::set_bandwidths (enum role iface, const bandwidths_config &bw) |
| Sets bandwidths for dual-band operation on the specified interface. | |
| bandwidths_config | idfxx::wifi::get_bandwidths (enum role iface) |
| Gets bandwidths for dual-band operation on the specified interface. | |
| result< void > | idfxx::wifi::try_set_bandwidth (enum role iface, enum bandwidth bw) |
| Sets the channel bandwidth for the specified interface. | |
| result< enum bandwidth > | idfxx::wifi::try_get_bandwidth (enum role iface) |
| Gets the current channel bandwidth for the specified interface. | |
| result< void > | idfxx::wifi::try_set_bandwidths (enum role iface, const bandwidths_config &bw) |
| Sets bandwidths for dual-band operation on the specified interface. | |
| result< bandwidths_config > | idfxx::wifi::try_get_bandwidths (enum role iface) |
| Gets bandwidths for dual-band operation on the specified interface. | |
| void | idfxx::wifi::set_mac (enum role iface, mac_address mac) |
| Sets the MAC address for the specified interface. | |
| mac_address | idfxx::wifi::get_mac (enum role iface) |
| Gets the MAC address for the specified interface. | |
| result< void > | idfxx::wifi::try_set_mac (enum role iface, mac_address mac) |
| Sets the MAC address for the specified interface. | |
| result< mac_address > | idfxx::wifi::try_get_mac (enum role iface) |
| Gets the MAC address for the specified interface. | |
| ap_record | idfxx::wifi::get_ap_info () |
| Gets information about the currently connected access point. | |
| result< ap_record > | idfxx::wifi::try_get_ap_info () |
| Gets information about the currently connected access point. | |
| void | idfxx::wifi::set_channel (uint8_t primary, std::optional< enum second_channel > second=std::nullopt) |
| Sets the primary and secondary channel. | |
| channel_info | idfxx::wifi::get_channel () |
| Gets the current primary and secondary channel. | |
| result< void > | idfxx::wifi::try_set_channel (uint8_t primary, std::optional< enum second_channel > second=std::nullopt) |
| Sets the primary and secondary channel. | |
| result< channel_info > | idfxx::wifi::try_get_channel () |
| Gets the current primary and secondary channel. | |
| void | idfxx::wifi::set_country (const country_config &cfg) |
| Sets the WiFi country configuration. | |
| country_config | idfxx::wifi::get_country () |
| Gets the current WiFi country configuration. | |
| void | idfxx::wifi::set_country_code (std::string_view cc, bool ieee80211d_enabled) |
| Sets the country code. | |
| std::string | idfxx::wifi::get_country_code () |
| Gets the current country code. | |
| result< void > | idfxx::wifi::try_set_country (const country_config &cfg) |
| Sets the WiFi country configuration. | |
| result< country_config > | idfxx::wifi::try_get_country () |
| Gets the current WiFi country configuration. | |
| result< void > | idfxx::wifi::try_set_country_code (std::string_view cc, bool ieee80211d_enabled) |
| Sets the country code. | |
| result< std::string > | idfxx::wifi::try_get_country_code () |
| Gets the current country code. | |
| void | idfxx::wifi::set_max_tx_power (int8_t power) |
| Sets the maximum transmit power. | |
| int8_t | idfxx::wifi::get_max_tx_power () |
| Gets the current maximum transmit power. | |
| result< void > | idfxx::wifi::try_set_max_tx_power (int8_t power) |
| Sets the maximum transmit power. | |
| result< int8_t > | idfxx::wifi::try_get_max_tx_power () |
| Gets the current maximum transmit power. | |
| void | idfxx::wifi::set_rssi_threshold (int32_t rssi) |
| Sets the RSSI threshold for the sta_bss_rssi_low event. | |
| int | idfxx::wifi::get_rssi () |
| Gets the current RSSI of the connected AP. | |
| result< void > | idfxx::wifi::try_set_rssi_threshold (int32_t rssi) |
| Sets the RSSI threshold for the sta_bss_rssi_low event. | |
| result< int > | idfxx::wifi::try_get_rssi () |
| Gets the current RSSI of the connected AP. | |
| void | idfxx::wifi::set_protocol (enum role iface, flags< protocol > protos) |
| Sets the enabled WiFi protocols for the specified interface. | |
| flags< protocol > | idfxx::wifi::get_protocol (enum role iface) |
| Gets the enabled WiFi protocols for the specified interface. | |
| void | idfxx::wifi::set_protocols (enum role iface, const protocols_config &cfg) |
| Sets the enabled WiFi protocols for dual-band operation. | |
| protocols_config | idfxx::wifi::get_protocols (enum role iface) |
| Gets the enabled WiFi protocols for dual-band operation. | |
| result< void > | idfxx::wifi::try_set_protocol (enum role iface, flags< protocol > protos) |
| Sets the enabled WiFi protocols for the specified interface. | |
| result< flags< protocol > > | idfxx::wifi::try_get_protocol (enum role iface) |
| Gets the enabled WiFi protocols for the specified interface. | |
| result< void > | idfxx::wifi::try_set_protocols (enum role iface, const protocols_config &cfg) |
| Sets the enabled WiFi protocols for dual-band operation. | |
| result< protocols_config > | idfxx::wifi::try_get_protocols (enum role iface) |
| Gets the enabled WiFi protocols for dual-band operation. | |
| void | idfxx::wifi::set_band (enum band b) |
| Sets the WiFi band. | |
| enum band | idfxx::wifi::get_band () |
| Gets the current WiFi band. | |
| void | idfxx::wifi::set_band_mode (enum band_mode m) |
| Sets the WiFi band mode. | |
| enum band_mode | idfxx::wifi::get_band_mode () |
| Gets the current WiFi band mode. | |
| result< void > | idfxx::wifi::try_set_band (enum band b) |
| Sets the WiFi band. | |
| result< enum band > | idfxx::wifi::try_get_band () |
| Gets the current WiFi band. | |
| result< void > | idfxx::wifi::try_set_band_mode (enum band_mode m) |
| Sets the WiFi band mode. | |
| result< enum band_mode > | idfxx::wifi::try_get_band_mode () |
| Gets the current WiFi band mode. | |
| void | idfxx::wifi::set_storage (enum storage s) |
| Sets the WiFi configuration storage location. | |
| result< void > | idfxx::wifi::try_set_storage (enum storage s) |
| Sets the WiFi configuration storage location. | |
| void | idfxx::wifi::set_inactive_time (enum role iface, uint16_t sec) |
| Sets the inactive time before a station is deauthenticated. | |
| uint16_t | idfxx::wifi::get_inactive_time (enum role iface) |
| Gets the inactive time before a station is deauthenticated. | |
| result< void > | idfxx::wifi::try_set_inactive_time (enum role iface, uint16_t sec) |
| Sets the inactive time before a station is deauthenticated. | |
| result< uint16_t > | idfxx::wifi::try_get_inactive_time (enum role iface) |
| Gets the inactive time before a station is deauthenticated. | |
| void | idfxx::wifi::set_event_mask (flags< event_mask > mask) |
| Sets the WiFi event mask. | |
| flags< event_mask > | idfxx::wifi::get_event_mask () |
| Gets the current WiFi event mask. | |
| result< void > | idfxx::wifi::try_set_event_mask (flags< event_mask > mask) |
| Sets the WiFi event mask. | |
| result< flags< event_mask > > | idfxx::wifi::try_get_event_mask () |
| Gets the current WiFi event mask. | |
| void | idfxx::wifi::force_wakeup_acquire () |
| Acquires a WiFi wakeup lock. | |
| void | idfxx::wifi::force_wakeup_release () |
| Releases a WiFi wakeup lock. | |
| result< void > | idfxx::wifi::try_force_wakeup_acquire () |
| Acquires a WiFi wakeup lock. | |
| result< void > | idfxx::wifi::try_force_wakeup_release () |
| Releases a WiFi wakeup lock. | |
| void | idfxx::wifi::set_promiscuous (bool en) |
| Enables or disables promiscuous mode. | |
| bool | idfxx::wifi::get_promiscuous () |
| Gets whether promiscuous mode is enabled. | |
| void | idfxx::wifi::set_promiscuous_rx_cb (void(*cb)(void *, int)) |
| Sets the promiscuous mode receive callback. | |
| void | idfxx::wifi::set_promiscuous_filter (flags< promiscuous_filter > filter) |
| Sets the promiscuous mode packet type filter. | |
| flags< promiscuous_filter > | idfxx::wifi::get_promiscuous_filter () |
| Gets the current promiscuous mode packet type filter. | |
| void | idfxx::wifi::set_promiscuous_ctrl_filter (flags< promiscuous_ctrl_filter > filter) |
| Sets the promiscuous mode control frame sub-type filter. | |
| flags< promiscuous_ctrl_filter > | idfxx::wifi::get_promiscuous_ctrl_filter () |
| Gets the current promiscuous mode control frame sub-type filter. | |
| result< void > | idfxx::wifi::try_set_promiscuous (bool en) |
| Enables or disables promiscuous mode. | |
| result< bool > | idfxx::wifi::try_get_promiscuous () |
| Gets whether promiscuous mode is enabled. | |
| result< void > | idfxx::wifi::try_set_promiscuous_rx_cb (void(*cb)(void *, int)) |
| Sets the promiscuous mode receive callback. | |
| result< void > | idfxx::wifi::try_set_promiscuous_filter (flags< promiscuous_filter > filter) |
| Sets the promiscuous mode packet type filter. | |
| result< flags< promiscuous_filter > > | idfxx::wifi::try_get_promiscuous_filter () |
| Gets the current promiscuous mode packet type filter. | |
| result< void > | idfxx::wifi::try_set_promiscuous_ctrl_filter (flags< promiscuous_ctrl_filter > filter) |
| Sets the promiscuous mode control frame sub-type filter. | |
| result< flags< promiscuous_ctrl_filter > > | idfxx::wifi::try_get_promiscuous_ctrl_filter () |
| Gets the current promiscuous mode control frame sub-type filter. | |
| void | idfxx::wifi::tx_80211 (enum role iface, std::span< const uint8_t > buffer, bool en_sys_seq) |
| Transmits a raw 802.11 frame. | |
| void | idfxx::wifi::register_80211_tx_cb (void(*cb)(const void *)) |
| Registers a callback for 802.11 TX completion. | |
| result< void > | idfxx::wifi::try_tx_80211 (enum role iface, std::span< const uint8_t > buffer, bool en_sys_seq) |
| Transmits a raw 802.11 frame. | |
| result< void > | idfxx::wifi::try_register_80211_tx_cb (void(*cb)(const void *)) |
| Registers a callback for 802.11 TX completion. | |
| void | idfxx::wifi::set_vendor_ie (bool enable, enum vendor_ie_type type, enum vendor_ie_id id, const void *vnd_ie) |
| Sets a vendor-specific information element. | |
| void | idfxx::wifi::set_vendor_ie_cb (void(*cb)(void *, int, const uint8_t *, const void *, int), void *ctx) |
| Registers a callback for received vendor-specific IEs. | |
| result< void > | idfxx::wifi::try_set_vendor_ie (bool enable, enum vendor_ie_type type, enum vendor_ie_id id, const void *vnd_ie) |
| Sets a vendor-specific information element. | |
| result< void > | idfxx::wifi::try_set_vendor_ie_cb (void(*cb)(void *, int, const uint8_t *, const void *, int), void *ctx) |
| Registers a callback for received vendor-specific IEs. | |
| void | idfxx::wifi::set_csi (bool en) |
| Enables or disables CSI (Channel State Information) collection. | |
| void | idfxx::wifi::set_csi_config (const csi_config &cfg) |
| Sets the CSI configuration. | |
| csi_config | idfxx::wifi::get_csi_config () |
| Gets the current CSI configuration. | |
| void | idfxx::wifi::set_csi_rx_cb (void(*cb)(void *, void *), void *ctx) |
| Registers a callback for CSI data reception. | |
| result< void > | idfxx::wifi::try_set_csi (bool en) |
| Enables or disables CSI (Channel State Information) collection. | |
| result< void > | idfxx::wifi::try_set_csi_config (const csi_config &cfg) |
| Sets the CSI configuration. | |
| result< csi_config > | idfxx::wifi::try_get_csi_config () |
| Gets the current CSI configuration. | |
| result< void > | idfxx::wifi::try_set_csi_rx_cb (void(*cb)(void *, void *), void *ctx) |
| Registers a callback for CSI data reception. | |
| void | idfxx::wifi::ftm_initiate_session (const ftm_initiator_config &cfg) |
| Initiates an FTM (Fine Timing Measurement) session. | |
| void | idfxx::wifi::ftm_end_session () |
| Ends the current FTM session. | |
| void | idfxx::wifi::ftm_resp_set_offset (int16_t offset) |
| Sets the FTM responder offset. | |
| std::vector< ftm_report_entry > | idfxx::wifi::ftm_get_report (size_t max_entries) |
| Retrieves the FTM measurement report entries. | |
| result< void > | idfxx::wifi::try_ftm_initiate_session (const ftm_initiator_config &cfg) |
| Initiates an FTM (Fine Timing Measurement) session. | |
| result< void > | idfxx::wifi::try_ftm_end_session () |
| Ends the current FTM session. | |
| result< void > | idfxx::wifi::try_ftm_resp_set_offset (int16_t offset) |
| Sets the FTM responder offset. | |
| result< std::vector< ftm_report_entry > > | idfxx::wifi::try_ftm_get_report (size_t max_entries) |
| Retrieves the FTM measurement report entries. | |
| int64_t | idfxx::wifi::get_tsf_time (enum role iface) |
| Gets the TSF (Timing Synchronization Function) time for the specified interface. | |
| void | idfxx::wifi::statis_dump (flags< statis_module > modules) |
| Dumps WiFi statistics for the specified modules. | |
| void | idfxx::wifi::config_11b_rate (enum role iface, bool disable) |
| Enables or disables 802.11b rate for the specified interface. | |
| void | idfxx::wifi::config_80211_tx_rate (enum role iface, enum phy_rate rate) |
| Sets the 802.11 TX rate for the specified interface. | |
| void | idfxx::wifi::disable_pmf_config (enum role iface) |
| Disables PMF (Protected Management Frames) for the specified interface. | |
| void | idfxx::wifi::set_dynamic_cs (bool enabled) |
| Enables or disables dynamic CS (Carrier Sense). | |
| void | idfxx::wifi::connectionless_module_set_wake_interval (uint16_t interval) |
| Sets the connectionless module wake interval. | |
| result< void > | idfxx::wifi::try_statis_dump (flags< statis_module > modules) |
| Dumps WiFi statistics for the specified modules. | |
| result< void > | idfxx::wifi::try_config_11b_rate (enum role iface, bool disable) |
| Enables or disables 802.11b rate for the specified interface. | |
| result< void > | idfxx::wifi::try_config_80211_tx_rate (enum role iface, enum phy_rate rate) |
| Sets the 802.11 TX rate for the specified interface. | |
| result< void > | idfxx::wifi::try_disable_pmf_config (enum role iface) |
| Disables PMF (Protected Management Frames) for the specified interface. | |
| result< void > | idfxx::wifi::try_set_dynamic_cs (bool enabled) |
| Enables or disables dynamic CS (Carrier Sense). | |
| result< void > | idfxx::wifi::try_connectionless_module_set_wake_interval (uint16_t interval) |
| Sets the connectionless module wake interval. | |
| netif::interface | idfxx::wifi::create_default_sta_netif () |
| Creates a default WiFi station network interface. | |
| netif::interface | idfxx::wifi::create_default_ap_netif () |
| Creates a default WiFi access point network interface. | |
| result< netif::interface > | idfxx::wifi::try_create_default_sta_netif () |
| Creates a default WiFi station network interface. | |
| result< netif::interface > | idfxx::wifi::try_create_default_ap_netif () |
| Creates a default WiFi access point network interface. | |
| const wifi::error_category & | idfxx::wifi_category () noexcept |
| Returns a reference to the WiFi error category singleton. | |
| std::unexpected< std::error_code > | idfxx::wifi_error (esp_err_t e) |
| Creates an unexpected error from an ESP-IDF error code, mapping to WiFi error codes where possible. | |
| std::string | idfxx::to_string (flags< wifi::role > roles) |
| Returns a string representation of active WiFi roles. | |
| std::string | idfxx::to_string (wifi::auth_mode m) |
| Returns a string representation of a WiFi authentication mode. | |
| std::string | idfxx::to_string (wifi::cipher_type c) |
| Returns a string representation of a WiFi cipher type. | |
| std::string | idfxx::to_string (wifi::disconnect_reason r) |
| Returns a string representation of a WiFi disconnect reason. | |
| std::error_code | idfxx::wifi::make_error_code (errc e) noexcept |
| Creates an error code from an idfxx::wifi::errc value. | |
Variables | |
| const event_base< event_id > | idfxx::wifi::events |
| WiFi event base. | |
| constexpr idfxx::event< event_id, connected_event_data > | idfxx::wifi::sta_connected {event_id::sta_connected} |
| Station connected event with connection details. | |
| constexpr idfxx::event< event_id, disconnected_event_data > | idfxx::wifi::sta_disconnected {event_id::sta_disconnected} |
| Station disconnected event with disconnection details. | |
| constexpr idfxx::event< event_id, scan_done_event_data > | idfxx::wifi::scan_done {event_id::scan_done} |
| Scan completed event with scan results summary. | |
| constexpr idfxx::event< event_id, authmode_change_event_data > | idfxx::wifi::sta_authmode_change {event_id::sta_authmode_change} |
| Station authentication mode changed event. | |
| constexpr idfxx::event< event_id, ap_sta_connected_event_data > | idfxx::wifi::ap_sta_connected {event_id::ap_sta_connected} |
| Station connected to soft-AP event. | |
| constexpr idfxx::event< event_id, ap_sta_disconnected_event_data > | idfxx::wifi::ap_sta_disconnected |
| Station disconnected from soft-AP event. | |
| constexpr idfxx::event< event_id, ap_probe_req_event_data > | idfxx::wifi::ap_probe_req_received {event_id::ap_probe_req_received} |
| Probe request received by soft-AP event. | |
| constexpr idfxx::event< event_id, bss_rssi_low_event_data > | idfxx::wifi::sta_bss_rssi_low {event_id::sta_bss_rssi_low} |
| BSS RSSI dropped below threshold event. | |
| constexpr idfxx::event< event_id, home_channel_change_event_data > | idfxx::wifi::home_channel_change |
| Home channel changed event. | |
| constexpr idfxx::event< event_id, ftm_report_event_data > | idfxx::wifi::ftm_report {event_id::ftm_report} |
| FTM report received event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ready {event_id::ready} |
| WiFi ready event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_start {event_id::sta_start} |
| Station started event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_stop {event_id::sta_stop} |
| Station stopped event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_start {event_id::ap_start} |
| Soft-AP started event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_stop {event_id::ap_stop} |
| Soft-AP stopped event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_beacon_timeout {event_id::sta_beacon_timeout} |
| Station beacon timeout event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_wps_er_success {event_id::sta_wps_er_success} |
| WPS enrollee success event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_wps_er_failed {event_id::sta_wps_er_failed} |
| WPS enrollee failed event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_wps_er_timeout {event_id::sta_wps_er_timeout} |
| WPS enrollee timeout event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_wps_er_pin {event_id::sta_wps_er_pin} |
| WPS enrollee PIN received event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_wps_er_pbc_overlap {event_id::sta_wps_er_pbc_overlap} |
| WPS PBC overlap detected event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::action_tx_status {event_id::action_tx_status} |
| Action frame TX status event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::roc_done {event_id::roc_done} |
| Remain-on-channel done event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::connectionless_module_wake_interval_start |
| Connectionless module wake interval start event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wps_rg_success {event_id::ap_wps_rg_success} |
| AP WPS registrar success event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wps_rg_failed {event_id::ap_wps_rg_failed} |
| AP WPS registrar failed event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wps_rg_timeout {event_id::ap_wps_rg_timeout} |
| AP WPS registrar timeout event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wps_rg_pin {event_id::ap_wps_rg_pin} |
| AP WPS registrar PIN received event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wps_rg_pbc_overlap {event_id::ap_wps_rg_pbc_overlap} |
| AP WPS PBC overlap detected event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::itwt_setup {event_id::itwt_setup} |
| Individual TWT setup event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::itwt_teardown {event_id::itwt_teardown} |
| Individual TWT teardown event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::itwt_probe {event_id::itwt_probe} |
| Individual TWT probe event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::itwt_suspend {event_id::itwt_suspend} |
| Individual TWT suspend event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::twt_wakeup {event_id::twt_wakeup} |
| TWT wakeup event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::btwt_setup {event_id::btwt_setup} |
| Broadcast TWT setup event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::btwt_teardown {event_id::btwt_teardown} |
| Broadcast TWT teardown event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::nan_started {event_id::nan_started} |
| NAN started event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::nan_stopped {event_id::nan_stopped} |
| NAN stopped event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::nan_svc_match {event_id::nan_svc_match} |
| NAN service match event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::nan_replied {event_id::nan_replied} |
| NAN replied event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::nan_receive {event_id::nan_receive} |
| NAN receive event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ndp_indication {event_id::ndp_indication} |
| NDP indication event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ndp_confirm {event_id::ndp_confirm} |
| NDP confirm event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ndp_terminated {event_id::ndp_terminated} |
| NDP terminated event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_neighbor_rep {event_id::sta_neighbor_rep} |
| Station neighbor report received event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::ap_wrong_password {event_id::ap_wrong_password} |
| AP detected wrong password from station event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::sta_beacon_offset_unstable {event_id::sta_beacon_offset_unstable} |
| Station beacon offset unstable event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::dpp_uri_ready {event_id::dpp_uri_ready} |
| DPP URI ready event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::dpp_cfg_recvd {event_id::dpp_cfg_recvd} |
| DPP configuration received event. | |
| constexpr idfxx::event< event_id > | idfxx::wifi::dpp_failed {event_id::dpp_failed} |
| DPP failed event. | |
WiFi type definitions and free function API.
Definition in file wifi.hpp.