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.

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

Enabled the onboard ceramic antenna by default when creating a new project with XIAO_ESP32C6 #10066

Merged
merged 11 commits into from
Aug 2, 2024

Conversation

Cincinnatu
Copy link
Contributor

@Cincinnatu Cincinnatu commented Jul 23, 2024

By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes

Checklist

  1. Please provide specific title of the PR describing the change, including the component name (eg. „Update of Documentation link on Readme.md“)
  2. Please provide related links (eg. Issue which will be closed by this Pull Request)
  3. Please update relevant Documentation if applicable
  4. Please check Contributing guide
  5. Please confirm option to "Allow edits and access to secrets by maintainers" when opening a Pull Request

This entire section above can be deleted if all items are checked.


Description of Change

Please describe your proposed Pull Request and it's impact.

Tests scenarios

Please describe on what Hardware and Software combinations you have tested this Pull Request and how.

(eg. I have tested my Pull Request on Arduino-esp32 core v2.0.2 with ESP32 and ESP32-S2 Board with this scenario)

Related links

Please provide links to related issue, PRs etc.

(eg. Closes #number of issue)

Copy link
Contributor

github-actions bot commented Jul 23, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Create variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update pins_arduino.h":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variant.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update variants/XIAO_ESP32C6/variant.cpp":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

⚠️ Please consider squashing your 11 commits (simplifying branch history).

👋 Hello Cincinnatu, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 004d14f

@CLAassistant
Copy link

CLAassistant commented Jul 23, 2024

CLA assistant check
All committers have signed the CLA.

@P-R-O-C-H-Y
Copy link
Member

Hello @Cincinnatu, can you please provide some description about the change and also add some related links?
I will also recommend to define the antenna pins in variants/XIAO_ESP32C6/pins_arduino.h and use the definitions instead of PIN number in variant.cpp.

Copy link
Collaborator

@Jason2866 Jason2866 left a comment

Choose a reason for hiding this comment

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

the comment is wrong. Correct is //use onboard antenna
The code is not needed at all, since using onboard antenna is default (without any setup). Only needed when the extern antenna should be activated.

@Cincinnatu
Copy link
Contributor Author

Due to the hardware design of XIAO_ESP32C6, the WIFI antenna will not be turned on by default during use. Some of our users may not know how to turn on the WIFI by themselves, therefore, so I have submitted this PR.

@Cincinnatu
Copy link
Contributor Author

您好,您能否提供一些有关更改的描述并添加一些相关链接?我还建议定义天线引脚,并在 variant.cpp 中使用定义而不是 PIN 号。variants/XIAO_ESP32C6/pins_arduino.h

Sure, I'll add it later.

@Jason2866
Copy link
Collaborator

@Cincinnatu

Due to the hardware design of XIAO_ESP32C6, the WIFI antenna will not be turned on by default during use. Some of our users may not know how to turn on the WIFI by themselves, therefore, so I have submitted this PR.

So the behaviour described how it works is wrong at the Web page!
This needs to be corrected.

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
@VojtechBartoska VojtechBartoska added the Status: In Progress Issue is in progress label Jul 26, 2024
@me-no-dev
Copy link
Member

I would suggest adding the following defines to pins_arduino.h to help the users:

#define useInternalAntenna() digitalWrite(WIFI_ANT_CONFIG, LOW)
#define useExternalAntenna() digitalWrite(WIFI_ANT_CONFIG, HIGH)

Then maybe that to be documented in the board web page.

Is there a case where the WiFi should not be enabled?

@Jason2866
Copy link
Collaborator

Is there a case where the WiFi should not be enabled?

You never know all uses cases. If it is possible to switch off, there will be probably a use case found for.

@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: In Progress Issue is in progress labels Aug 2, 2024
@me-no-dev me-no-dev merged commit 38d6ed5 into espressif:master Aug 2, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged Type: 3rd party Boards
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants