Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wifi ready doc changes #15765

Closed
wants to merge 3 commits into from
Closed

Wifi ready doc changes #15765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85f196b
doc: Update changelog for station sample
D-Triveni Jun 5, 2024
62a5678
samples: wifi: sta: Update RPU recovery testing section
D-Triveni Jun 5, 2024
c0193e0
doc: Update changelog for wifi_ready library
D-Triveni Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,10 @@ Wi-Fi samples that used :ref:`zephyr:bluetooth-hci-ipc-sample` or :ref:`zephyr:n

* Added the :ref:`wifi_promiscuous_sample` sample that demonstrates how to set Promiscuous mode, establish a connection to an Access Point (AP), analyze incoming Wi-Fi packets, and print packet statistics.

* :ref:`wifi_station_sample` sample:

* Modified to verify Wi-Fi readiness using the :ref:`wifi_ready` library.

Other samples
-------------

Expand Down Expand Up @@ -907,6 +911,12 @@ Libraries for networking
* Function :c:func:`wifi_credentials_is_empty` to check if the Wi-Fi credentials storage is empty.
* New parameter ``channel`` to the structure :c:struct:`wifi_credentials_header` to store the channel information of the Wi-Fi network.

* Added the :ref:`lib_wifi_ready` library that manages Wi-Fi readiness for applications by handling supplicant ready and not ready events.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just have bullet "Added" after the Libraries for networking heading and the two entries (softap provision and this) under it similarly to the existing softap provisioning entry. Like this:

  • Added:

    • :ref:lib_softap_wifi_provision library.
    • :ref:lib_wifi_ready library


* :ref:`lib_wifi_ready` library:

* Notifies applications of Wi-Fi readiness by managing supplicant events, indicating when Wi-Fi is available for use.
Comment on lines +916 to +918
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`lib_wifi_ready` library:
* Notifies applications of Wi-Fi readiness by managing supplicant events, indicating when Wi-Fi is available for use.


* :ref:`lib_nrf_cloud` library:

* Added:
Expand Down
29 changes: 28 additions & 1 deletion samples/wifi/sta/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ The sample can perform Wi-Fi operations such as connect and disconnect in the 2.

Using this sample, the development kit can connect to the specified access point in :abbr:`STA (Station)` mode.

The sample uses the :ref:`wifi_ready` library to check Wi-Fi readiness.
To use the :ref:`wifi_ready` library, enable the :kconfig:option:`CONFIG_WIFI_READY_EVENT_HANDLING` Kconfig option.

User interface
**************

Expand Down Expand Up @@ -105,7 +108,7 @@ Testing

|test_sample|

#. |connect_kit|
1. |connect_kit|
#. |connect_terminal|

The sample shows the following output:
Expand Down Expand Up @@ -180,6 +183,30 @@ Testing
[00:00:07.720,245] <inf> sta: RSSI: -57
[00:00:07.720,245] <inf> sta: Static IP address:

RPU recovery
************

The RPU recovery mechanism is used to recover from the RPU (nRF70) hang.
This feature performs an interface reset (down and up), which triggers an RPU cold boot.
Application's network connection will be lost during the recovery process, and it is application's responsibility to re-establish the network connection.

Testing
=======

To test RPU recovery, build the sample with the :kconfig:option:`CONFIG_SHELL` and :kconfig:option:`CONFIG_NRF700X_UTIL` Kconfig options.

Trigger RPU recovery using the following command:

.. code-block:: console

wifi_util rpu_recovery_test

If RPU recovery is triggered, you should see an output similar to the following:

.. code-block:: console

RPU recovery triggered

Power management testing
************************

Expand Down
Loading