Merge branch 'docs/esp_bsp' into 'master'

docs: Add information about BSPs

See merge request espressif/esp-idf!18096

docs/en/get-started/linux-macos-start-project.rst

@@ -72,3 +72,7 @@ You are using this menu to set up project specific variables, e.g., Wi-Fi networ
 .. note::
 
     The colors of the menu could be different in your terminal. You can change the appearance with the option ``--style``. Please run ``idf.py menuconfig --help`` for further information.
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    If you are using one of the supported development boards, you can speed up your development by using Board Support Package. See `Additional Tips <#additional-tips>`__ for more information.

docs/en/get-started/start-project.rst

@@ -378,3 +378,44 @@ Python compatibility
 ~~~~~~~~~~~~~~~~~~~~
 
 ESP-IDF supports Python 3.7 or newer. It is recommended to upgrade your operating system to a recent version satisfying this requirement. Other options include the installation of Python from `sources <https://www.python.org/downloads/>`_ or the use of a Python version management system such as `pyenv <https://github.com/pyenv/pyenv>`_.
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    ..
+        When adding new targets to the line above, please update this list in windows-start-project.rst and linux-macos-start-project.rst
+
+
+    Start with Board Support Package
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    To speed up prototyping on some development boards, you can use `Board Support Packages (BSPs) <https://github.com/espressif/esp-bsp>`_, which makes initialization of a particular board as easy as few function calls.
+
+    A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc.
+
+    The BSPs are distributed via `IDF Component Manager <../api-guides/tools/idf-component-manager>`_, so they can be found in `IDF Component Registry <https://components.espressif.com>`_.
+
+    .. only:: esp32
+
+        **Here's an example of how to add ESP-WROVER-KIT BSP to your project:**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp_wrover_kit 
+
+    .. only:: esp32s2
+
+        **Here's an example of how to add ESP32-S2-Kaluga-Kit BSP to your project:**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp32_s2_kaluga_kit
+
+    .. only:: esp32s3
+
+        **Here's an example of how to add ESP-BOX BSP to your project:**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp-box 
+
+    More examples of BSP usage can be found in `BSP examples folder <https://github.com/espressif/esp-bsp/tree/master/examples>`_.

docs/en/get-started/windows-start-project.rst

@@ -72,3 +72,7 @@ You are using this menu to set up project specific variables, e.g., Wi-Fi networ
 .. note::
 
     The colors of the menu could be different in your terminal. You can change the appearance with the option ``--style``. Please run ``idf.py menuconfig --help`` for further information.
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    If you are using one of the supported development boards, you can speed up your development by using Board Support Package. See `Additional Tips <#additional-tips>`__ for more information.

docs/en/hw-reference/esp32/get-started-wrover-kit.rst

@@ -422,6 +422,8 @@ Now to Development
 
 Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an example project onto your board.
 
+A Board Support Package can be found in `IDF Component Registry <https://components.espressif.com/component/espressif/esp_wrover_kit>`_.
+
 The application examples that use some hardware specific to your ESP-WROVER-KIT can be found below.
 
 * On-board LCD example: :example:`peripherals/spi_master/lcd`

docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst

@@ -224,6 +224,8 @@ Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-starte
 
 The programming guide and application examples for your ESP32-S2-Kaluga-1 kit can be found in `esp-dev-kits <https://github.com/espressif/esp-dev-kits/tree/master/esp32-s2-kaluga-1>`_ repository on GitHub.
 
+A Board Support Package can be found in `IDF Component Registry <https://components.espressif.com/component/espressif/esp32_s2_kaluga_kit>`_.
+
 
 Contents and Packaging
 ----------------------

docs/en/libraries-and-frameworks/libs-frameworks.rst

@@ -82,7 +82,7 @@ ESP-IoT-Solution includes:
 
 
 ESP-Protocols
-----------------
+-------------
 
 `ESP-Protocols <https://github.com/espressif/esp-protocols>`_ repository contains collection of protocol components for ESP-IDF. The code within the ESP-Protocols is organized into separate components, allowing them to be easily integrated into an ESP-IDF project. In addition to that, each component is available in `IDF Component Registry <https://components.espressif.com/>`_.
 
@@ -92,3 +92,8 @@ ESP-Protocols components:
 
 * `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation <https://espressif.github.io/esp-protocols/esp_websocket_client/index.html>`_.
 
+
+ESP-BSP
+-------
+
+`ESP-BSP <https://github.com/espressif/esp-bsp>`_ repository contains Board Support Packages (BSPs) for various Espressif's and 3rd party development boards. BSPs are useful for quick start on a supported board. Usually they contain pinout definition and helper functions, that will initialize peripherals for the specific board. Additionally, the BSP would contain drivers for external chips populated on the development board, such as sensors, displays, audio codecs etc.

docs/zh_CN/get-started/linux-macos-start-project.rst

@@ -72,3 +72,7 @@
 .. note::
 
     您终端窗口中显示出的菜单颜色可能会与上图不同。您可以通过选项 ``--style`` 来改变外观。请运行 ``idf.py menuconfig --help`` 命令，获取更多信息。
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    如果您使用的是支持的开发板，可以通过板级支持包 (BSP) 来协助您的开发。更多信息，请见 `其他提示 <#additional-tips>`__。

docs/zh_CN/get-started/start-project.rst

@@ -378,3 +378,44 @@
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ESP-IDF 支持 Python 3.7 及以上版本，建议升级操作系统到最新版本从而更新 Python。也可选择从 `sources <https://www.python.org/downloads/>`_ 安装最新版 Python，或使用 Python 管理系统如 `pyenv <https://github.com/pyenv/pyenv>`_ 对版本进行升级管理。
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    ..
+        当在上述行中添加新目标时，请同时更新 windows-start-project.rst 和 linux-macos-start-project.rst 中的列表。
+
+
+    上手板级支持包
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    您可以使用 `板级支持包 (BSP) <https://github.com/espressif/esp-bsp>`_，协助您在开发板上的原型开发。仅需要调用几个函数，便可以完成对特定开发板的初始化。
+
+    一般来说，BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外，BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。
+
+    BSP 通过 `IDF 组件管理器 <../api-guides/tools/idf-component-manager>`_ 发布，您可以前往 `IDF 组件注册器 <https://components.espressif.com>`_ 进行下载。
+
+    .. only:: esp32
+
+        **以下示例演示了如何将 ESP-WROVER-KIT BSP 添加到项目中：**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp_wrover_kit 
+
+    .. only:: esp32s2
+
+        **以下示例演示了如何将 ESP32-S2-Kaluga-Kit BSP 添加到项目中：**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp32_s2_kaluga_kit
+
+    .. only:: esp32s3
+
+        **以下示例演示了如何将 ESP-BOX BSP 添加到项目中：**
+        
+        .. code-block:: bash
+        
+            idf.py add-dependency esp-box 
+
+    更多有关使用 BSP 的示例，请前往 `BSP 示例文件夹 <https://github.com/espressif/esp-bsp/tree/master/examples>`_。

docs/zh_CN/get-started/windows-start-project.rst

@@ -72,3 +72,8 @@ Windows
 .. note::
 
     您终端窗口中显示出的菜单颜色可能会与上图不同。您可以通过选项 ``--style`` 来改变外观。请运行 ``idf.py menuconfig --help`` 命令，获取更多信息。
+
+.. only:: esp32 or esp32s2 or esp32s3
+
+    如果您使用的是支持的开发板，可以通过板级支持包 (BSP) 来协助您的开发。更多信息，请见 `其他提示 <#additional-tips>`__。
+    

docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst

@@ -422,6 +422,8 @@ USB 供电                   使能 UART 通信
 
 现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
 
+您可以在 `IDF 组件注册器 <https://components.espressif.com>`_ 中下载板级支持包 (BSP)。
+
 以下链接提供了与 ESP-WROVER-KIT 开发板硬件相关的示例：
 
 * 板上 LCD 示例：:example:`peripherals/spi_master/lcd`

docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst

@@ -224,6 +224,8 @@ ESP32-S2-Kaluga-1 上电前，请首先确认开发板完好无损。
 
 您还可以点击 `这里 <https://github.com/espressif/esp-dev-kits/tree/master/esp32-s2-kaluga-1>`_，获取有关 ESP32-S2-Kaluga-1 套件编程指南与应用示例的更多内容。
 
+您可以在 `IDF 组件注册器 <https://components.espressif.com>`_ 中下载板级支持包 (BSP)。
+
 
 内容和包装
 ----------