Configuration for WiFi initialization. More...

Public Member Functions
constexpr bool	operator== (const init_config &) const noexcept=default

Public Attributes
std::optional< unsigned int >	static_rx_buf_num

std::optional< unsigned int >	dynamic_rx_buf_num

std::optional< unsigned int >	static_tx_buf_num

std::optional< unsigned int >	dynamic_tx_buf_num

std::optional< unsigned int >	cache_tx_buf_num

std::optional< unsigned int >	rx_ba_win

std::optional< bool >	ampdu_rx_enable

std::optional< bool >	ampdu_tx_enable

std::optional< bool >	nvs_enable

std::optional< core_id >	wifi_task_core_id

Detailed Description

Configuration for WiFi initialization.

Controls buffer allocation, AMPDU settings, NVS persistence, and task pinning for the WiFi subsystem. All fields default to std::nullopt, which preserves the Kconfig default values.

idfxx::wifi::init({
    .static_rx_buf_num = 8,
    .ampdu_rx_enable = true,
    .nvs_enable = false,
});

Definition at line 814 of file wifi.hpp.

Member Function Documentation

◆ operator==()

constexpr bool idfxx::wifi::init_config::operator== ( const init_config & ) const

constexprdefaultnoexcept

Member Data Documentation

◆ ampdu_rx_enable

std::optional<bool> idfxx::wifi::init_config::ampdu_rx_enable

AMPDU RX feature enable.

Definition at line 821 of file wifi.hpp.

◆ ampdu_tx_enable

std::optional<bool> idfxx::wifi::init_config::ampdu_tx_enable

AMPDU TX feature enable.

Definition at line 822 of file wifi.hpp.

◆ cache_tx_buf_num

std::optional<unsigned int> idfxx::wifi::init_config::cache_tx_buf_num

TX cache buffer count.

Definition at line 819 of file wifi.hpp.

◆ dynamic_rx_buf_num

std::optional<unsigned int> idfxx::wifi::init_config::dynamic_rx_buf_num

Dynamic RX buffer count.

Definition at line 816 of file wifi.hpp.

◆ dynamic_tx_buf_num

std::optional<unsigned int> idfxx::wifi::init_config::dynamic_tx_buf_num

Dynamic TX buffer count.

Definition at line 818 of file wifi.hpp.

◆ nvs_enable

std::optional<bool> idfxx::wifi::init_config::nvs_enable

NVS flash for WiFi config persistence.

Definition at line 823 of file wifi.hpp.

◆ rx_ba_win

std::optional<unsigned int> idfxx::wifi::init_config::rx_ba_win

Block Ack RX window size.

Definition at line 820 of file wifi.hpp.

◆ static_rx_buf_num

std::optional<unsigned int> idfxx::wifi::init_config::static_rx_buf_num

Static RX buffer count.

Definition at line 815 of file wifi.hpp.

◆ static_tx_buf_num

std::optional<unsigned int> idfxx::wifi::init_config::static_tx_buf_num

Static TX buffer count.

Definition at line 817 of file wifi.hpp.

◆ wifi_task_core_id

std::optional<core_id> idfxx::wifi::init_config::wifi_task_core_id

WiFi task core ID.

Definition at line 824 of file wifi.hpp.

The documentation for this struct was generated from the following file:

idfxx_wifi/include/idfxx/wifi.hpp

Public Member Functions

Public Attributes