Sync dev-platforms

platformio · Aug 31, 2023 · 7299f77 · 7299f77
1 parent 5a20b88
commit 7299f77
Show file tree

Hide file tree

Showing 23 changed files with 5,940 additions and 0 deletions.
diff --git a/boards/espressif32/adafruit_matrixportal_esp32s3.rst b/boards/espressif32/adafruit_matrixportal_esp32s3.rst
@@ -0,0 +1,168 @@
+..  Copyright (c) 2014-present PlatformIO <[email protected]>
+    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_matrixportal_esp32s3:
+
+Adafruit MatrixPortal ESP32-S3
+==============================
+
+.. 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**
+    - 8MB
+  * - **RAM**
+    - 320KB
+  * - **Vendor**
+    - `Adafruit <https://www.adafruit.com/product/5778?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``adafruit_matrixportal_esp32s3`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:adafruit_matrixportal_esp32s3]
+  platform = espressif32
+  board = adafruit_matrixportal_esp32s3
+
+You can override default Adafruit MatrixPortal ESP32-S3 settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `adafruit_matrixportal_esp32s3.json <https://github.com/platformio/platform-espressif32/blob/master/boards/adafruit_matrixportal_esp32s3.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:adafruit_matrixportal_esp32s3]
+  platform = espressif32
+  board = adafruit_matrixportal_esp32s3
+
+  ; change microcontroller
+  board_build.mcu = esp32s3
+
+  ; change MCU frequency
+  board_build.f_cpu = 240000000L
+
+
+Uploading
+---------
+Adafruit MatrixPortal ESP32-S3 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:adafruit_matrixportal_esp32s3]
+  platform = espressif32
+  board = adafruit_matrixportal_esp32s3
+
+  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 MatrixPortal ESP32-S3 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
diff --git a/boards/espressif32/arduino_nano_esp32.rst b/boards/espressif32/arduino_nano_esp32.rst
@@ -0,0 +1,172 @@
+..  Copyright (c) 2014-present PlatformIO <[email protected]>
+    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_arduino_nano_esp32:
+
+Arduino Nano ESP32
+==================
+
+.. 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**
+    - `Arduino <https://docs.arduino.cc/hardware/nano-esp32?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``arduino_nano_esp32`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:arduino_nano_esp32]
+  platform = espressif32
+  board = arduino_nano_esp32
+
+You can override default Arduino Nano ESP32 settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `arduino_nano_esp32.json <https://github.com/platformio/platform-espressif32/blob/master/boards/arduino_nano_esp32.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:arduino_nano_esp32]
+  platform = espressif32
+  board = arduino_nano_esp32
+
+  ; change microcontroller
+  board_build.mcu = esp32s3
+
+  ; change MCU frequency
+  board_build.f_cpu = 240000000L
+
+
+Uploading
+---------
+Arduino Nano ESP32 supports the following uploading protocols:
+
+* ``cmsis-dap``
+* ``dfu``
+* ``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 ``dfu``
+
+You can change upload protocol using :ref:`projectconf_upload_protocol` option:
+
+.. code-block:: ini
+
+  [env:arduino_nano_esp32]
+  platform = espressif32
+  board = arduino_nano_esp32
+
+  upload_protocol = dfu
+
+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`.
+
+Arduino Nano ESP32 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
+  * - :ref:`debugging_tool_dfu`
+    - 
+    - 
+  * - ``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