Skip to content

Commit d1f0d6c

Browse files
authored
Added more details about PlatformIO (#5540)
* Added more details about PlatformIO * Fixed typo
1 parent bf58ab6 commit d1f0d6c

File tree

4 files changed

+93
-22
lines changed

4 files changed

+93
-22
lines changed

Diff for: docs/source/_static/logo_arduino.png

22.5 KB
Loading

Diff for: docs/source/_static/logo_pio.png

25.4 KB
Loading

Diff for: docs/source/getting_started.rst

+14
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,20 @@ Supported Operating Systems
6666
.. |linux-logo| image:: _static/logo_linux.png
6767
.. |macos-logo| image:: _static/logo_macos.png
6868

69+
Supported IDEs
70+
---------------------------
71+
72+
Here is the list of supported IDE for Arduino ESP32 support integration.
73+
74+
+-------------------+-------------------+
75+
| |arduino-logo| | |pio-logo| |
76+
+-------------------+-------------------+
77+
| Arduino IDE | PlatformIO |
78+
+-------------------+-------------------+
79+
80+
.. |arduino-logo| image:: _static/logo_arduino.png
81+
.. |pio-logo| image:: _static/logo_pio.png
82+
6983
See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
7084

7185
Support

Diff for: docs/source/installing.rst

+79-22
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,18 @@ This guide will show how to install the Arduino-ESP32 support.
77
Before Installing
88
-----------------
99

10-
We recommend you install the support using the Boards Manager, but other options are available depending on your operating system.
10+
We recommend you install the support using your favorite IDE, but other options are available depending on your operating system.
1111
To install Arduino-ESP32 support, you can use one of the following options.
1212

13-
Installing using Boards Manager
14-
-------------------------------
13+
Installing using Arduino IDE
14+
----------------------------
1515

16-
This is the preferred and easiest way to install Arduino-ESP32.
16+
.. figure:: _static/logo_arduino.png
17+
:align: center
18+
:width: 200
19+
:figclass: align-center
20+
21+
This is the way to install Arduino-ESP32 directly from the Arduino IDE.
1722

1823
.. note::
1924
For overview of SoC's support, take a look on `Supported Soc's table <https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#supported-soc-s>`_ where you can find if the particular chip is under stable or development release.
@@ -58,8 +63,70 @@ To start the installation process using the Boards Managaer, follow these steps:
5863

5964
- Restart Arduino IDE.
6065

61-
Windows
62-
-------
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 one of most popular embedded development tool. Currently, it supports Arduino ESP32 and ESP-IDF from Espressif (other platforms are also supported).
75+
76+
To install PIO, you can follow this Getting Started, provided by PIO at `docs.platformio.org`_.
77+
78+
To test the latest Arduino ESP32, you need to change your project *platform.ini* accordingly.
79+
80+
- Start a new project and select one of the available board. You can change after by changing the *platform.ini* file.
81+
82+
- For ESP32
83+
84+
.. code-block:: bash
85+
86+
[env:arduino-esp32]
87+
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
88+
board = esp32dev
89+
framework = arduino
90+
platform_packages =
91+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
92+
93+
- For ESP32-S2 (ESP32-S2-Saola-1 board)
94+
95+
.. code-block:: bash
96+
97+
[env:arduino-esp32s2]
98+
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
99+
board = esp32-s2-saola-1
100+
framework = arduino
101+
platform_packages =
102+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
103+
104+
- For ESP32-C3 (ESP32-S3-DevKitM-1 board)
105+
106+
.. code-block:: bash
107+
108+
[env:arduino-esp32c3]
109+
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
110+
board = esp32-c3-devkitm-1
111+
framework = arduino
112+
platform_packages =
113+
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
114+
115+
Now you're able to use the latest Arduino ESP32 support directly from Espressif GitHub repository.
116+
117+
To get more information about PlatformIO, see the following links:
118+
119+
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_
120+
121+
- `PlatformIO Home <https://docs.platformio.org/en/latest/home/index.html>`_
122+
123+
- `Tutorials and Examples <https://docs.platformio.org/en/latest/tutorials/index.html>`_
124+
125+
- `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html>`_
126+
127+
128+
Windows (manual installation)
129+
-----------------------------
63130

64131
.. warning:: Arduino ESP32 core v2.x.x cannot be used on Windows 8.x x86 (32 bits), Windows 7 or earlier. The Windows 32 bits OS is no longer supported by this toolchain.
65132

@@ -150,6 +217,11 @@ How to update to the latest code
150217
Linux
151218
-----
152219

220+
.. figure:: _static/logo_linux.png
221+
:align: center
222+
:width: 200
223+
:figclass: align-center
224+
153225
Debian/Ubuntu
154226
*************
155227

@@ -263,20 +335,5 @@ Where ``~/Documents/Arduino`` represents your sketch book location as per "Ardui
263335

264336
- Restart Arduino IDE.
265337

266-
PlatformIO
267-
----------
268-
269-
- `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp32>`_
270-
271-
- `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp32>`_
272-
273-
- `PlatformIO Core <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp32>`_
274-
275-
- `Advanced usage <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32>`_: Custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
276-
277-
- `Integration with Cloud and Standalone IDEs <https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp32>`_: Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
278-
279-
- `Project Examples <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32#examples>`_
280-
281-
282338
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
339+
.. _docs.platformio.org: https://docs.platformio.org/en/latest/integration/ide/pioide.html

0 commit comments

Comments
 (0)