Struct esp_idf_sys::wifi_sta_config_t

source ·
#[repr(C)]
pub struct wifi_sta_config_t {
Show 18 fields pub ssid: [u8; 32], pub password: [u8; 64], pub scan_method: wifi_scan_method_t, pub bssid_set: bool, pub bssid: [u8; 6], pub channel: u8, pub listen_interval: u16, pub sort_method: wifi_sort_method_t, pub threshold: wifi_scan_threshold_t, pub pmf_cfg: wifi_pmf_config_t, pub _bitfield_align_1: [u32; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 4]>, pub sae_pwe_h2e: wifi_sae_pwe_method_t, pub sae_pk_mode: wifi_sae_pk_mode_t, pub failure_retry_cnt: u8, pub _bitfield_align_2: [u32; 0], pub _bitfield_2: __BindgenBitfieldUnit<[u8; 4]>, pub sae_h2e_identifier: [u8; 32],
}
Expand description

@brief STA configuration settings for the device

Fields§

§ssid: [u8; 32]

< SSID of target AP.

§password: [u8; 64]

< Password of target AP.

§scan_method: wifi_scan_method_t

< do all channel scan or fast scan

§bssid_set: bool

< whether set MAC address of target AP or not. Generally, station_config.bssid_set needs to be 0; and it needs to be 1 only when users need to check the MAC address of the AP.

§bssid: [u8; 6]

< MAC address of target AP

§channel: u8

< channel of target AP. Set to 1~13 to scan starting from the specified channel before connecting to AP. If the channel of AP is unknown, set it to 0.

§listen_interval: u16

< Listen interval for ESP32 station to receive beacon when WIFI_PS_MAX_MODEM is set. Units: AP beacon intervals. Defaults to 3 if set to 0.

§sort_method: wifi_sort_method_t

< sort the connect AP in the list by rssi or security mode

§threshold: wifi_scan_threshold_t

< When scan_threshold is set, only APs which have an auth mode that is more secure than the selected auth mode and a signal stronger than the minimum RSSI will be used.

§pmf_cfg: wifi_pmf_config_t

< Configuration for Protected Management Frame. Will be advertised in RSN Capabilities in RSN IE.

§_bitfield_align_1: [u32; 0]§_bitfield_1: __BindgenBitfieldUnit<[u8; 4]>§sae_pwe_h2e: wifi_sae_pwe_method_t

< Configuration for SAE PWE derivation method

§sae_pk_mode: wifi_sae_pk_mode_t

< Configuration for SAE-PK (Public Key) Authentication method

§failure_retry_cnt: u8

< Number of connection retries station will do before moving to next AP. scan_method should be set as WIFI_ALL_CHANNEL_SCAN to use this config. Note: Enabling this may cause connection time to increase incase best AP doesn’t behave properly.

§_bitfield_align_2: [u32; 0]§_bitfield_2: __BindgenBitfieldUnit<[u8; 4]>§sae_h2e_identifier: [u8; 32]

< Password identifier for H2E. this needs to be null terminated string

Implementations§

source§

impl wifi_sta_config_t

source

pub fn rm_enabled(&self) -> u32

source

pub fn set_rm_enabled(&mut self, val: u32)

source

pub fn btm_enabled(&self) -> u32

source

pub fn set_btm_enabled(&mut self, val: u32)

source

pub fn mbo_enabled(&self) -> u32

source

pub fn set_mbo_enabled(&mut self, val: u32)

source

pub fn ft_enabled(&self) -> u32

source

pub fn set_ft_enabled(&mut self, val: u32)

source

pub fn owe_enabled(&self) -> u32

source

pub fn set_owe_enabled(&mut self, val: u32)

source

pub fn transition_disable(&self) -> u32

source

pub fn set_transition_disable(&mut self, val: u32)

source

pub fn reserved(&self) -> u32

source

pub fn set_reserved(&mut self, val: u32)

source

pub fn new_bitfield_1( rm_enabled: u32, btm_enabled: u32, mbo_enabled: u32, ft_enabled: u32, owe_enabled: u32, transition_disable: u32, reserved: u32, ) -> __BindgenBitfieldUnit<[u8; 4]>

source

pub fn he_dcm_set(&self) -> u32

source

pub fn set_he_dcm_set(&mut self, val: u32)

source

pub fn he_dcm_max_constellation_tx(&self) -> u32

source

pub fn set_he_dcm_max_constellation_tx(&mut self, val: u32)

source

pub fn he_dcm_max_constellation_rx(&self) -> u32

source

pub fn set_he_dcm_max_constellation_rx(&mut self, val: u32)

source

pub fn he_mcs9_enabled(&self) -> u32

source

pub fn set_he_mcs9_enabled(&mut self, val: u32)

source

pub fn he_su_beamformee_disabled(&self) -> u32

source

pub fn set_he_su_beamformee_disabled(&mut self, val: u32)

source

pub fn he_trig_su_bmforming_feedback_disabled(&self) -> u32

source

pub fn set_he_trig_su_bmforming_feedback_disabled(&mut self, val: u32)

source

pub fn he_trig_mu_bmforming_partial_feedback_disabled(&self) -> u32

source

pub fn set_he_trig_mu_bmforming_partial_feedback_disabled(&mut self, val: u32)

source

pub fn he_trig_cqi_feedback_disabled(&self) -> u32

source

pub fn set_he_trig_cqi_feedback_disabled(&mut self, val: u32)

source

pub fn he_reserved(&self) -> u32

source

pub fn set_he_reserved(&mut self, val: u32)

source

pub fn new_bitfield_2( he_dcm_set: u32, he_dcm_max_constellation_tx: u32, he_dcm_max_constellation_rx: u32, he_mcs9_enabled: u32, he_su_beamformee_disabled: u32, he_trig_su_bmforming_feedback_disabled: u32, he_trig_mu_bmforming_partial_feedback_disabled: u32, he_trig_cqi_feedback_disabled: u32, he_reserved: u32, ) -> __BindgenBitfieldUnit<[u8; 4]>

Trait Implementations§

source§

impl Clone for wifi_sta_config_t

source§

fn clone(&self) -> wifi_sta_config_t

Returns a copy of the value. Read more
1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for wifi_sta_config_t

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for wifi_sta_config_t

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Copy for wifi_sta_config_t

Auto Trait Implementations§

§

impl Freeze for wifi_sta_config_t

§

impl RefUnwindSafe for wifi_sta_config_t

§

impl Send for wifi_sta_config_t

§

impl Sync for wifi_sta_config_t

§

impl Unpin for wifi_sta_config_t

§

impl UnwindSafe for wifi_sta_config_t

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.