idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
idfxx::wifi::csi_config Struct Reference

CSI (Channel State Information) configuration. More...

Public Member Functions

constexpr bool operator== (const csi_config &) const noexcept=default
 

Public Attributes

bool lltf_en = true
 
bool htltf_en = true
 
bool stbc_htltf2_en = true
 
bool ltf_merge_en = true
 
bool channel_filter_en = true
 
bool manu_scale = false
 
uint8_t shift = 0
 
bool dump_ack_en = false
 

Detailed Description

CSI (Channel State Information) configuration.

The fields of this struct differ by target, mirroring ESP-IDF's wifi_csi_config_t:

  • On Wi-Fi 4/5 targets (esp32, esp32s2, esp32s3, esp32c3), it exposes the legacy LTF/channel-filter toggles.
  • On Wi-Fi 6 (HE) targets, it mirrors wifi_csi_acquire_config_t, which itself has two variants selected by SOC_WIFI_MAC_VERSION_NUM. Users writing HE-target CSI code should consult the ESP-IDF API reference for the meaning of each acquire_csi_* field.
Note
Because the field set varies by target, source code that writes to specific members is not portable across Wi-Fi 4/5 and Wi-Fi 6 targets.

Definition at line 982 of file wifi.hpp.

Member Function Documentation

◆ operator==()

constexpr bool idfxx::wifi::csi_config::operator== ( const csi_config ) const
constexprdefaultnoexcept

Member Data Documentation

◆ channel_filter_en

bool idfxx::wifi::csi_config::channel_filter_en = true

Enable channel filter.

Definition at line 987 of file wifi.hpp.

◆ dump_ack_en

bool idfxx::wifi::csi_config::dump_ack_en = false

Enable dumping ACK frames.

Definition at line 990 of file wifi.hpp.

◆ htltf_en

bool idfxx::wifi::csi_config::htltf_en = true

Enable receiving HT long training field.

Definition at line 984 of file wifi.hpp.

◆ lltf_en

bool idfxx::wifi::csi_config::lltf_en = true

Enable receiving legacy long training field.

Definition at line 983 of file wifi.hpp.

◆ ltf_merge_en

bool idfxx::wifi::csi_config::ltf_merge_en = true

Enable LTF merging.

Definition at line 986 of file wifi.hpp.

◆ manu_scale

bool idfxx::wifi::csi_config::manu_scale = false

Manually scale CSI data.

Definition at line 988 of file wifi.hpp.

◆ shift

uint8_t idfxx::wifi::csi_config::shift = 0

Manual scale shift value.

Definition at line 989 of file wifi.hpp.

◆ stbc_htltf2_en

bool idfxx::wifi::csi_config::stbc_htltf2_en = true

Enable receiving STBC HT-LTF2.

Definition at line 985 of file wifi.hpp.


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