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

feat(matter): New example => Wifi Prov within Matter as alternative for wireless network provisioning #10658

Merged
merged 4 commits into from
Dec 2, 2024
Merged

feat(matter): New example => Wifi Prov within Matter as alternative for wireless network provisioning #10658

merged 4 commits into from
Dec 2, 2024

Conversation

SuGlider
Copy link
Collaborator

Description of Change

WiFi Prov based on BLE or SoftAP can be used for WiFi Network provisioning within Matter Accessories.
This is an alternative that helps application that don't want to fix any SSID/Password in the code.

This example can be used with an other sort of WiFi Provisioning, including, for instance, WiFi Manager Library.

Tests scenarios

Tested with ESP32-S3 and the provided example.

Related links

Related to #7432

@SuGlider SuGlider added Area: Libraries Issue is related to Library support. Status: Review needed Issue or PR is awaiting review Area: WiFi Issue related to WiFi labels Nov 27, 2024
@SuGlider SuGlider added this to the 3.1.0 milestone Nov 27, 2024
@SuGlider SuGlider self-assigned this Nov 27, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 27, 2024 •
edited
Loading

Warnings
⚠️ 
	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.
Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 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.
- 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 12d56b2

@SuGlider SuGlider added the Type: Example Issue is related to specific example. label Nov 27, 2024
@github-actions GitHub Actions
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/WiFiProvWithinMatter----------

@SuGlider SuGlider added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Dec 2, 2024
@SuGlider SuGlider merged commit c2ce738 into release/v3.1.x Dec 2, 2024
21 checks passed
Jason2866 added a commit to tasmota/arduino-esp32 that referenced this pull request Dec 6, 2024
@Jason2866 @SuGlider
@P-R-O-C-H-Y @me-no-dev @pre-commit-ci-lite
Merge 31 (#562)
136190d 
* fix(zigbee): Increase timeout, commision again on failure + setScanDuration (espressif#10651)

* fix(zigbee): Increase timeout, commision again on failure
* fix(zigbee): Update library keywords

* feat(Matter): add new MatterColorLight endpoint (espressif#10654)

* feat(matter): adds Matter Color Light endpoint

* Tasmota changes

* optional Ethernet support (JL1101 driver added)
* esp-modem only esp32, esp32s2 and esp32s3
* remove `OpenThread`
* remove all BT BLE libraries
* remove zigbee
* remove SPIFFS
* remove Client Secure
* remove Provisioning
* remove TfLite, Insights and Rainmaker
* make GPIOViewer working see arendst/Tasmota@9696118
* remove FS log which is just littering

* feat(matter): New example => Wifi Prov within Matter as alternative for wireless network provisioning (espressif#10658)

* feat(matter): Arduino WiFi Prov example for Matter

* feat(matter): Adds Matter Enhanced Color Light Endpoint (CW/WW/RGB) (espressif#10657)

* feat(matter): created enhanced color light new matter endpoint and example

* feat(matter): Adds a new Matter Endpoint: Generic Switch (smart button) (espressif#10662)

* feat(matter): adds new matter generic switch endpoint

* fix(matter): no need of arduino preferences here

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

---------

Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
@SuGlider SuGlider deleted the wifi_prov_with_matter branch December 6, 2024 21:38
Jason2866 added a commit to tasmota/arduino-esp32 that referenced this pull request Dec 11, 2024
@Jason2866 @SuGlider
@P-R-O-C-H-Y @me-no-dev @pre-commit-ci-lite @sylque @lucasssvaz @pcbcupid @Neutrino-1 @github-actions @mstegen
Upstream changes (#564)
2c87943 
* fix(zigbee): Increase timeout, commision again on failure + setScanDuration (espressif#10651)

* fix(zigbee): Increase timeout, commision again on failure
* fix(zigbee): Update library keywords

* feat(Matter): add new MatterColorLight endpoint (espressif#10654)

* feat(matter): adds Matter Color Light endpoint

* feat(matter): New example => Wifi Prov within Matter as alternative for wireless network provisioning (espressif#10658)

* feat(matter): Arduino WiFi Prov example for Matter

* feat(matter): Adds Matter Enhanced Color Light Endpoint (CW/WW/RGB) (espressif#10657)

* feat(matter): created enhanced color light new matter endpoint and example

* feat(matter): Adds a new Matter Endpoint: Generic Switch (smart button) (espressif#10662)

* feat(matter): adds new matter generic switch endpoint

* fix(matter): no need of arduino preferences here

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

* BLECharacteristic optimization (espressif#10665)

* BLECharacteristic::notify() optimization

GeneralUtils::hexDump() doesn't output anything if the log level is not "VERBOSE". Additionally, it is very CPU intensive, even when it doesn't output anything. So it is much better to *not* call it at all if not needed. 

In a simple program which calls BLECharacteristic::notify() every 50 ms, the performance gain of this little optimization is 37% in release mode (-O3) and 57% in debug mode. 

Of course, the "#if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_VERBOSE" guard could also be put inside the GeneralUtils::hexDump() function itself. But it's better to put it here also, as it is clearer (indicating a verbose log thing) and it allows to remove the "m_value.getValue().c_str()" call, which is in itself quite CPU intensive.

* BLECharacteristic optimization

Calls to BLEUtils::buildHexData() don't output anything when the log level is not "VERBOSE" or "DEBUG". As this function is quite CPU intensive, it is better to not call it when not needed.

* Remove 3rd party references in code and documentation (espressif#10666)

* feat(support): documentation adjustment
* feat(support): readme files, commentaries and examples
* fix(template): Fix Issue Report Template
-----------------------------
Co-authored-by: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com>

* Tasmota changes

* optional Ethernet support (JL1101 driver added)
* esp-modem only esp32, esp32s2 and esp32s3
* remove `OpenThread`
* remove all BT BLE libraries
* remove zigbee
* remove SPIFFS
* remove Client Secure
* remove Provisioning
* remove TfLite, Insights and Rainmaker
* make GPIOViewer working see arendst/Tasmota@9696118
* remove FS log which is just littering

* refactor(uart): Refactor UART test to work with any number of UARTs (espressif#10593)

* refactor(uart): Refactor UART test to work with any number of UARTs

Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>

* fix(uart): Set CPU freq on ESP32

* ci(pre-commit): Apply automatic fixes

* fix(spelling): Fix codespell error

---------

Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

* feat (Variants) Added custom boards variants GLYPH C3, GLYPHC6 & GLYPHH2 (espressif#10671)

* Added custom boards GLYPH C3, GLYPHC6 & GLYPHH2 based on ESP32C3, ESP32C6 & ESP32H2

* feat(Variants) : Added custom boards GLYPH C3, GLYPHC6 & GLYPHH2

Added custom boards variants from PCBCUPID - GLYPH C3, GLYPHC6 & GLYPHH2 based on ESP32C3, ESP32C6 & ESP32H2

* added required fix : moved the variants to end and fixed build.board

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: srini <srinivasanm329@gmail.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

* feat(Zigbee): Recall bounded devices after reboot + IEEE address option for commands (espressif#10676)

* feat(zigbee): Recall bound devices after reboot

* fix(zigbee): Add missing locks + allow printBoundDevices to Serial

* fix(Zigbee): Add locks to temp sensor setReporting

* fix(Zigbee): remove unnecessary space in formatting

* fix(Zigbee): proper parameter in printBoundDevices

* feat(Zigbee): factory reset when removed from network

* fix(zigbee): Update comment

* fix(zigbee): fix serial and add missing factoryReset to example

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

* ci(pre-commit): Bump hooks versions and fix leftover files (espressif#10680)

* update(hooks): Bump pre-commit hooks versions

* fix(formatting): Fix python script formatting

* fix(formatting): Fix leftover files on protected folders

* feat(Matter): Creates New Matter Fan Controller Endpoint (espressif#10691)

* feat(matter): creates new matter fan controller endpoint

* change(tools): Push generated binaries to PR

* ci(pre-commit): Add bash script formatter and linter (espressif#10681)

* ci(pre-commit): Add check for bash scripts

* fix(formatting): Fix bash scripts

* docs(pre-commit): Add info about the included hooks

* fix ESP32-U4WDH chip detection by ESP.getChipModel() (espressif#10696)

* fixes chip detection for ESP32-U4WDH

* fix(push): Re-comment unused code

* feat(matter): adds new Temperature Sensor Matter Endpoint (espressif#10698)

* feat(matter): adds new temperature sensor matter endpoint

* feat(matter): commentaries review and fixes

* feat(matter): commentaries review and fixes

* feat(matter): commentaries review and fixes

* feat(matter): commentaries review and fixes

* feat(matter): commentaries review and fixes

* feat(matter): commentaries review and fixes

* feat(matter): general commentaries and code review

* feat(matter): keeping arduino style for local variables (lower case)

* feat(matter): applies a generic temperature unit to the implementation and example

* fix(matter): fixed problem with begin(float) implementation

* fix(matter): fixed begin(float) initiallization

* feat(matter): updated matter temperature keywords with new api

* ci(pre-commit): Apply automatic fixes

* fix(matter): fixed code spell ci errors in matter temperature sensor

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

* feat(chip): Add definition for BOOT_PIN for all chips (espressif#10700)

* feat(chip): Add definition for BOOT_PIN for all chips

For use in sketches as default button

* fix(core): Make BOOT_PIN static

* fix(hal): BOOT_PIN should always be defined

* feat(Matter): Adds New Matter Humidity Sensor Endpoint (espressif#10703)

* feat(matter): adds matter humidity sensor endpoint

* Update and rename platformio-build.py to pioarduino-build.py

* feat(matter_examples): apply boot button change to all examples (espressif#10702)

* feat(matter_examples): apply boot button change to all examples

* ci(tests): Re-enable UART test for P4

* Delete libraries/Matter directory

---------

Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: Sylvain Quendez <sylvain.quendez@gmail.com>
Co-authored-by: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com>
Co-authored-by: PCB CUPID <123002577+pcbcupid@users.noreply.github.com>
Co-authored-by: srini <srinivasanm329@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Michael Stegen <mstegen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@me-no-dev me-no-dev me-no-dev approved these changes

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

Assignees

@SuGlider SuGlider

Labels
Area: Libraries Issue is related to Library support. Area: WiFi Issue related to WiFi Status: Pending Merge Pull Request is ready to be merged Type: Example Issue is related to specific example.
Projects
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
3.1.0
Development

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