From 1cc10b7811a945773b1c8fa32ec56ca9a4e8bd1d Mon Sep 17 00:00:00 2001 From: sanjaybhat2004 Date: Fri, 6 Sep 2024 20:53:20 +0530 Subject: [PATCH] wifi: Update wifi-user.rst and changes.md to reflect the changes made to WifiHelper::SetStandard() --- CHANGES.md | 1 + src/wifi/doc/source/wifi-user.rst | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index ce75b08e3..a8b50ffb3 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -22,6 +22,7 @@ Changes from ns-3.42 to ns-3-dev * (core) Added `LaplacianRandomVariable` class implementing the Laplacian random variable, and `LargestExtremeValueRandomVariable` class implementing the Largest Extreme Value random variable. * (wifi) Added a new trace source to `WifiPhy`: **PhyRxMacHeaderEnd**, which is fired when the reception of the MAC header of an MPDU is completed and provides the MAC header and the remaining PSDU duration. The trace source is actually fired when the new **NotifyMacHdrRxEnd** attribute of `WifiPhy` is set to true (it is set to false by default). * (lr-wpan) Added a new test to `lr-wpan-cca-test.cc` suite. The added test demonstrates a known CCA vulnerability window. +* (wifi) WifiHelper::SetStandard() method now accepts selected string values in addition to enum argument. ### Changes to existing API diff --git a/src/wifi/doc/source/wifi-user.rst b/src/wifi/doc/source/wifi-user.rst index a28118413..900b45534 100644 --- a/src/wifi/doc/source/wifi-user.rst +++ b/src/wifi/doc/source/wifi-user.rst @@ -266,12 +266,16 @@ This section provides guidance on how to properly configure these settings. WifiHelper::SetStandard() +++++++++++++++++++++++++ -``WifiHelper::SetStandard ()`` is a method required to set various parameters +``WifiHelper::SetStandard()`` is a method required to set various parameters in the Mac and Phy to standard values, but also to check that the channel settings as described above are allowed. For instance, a channel in the 2.4 GHz band cannot be configured if the standard is 802.11ac, or a channel in the 6 GHz band can only be configured if the standard is 802.11ax (or beyond). +``WifiHelper::SetStandard()`` can also be called by passing a string with the +standard name. For example any of the strings "802.11ax", "11ax" or "HE" can +be passed in order to set the standard as ``WIFI_STANDARD_80211ax``. + The following values for WifiStandard are defined in ``src/wifi/model/wifi-standards.h``: