Skip to content

Update Document for nxp_m2_wifi_bt Shield with Hardware-Rework and Correct Wi-Fi Shell Build Command #90749

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.

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

Merged

Conversation

nirav-agrawal
Copy link
Contributor

  • Update hardware rework details require for Bluetooth HCI UART and I2S interfaces to work with M.2 module.
  • Update west build command for Wi-Fi shell app with extra config overlay file.

@github-actions github-actions bot added the area: Shields Shields (add-on boards) label May 28, 2025
DerekSnell
DerekSnell previously approved these changes May 28, 2025
@nirav-agrawal
Copy link
Contributor Author

Hi @kartben , I need your help to understand compliance error with this PR. I tried to update the image from PNG to SVG which reduces image size from 5.47mb to 837kb. It seems the size needs smaller than 100kb which seems not possible. can you suggest if there is any alternate to it?

@nirav-agrawal nirav-agrawal requested a review from DerekSnell May 29, 2025 03:26
@kartben
Copy link
Collaborator

kartben commented May 29, 2025

Hi @kartben , I need your help to understand compliance error with this PR. I tried to update the image from PNG to SVG which reduces image size from 5.47mb to 837kb. It seems the size needs smaller than 100kb which seems not possible. can you suggest if there is any alternate to it?

SVG is not meant to be used for photos :)
Just use tinypng.com or the cwebp command line locally to convert to webp. Also make sure to resize the image to like 1000px width
FWIW, a good alternative would probably be to simply add an external link to the shield documentation on NXP website, which I'm guessing is more complete and will have the merit of always being up-to-date

@nirav-agrawal nirav-agrawal force-pushed the update_nxp_shield_doc branch from 0aae533 to 0a541ba Compare May 29, 2025 08:39
@nirav-agrawal
Copy link
Contributor Author

Hi @kartben , I need your help to understand compliance error with this PR. I tried to update the image from PNG to SVG which reduces image size from 5.47mb to 837kb. It seems the size needs smaller than 100kb which seems not possible. can you suggest if there is any alternate to it?

SVG is not meant to be used for photos :) Just use tinypng.com or the cwebp command line locally to convert to webp. Also make sure to resize the image to like 1000px width FWIW, a good alternative would probably be to simply add an external link to the shield documentation on NXP website, which I'm guessing is more complete and will have the merit of always being up-to-date

Hi @kartben, thank you so much for your suggestions. now I have used webp after converting it from png to and tried to keep it under 100kb. In future when we have such link available from the company site, we will use it here. :)

DerekSnell
DerekSnell previously approved these changes May 29, 2025
@nirav-agrawal
Copy link
Contributor Author

@kartben, can you help approve and merge this PR? thank you :)

@kartben
Copy link
Collaborator

kartben commented May 29, 2025

@kartben, can you help approve and merge this PR? thank you :)

Sure, but it hasn't even been open for 24 hours :)

I will have a look, but this won't be merged until it's been in review for at least 2 business days anyway.

@nirav-agrawal
Copy link
Contributor Author

@kartben, can you help approve and merge this PR? thank you :)

Sure, but it hasn't even been open for 24 hours :)

I will have a look, but this won't be merged until it's been in review for at least 2 business days anyway.

Hi @kartben, can you help merge this PR? thank you :)

@kartben
Copy link
Collaborator

kartben commented Jun 2, 2025

@nirav-agrawal Can I please ask that you give reviewers time to come back to their PRs in due course instead of pingging every other day? Thanks! :)

mmahadevan108
mmahadevan108 previously approved these changes Jun 2, 2025
Comment on lines 37 to 38
This shield is validated for use with the host platform listed below, which is actively maintained and supported by NXP.
While the shield can be integrated with other host platforms, NXP may not actively test or validate those configurations.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This shield is validated for use with the host platform listed below, which is actively maintained and supported by NXP.
While the shield can be integrated with other host platforms, NXP may not actively test or validate those configurations.
This shield is validated and tested for use with the host platform listed below. It can be used with
other host platforms, but the functionality is not guaranteed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @kartben, thank you for your suggestion. I updated doc with suggested lines.

Comment on lines 76 to 78
.. note::
To build Wi-Fi shell application, "nxp/overlay_hosted_mcu.conf" config file
must be passed along with default conf file as mentioned in above build command.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This note seems redundant? However, if these are options that are always needed when user wants to do anything Wi-Fi (i.e not just the wifi shell sample specifically), then maybe it can be reworded along these lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @kartben, the given config file is required for any Wi-Fi application. reworded the line as suggested. thank you. :)

- Update hardware rework details require for Bluetooth HCI UART and
 I2S interfaces to work with M.2 module.
- Update west build command for Wi-Fi shell app with extra config
 overlay file.

Signed-off-by: Nirav Agrawal <nirav.agrawal@nxp.com>
Copy link

sonarqubecloud bot commented Jun 3, 2025

@kartben kartben merged commit 550f3bb into zephyrproject-rtos:main Jun 3, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Shields Shields (add-on boards) platform: NXP NXP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants