samples: wifi: ble_coex: Readme update #16359

muraliThokala · 2024-07-08T17:47:46Z

Update readme to suit the latest documentation style.

NordicBuilder · 2024-07-08T17:57:16Z

Test specification

CI/Jenkins/NRF

Skipped

CI/Jenkins/integration

Skipped

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2024-07-08T18:27:52Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

samples/wifi/ble_coex/README.rst

NordicBuilder · 2024-09-03T05:21:44Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 22

Inputs:

Sources:

more details

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain
◻️ Build twister
◻️ Integration tests

Note: This message is automatically posted and updated by the CI

samples/wifi/ble_coex/README.rst

Update readme to suit the latest documentation style. Signed-off-by: Murali Thokala <Murali.Thokala@nordicsemi.no>

mia-ko · 2024-09-20T08:56:39Z

samples/wifi/ble_coex/README.rst

@@ -9,7 +9,6 @@ Wi-Fi: Bluetooth LE coexistence
   :depth: 2

 The Bluetooth LE coexistence sample demonstrates coexistence between Wi-Fi® and Bluetooth LE radios in 2.4 GHz frequency.


Add registered trademark for Bluetooth LE here instead (first occurrence), then it can be removed from the one in Overview section (or any other places if they appear)

mia-ko · 2024-09-20T08:59:22Z

samples/wifi/ble_coex/README.rst

@@ -18,50 +17,49 @@ The sample supports the following development kit:

 .. table-from-sample-yaml::

+Running coexistence sample test cases require additional software such as the Wi-Fi **iperf** application.


iPerf?
The Network Traffic Generator that is being linked to is using iPerf and not iperf.

mia-ko · 2024-09-20T09:03:16Z

samples/wifi/ble_coex/README.rst

@@ -18,50 +17,49 @@ The sample supports the following development kit:

 .. table-from-sample-yaml::

+Running coexistence sample test cases require additional software such as the Wi-Fi **iperf** application.
+Use **iperf** version 2.0.5.


Using iPerf to emphasize the first time is ok. But I would suggest not to use it throughout the doc. To just use iPerf should be enough.

mia-ko · 2024-09-20T09:05:53Z

samples/wifi/ble_coex/README.rst

+| nRF7002 DK   | Bluetooth LE   | The sample runs Wi-Fi throughput only, Bluetooth LE throughput only,               |
+| (DUT)        | coex sample    | or a combination of both based on configuration selections in the                  |
+|              |                | :file:`prj.conf`.                                                                  |


mia-ko · 2024-09-20T09:25:41Z

samples/wifi/ble_coex/README.rst

 |                        | throughput in Mbps | throughput in kbps |
 +========================+====================+====================+
-| Wi-Fi only,            | 10.2               | N.A                |
-| client (UDP Tx)        |                    |                    |
+| Wi-Fi-only,            | 10.2               | N.A                |


Suggested change

| Wi-Fi-only, | 10.2 | N.A |

| Wi-Fi-only, | 10.2 | N.A. |

mia-ko · 2024-09-20T09:27:53Z

samples/wifi/ble_coex/README.rst

 |                        | throughput in Mbps | throughput in kbps |
 +========================+====================+====================+
-| Wi-Fi only,            | 3.5                | N.A                |
-| client (UDP Tx)        |                    |                    |
+| Wi-Fi-only,            | 3.5                | N.A                |


Suggested change

| Wi-Fi-only, | 3.5 | N.A |

| Wi-Fi-only, | 3.5 | N.A. |

mia-ko · 2024-09-20T09:28:07Z

samples/wifi/ble_coex/README.rst

 +------------------------+--------------------+--------------------+
-| Bluetooth LE only,     | N.A                | 1190               |
+| Bluetooth LE-only,     | N.A                | 1190               |


Suggested change

| Bluetooth LE-only, | N.A | 1190 |

| Bluetooth LE-only, | N.A. | 1190 |

mia-ko · 2024-09-20T09:29:00Z

samples/wifi/ble_coex/README.rst

 |                        | throughput in Mbps | throughput in kbps |
 +========================+====================+====================+
-| Wi-Fi only,            | 10.2               | N.A                |
-| client (UDP Tx)        |                    |                    |
+| Wi-Fi-only,            | 10.2               | N.A                |


Suggested change

| Wi-Fi-only, | 10.2 | N.A |

| Wi-Fi-only, | 10.2 | N.A. |

mia-ko · 2024-09-20T09:29:10Z

samples/wifi/ble_coex/README.rst

 +------------------------+--------------------+--------------------+
-| Bluetooth LE only,     | N.A                | 1139               |
+| Bluetooth LE-only,     | N.A                | 1139               |


Suggested change

| Bluetooth LE-only, | N.A | 1139 |

| Bluetooth LE-only, | N.A. | 1139 |

mia-ko · 2024-09-20T09:29:32Z

samples/wifi/ble_coex/README.rst

 |                        | throughput in Mbps | throughput in kbps |
 +========================+====================+====================+
-| Wi-Fi only,            | 10.2               | N.A                |
-| client (UDP Tx)        |                    |                    |
+| Wi-Fi-only,            | 10.2               | N.A                |


Suggested change

| Wi-Fi-only, | 10.2 | N.A |

| Wi-Fi-only, | 10.2 | N.A. |

peknis · 2024-09-20T09:46:30Z

samples/wifi/ble_coex/README.rst


 Programming DKs
 ===============

-To program the nRF5340 DK:
+Complete the following steps to program the nRF5340 DK:


You could use tabs for different DKs/devices. For example like in https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/matter/lock/README.html#testing
Like this:

.. tabs:: .. group-tab:: nRF5340 DK 1. First step .. group-tab:: nRF7002 1. First step

muraliThokala requested a review from bama-nordic as a code owner July 8, 2024 17:47

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jul 8, 2024

muraliThokala added the CI-disable Disable CI for this PR label Jul 8, 2024

muraliThokala force-pushed the ble_coex_readme_update branch from ed8295b to 7aea7b3 Compare July 9, 2024 10:11

muraliThokala requested review from richabp and peknis July 10, 2024 04:28

peknis requested changes Jul 10, 2024

View reviewed changes

samples/wifi/ble_coex/README.rst Outdated Show resolved Hide resolved

muraliThokala force-pushed the ble_coex_readme_update branch from 7aea7b3 to 4bde1b0 Compare July 11, 2024 04:11

muraliThokala requested a review from peknis July 11, 2024 05:57

peknis approved these changes Jul 11, 2024

View reviewed changes

muraliThokala force-pushed the ble_coex_readme_update branch from 4bde1b0 to dbf0885 Compare July 15, 2024 05:35

muraliThokala marked this pull request as draft July 15, 2024 17:01

muraliThokala marked this pull request as ready for review September 3, 2024 05:19

muraliThokala force-pushed the ble_coex_readme_update branch from dbf0885 to bd8e418 Compare September 3, 2024 05:20

muraliThokala force-pushed the ble_coex_readme_update branch 3 times, most recently from 75d966f to 9941041 Compare September 3, 2024 05:44

muraliThokala requested a review from srkanordic September 3, 2024 06:11

muraliThokala force-pushed the ble_coex_readme_update branch from 9941041 to 351d7b2 Compare September 3, 2024 06:46

richabp requested changes Sep 4, 2024

View reviewed changes

muraliThokala force-pushed the ble_coex_readme_update branch 3 times, most recently from 39f4079 to 0014d54 Compare September 4, 2024 11:00

muraliThokala requested a review from richabp September 4, 2024 11:15

muraliThokala force-pushed the ble_coex_readme_update branch 2 times, most recently from c6956b0 to a01b560 Compare September 4, 2024 13:11

richabp requested changes Sep 5, 2024

View reviewed changes

muraliThokala force-pushed the ble_coex_readme_update branch from a01b560 to 0348c54 Compare September 5, 2024 11:18

muraliThokala requested a review from richabp September 5, 2024 11:19

muraliThokala force-pushed the ble_coex_readme_update branch 5 times, most recently from 2d22eb6 to eecbd03 Compare September 6, 2024 07:53

muraliThokala force-pushed the ble_coex_readme_update branch 2 times, most recently from af24a37 to 0b3a495 Compare September 20, 2024 07:42

muraliThokala requested a review from a team as a code owner September 20, 2024 07:42

muraliThokala requested a review from peknis September 20, 2024 09:33

samples: wifi: ble_coex: Readme update

065eb5f

Update readme to suit the latest documentation style. Signed-off-by: Murali Thokala <Murali.Thokala@nordicsemi.no>

muraliThokala force-pushed the ble_coex_readme_update branch from 0b3a495 to 065eb5f Compare September 20, 2024 09:45

mia-ko requested changes Sep 20, 2024

View reviewed changes

peknis requested changes Sep 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

samples: wifi: ble_coex: Readme update #16359

samples: wifi: ble_coex: Readme update #16359

muraliThokala commented Jul 8, 2024

NordicBuilder commented Jul 8, 2024

NordicBuilder commented Jul 8, 2024

NordicBuilder commented Sep 3, 2024 •

edited

Loading

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

mia-ko Sep 20, 2024

peknis Sep 20, 2024

		@@ -9,7 +9,6 @@ Wi-Fi: Bluetooth LE coexistence
		:depth: 2

		The Bluetooth LE coexistence sample demonstrates coexistence between Wi-Fi® and Bluetooth LE radios in 2.4 GHz frequency.

		@@ -18,50 +17,49 @@ The sample supports the following development kit:

		.. table-from-sample-yaml::

		Running coexistence sample test cases require additional software such as the Wi-Fi iperf application.

	\| Bluetooth LE-only, \| N.A \| 1190 \|
	\| Bluetooth LE-only, \| N.A. \| 1190 \|

	\| Bluetooth LE-only, \| N.A \| 1139 \|
	\| Bluetooth LE-only, \| N.A. \| 1139 \|

samples: wifi: ble_coex: Readme update #16359

Are you sure you want to change the base?

samples: wifi: ble_coex: Readme update #16359

Conversation

muraliThokala commented Jul 8, 2024

NordicBuilder commented Jul 8, 2024

Test specification

NordicBuilder commented Jul 8, 2024

NordicBuilder commented Sep 3, 2024 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented Sep 3, 2024 •

edited

Loading