forked from espressif/arduino-esp32
Added more details about PlatformIO (#5540)
* Added more details about PlatformIO * Fixed typo
This commit is contained in:
BIN
docs/source/_static/logo_arduino.png
Normal file
BIN
docs/source/_static/logo_arduino.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
BIN
docs/source/_static/logo_pio.png
Normal file
BIN
docs/source/_static/logo_pio.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 25 KiB |
@ -66,6 +66,20 @@ Supported Operating Systems
|
||||
.. |linux-logo| image:: _static/logo_linux.png
|
||||
.. |macos-logo| image:: _static/logo_macos.png
|
||||
|
||||
Supported IDEs
|
||||
---------------------------
|
||||
|
||||
Here is the list of supported IDE for Arduino ESP32 support integration.
|
||||
|
||||
+-------------------+-------------------+
|
||||
| |arduino-logo| | |pio-logo| |
|
||||
+-------------------+-------------------+
|
||||
| Arduino IDE | PlatformIO |
|
||||
+-------------------+-------------------+
|
||||
|
||||
.. |arduino-logo| image:: _static/logo_arduino.png
|
||||
.. |pio-logo| image:: _static/logo_pio.png
|
||||
|
||||
See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
|
||||
|
||||
Support
|
||||
|
@ -7,13 +7,18 @@ This guide will show how to install the Arduino-ESP32 support.
|
||||
Before Installing
|
||||
-----------------
|
||||
|
||||
We recommend you install the support using the Boards Manager, but other options are available depending on your operating system.
|
||||
We recommend you install the support using your favorite IDE, but other options are available depending on your operating system.
|
||||
To install Arduino-ESP32 support, you can use one of the following options.
|
||||
|
||||
Installing using Boards Manager
|
||||
-------------------------------
|
||||
Installing using Arduino IDE
|
||||
----------------------------
|
||||
|
||||
This is the preferred and easiest way to install Arduino-ESP32.
|
||||
.. figure:: _static/logo_arduino.png
|
||||
:align: center
|
||||
:width: 200
|
||||
:figclass: align-center
|
||||
|
||||
This is the way to install Arduino-ESP32 directly from the Arduino IDE.
|
||||
|
||||
.. note::
|
||||
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:
|
||||
|
||||
- Restart Arduino IDE.
|
||||
|
||||
Windows
|
||||
-------
|
||||
Installing using PlatformIO
|
||||
---------------------------
|
||||
|
||||
.. figure:: _static/logo_pio.png
|
||||
:align: center
|
||||
: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).
|
||||
|
||||
To install PIO, you can follow this Getting Started, provided by PIO at `docs.platformio.org`_.
|
||||
|
||||
To test the latest Arduino ESP32, you need to change your project *platform.ini* accordingly.
|
||||
|
||||
- Start a new project and select one of the available board. You can change after by changing the *platform.ini* file.
|
||||
|
||||
- For ESP32
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[env:arduino-esp32]
|
||||
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
|
||||
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
|
||||
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)
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[env:arduino-esp32c3]
|
||||
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
|
||||
board = esp32-c3-devkitm-1
|
||||
framework = arduino
|
||||
platform_packages =
|
||||
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:
|
||||
|
||||
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_
|
||||
|
||||
- `PlatformIO Home <https://docs.platformio.org/en/latest/home/index.html>`_
|
||||
|
||||
- `Tutorials and Examples <https://docs.platformio.org/en/latest/tutorials/index.html>`_
|
||||
|
||||
- `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html>`_
|
||||
|
||||
|
||||
Windows (manual installation)
|
||||
-----------------------------
|
||||
|
||||
.. 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.
|
||||
|
||||
@ -150,6 +217,11 @@ How to update to the latest code
|
||||
Linux
|
||||
-----
|
||||
|
||||
.. figure:: _static/logo_linux.png
|
||||
:align: center
|
||||
:width: 200
|
||||
:figclass: align-center
|
||||
|
||||
Debian/Ubuntu
|
||||
*************
|
||||
|
||||
@ -263,20 +335,5 @@ Where ``~/Documents/Arduino`` represents your sketch book location as per "Ardui
|
||||
|
||||
- Restart Arduino IDE.
|
||||
|
||||
PlatformIO
|
||||
----------
|
||||
|
||||
- `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp32>`_
|
||||
|
||||
- `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp32>`_
|
||||
|
||||
- `PlatformIO Core <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp32>`_
|
||||
|
||||
- `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
|
||||
|
||||
- `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
|
||||
|
||||
- `Project Examples <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32#examples>`_
|
||||
|
||||
|
||||
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
|
||||
.. _docs.platformio.org: https://docs.platformio.org/en/latest/integration/ide/pioide.html
|
||||
|
Reference in New Issue
Block a user