Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c7022ca

Browse files
SuGliderlucasssvaz
andauthoredDec 3, 2024
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>
1 parent 6ce4369 commit c7022ca

File tree

30 files changed

+10
-558
lines changed

30 files changed

+10
-558
lines changed
 

‎.github/ISSUE_TEMPLATE/Issue-report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ body:
7575
attributes:
7676
label: IDE Name
7777
description: What IDE are you using?
78-
placeholder: eg. Arduino IDE, PlatformIO, Sloeber...
78+
placeholder: eg. Arduino IDE, VSCode, Sloeber...
7979
validations:
8080
required: true
8181
- type: input

‎docs/_static/logo_pio.png

-25.4 KB
Binary file not shown.

‎docs/en/getting_started.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,13 @@ Supported IDEs
7878

7979
Here is the list of supported IDE for Arduino ESP32 support integration.
8080

81-
+-------------------+-------------------+
82-
| |arduino-logo| | |pio-logo| |
83-
+-------------------+-------------------+
84-
| Arduino IDE | PlatformIO |
85-
+-------------------+-------------------+
81+
+-------------------+
82+
| |arduino-logo| |
83+
+-------------------+
84+
| Arduino IDE |
85+
+-------------------+
8686

8787
.. |arduino-logo| image:: ../_static/logo_arduino.png
88-
.. |pio-logo| image:: ../_static/logo_pio.png
8988

9089
See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
9190

‎docs/en/installing.rst

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -63,92 +63,6 @@ To start the installation process using the Boards Manager, follow these steps:
6363

6464
- Restart Arduino IDE.
6565

66-
Installing using PlatformIO
67-
---------------------------
68-
69-
.. figure:: ../_static/logo_pio.png
70-
:align: center
71-
:width: 200
72-
:figclass: align-center
73-
74-
PlatformIO is a professional collaborative platform for embedded development. It has out-of-the-box support for ESP32 SoCs and allows working with Arduino ESP32 as well as ESP-IDF from Espressif without changing your development environment. PlatformIO includes lots of instruments for the most common development tasks such as debugging, unit testing, and static code analysis.
75-
76-
.. warning:: Integration of the Arduino Core ESP32 project in PlatformIO is maintained by PlatformIO developers. Arduino Core ESP32 Project Team cannot support PlatformIO-specific issues. Please report these issues in official `PlatformIO repositories <https://github.com/platformio>`_.
77-
78-
A detailed overview of the PlatformIO ecosystem and its philosophy can be found in `the official documentation <https://docs.platformio.org/en/latest/core/index.html>`_.
79-
80-
PlatformIO can be used in two flavors:
81-
82-
- `PlatformIO IDE <https://platformio.org/platformio-ide>`_ is a toolset for embedded C/C++ development available on Windows, macOS and Linux platforms
83-
84-
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_ is a command-line tool that consists of a multi-platform build system, platform and library managers and other integration components. It can be used with a variety of code development environments and allows integration with cloud platforms and web services
85-
86-
To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_.
87-
88-
Using the stable code
89-
*********************
90-
91-
.. note::
92-
A detailed overview of supported development boards, examples and frameworks can be found on `the official Espressif32 dev-platform page <https://registry.platformio.org/platforms/platformio/espressif32>`_ in the PlatformIO Registry.
93-
94-
The most reliable and easiest way to get started is to use the latest stable version of the ESP32 development platform that passed all tests/verifications and can be used in production.
95-
96-
Create a new project and select one of the available boards. You can change after by changing the `platformio.ini <https://docs.platformio.org/en/latest/projectconf/index.html>`_ file.
97-
98-
- For ESP32
99-
100-
.. code-block:: bash
101-
102-
[env:esp32dev]
103-
platform = espressif32
104-
board = esp32dev
105-
framework = arduino
106-
107-
- For ESP32-S2 (ESP32-S2-Saola-1 board)
108-
109-
.. code-block:: bash
110-
111-
[env:esp32-s2-saola-1]
112-
platform = espressif32
113-
board = esp32-s2-saola-1
114-
framework = arduino
115-
116-
- For ESP32-C3 (ESP32-C3-DevKitM-1 board)
117-
118-
.. code-block:: bash
119-
120-
[env:esp32-c3-devkitm-1]
121-
platform = espressif32
122-
board = esp32-c3-devkitm-1
123-
framework = arduino
124-
125-
How to update to the latest code
126-
********************************
127-
128-
To test the latest Arduino ESP32, you need to change your project *platformio.ini* accordingly.
129-
The following configuration uses the upstream version of the Espressif development platform and the latest Arduino core directly from the Espressif GitHub repository:
130-
131-
.. code-block:: bash
132-
133-
[env:esp32-c3-devkitm-1]
134-
platform = https://github.com/platformio/platform-espressif32.git
135-
board = esp32-c3-devkitm-1
136-
framework = arduino
137-
platform_packages =
138-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
139-
140-
141-
To get more information about PlatformIO, see the following links:
142-
143-
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_
144-
145-
- `PlatformIO Home <https://docs.platformio.org/en/latest/home/index.html>`_
146-
147-
- `Tutorials and Examples <https://docs.platformio.org/en/latest/tutorials/index.html>`_
148-
149-
- `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html>`_
150-
151-
15266
Windows (manual installation)
15367
-----------------------------
15468

@@ -360,4 +274,3 @@ Where ``~/Documents/Arduino`` represents your sketch book location as per "Ardui
360274
- Restart Arduino IDE.
361275

362276
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
363-
.. _docs.platformio.org: https://docs.platformio.org/en/latest/integration/ide/pioide.html

‎docs/en/tutorials/blink.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Introduction
77

88
This is the interactive blink tutorial using `Wokwi`_. For this tutorial, you don't need the ESP32 board or the Arduino toolchain.
99

10-
.. note:: If you don't want to use this tutorial with the simulation, you can copy and paste the :ref:`blink_example_code` from `Wokwi`_ editor and use it on the `Arduino IDE`_ or `PlatformIO`_.
10+
.. note:: If you don't want to use this tutorial with the simulation, you can copy and paste the :ref:`blink_example_code` from `Wokwi`_ editor and use it on the `Arduino IDE`.
1111

1212
About this Tutorial
1313
-------------------
@@ -109,5 +109,4 @@ Resources
109109

110110
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
111111
.. _Wokwi: https://wokwi.com/
112-
.. _PlatformIO: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#platformio
113112
.. _Arduino IDE: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager

‎libraries/ESP32/examples/FreeRTOS/BasicMultiThreading/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
6262
* Before Compile/Verify, select the correct board: `Tools -> Board`.
6363
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
6464

65-
#### Using Platform IO
66-
67-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
68-
6965
## Troubleshooting
7066

7167
***Important: Make sure you are using a good quality USB cable and that you have a reliable power source***

‎libraries/ESP32/examples/FreeRTOS/Mutex/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
5151
* Before Compile/Verify, select the correct board: `Tools -> Board`.
5252
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
5353

54-
#### Using Platform IO
55-
56-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
57-
5854
## Example Log Output
5955

6056
The expected output of shared variables protected by mutex demonstrates mutually exclusive access from tasks - they do not interrupt each other and do not rewrite the value before the other task has read it back.

‎libraries/ESP32/examples/FreeRTOS/Queue/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
2929
* Before Compile/Verify, select the correct board: `Tools -> Board`.
3030
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
3131

32-
#### Using Platform IO
33-
34-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
35-
3632
## Example Log Output
3733

3834
```

‎libraries/ESP32/examples/FreeRTOS/Semaphore/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
3535
* Before Compile/Verify, select the correct board: `Tools -> Board`.
3636
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
3737

38-
#### Using Platform IO
39-
40-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
41-
4238
## Example Log Output
4339

4440
```

‎libraries/ESP32/examples/RMT/Legacy_RMT_Driver_Compatible/Legacy_RMT_Driver_Compatible.ino

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NO_RGB_BUILTIN" to use the RMT Legacy driver
1313
#error "ESP32_ARDUINO_NO_RGB_BUILTIN is not defined, this example is intended to demonstrate the RMT Legacy driver."
1414
#error "Please add the file 'build_opt.h' with '-DESP32_ARDUINO_NO_RGB_BUILTIN' to your Arduino project folder."
15-
#error "Another way to disable the RGB_BUILTIN is to define it in the platformio.ini file, for instance: '-D ESP32_ARDUINO_NO_RGB_BUILTIN'"
1615

1716
#else
1817

‎libraries/ESP32/examples/Template/ExampleTemplate/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
6464
* Before Compile/Verify, select the correct board: `Tools -> Board`.
6565
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
6666

67-
#### Using Platform IO
68-
69-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
70-
7167
## Example/Log Output ==(OPTIONAL)==
7268

7369
==*Add the log/serial output here!*==

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/.gitignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/README.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/data/file1.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/data/testfolder/test2.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/include/.placeholder.txt

Whitespace-only changes.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/lib/.placeholder.txt

Whitespace-only changes.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/partitions_custom.csv

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/platformio.ini

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎libraries/LittleFS/examples/LITTLEFS_PlatformIO/src/main.cpp

Lines changed: 0 additions & 286 deletions
This file was deleted.

‎libraries/NetworkClientSecure/README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,11 @@ This method is similar to the single root certificate verification above, but it
3232
root certificates from Mozilla to authenticate against, while the previous method only accepts a single
3333
certificate for a given server. This allows the client to connect to all public SSL servers.
3434

35-
To use this feature in PlatformIO:
36-
1. create a certificate bundle as described in the document below, or obtain a pre-built one you trust:
37-
https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/protocols/esp_crt_bundle.html
38-
(gen_crt_bundle.py can be found in the /tools folder)
39-
a. note: the full bundle will take up around 64k of flash space, but has minimal RAM usage, as only
40-
the index of the certificates is kept in RAM
41-
2. Place the bundle under the file name "data/cert/x509_crt_bundle.bin" in your platformio project
42-
3. add "board_build.embed_files = data/cert/x509_crt_bundle.bin" in your platformio.ini
43-
4. add the following global declaration in your project:
44-
extern const uint8_t rootca_crt_bundle_start[] asm("_binary_data_cert_x509_crt_bundle_bin_start");
45-
5. before initiating the first SSL connection, call
46-
my_client.setCACertBundle(rootca_crt_bundle_start);
47-
4835
To use this feature in Arduino IDE:
4936
If the Arduino IDE added support for embedding files in the meantime, then follow the instructions above.
50-
If not, you have three choices:
51-
1. convert your project to PlatformIO
52-
2. create a makefile where you can add the idf_component_register() declaration to include the certificate bundle
53-
3. Store the bundle as a SPIFFS file, but then you have to load it into RAM in runtime and waste 64k of precious memory
37+
If not, you have two choices:
38+
1. create a makefile where you can add the idf_component_register() declaration to include the certificate bundle
39+
2. Store the bundle as a SPIFFS file, but then you have to load it into RAM in runtime and waste 64k of precious memory
5440

5541
Using a root CA cert and client cert/keys
5642
-----------------------------------------

‎libraries/WebServer/examples/MultiHomedServers/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
6767
* Before Compile/Verify, select the correct board: `Tools -> Board`.
6868
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
6969

70-
#### Using Platform IO
71-
72-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
73-
7470
## Example Log Output
7571

7672
```

‎libraries/WiFi/examples/FTM/FTM_Initiator/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
5555
* Before Compile/Verify, select the correct board: `Tools -> Board`.
5656
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
5757

58-
#### Using Platform IO
59-
60-
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
61-
6258
## Log Output
6359

6460
Expected log output:

‎libraries/WiFi/examples/FTM/FTM_Responder/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
4848
* Before Compile/Verify, select the correct board: `Tools -> Board`.
4949
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
5050

51-
#### Using Platform IO
52-
53-
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
54-
5551
## Log Output
5652

5753
Expected log output:

‎libraries/WiFi/examples/WiFiClient/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,6 @@ To get more information about the Espressif boards see [Espressif Development Ki
6161
* Before Compile/Verify, select the correct board: `Tools -> Board`.
6262
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
6363

64-
#### Using Platform IO
65-
66-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
67-
6864
## Example Log Output
6965

7066
The initial output which is common for all examples can be ignored:

‎libraries/WiFi/examples/WiFiClientConnect/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ Currently, this example supports the following targets.
1818
* Before Compile/Verify, select the correct board: `Tools -> Board`.
1919
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
2020

21-
#### Using Platform IO
22-
23-
* Select the COM port: `Devices` or set the `upload_port`` option on the `platformio.ini` file.
24-
2521
## Example/Log Output
2622

2723
```

‎libraries/WiFi/examples/WiFiScan/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ Currently, this example supports the following targets.
1818
* Before Compile/Verify, select the correct board: `Tools -> Board`.
1919
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
2020

21-
#### Using Platform IO
22-
23-
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
24-
2521
## Example/Log Output
2622

2723
```

‎libraries/WiFi/examples/WiFiScanAsync/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ Currently, this example supports the following targets.
1818
* Before Compile/Verify, select the correct board: `Tools -> Board`.
1919
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
2020

21-
#### Using Platform IO
22-
23-
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
24-
2521
## Example/Log Output
2622

2723
```

‎libraries/WiFi/examples/WiFiScanDualAntenna/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ This example is compatible with the ESP32-WROOM-DA.
1717
* Before Compile/Verify, select the correct board: `Tools -> Board`.
1818
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
1919

20-
#### Using Platform IO
21-
22-
* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
23-
2420
## Example/Log Output
2521

2622
```

‎libraries/WiFi/examples/WiFiScanTime/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ Currently, this example supports the following targets.
1818
* Before Compile/Verify, select the correct board: `Tools -> Board`.
1919
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
2020

21-
#### Using Platform IO
22-
23-
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
24-
2521
## Example/Log Output
2622

2723
```

0 commit comments

Comments
 (0)
Please sign in to comment.