From 4830d08b5548b6383bc490c9b7f5edd1ed198447 Mon Sep 17 00:00:00 2001 From: Valerii Koval Date: Mon, 25 Apr 2022 23:44:47 +0300 Subject: [PATCH 1/2] Actualize PlatformIO installation instructions Split instructions for stable and upstream versions --- docs/source/installing.rst | 56 ++++++++++++++++++++++++++------------ 1 file changed, 39 insertions(+), 17 deletions(-) diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 39c5d22b616..80689bc3ee5 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -71,48 +71,70 @@ Installing using PlatformIO :width: 200 :figclass: align-center -PlatformIO is one of most popular embedded development tool. Currently, it supports Arduino ESP32 and ESP-IDF from Espressif (other platforms are also supported). +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. -To install PIO, you can follow this Getting Started, provided by PIO at `docs.platformio.org`_. +A detailed overview of the PlatformIO ecosystem and its philosophy can be found in `the official documentation `_. -To test the latest Arduino ESP32, you need to change your project *platform.ini* accordingly. +PlatformIO can be used in two flavors: -- Start a new project and select one of the available board. You can change after by changing the *platform.ini* file. +- `PlatformIO IDE `_ is a toolset for embedded C/C++ development available on Windows, macOS and Linux platforms + +- `PlatformIO Core (CLI) `_ 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 + +To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_. + +Using the stable code +********************* + +.. note:: + A detailed overview of supported development boards, examples and frameworks can be found on `the official Espressif32 dev-platform page `_ in the PlatformIO Registry. + +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. + +Create a new project and select one of the available boards. You can change after by changing the *platformio.ini* file. - For ESP32 .. code-block:: bash - [env:arduino-esp32] - platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream + [env:esp32dev] + platform = espressif32 board = esp32dev framework = arduino - platform_packages = - framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master - For ESP32-S2 (ESP32-S2-Saola-1 board) .. code-block:: bash - [env:arduino-esp32s2] - platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream + [env:esp32-s2-saola-1] + platform = espressif32 board = esp32-s2-saola-1 framework = arduino - platform_packages = - framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master -- For ESP32-C3 (ESP32-S3-DevKitM-1 board) +- For ESP32-C3 (ESP32-C3-DevKitM-1 board) + +.. code-block:: bash + + [env:esp32-c3-devkitm-1] + platform = espressif32 + board = esp32-c3-devkitm-1 + framework = arduino + +How to update to the latest code +******************************** + +To test the latest Arduino ESP32, you need to change your project *platformio.ini* accordingly. +The following configuration uses the upstream version of the Espressif development platform and the latest Arduino core directly from the Espressif GitHub repository: .. code-block:: bash - [env:arduino-esp32c3] - platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream + [env:esp32-c3-devkitm-1] + platform = https://github.com/platformio/platform-espressif32.git board = esp32-c3-devkitm-1 framework = arduino platform_packages = - framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master + framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master -Now you're able to use the latest Arduino ESP32 support directly from Espressif GitHub repository. To get more information about PlatformIO, see the following links: From 3f5745689d59dc3182e2cd1405a6d13a64f6f8ad Mon Sep 17 00:00:00 2001 From: Valerii Koval Date: Tue, 26 Apr 2022 12:10:07 +0300 Subject: [PATCH 2/2] Add link to platformio.ini documentation --- docs/source/installing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 80689bc3ee5..6120973fb87 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -91,7 +91,7 @@ Using the stable code 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. -Create a new project and select one of the available boards. You can change after by changing the *platformio.ini* file. +Create a new project and select one of the available boards. You can change after by changing the `platformio.ini `_ file. - For ESP32