TWT request structure to auto select a session.

Public Attributes#

uint8_t

TWT enable. 0 - TWT session teardown; 1 - TWT session setup.

uint16_t

This is the expected average Tx throughput in Kbps. Value ranges from 0 to 10Mbps, which is half of the default device_average_throughput (20Mbps by default).

uint32_t

The allowed latency, in milliseconds, within which the given Tx operation is expected to be completed. If 0 is configured, maximum allowed Tx latency is same as rx_latency. Otherwise, valid values are in the range of [200ms - 6hrs].

uint32_t

The maximum latency, in milliseconds, for receiving buffered packets from the AP. The device wakes up at least once for a TWT service period within the configured rx_latency if there are any pending packets destined for the device from the AP. If set to 0, the default latency of 2 seconds is used. Valid range is between 2 seconds to 6 hours. Recommended range is 2 seconds to 60 seconds to avoid connection failures with AP due to longer sleep time.

uint16_t

Refers to the average Tx throughput that the device is capable of achieving in Kbps. The default value is 20Mbps. Internal SDK use only: do not use.

uint8_t

The percentage by which wake duration is supposed to be overestimated to compensate for bss congestion. Recommended input range is 0 - 50%. The default value is 0. Internal SDK use only: do not use.

uint8_t

The allowed deviation percentage of wake duration TWT response. Recommended input range is 0 - 50%. The default value is 10. Internal SDK use only: do not use.

uint32_t

Default minimum wake interval. Recommended Range: 512ms to 1024ms. The default value is 1024msec. Internal SDK use only: do not use.

uint32_t

Default minimum wake interval. Recommended Range: 8ms - 16ms. The default value is 8ms. Internal SDK use only: do not use.

uint8_t

The number of beacons after the service period completion for which the module wakes up and listens for any pending RX. The default value is 2. Internal SDK use only: do not use.

Public Attribute Documentation#

twt_enable#

uint8_t sl_wifi_twt_selection_t::twt_enable

TWT enable. 0 - TWT session teardown; 1 - TWT session setup.


Definition at line 319 of file components/protocol/wifi/inc/sl_wifi_types.h

average_tx_throughput#

uint16_t sl_wifi_twt_selection_t::average_tx_throughput

This is the expected average Tx throughput in Kbps. Value ranges from 0 to 10Mbps, which is half of the default device_average_throughput (20Mbps by default).


Definition at line 321 of file components/protocol/wifi/inc/sl_wifi_types.h

tx_latency#

uint32_t sl_wifi_twt_selection_t::tx_latency

The allowed latency, in milliseconds, within which the given Tx operation is expected to be completed. If 0 is configured, maximum allowed Tx latency is same as rx_latency. Otherwise, valid values are in the range of [200ms - 6hrs].


Definition at line 323 of file components/protocol/wifi/inc/sl_wifi_types.h

rx_latency#

uint32_t sl_wifi_twt_selection_t::rx_latency

The maximum latency, in milliseconds, for receiving buffered packets from the AP. The device wakes up at least once for a TWT service period within the configured rx_latency if there are any pending packets destined for the device from the AP. If set to 0, the default latency of 2 seconds is used. Valid range is between 2 seconds to 6 hours. Recommended range is 2 seconds to 60 seconds to avoid connection failures with AP due to longer sleep time.


Definition at line 325 of file components/protocol/wifi/inc/sl_wifi_types.h

device_average_throughput#

uint16_t sl_wifi_twt_selection_t::device_average_throughput

Refers to the average Tx throughput that the device is capable of achieving in Kbps. The default value is 20Mbps. Internal SDK use only: do not use.


Definition at line 327 of file components/protocol/wifi/inc/sl_wifi_types.h

estimated_extra_wake_duration_percent#

uint8_t sl_wifi_twt_selection_t::estimated_extra_wake_duration_percent

The percentage by which wake duration is supposed to be overestimated to compensate for bss congestion. Recommended input range is 0 - 50%. The default value is 0. Internal SDK use only: do not use.


Definition at line 329 of file components/protocol/wifi/inc/sl_wifi_types.h

twt_tolerable_deviation#

uint8_t sl_wifi_twt_selection_t::twt_tolerable_deviation

The allowed deviation percentage of wake duration TWT response. Recommended input range is 0 - 50%. The default value is 10. Internal SDK use only: do not use.


Definition at line 331 of file components/protocol/wifi/inc/sl_wifi_types.h

default_wake_interval_ms#

uint32_t sl_wifi_twt_selection_t::default_wake_interval_ms

Default minimum wake interval. Recommended Range: 512ms to 1024ms. The default value is 1024msec. Internal SDK use only: do not use.


Definition at line 333 of file components/protocol/wifi/inc/sl_wifi_types.h

default_minimum_wake_duration_ms#

uint32_t sl_wifi_twt_selection_t::default_minimum_wake_duration_ms

Default minimum wake interval. Recommended Range: 8ms - 16ms. The default value is 8ms. Internal SDK use only: do not use.


Definition at line 335 of file components/protocol/wifi/inc/sl_wifi_types.h

beacon_wake_up_count_after_sp#

uint8_t sl_wifi_twt_selection_t::beacon_wake_up_count_after_sp

The number of beacons after the service period completion for which the module wakes up and listens for any pending RX. The default value is 2. Internal SDK use only: do not use.


Definition at line 337 of file components/protocol/wifi/inc/sl_wifi_types.h