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

Adds a Minimum Code Matter Example #10639

Merged
merged 11 commits into from
Nov 24, 2024
Merged

Conversation

SuGlider
Copy link
Collaborator

Description of Change

Adds the minimum Matter Accessory example code in order to ilustrate how simple it is to work with the new ESP32 Arduino Matter Library.

Tests scenarios

ESP32-S3 with the provided example

Related links

Related to #7432

@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 22, 2024
@SuGlider SuGlider added this to the 3.1.0 milestone Nov 22, 2024
@SuGlider SuGlider self-assigned this Nov 22, 2024
Copy link
Contributor

github-actions bot commented Nov 22, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(matter): better commentary about the GPIO.":
    • summary should not end with a period (full stop)
  • the commit message "feat(matter): clearer commentary and formatting.":
    • summary should not end with a period (full stop)

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).
⚠️
	The **target branch** for this Pull Request **must be the default branch** of the project (`master`).

	If you would like to add this feature to a different branch, please state this in the PR description and we will consider it.

👋 Hello SuGlider, 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 73ffd5e

Copy link
Contributor

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
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
Matter/examples/MatterMinimum----------

@SuGlider SuGlider added the Type: Example Issue is related to specific example. label Nov 22, 2024
@me-no-dev
Copy link
Member

this is not a working example, right? Maybe add the basic callback to it only work so it can change the led builtin (no preferences, etc.)

@SuGlider
Copy link
Collaborator Author

this is not a working example, right? Maybe add the basic callback to it only work so it can change the led builtin (no preferences, etc.)

Done, tested and working.

@SuGlider
Copy link
Collaborator Author

Commentaries were updated to reflect code change (adding a GPIO that can be controlled by the Matter Smartphone APP).

@SuGlider SuGlider added the Status: Pending Merge Pull Request is ready to be merged label Nov 23, 2024
@SuGlider SuGlider merged commit 962ab3a into release/v3.1.x Nov 24, 2024
21 checks passed
@SuGlider SuGlider deleted the minimum_matter_example branch November 24, 2024 22:09
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 Status: Review needed Issue or PR is awaiting review Type: Example Issue is related to specific example.
Projects
Development

Successfully merging this pull request may close these issues.

4 participants