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

Add I2S examples and documentation #9030

Merged
merged 3 commits into from
Jan 19, 2024
Merged

Add I2S examples and documentation #9030

merged 3 commits into from
Jan 19, 2024

Conversation

lucasssvaz
Copy link
Collaborator

@lucasssvaz lucasssvaz commented Dec 20, 2023 •
edited
Loading

Description of Change

Adds examples and documentation for the new I2S library.

Tests scenarios

Tested loopback example on the ESP32-LyraT and the WAV recorder example on the ESP32-S3-EYE.

@lucasssvaz lucasssvaz added the Area: Libraries Issue is related to Library support. label Dec 20, 2023
@lucasssvaz lucasssvaz self-assigned this Dec 20, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 20, 2023 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "docs(i2s): Add I2S API docs":
    • summary looks too short
  • the commit message "feat(i2s): Add I2S examples":
    • summary looks too short

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).
Messages
📖 You might consider squashing your 3 commits (simplifying branch history).
📖 This PR seems to be quite large (total lines of code: 2816), you might consider splitting it into smaller PRs

👋 Hello lucasssvaz, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 e797a58

@VojtechBartoska VojtechBartoska added the Type: Example Issue is related to specific example. label Dec 21, 2023
@VojtechBartoska
Copy link
Collaborator

Closes #8993

@lucasssvaz
Copy link
Collaborator Author

Both examples work, just need to add the documentation and refactor the code a bit.

@lucasssvaz lucasssvaz mentioned this pull request Dec 22, 2023
Closed
1 task
@lucasssvaz lucasssvaz force-pushed the feature/i2s_examples branch 2 times, most recently from 63b7afc to 678aea5 Compare December 22, 2023 22:46
@lucasssvaz lucasssvaz marked this pull request as ready for review December 22, 2023 22:53
@lucasssvaz lucasssvaz added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Dec 24, 2023
@lucasssvaz lucasssvaz changed the title Add I2S examples Add I2S examples and Documentation Dec 24, 2023
@lucasssvaz lucasssvaz changed the title Add I2S examples and Documentation Add I2S examples and documentation Dec 24, 2023
@lucasssvaz
feat(i2s): Add I2S examples
2af9969 
- ES8388 loopback example using the LyraT board
- ESP32-S3-EYE record WAV to SD card example
- Simple tone example
@lucasssvaz
docs(i2s): Add I2S API docs
95a349d
@VojtechBartoska VojtechBartoska added the Status: Review needed Issue or PR is awaiting review label Jan 17, 2024
@me-no-dev
Copy link
Member

@lucasssvaz please fix the conflict

@lucasssvaz
Copy link
Collaborator Author

@lucasssvaz please fix the conflict

Done

@me-no-dev me-no-dev merged commit 1149650 into espressif:master Jan 19, 2024
40 checks passed
@lucasssvaz lucasssvaz deleted the feature/i2s_examples branch February 7, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P-R-O-C-H-Y P-R-O-C-H-Y Awaiting requested review from P-R-O-C-H-Y

Assignees

@lucasssvaz lucasssvaz

Labels
Area: Libraries Issue is related to Library support. Status: Review needed Issue or PR is awaiting review Type: Documentation Issue pertains to Documentation of Arduino ESP32 Type: Example Issue is related to specific example.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lucasssvaz @VojtechBartoska @me-no-dev