Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed Sep 26, 2024
1 parent 95504af commit 11dbb1f
Show file tree
Hide file tree
Showing 2,177 changed files with 15,847 additions and 9,479 deletions.
6 changes: 3 additions & 3 deletions en/stable/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="/en/latest/_static/jquery.js?v=5d32c60e"></script>
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="/en/latest/_static/documentation_options.js?v=179e3750"></script>
<script src="/en/latest/_static/documentation_options.js?v=2066bd3a"></script>
<script src="/en/latest/_static/doctools.js?v=9a2dae69"></script>
<script src="/en/latest/_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="/en/latest/_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -66,7 +66,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="/en/latest/projectconf/index.html">platformio.ini</a></li>
<li class="toctree-l1"><a class="reference internal" href="/en/latest/projectconf/build_configurations.html">Build Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="/en/latest/envvars.html">Environment variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="/en/latest/envvars.html">Environment Variables</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Instruments</span></p>
<ul>
Expand Down Expand Up @@ -250,7 +250,7 @@ <h1>Page not found</h1>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.15 (stable)
v6.1.16 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power s
* - **Flash**
- 8MB
* - **RAM**
- 512KB
- 320KB
* - **Vendor**
- `Espressif <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html?utm_source=platformio.org&utm_medium=docs>`__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
See the License for the specific language governing permissions and
limitations under the License.
.. _board_espressif32_briki_abc_esp32:
.. _board_espressif32_esp32s3_powerfeather:

Briki ABC (MBC-WB) - ESP32
==========================
ESP32-S3 PowerFeather
=====================

.. contents::

Expand All @@ -24,74 +24,76 @@ Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power s
.. list-table::

* - **Microcontroller**
- ESP32
- ESP32S3
* - **Frequency**
- 240MHz
* - **Flash**
- 3.25MB
- 8MB
* - **RAM**
- 320KB
* - **Vendor**
- `meteca <https://briki.org?utm_source=platformio.org&utm_medium=docs>`__
- `PowerFeather <https://powerfeather.dev/?utm_source=platformio.org&utm_medium=docs>`__


Configuration
-------------

Please use ``briki_abc_esp32`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
Please use ``esp32s3_powerfeather`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:

.. code-block:: ini
[env:briki_abc_esp32]
[env:esp32s3_powerfeather]
platform = espressif32
board = briki_abc_esp32
board = esp32s3_powerfeather
You can override default Briki ABC (MBC-WB) - ESP32 settings per build environment using
You can override default ESP32-S3 PowerFeather settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `briki_abc_esp32.json <https://github.com/platformio/platform-espressif32/blob/master/boards/briki_abc_esp32.json>`_. For example,
board manifest `esp32s3_powerfeather.json <https://github.com/platformio/platform-espressif32/blob/master/boards/esp32s3_powerfeather.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini
[env:briki_abc_esp32]
[env:esp32s3_powerfeather]
platform = espressif32
board = briki_abc_esp32
board = esp32s3_powerfeather
; change microcontroller
board_build.mcu = esp32
board_build.mcu = esp32s3
; change MCU frequency
board_build.f_cpu = 240000000L
Uploading
---------
Briki ABC (MBC-WB) - ESP32 supports the following uploading protocols:
ESP32-S3 PowerFeather supports the following uploading protocols:

* ``cmsis-dap``
* ``esp-bridge``
* ``esp-builtin``
* ``esp-prog``
* ``espota``
* ``esptool``
* ``iot-bus-jtag``
* ``jlink``
* ``mbctool``
* ``minimodule``
* ``olimex-arm-usb-ocd``
* ``olimex-arm-usb-ocd-h``
* ``olimex-arm-usb-tiny-h``
* ``olimex-jtag-tiny``
* ``tumpa``

Default protocol is ``mbctool``
Default protocol is ``esptool``

You can change upload protocol using :ref:`projectconf_upload_protocol` option:

.. code-block:: ini
[env:briki_abc_esp32]
[env:esp32s3_powerfeather]
platform = espressif32
board = briki_abc_esp32
board = esp32s3_powerfeather
upload_protocol = mbctool
upload_protocol = esptool
Debugging
---------
Expand All @@ -106,7 +108,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Briki ABC (MBC-WB) - 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.
ESP32-S3 PowerFeather 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
Expand All @@ -120,6 +122,9 @@ Briki ABC (MBC-WB) - ESP32 does not have on-board debug probe and **IS NOT READY
* - ``esp-bridge``
-
-
* - ``esp-builtin``
-
-
* - :ref:`debugging_tool_esp-prog`
-
-
Expand Down Expand Up @@ -157,4 +162,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_espidf`
- Espressif IoT Development Framework. Official development framework for ESP32 chip
102 changes: 102 additions & 0 deletions en/stable/_sources/boards/espressif32/m5stack-core-esp32-16M.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.. 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_m5stack-core-esp32-16M:

M5Stack Core ESP32 16M
======================

.. 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**
- ESP32
* - **Frequency**
- 240MHz
* - **Flash**
- 16MB
* - **RAM**
- 520KB
* - **Vendor**
- `M5Stack <http://www.m5stack.com?utm_source=platformio.org&utm_medium=docs>`__


Configuration
-------------

Please use ``m5stack-core-esp32-16M`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:

.. code-block:: ini
[env:m5stack-core-esp32-16M]
platform = espressif32
board = m5stack-core-esp32-16M
You can override default M5Stack Core ESP32 16M settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `m5stack-core-esp32-16M.json <https://github.com/platformio/platform-espressif32/blob/master/boards/m5stack-core-esp32-16M.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini
[env:m5stack-core-esp32-16M]
platform = espressif32
board = m5stack-core-esp32-16M
; change microcontroller
board_build.mcu = esp32
; change MCU frequency
board_build.f_cpu = 240000000L
Uploading
---------
M5Stack Core ESP32 16M supports the following uploading protocols:

* ``espota``
* ``esptool``

Default protocol is ``esptool``

You can change upload protocol using :ref:`projectconf_upload_protocol` option:

.. code-block:: ini
[env:m5stack-core-esp32-16M]
platform = espressif32
board = m5stack-core-esp32-16M
upload_protocol = esptool
Debugging
---------
:ref:`piodebug` currently does not support M5Stack Core ESP32 16M board.

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
Loading

0 comments on commit 11dbb1f

Please sign in to comment.