Commit c7022ca

SuGliderlucasssvaz

and

authored

Remove 3rd party references in code and documentation (#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 c7022caCopy full SHA for c7022ca

File tree

30 files changed

+10

-558

lines changed

.github/ISSUE_TEMPLATE
- Issue-report.yml
docs
- _static
  - logo_pio.png
- en
  - getting_started.rst
  - installing.rst
  - tutorials
    - blink.rst
libraries
- ESP32/examples
  - FreeRTOS
    - BasicMultiThreading
      - README.md
    - Mutex
      - README.md
    - Queue
      - README.md
    - Semaphore
      - README.md
  - RMT/Legacy_RMT_Driver_Compatible
    - Legacy_RMT_Driver_Compatible.ino
  - Template/ExampleTemplate
    - README.md
- LittleFS/examples/LITTLEFS_PlatformIO
  - .gitignore
  - README.md
  - data
    - file1.txt
    - testfolder
      - test2.txt
  - include
    - .placeholder.txt
  - lib
    - .placeholder.txt
  - partitions_custom.csv
  - platformio.ini
  - src
    - main.cpp
- NetworkClientSecure
  - README.md
- WebServer/examples/MultiHomedServers
  - README.md
- WiFi/examples
  - FTM
    - FTM_Initiator
      - README.md
    - FTM_Responder
      - README.md
  - WiFiClientConnect
    - README.md
  - WiFiClient
    - README.md
  - WiFiScanAsync
    - README.md
  - WiFiScanDualAntenna
    - README.md
  - WiFiScanTime
    - README.md
  - WiFiScan
    - README.md

30 files changed

+10

-558

lines changed

`‎.github/ISSUE_TEMPLATE/Issue-report.yml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ body:`
`75`	`75`	`attributes:`
`76`	`76`	`label: IDE Name`
`77`	`77`	`description: What IDE are you using?`
`78`		`- placeholder: eg. Arduino IDE, PlatformIO, Sloeber...`
	`78`	`+ placeholder: eg. Arduino IDE, VSCode, Sloeber...`
`79`	`79`	`validations:`
`80`	`80`	`required: true`
`81`	`81`	`- 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 number	Diff line number	Diff line change
`@@ -78,14 +78,13 @@ Supported IDEs`
`78`	`78`
`79`	`79`	`Here is the list of supported IDE for Arduino ESP32 support integration.`
`80`	`80`
`81`		`-+-------------------+-------------------+`
`82`		`-\| \|arduino-logo\| \| \|pio-logo\| \|`
`83`		`-+-------------------+-------------------+`
`84`		`-\| Arduino IDE \| PlatformIO \|`
`85`		`-+-------------------+-------------------+`
	`81`	`++-------------------+`
	`82`	`+\| \|arduino-logo\| \|`
	`83`	`++-------------------+`
	`84`	`+\| Arduino IDE \|`
	`85`	`++-------------------+`
`86`	`86`
`87`	`87`	`.. \|arduino-logo\| image:: ../_static/logo_arduino.png`
`88`		`-.. \|pio-logo\| image:: ../_static/logo_pio.png`
`89`	`88`
`90`	`89`	See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
`91`	`90`

`‎docs/en/installing.rst‎`

Lines changed: 0 additions & 87 deletions

Original file line number	Diff line number	Diff line change
`@@ -63,92 +63,6 @@ To start the installation process using the Boards Manager, follow these steps:`
`63`	`63`
`64`	`64`	`- Restart Arduino IDE.`
`65`	`65`
`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`		`-`
`152`	`66`	`Windows (manual installation)`
`153`	`67`	`-----------------------------`
`154`	`68`
@@ -360,4 +274,3 @@ Where ``~/Documents/Arduino`` represents your sketch book location as per "Ardui
`360`	`274`	`- Restart Arduino IDE.`
`361`	`275`
`362`	`276`	`.. _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 number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ Introduction`
`7`	`7`
`8`	`8`	This is the interactive blink tutorial using `Wokwi`_. For this tutorial, you don't need the ESP32 board or the Arduino toolchain.
`9`	`9`
`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`.
`11`	`11`
`12`	`12`	`About this Tutorial`
`13`	`13`	`-------------------`
`@@ -109,5 +109,4 @@ Resources`
`109`	`109`
`110`	`110`	`.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf`
`111`	`111`	`.. _Wokwi: https://wokwi.com/`
`112`		`-.. _PlatformIO: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#platformio`
`113`	`112`	`.. _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 number	Diff line number	Diff line change
`@@ -62,10 +62,6 @@ To get more information about the Espressif boards see [Espressif Development Ki`
`62`	`62`	* Before Compile/Verify, select the correct board: `Tools -> Board`.
`63`	`63`	* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
`64`	`64`
`65`		`-#### Using Platform IO`
`66`		`-`
`67`		-* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
`68`		`-`
`69`	`65`	`## Troubleshooting`
`70`	`66`
`71`	`67`	`*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 number	Diff line number	Diff line change
`@@ -51,10 +51,6 @@ To get more information about the Espressif boards see [Espressif Development Ki`
`51`	`51`	* Before Compile/Verify, select the correct board: `Tools -> Board`.
`52`	`52`	* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
`53`	`53`
`54`		`-#### Using Platform IO`
`55`		`-`
`56`		-* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
`57`		`-`
`58`	`54`	`## Example Log Output`
`59`	`55`
`60`	`56`	`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 number	Diff line number	Diff line change
`@@ -29,10 +29,6 @@ To get more information about the Espressif boards see [Espressif Development Ki`
`29`	`29`	* Before Compile/Verify, select the correct board: `Tools -> Board`.
`30`	`30`	* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
`31`	`31`
`32`		`-#### Using Platform IO`
`33`		`-`
`34`		-* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
`35`		`-`
`36`	`32`	`## Example Log Output`
`37`	`33`
`38`	`34`	```

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

Lines changed: 0 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,6 @@ To get more information about the Espressif boards see [Espressif Development Ki`
`35`	`35`	* Before Compile/Verify, select the correct board: `Tools -> Board`.
`36`	`36`	* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
`37`	`37`
`38`		`-#### Using Platform IO`
`39`		`-`
`40`		-* Select the COM port: `Devices` or set the `upload_port` option on the `platformio.ini` file.
`41`		`-`
`42`	`38`	`## Example Log Output`
`43`	`39`
`44`	`40`	```

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

Lines changed: 0 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@`
`12`	`12`	`// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NO_RGB_BUILTIN" to use the RMT Legacy driver`
`13`	`13`	`#error "ESP32_ARDUINO_NO_RGB_BUILTIN is not defined, this example is intended to demonstrate the RMT Legacy driver."`
`14`	`14`	`#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'"`
`16`	`15`
`17`	`16`	`#else`
`18`	`17`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit c7022ca

File tree

30 files changed

30 files changed

`‎.github/ISSUE_TEMPLATE/Issue-report.yml‎`

`‎docs/_static/logo_pio.png‎`

`‎docs/en/getting_started.rst‎`

`‎docs/en/installing.rst‎`

`‎docs/en/tutorials/blink.rst‎`

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

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

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

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

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

0 commit comments