Remove 3rd party references in code and documentation #10666

SuGlider · 2024-11-29T22:16:16Z

Description of Change

This PR changes documentation and examples to leave only those platforms that are officially supported by Espressif.

Pending changes to CI and scripts (e.g. renaming files) will be done in a separate PR to minimize breaking changes with existing projects.

Tests scenarios

CI Only

Test Results

56 files 56 suites 4m 15s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
134 runs 134 ✅ 0 💤 0 ❌

Results for commit c03a574.

♻️ This comment has been updated with latest results.

SuGlider · 2024-11-29T22:32:07Z

@lucasssvaz - Please review the CI Tools changes.
@me-no-dev - I'll also add a PR to Lib Builder.

@pedrominatel | @rftafas | @P-R-O-C-H-Y
These are all places that I found a referece to PIO in this repository.

Jason2866 · 2024-11-30T10:08:14Z

@SuGlider @me-no-dev This PR removes support for Platformio / pioarduino
Why doing this?

mathieucarbou · 2024-11-30T12:19:58Z

Is there an equivalent alternative or backward compatibility "path" somewhere, or the motivation from expressif is really to break the daily dev / build of everyone using pioarduino ?

SuGlider · 2024-11-30T13:24:40Z

This PR is under review. Please fell free to comment with a change request.

It is intended to remove Trade Marks, Brand Names and other reserved name in order to avoid legal issues.
It has been already done with NeoPixel (Adafruit Brand Name).

Jason2866 · 2024-11-30T13:28:04Z

tools/platformio-build.py

Keep this file and rename it to pioarduino-build.py any appearance of Platformio can be replaced with pioarduino if needed

Jason2866 · 2024-11-30T13:29:40Z

.github/scripts/on-release.sh

The deleted file is needed. Rename to pioarduino-build.py

We shall change the name of this file. What is the name of the Community Project?

I've found PioArduino (https://github.com/pioarduino/platform-espressif32)
Is that the right repository, @Jason2866?

That's the right one. There is a Discord also if you need.

@SuGlider Well, if only trademarks and brands name appearing is the reason, please do the suggested changes without removing. Remove does kill the Open Source Project pioarduino. And yes, that is the correct repo.

What 3rd party software is there?

We are also removing third party software.

Arduino Core for ESP32 is somewhat a component for that IDE.

Since when ? Arduino Core has always been the Arduino API on ESP32 chips, that's what has always been stated in the doc so far.

IDE compatibility has nothing to do with a framework and obviously a framework is not a component of an IDE: to build Arduino apps on ESP32 chips, one should not have to be forced to use Arduino IDE, which IMHO, is far from being the best available IDE out there for complex projects and it is about time Espressif recognise this fact. There are reasons why so many people are not using Arduino or ESP-IDF CLI. If it was so good, people would not bother using alternatives.

Some of your doc

https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#about-arduino-esp32

https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html

https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-platformio

https://docs.espressif.com/projects/arduino-esp32/en/latest/guides/core_compatibility.html

So... Should the community understand that Espressif is actually changing the direction of the Arduino Core project completely so that it only becomes available from Arduino IDE ? Which, consequently would break all projects out there based on platformio or pioarduino and would have far more implications than just dropping support for PlatformIO ?

I thought @VojtechBartoska is the responsible project leader for espressif Arduino.
@rftafas I am interested what is your role regarding espressif Arduino?

Vojtech is no longer part of Espressif team. He decided to venture for other endeavors. I've been the Product Manager since 2022.

There are 3 products here:

The Arduino Core for ESP32, that is an 'add-on' to Arduino IDE, reason why even being a 3rd Party Software, Arduino IDE will be kept.

The Arduino Component for ESP-IDF, which most people use along normal/usual ESP-IDF tools.

The source code. People will use it however they please.

Third party software (i.e. not owned or 'managed' by Espressif) will be moved to a specific place in documentation, if/when using updated/supported Espressif software. Changes are on documentation for now, and we are only aiming the software (i.e. the source code) when it is related to trademarks (SuGlider examples). We are making it very clear about what is an Espressif Product and what is not.

Why?

Well... This very thread is an example in itself. The very statement that "Espressif will no longer support PlatformIO" is problematic in its core and it does break one PIO Labs trademark rules, making it appear that we own PlatformIO. We don't. PlatformIO is a commercial product, which is owned, supported and maintained by PIO Labs. We can't be the 'maintainers' or even the 'supporters' of it. It is NOT shared property. PIO Labs is the sole owner.

Simple warnings do not make a difference on defining this (they are there, yet, confusion remains). So, in order to be compliant to any third party projects and their trademarks, what is our product and so on, we are reviewing all content. This is the scope of this PR.

As for renaming to pioarduino-build.py, for example, AFAIK, PIOArduino isn't a trademark (yet). We might think this later, but it doesn't need to be now. Goal for now is documentation update.

SuGlider · 2024-11-30T17:12:56Z

@Jason2866 @mathieucarbou - We support community initiatives.
No danger or bad intentions to your initiative.
As I said, we shall not use PIO or PlatformIO terms anymore.

Let's focus on that. Please let's work together on it.

Jason2866 · 2024-11-30T19:16:20Z

@rftafas Thx for the explanation and clarification. Good to hear to keep support for community pioarduino :-)

TD-er · 2024-12-02T21:00:10Z

I don't understand it... There were numerous changes requested by @Jason2866, like not to delete files.
There are no new commits since and still the PR is approved???

What am I missing here?

This reverts commit 857935c.

lucasssvaz · 2024-12-02T21:45:12Z

@SuGlider @me-no-dev
Updated description to make intentions more clear and reverted changes to scripts as discussed in our internal meeting.

SuGlider · 2024-12-02T22:34:42Z

I don't understand it... There were numerous changes requested by @Jason2866, like not to delete files. There are no new commits since and still the PR is approved???

What am I missing here?

No worries. @Jason2866 request is fine and executed.

* 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 <[email protected]> * 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 <[email protected]> * fix(uart): Set CPU freq on ESP32 * ci(pre-commit): Apply automatic fixes * fix(spelling): Fix codespell error --------- Co-authored-by: Rodrigo Garcia <[email protected]> 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 <[email protected]> Co-authored-by: Jan Procházka <[email protected]> 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 <[email protected]> Co-authored-by: Jan Procházka <[email protected]> Co-authored-by: Me No Dev <[email protected]> Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com> Co-authored-by: Sylvain Quendez <[email protected]> Co-authored-by: Lucas Saavedra Vaz <[email protected]> Co-authored-by: PCB CUPID <[email protected]> Co-authored-by: srini <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Michael Stegen <[email protected]>

SuGlider added 3 commits November 29, 2024 19:10

feat(support): toll and ci changes

857935c

feat(support): documentation adjustment

34f15c0

feat(support): readme files, commentaries and examples

cb672d8

SuGlider self-assigned this Nov 29, 2024

SuGlider added this to the 3.0.8 milestone Nov 29, 2024

fix(support): left over in documentation.

c03a574

SuGlider requested review from lucasssvaz, pedrominatel, P-R-O-C-H-Y, me-no-dev and rftafas November 29, 2024 22:24

SuGlider mentioned this pull request Nov 29, 2024

feat(doc): documentation update #10652

Closed

Jason2866 reviewed Nov 30, 2024

View reviewed changes

lucasssvaz marked this pull request as draft November 30, 2024 17:15

SuGlider mentioned this pull request Nov 30, 2024

remove PIO in release/v5.1 lib builder espressif/esp32-arduino-lib-builder#251

Closed

SuGlider changed the title ~~Platform Support Change~~ Remove 3rd party references in code and documentatin Dec 1, 2024

lucasssvaz changed the title ~~Remove 3rd party references in code and documentatin~~ Remove 3rd party references in code and documentation Dec 2, 2024

rftafas approved these changes Dec 2, 2024

View reviewed changes

lucasssvaz added 2 commits December 2, 2024 18:37

Revert "feat(support): toll and ci changes"

d0b2c59

This reverts commit 857935c.

fix(template): Fix Issue Report Template

47c6146

lucasssvaz marked this pull request as ready for review December 2, 2024 22:20

lucasssvaz approved these changes Dec 2, 2024

View reviewed changes

lucasssvaz requested review from Jason2866 and mathieucarbou December 2, 2024 22:23

SuGlider added Status: Review needed Issue or PR is awaiting review and removed Area: Tools & Build System Issue is related to tools and/or the build system labels Dec 2, 2024

Jason2866 approved these changes Dec 2, 2024

View reviewed changes

me-no-dev approved these changes Dec 3, 2024

View reviewed changes

pedrominatel approved these changes Dec 3, 2024

View reviewed changes

P-R-O-C-H-Y approved these changes Dec 3, 2024

View reviewed changes

lucasssvaz added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Dec 3, 2024

pre-commit-ci-lite bot and others added 2 commits December 3, 2024 14:00

ci(pre-commit): Apply automatic fixes

723ad19

Merge branch 'master' into support_change

299e41b

SuGlider merged commit c7022ca into espressif:master Dec 3, 2024
37 of 39 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove 3rd party references in code and documentation #10666

Remove 3rd party references in code and documentation #10666

SuGlider commented Nov 29, 2024 •

edited by lucasssvaz

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

SuGlider commented Nov 29, 2024 •

edited by lucasssvaz

Loading

Jason2866 commented Nov 30, 2024

mathieucarbou commented Nov 30, 2024 •

edited

Loading

SuGlider commented Nov 30, 2024 •

edited

Loading

Jason2866 Nov 30, 2024

Jason2866 Nov 30, 2024

SuGlider Nov 30, 2024 •

edited

Loading

SuGlider Nov 30, 2024

mathieucarbou Nov 30, 2024

Jason2866 Nov 30, 2024 •

edited

Loading

Jason2866 Nov 30, 2024

mathieucarbou Nov 30, 2024 •

edited

Loading

Jason2866 Nov 30, 2024

rftafas Nov 30, 2024

rftafas Nov 30, 2024

SuGlider commented Nov 30, 2024

Jason2866 commented Nov 30, 2024

TD-er commented Dec 2, 2024

lucasssvaz commented Dec 2, 2024

SuGlider commented Dec 2, 2024

Remove 3rd party references in code and documentation #10666

Remove 3rd party references in code and documentation #10666

Conversation

SuGlider commented Nov 29, 2024 • edited by lucasssvaz Loading

Description of Change

Tests scenarios

Related links

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

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

Test Results

SuGlider commented Nov 29, 2024 • edited by lucasssvaz Loading

Jason2866 commented Nov 30, 2024

mathieucarbou commented Nov 30, 2024 • edited Loading

SuGlider commented Nov 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuGlider Nov 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jason2866 Nov 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mathieucarbou Nov 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuGlider commented Nov 30, 2024

Jason2866 commented Nov 30, 2024

TD-er commented Dec 2, 2024

lucasssvaz commented Dec 2, 2024

SuGlider commented Dec 2, 2024

SuGlider commented Nov 29, 2024 •

edited by lucasssvaz

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

SuGlider commented Nov 29, 2024 •

edited by lucasssvaz

Loading

mathieucarbou commented Nov 30, 2024 •

edited

Loading

SuGlider commented Nov 30, 2024 •

edited

Loading

SuGlider Nov 30, 2024 •

edited

Loading

Jason2866 Nov 30, 2024 •

edited

Loading

mathieucarbou Nov 30, 2024 •

edited

Loading