Sync Docs platformio/platformio-core@591b377

platformio · Mar 29, 2024 · 1e682af · 1e682af
1 parent 0247cc7
commit 1e682af
Show file tree

Hide file tree

Showing 524 changed files with 8,778 additions and 5,507 deletions.
diff --git a/en/latest/_sources/boards/espressif32/adafruit_feather_esp32s2.rst.txt b/en/latest/_sources/boards/espressif32/adafruit_feather_esp32s2.rst.txt
@@ -0,0 +1,164 @@
+..  Copyright (c) 2014-present PlatformIO <contact@platformio.org>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _board_espressif32_adafruit_feather_esp32s2:
+
+Adafruit Feather ESP32-S2
+=========================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power system on a chip microcontrollers with integrated Wi-Fi and Bluetooth. ESP32 integrates an antenna switch, RF balun, power amplifier, low-noise receive amplifier, filters, and power management modules.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ESP32S2
+  * - **Frequency**
+    - 240MHz
+  * - **Flash**
+    - 4MB
+  * - **RAM**
+    - 320KB
+  * - **Vendor**
+    - `Adafruit <https://www.adafruit.com/product/5000?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``adafruit_feather_esp32s2`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:adafruit_feather_esp32s2]
+  platform = espressif32
+  board = adafruit_feather_esp32s2
+
+You can override default Adafruit Feather ESP32-S2 settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `adafruit_feather_esp32s2.json <https://github.com/platformio/platform-espressif32/blob/master/boards/adafruit_feather_esp32s2.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:adafruit_feather_esp32s2]
+  platform = espressif32
+  board = adafruit_feather_esp32s2
+
+  ; change microcontroller
+  board_build.mcu = esp32s2
+
+  ; change MCU frequency
+  board_build.f_cpu = 240000000L
+
+
+Uploading
+---------
+Adafruit Feather ESP32-S2 supports the following uploading protocols:
+
+* ``cmsis-dap``
+* ``esp-bridge``
+* ``esp-prog``
+* ``espota``
+* ``esptool``
+* ``iot-bus-jtag``
+* ``jlink``
+* ``minimodule``
+* ``olimex-arm-usb-ocd``
+* ``olimex-arm-usb-ocd-h``
+* ``olimex-arm-usb-tiny-h``
+* ``olimex-jtag-tiny``
+* ``tumpa``
+
+Default protocol is ``esptool``
+
+You can change upload protocol using :ref:`projectconf_upload_protocol` option:
+
+.. code-block:: ini
+
+  [env:adafruit_feather_esp32s2]
+  platform = espressif32
+  board = adafruit_feather_esp32s2
+
+  upload_protocol = esptool
+
+Debugging
+---------
+
+:ref:`piodebug` - "1-click" solution for debugging with a zero configuration.
+
+.. warning::
+    You will need to install debug tool drivers depending on your system.
+    Please click on compatible debug tool below for the further
+    instructions and configuration information.
+
+You can switch between debugging :ref:`debugging_tools` using
+:ref:`projectconf_debug_tool` option in :ref:`projectconf`.
+
+Adafruit Feather ESP32-S2 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.
+
+.. list-table::
+  :header-rows:  1
+
+  * - Compatible Tools
+    - On-board
+    - Default
+  * - :ref:`debugging_tool_cmsis-dap`
+    - 
+    - Yes
+  * - ``esp-bridge``
+    - 
+    - 
+  * - :ref:`debugging_tool_esp-prog`
+    - 
+    - 
+  * - :ref:`debugging_tool_iot-bus-jtag`
+    - 
+    - 
+  * - :ref:`debugging_tool_jlink`
+    - 
+    - 
+  * - :ref:`debugging_tool_minimodule`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-ocd`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-ocd-h`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-tiny-h`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-jtag-tiny`
+    - 
+    - 
+  * - :ref:`debugging_tool_tumpa`
+    - 
+    - 
+
+Frameworks
+----------
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Description
+
+    * - :ref:`framework_arduino`
+      - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
+
+    * - :ref:`framework_espidf`
+      - Espressif IoT Development Framework. Official development framework for ESP32 chip
diff --git a/en/latest/_sources/boards/espressif32/lilka_v2.rst.txt b/en/latest/_sources/boards/espressif32/lilka_v2.rst.txt
@@ -0,0 +1,168 @@
+..  Copyright (c) 2014-present PlatformIO <contact@platformio.org>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _board_espressif32_lilka_v2:
+
+Lilka v2
+========
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power system on a chip microcontrollers with integrated Wi-Fi and Bluetooth. ESP32 integrates an antenna switch, RF balun, power amplifier, low-noise receive amplifier, filters, and power management modules.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ESP32S3
+  * - **Frequency**
+    - 240MHz
+  * - **Flash**
+    - 16MB
+  * - **RAM**
+    - 320KB
+  * - **Vendor**
+    - `Anderson & friends <https://github.com/and3rson/lilka?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``lilka_v2`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:lilka_v2]
+  platform = espressif32
+  board = lilka_v2
+
+You can override default Lilka v2 settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `lilka_v2.json <https://github.com/platformio/platform-espressif32/blob/master/boards/lilka_v2.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:lilka_v2]
+  platform = espressif32
+  board = lilka_v2
+
+  ; change microcontroller
+  board_build.mcu = esp32s3
+
+  ; change MCU frequency
+  board_build.f_cpu = 240000000L
+
+
+Uploading
+---------
+Lilka v2 supports the following uploading protocols:
+
+* ``cmsis-dap``
+* ``esp-bridge``
+* ``esp-builtin``
+* ``esp-prog``
+* ``espota``
+* ``esptool``
+* ``iot-bus-jtag``
+* ``jlink``
+* ``minimodule``
+* ``olimex-arm-usb-ocd``
+* ``olimex-arm-usb-ocd-h``
+* ``olimex-arm-usb-tiny-h``
+* ``olimex-jtag-tiny``
+* ``tumpa``
+
+Default protocol is ``esptool``
+
+You can change upload protocol using :ref:`projectconf_upload_protocol` option:
+
+.. code-block:: ini
+
+  [env:lilka_v2]
+  platform = espressif32
+  board = lilka_v2
+
+  upload_protocol = esptool
+
+Debugging
+---------
+
+:ref:`piodebug` - "1-click" solution for debugging with a zero configuration.
+
+.. warning::
+    You will need to install debug tool drivers depending on your system.
+    Please click on compatible debug tool below for the further
+    instructions and configuration information.
+
+You can switch between debugging :ref:`debugging_tools` using
+:ref:`projectconf_debug_tool` option in :ref:`projectconf`.
+
+Lilka v2 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.
+
+.. list-table::
+  :header-rows:  1
+
+  * - Compatible Tools
+    - On-board
+    - Default
+  * - :ref:`debugging_tool_cmsis-dap`
+    - 
+    - Yes
+  * - ``esp-bridge``
+    - 
+    - 
+  * - ``esp-builtin``
+    - 
+    - 
+  * - :ref:`debugging_tool_esp-prog`
+    - 
+    - 
+  * - :ref:`debugging_tool_iot-bus-jtag`
+    - 
+    - 
+  * - :ref:`debugging_tool_jlink`
+    - 
+    - 
+  * - :ref:`debugging_tool_minimodule`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-ocd`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-ocd-h`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-arm-usb-tiny-h`
+    - 
+    - 
+  * - :ref:`debugging_tool_olimex-jtag-tiny`
+    - 
+    - 
+  * - :ref:`debugging_tool_tumpa`
+    - 
+    - 
+
+Frameworks
+----------
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Description
+
+    * - :ref:`framework_arduino`
+      - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
+
+    * - :ref:`framework_espidf`
+      - Espressif IoT Development Framework. Official development framework for ESP32 chip