Skip to content

Commit 45583af

Browse files
authored
[Docs] Actualize PlatformIO installation instructions (espressif#6629)
* Actualize PlatformIO installation instructions Split instructions for stable and upstream versions * Add link to platformio.ini documentation
1 parent f60cd8a commit 45583af

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

docs/source/installing.rst

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -71,48 +71,70 @@ Installing using PlatformIO
7171
:width: 200
7272
:figclass: align-center
7373

74-
PlatformIO is one of most popular embedded development tool. Currently, it supports Arduino ESP32 and ESP-IDF from Espressif (other platforms are also supported).
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.
7575

76-
To install PIO, you can follow this Getting Started, provided by PIO at `docs.platformio.org`_.
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>`_.
7777

78-
To test the latest Arduino ESP32, you need to change your project *platform.ini* accordingly.
78+
PlatformIO can be used in two flavors:
7979

80-
- Start a new project and select one of the available board. You can change after by changing the *platform.ini* file.
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.
8195

8296
- For ESP32
8397

8498
.. code-block:: bash
8599
86-
[env:arduino-esp32]
87-
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
100+
[env:esp32dev]
101+
platform = espressif32
88102
board = esp32dev
89103
framework = arduino
90-
platform_packages =
91-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
92104
93105
- For ESP32-S2 (ESP32-S2-Saola-1 board)
94106

95107
.. code-block:: bash
96108
97-
[env:arduino-esp32s2]
98-
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
109+
[env:esp32-s2-saola-1]
110+
platform = espressif32
99111
board = esp32-s2-saola-1
100112
framework = arduino
101-
platform_packages =
102-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
103113
104-
- For ESP32-C3 (ESP32-S3-DevKitM-1 board)
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:
105128

106129
.. code-block:: bash
107130
108-
[env:arduino-esp32c3]
109-
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
131+
[env:esp32-c3-devkitm-1]
132+
platform = https://github.com/platformio/platform-espressif32.git
110133
board = esp32-c3-devkitm-1
111134
framework = arduino
112135
platform_packages =
113-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
136+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
114137
115-
Now you're able to use the latest Arduino ESP32 support directly from Espressif GitHub repository.
116138
117139
To get more information about PlatformIO, see the following links:
118140

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy