Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new section about using ESP-IDF with PlatformIO (IDFGH-3111) #5132

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/platformio-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/en/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,6 @@ Related Documents
../api-guides/tools/idf-monitor
toolchain-setup-scratch
:esp32: ../get-started-legacy/index

valeros marked this conversation as resolved.
Show resolved Hide resolved
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
.. _Releases page: https://github.com/espressif/esp-idf/releases
10 changes: 10 additions & 0 deletions docs/en/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ Resources
*********
:link_to_translation:`zh_CN:[中文]`

.. toctree::
:caption: Third-Party Tools
:maxdepth: 2

third-party-tools/platformio


Useful Links
############

* The `esp32.com forum <https://esp32.com/>`_ is a place to ask questions and find community resources.

* Check the `Issues <https://github.com/espressif/esp-idf/issues>`_ section on GitHub if you find a bug or have a feature request. Please check existing `Issues <https://github.com/espressif/esp-idf/issues>`_ before opening a new one.
Expand Down
60 changes: 60 additions & 0 deletions docs/en/third-party-tools/platformio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. _platformio:

PlatformIO
##########

.. image:: ../../_static/platformio-logo.png
:target: https://platformio.org/?utm_source=docs.espressif.com

.. contents::
:local:

What is PlatformIO?
~~~~~~~~~~~~~~~~~~~

`PlatformIO <https://platformio.org/?utm_source=docs.espressif.com>`__
is a cross-platform embedded development environment with out-of-the-box support
for ESP-IDF.

Since ESP-IDF support within PlatformIO is not maintained by the Espressif team,
please report any issues with PlatformIO directly to its developers in
`the official PlatformIO repositories <https://github.com/platformio>`_.

A detailed overview of the PlatformIO ecosystem and its philosophy can be
found in `the official PlatformIO documentation <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=docs.espressif.com>`_.

Installation
~~~~~~~~~~~~

* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=docs.espressif.com>`_
is a toolset for embedded C/C++ development available on Windows, macOS and Linux
platforms
* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html?utm_source=docs.espressif.com>`_
is a command-line tool that consists of 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

Configuration
~~~~~~~~~~~~~

Please go through `the official PlatformIO configuration guide for ESP-IDF <https://docs.platformio.org/en/latest/frameworks/espidf.html?utm_source=docs.espressif.com#configuration>`_.

Tutorials
~~~~~~~~~

- `ESP-IDF and ESP32-DevKitC: debugging, unit testing, project analysis
<https://docs.platformio.org/en/latest/tutorials/espressif32/espidf_debugging_unit_testing_inspect.html?utm_source=docs.espressif.com>`__

Project Examples
~~~~~~~~~~~~~~~~

Please check ESP-IDF page in `the official PlatformIO documentation <https://docs.platformio.org/en/latest/frameworks/espidf.html?utm_source=docs.espressif.com#examples>`__

Next Steps
~~~~~~~~~~

Here are some useful links for exploring the PlatformIO ecosystem:

- Learn more about `integrations with other IDEs/Text Editors <https://docs.platformio.org/en/latest/integration/ide/index.html?utm_source=docs.espressif.com>`_
- Get help from `PlatformIO community <https://community.platformio.org/?utm_source=docs.espressif.com>`_
1 change: 1 addition & 0 deletions docs/zh_CN/third-party-tools/platformio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../en/third-party-tools/platformio.rst