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

Wire library: Add conditional compilation for second I2C interface based on SOC_I2C_NUM #10408

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

sivar2311
Copy link
Contributor

The ESP32, ESP32-S and ESP32-H series have two I2C interfaces, while the ESP32-C series has only one.


Description of Change

The Wire1 object is conditionally compiled and is not available on MCUs that only have a single I2C interface (e.g. MCUs of the ESP32-C series).

Tests scenarios

I tested my pull request on Arduino-esp32 core v3.1.0 with ESP32, ESP32-S3 and ESP32-C3 board with this scenario.
For the test I modified the WireScan example to use the Wire1 object. On an ESP32-C3 based board the compilation failed which is the expected behaviour and intention of this PR.

Related links

ESP32 Arduino Wire not working

…_NUM

The ESP32, ESP32-S and ESP32-H series have two I2C interfaces, while the ESP32-C series has only one.
@CLAassistant
Copy link

CLAassistant commented Oct 2, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add conditional compilation for second I2C interface based on SOC_I2C_NUM":
    • body's lines must not be longer than 100 characters
    • summary looks empty
    • type/action looks empty
    • body must have leading blank line

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).

👋 Hello sivar2311, 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 9aaea98

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3💚 -200💚 -0.010.00💚 -800💚 -0.670.00
ESP32C6💚 -220💚 -0.010.00💚 -800💚 -0.620.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
Wire/examples/WireMaster0000💚 -20💚 -80💚 -20💚 -800000
Wire/examples/WireScan0000💚 -20💚 -80💚 -20💚 -800000
Wire/examples/WireSlave0000💚 -20💚 -80💚 -22💚 -800000

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Test Results

 41 files   - 74   41 suites   - 74   3m 12s ⏱️ - 31m 21s
 19 tests  -  9   19 ✅ + 2  0 💤 ±0  0 ❌ ±0 
120 runs   - 87  120 ✅  - 31  0 💤 ±0  0 ❌ ±0 

Results for commit 9aaea98. ± Comparison against base commit 733373a.

This pull request removes 9 tests.
performance.coremark.test_coremark ‑ test_coremark
performance.fibonacci.test_fibonacci ‑ test_fibonacci
performance.psramspeed.test_psramspeed ‑ test_psramspeed
performance.ramspeed.test_ramspeed ‑ test_ramspeed
performance.superpi.test_superpi ‑ test_superpi
validation.periman.test_periman ‑ test_periman
validation.timer.test_timer ‑ test_timer
validation.uart.test_uart ‑ test_uart
validation.unity.test_unity ‑ test_unity

♻️ This comment has been updated with latest results.

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Oct 4, 2024
@me-no-dev me-no-dev merged commit 5d873c0 into espressif:master Oct 4, 2024
56 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants