Skip to content

Commit 47458a1

Browse files
committed
Documentation - Remove PlatformIO and general improvements
1 parent 099b432 commit 47458a1

File tree

4 files changed

+10
-93
lines changed

4 files changed

+10
-93
lines changed

docs/source/getting_started.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,13 @@ Supported IDEs
7171

7272
Here is the list of supported IDE for Arduino ESP32 support integration.
7373

74-
+-------------------+-------------------+
75-
| |arduino-logo| | |pio-logo| |
76-
+-------------------+-------------------+
77-
| Arduino IDE | PlatformIO |
78-
+-------------------+-------------------+
74+
+-------------------+
75+
| |arduino-logo| |
76+
+-------------------+
77+
| Arduino IDE |
78+
+-------------------+
7979

8080
.. |arduino-logo| image:: _static/logo_arduino.png
81-
.. |pio-logo| image:: _static/logo_pio.png
8281

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

docs/source/installing.rst

-84
Original file line numberDiff line numberDiff line change
@@ -63,90 +63,6 @@ To start the installation process using the Boards Managaer, 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-
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>`_.
77-
78-
PlatformIO can be used in two flavors:
79-
80-
- `PlatformIO IDE <https://platformio.org/platformio-ide>`_ is a toolset for embedded C/C++ development available on Windows, macOS and Linux platforms
81-
82-
- `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
83-
84-
To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_.
85-
86-
Using the stable code
87-
*********************
88-
89-
.. note::
90-
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.
91-
92-
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.
93-
94-
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.
95-
96-
- For ESP32
97-
98-
.. code-block:: bash
99-
100-
[env:esp32dev]
101-
platform = espressif32
102-
board = esp32dev
103-
framework = arduino
104-
105-
- For ESP32-S2 (ESP32-S2-Saola-1 board)
106-
107-
.. code-block:: bash
108-
109-
[env:esp32-s2-saola-1]
110-
platform = espressif32
111-
board = esp32-s2-saola-1
112-
framework = arduino
113-
114-
- For ESP32-C3 (ESP32-C3-DevKitM-1 board)
115-
116-
.. code-block:: bash
117-
118-
[env:esp32-c3-devkitm-1]
119-
platform = espressif32
120-
board = esp32-c3-devkitm-1
121-
framework = arduino
122-
123-
How to update to the latest code
124-
********************************
125-
126-
To test the latest Arduino ESP32, you need to change your project *platformio.ini* accordingly.
127-
The following configuration uses the upstream version of the Espressif development platform and the latest Arduino core directly from the Espressif GitHub repository:
128-
129-
.. code-block:: bash
130-
131-
[env:esp32-c3-devkitm-1]
132-
platform = https://github.com/platformio/platform-espressif32.git
133-
board = esp32-c3-devkitm-1
134-
framework = arduino
135-
platform_packages =
136-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
137-
138-
139-
To get more information about PlatformIO, see the following links:
140-
141-
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_
142-
143-
- `PlatformIO Home <https://docs.platformio.org/en/latest/home/index.html>`_
144-
145-
- `Tutorials and Examples <https://docs.platformio.org/en/latest/tutorials/index.html>`_
146-
147-
- `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html>`_
148-
149-
15066
Windows (manual installation)
15167
-----------------------------
15268

docs/source/ota_web_update.rst

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ OTAWebUpdate is done with a web browser that can be useful in the following typi
88
- after deployment if user is unable to expose Firmware for OTA from external update server
99
- provide updates after deployment to small quantity of modules when setting an update server is not practicable
1010

11+
For more information about the update process, please refer to the `OTA API reference <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/ota.html>`_
12+
section of the ESP-IDF documentation.
13+
1114
Requirements
1215
------------
1316

docs/source/tutorials/blink.rst

+2-3
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
113-
.. _Arduino IDE: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager
112+
.. _Arduino IDE: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager

0 commit comments

Comments
 (0)