Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed Jan 10, 2024
1 parent b8fd1e7 commit ad61e74
Show file tree
Hide file tree
Showing 2,005 changed files with 86,412 additions and 57,325 deletions.
26 changes: 14 additions & 12 deletions en/stable/404.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Page not found &mdash; PlatformIO v6.1 documentation</title>
<link rel="stylesheet" href="/en/latest/_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="/en/latest/_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="/en/latest/_static/copybutton.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="/en/latest/_static/pygments.css?v=266695fe" />
<link rel="stylesheet" type="text/css" href="/en/latest/_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="/en/latest/_static/copybutton.css?v=76b2166b" />


<link rel="shortcut icon" href="/en/latest/_static/favicon.ico"/>
<link rel="canonical" href="https://docs.platformio.org/404.html" />
<!--[if lt IE 9]>
<script src="/en/latest/_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="/en/latest/_static/jquery.js"></script>
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="#" id="documentation_options" src="/en/latest/_static/documentation_options.js"></script>
<script src="/en/latest/_static/doctools.js"></script>
<script src="/en/latest/_static/sphinx_highlight.js"></script>
<script src="/en/latest/_static/clipboard.min.js"></script>
<script src="/en/latest/_static/copybutton.js"></script>
<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=dc17a79d"></script>
<script src="/en/latest/_static/doctools.js?v=888ff710"></script>
<script src="/en/latest/_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="/en/latest/_static/clipboard.min.js?v=a7894cd8"></script>
<script src="/en/latest/_static/copybutton.js?v=f281be69"></script>
<script src="/en/latest/_static/js/theme.js"></script>
<link rel="index" title="Index" href="/en/latest/genindex.html" />
<link rel="search" title="Search" href="/en/latest/search.html" />
Expand Down Expand Up @@ -248,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.11 (stable)
v6.1.12 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ PVS-Studio
==========

**PVS-Studio** is a static code analysis tool for detecting bugs and security weaknesses
in the source code of programs, written in C, C++, C# and Java. It analyze source code
in the source code of programs, written in C, C++, C# and Java. It analyzes source code
intended for 32-bit, 64-bit and embedded ARM platforms.
Official page can be found `here <https://www.viva64.com/en/pvs-studio/>`__.
The official page can be found `here <https://www.viva64.com/en/pvs-studio/>`__.

.. contents:: Contents
:local:
Expand Down
103 changes: 103 additions & 0 deletions en/stable/_sources/boards/atmelavr/uno_mini.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
.. 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_atmelavr_uno_mini:

Arduino Uno Mini
================

.. contents::

Hardware
--------

Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industry's most code-efficient architecture for C and assembly programming

.. list-table::

* - **Microcontroller**
- ATMEGA328P
* - **Frequency**
- 16MHz
* - **Flash**
- 31.50KB
* - **RAM**
- 2KB
* - **Vendor**
- `Arduino <https://store.arduino.cc/products/uno-mini-le?utm_source=platformio.org&utm_medium=docs>`__


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

Please use ``uno_mini`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:

.. code-block:: ini
[env:uno_mini]
platform = atmelavr
board = uno_mini
You can override default Arduino Uno Mini settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `uno_mini.json <https://github.com/platformio/platform-atmelavr/blob/master/boards/uno_mini.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini
[env:uno_mini]
platform = atmelavr
board = uno_mini
; change microcontroller
board_build.mcu = atmega328p
; change MCU frequency
board_build.f_cpu = 16000000L
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 Uno Mini 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_avr-stub`
-
- Yes
* - :ref:`debugging_tool_simavr`
-
-

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.
Original file line number Diff line number Diff line change
@@ -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_4d_systems_esp32s3_gen4_r8n16:

4D Systems GEN4-ESP32 16MB (ESP32S3-R8N16)
==========================================

.. 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**
- `4D Systems <https://4dsystems.com.au/products?utm_source=platformio.org&utm_medium=docs>`__


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

Please use ``4d_systems_esp32s3_gen4_r8n16`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:

.. code-block:: ini
[env:4d_systems_esp32s3_gen4_r8n16]
platform = espressif32
board = 4d_systems_esp32s3_gen4_r8n16
You can override default 4D Systems GEN4-ESP32 16MB (ESP32S3-R8N16) settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `4d_systems_esp32s3_gen4_r8n16.json <https://github.com/platformio/platform-espressif32/blob/master/boards/4d_systems_esp32s3_gen4_r8n16.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini
[env:4d_systems_esp32s3_gen4_r8n16]
platform = espressif32
board = 4d_systems_esp32s3_gen4_r8n16
; change microcontroller
board_build.mcu = esp32s3
; change MCU frequency
board_build.f_cpu = 240000000L
Uploading
---------
4D Systems GEN4-ESP32 16MB (ESP32S3-R8N16) 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:4d_systems_esp32s3_gen4_r8n16]
platform = espressif32
board = 4d_systems_esp32s3_gen4_r8n16
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`.

4D Systems GEN4-ESP32 16MB (ESP32S3-R8N16) 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
Loading

0 comments on commit ad61e74

Please sign in to comment.