Sync Docs platformio/platformio-core@fe2fd5e

platformio · Dec 2, 2024 · ff9d92d · ff9d92d
1 parent d15d803
commit ff9d92d
Show file tree

Hide file tree

Showing 597 changed files with 6,000 additions and 1,295 deletions.
diff --git a/en/latest/_sources/boards/espressif32/weactstudio_esp32c3coreboard.rst.txt b/en/latest/_sources/boards/espressif32/weactstudio_esp32c3coreboard.rst.txt
@@ -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_weactstudio_esp32c3coreboard:
+
+WeAct Studio ESP32C3CoreBoard
+=============================
+
+.. 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**
+    - ESP32C3
+  * - **Frequency**
+    - 160MHz
+  * - **Flash**
+    - 384KB
+  * - **RAM**
+    - 400KB
+  * - **Vendor**
+    - `WeAct Studio <https://github.com/WeActStudio/WeActStudio.ESP32C3CoreBoard?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``weactstudio_esp32c3coreboard`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:weactstudio_esp32c3coreboard]
+  platform = espressif32
+  board = weactstudio_esp32c3coreboard
+
+You can override default WeAct Studio ESP32C3CoreBoard settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `weactstudio_esp32c3coreboard.json <https://github.com/platformio/platform-espressif32/blob/master/boards/weactstudio_esp32c3coreboard.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:weactstudio_esp32c3coreboard]
+  platform = espressif32
+  board = weactstudio_esp32c3coreboard
+
+  ; change microcontroller
+  board_build.mcu = esp32c3
+
+  ; change MCU frequency
+  board_build.f_cpu = 160000000L
+
+
+Uploading
+---------
+WeAct Studio ESP32C3CoreBoard 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:weactstudio_esp32c3coreboard]
+  platform = espressif32
+  board = weactstudio_esp32c3coreboard
+
+  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`.
+
+WeAct Studio ESP32C3CoreBoard 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/en/latest/_sources/boards/index.rst.txt b/en/latest/_sources/boards/index.rst.txt
@@ -671,6 +671,7 @@ Espressif 32
     espressif32/lolin_s3_pro
     espressif32/lolin32
     espressif32/lolin32_lite
+    espressif32/weactstudio_esp32c3coreboard
     espressif32/wemosbat
     espressif32/widora-air
     espressif32/wt32-eth01
@@ -1408,6 +1409,8 @@ ST STM32
     ststm32/rak811_tracker
     ststm32/rak811_tracker_32
     ststm32/rhf76_052
+    ststm32/rymcu_nebulapi_f103ve
+    ststm32/rymcu_f407ve
     ststm32/cloud_jam
     ststm32/cloud_jam_l4
     ststm32/disco_f334c8

diff --git a/en/latest/_sources/boards/renesas-ra/uno_r4_wifi.rst.txt b/en/latest/_sources/boards/renesas-ra/uno_r4_wifi.rst.txt
@@ -97,7 +97,7 @@ Debugging
 You can switch between debugging :ref:`debugging_tools` using
 :ref:`projectconf_debug_tool` option in :ref:`projectconf`.
 
-Arduino Uno R4 WiFi 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.
+Arduino Uno R4 WiFi has on-board debug probe and **IS READY** for debugging. You don't need to use/buy external debug probe.
 
 .. list-table::
   :header-rows:  1
@@ -106,7 +106,7 @@ Arduino Uno R4 WiFi does not have on-board debug probe and **IS NOT READY** for
     - On-board
     - Default
   * - :ref:`debugging_tool_cmsis-dap`
-    - 
+    - Yes
     - Yes
   * - :ref:`debugging_tool_jlink`
     - 

diff --git a/en/latest/_sources/boards/ststm32/nucleo_f439zi.rst.txt b/en/latest/_sources/boards/ststm32/nucleo_f439zi.rst.txt
@@ -30,9 +30,9 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
   * - **Flash**
     - 2MB
   * - **RAM**
-    - 256KB
+    - 192KB
   * - **Vendor**
-    - `ST <https://developer.mbed.org/platforms/ST-Nucleo-F439ZI/?utm_source=platformio.org&utm_medium=docs>`__
+    - `ST <https://www.st.com/en/evaluation-tools/nucleo-f439zi.html?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration
@@ -128,6 +128,9 @@ Frameworks
     * - 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_cmsis`
       - Vendor-independent hardware abstraction layer for the Cortex-M processor series
 

diff --git a/en/latest/_sources/boards/ststm32/nucleo_u575zi_q.rst.txt b/en/latest/_sources/boards/ststm32/nucleo_u575zi_q.rst.txt
@@ -129,4 +129,7 @@ Frameworks
       - 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.
+      - 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_mbed`
+      - Arm Mbed OS is a platform operating system designed for the internet of things
diff --git a/en/latest/_sources/boards/ststm32/rymcu_f407ve.rst.txt b/en/latest/_sources/boards/ststm32/rymcu_f407ve.rst.txt
@@ -0,0 +1,142 @@
+..  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_ststm32_rymcu_f407ve:
+
+RYMCU STM32F407VE (192k RAM. 512k Flash)
+========================================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - STM32F407VET6
+  * - **Frequency**
+    - 168MHz
+  * - **Flash**
+    - 502.23KB
+  * - **RAM**
+    - 128KB
+  * - **Vendor**
+    - `RYMCU <https://rymcu.com/products?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``rymcu_f407ve`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:rymcu_f407ve]
+  platform = ststm32
+  board = rymcu_f407ve
+
+You can override default RYMCU STM32F407VE (192k RAM. 512k Flash) settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `rymcu_f407ve.json <https://github.com/platformio/platform-ststm32/blob/master/boards/rymcu_f407ve.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:rymcu_f407ve]
+  platform = ststm32
+  board = rymcu_f407ve
+
+  ; change microcontroller
+  board_build.mcu = stm32f407vet6
+
+  ; change MCU frequency
+  board_build.f_cpu = 168000000L
+
+
+Uploading
+---------
+RYMCU STM32F407VE (192k RAM. 512k Flash) supports the following uploading protocols:
+
+* ``blackmagic``
+* ``cmsis-dap``
+* ``dfu``
+* ``jlink``
+* ``serial``
+* ``stlink``
+
+Default protocol is ``stlink``
+
+You can change upload protocol using :ref:`projectconf_upload_protocol` option:
+
+.. code-block:: ini
+
+  [env:rymcu_f407ve]
+  platform = ststm32
+  board = rymcu_f407ve
+
+  upload_protocol = stlink
+
+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`.
+
+RYMCU STM32F407VE (192k RAM. 512k Flash) 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_blackmagic`
+    - 
+    - 
+  * - :ref:`debugging_tool_cmsis-dap`
+    - 
+    - 
+  * - :ref:`debugging_tool_jlink`
+    - 
+    - 
+  * - :ref:`debugging_tool_stlink`
+    - 
+    - Yes
+
+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_cmsis`
+      - Vendor-independent hardware abstraction layer for the Cortex-M processor series
+
+    * - :ref:`framework_libopencm3`
+      - The libopencm3 project aims to create an open-source firmware library for various ARM Cortex-M microcontrollers.
+
+    * - :ref:`framework_stm32cube`
+      - STM32Cube embedded software libraries, including: The HAL hardware abstraction layer, enabling portability between different STM32 devices via standardized API calls; The Low-Layer (LL) APIs, a light-weight, optimized, expert oriented set of APIs designed for both performance and runtime efficiency