Skip to content

Commit fe25dcf

Browse files
ivankravetsivankravets
committed
1 parent 482eca0 commit fe25dcf

File tree

1,971 files changed

+59783
-50583
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,971 files changed

+59783
-50583
lines changed

‎en/stable/404.html

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
1+
2+
13
<!DOCTYPE html>
24
<html class="writer-html5" lang="en" data-content_root="./">
35
<head>
46
<meta charset="utf-8" />
7+
<!-- Google tag (gtag.js) -->
8+
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LQZCKGZE94"></script>
9+
<script>
10+
window.dataLayer = window.dataLayer || [];
11+
function gtag(){dataLayer.push(arguments);}
12+
gtag('js', new Date());
13+
gtag('config', 'G-LQZCKGZE94');
14+
</script>
15+
516
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
617
<title>Page not found &mdash; PlatformIO v6.1 documentation</title>
7-
<link rel="stylesheet" type="text/css" href="/en/latest/_static/pygments.css?v=266695fe" />
8-
<link rel="stylesheet" type="text/css" href="/en/latest/_static/css/theme.css?v=19f00094" />
18+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/pygments.css?v=3ba690ee" />
19+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/css/theme.css?v=e59714d7" />
920
<link rel="stylesheet" type="text/css" href="/en/latest/_static/copybutton.css?v=76b2166b" />
1021

1122

1223
<link rel="shortcut icon" href="/en/latest/_static/favicon.ico"/>
1324
<link rel="canonical" href="https://docs.platformio.org/404.html" />
14-
<!--[if lt IE 9]>
15-
<script src="/en/latest/_static/js/html5shiv.min.js"></script>
16-
<![endif]-->
17-
18-
<script src="/en/latest/_static/jquery.js?v=5d32c60e"></script>
19-
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="/en/latest/_static/documentation_options.js?v=2066bd3a"></script>
21-
<script src="/en/latest/_static/doctools.js?v=9a2dae69"></script>
22-
<script src="/en/latest/_static/sphinx_highlight.js?v=dc90522c"></script>
23-
<script src="/en/latest/_static/clipboard.min.js?v=a7894cd8"></script>
24-
<script src="/en/latest/_static/copybutton.js?v=f281be69"></script>
25+
<script src="/en/latest/_static/jquery.js?v=5d32c60e"></script>
26+
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27+
<script src="/en/latest/_static/documentation_options.js?v=841e3923"></script>
28+
<script src="/en/latest/_static/doctools.js?v=9bcbadda"></script>
29+
<script src="/en/latest/_static/sphinx_highlight.js?v=dc90522c"></script>
30+
<script src="/en/latest/_static/clipboard.min.js?v=a7894cd8"></script>
31+
<script src="/en/latest/_static/copybutton.js?v=f281be69"></script>
2532
<script src="/en/latest/_static/js/theme.js"></script>
2633
<link rel="index" title="Index" href="/en/latest/genindex.html" />
2734
<link rel="search" title="Search" href="/en/latest/search.html" />
@@ -250,7 +257,7 @@ <h1>Page not found</h1>
250257
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
251258
<span class="rst-current-version" data-toggle="rst-current-version">
252259
<span class="fa fa-book"> Documentation</span>
253-
v6.1.16 (stable)
260+
v6.1.17 (stable)
254261
<span class="fa fa-caret-down"></span>
255262
</span>
256263
<div class="rst-other-versions">
@@ -283,18 +290,7 @@ <h1>Page not found</h1>
283290
jQuery(function () {
284291
SphinxRtdTheme.Navigation.enable(true);
285292
});
286-
</script>
287-
<!-- Theme Analytics -->
288-
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LQZCKGZE94"></script>
289-
<script>
290-
window.dataLayer = window.dataLayer || [];
291-
function gtag(){dataLayer.push(arguments);}
292-
gtag('js', new Date());
293-
294-
gtag('config', 'G-LQZCKGZE94', {
295-
'anonymize_ip': false,
296-
});
297-
</script>
293+
</script>
298294

299295
</body>
300296
</html>

‎en/stable/_sources/advanced/unit-testing/frameworks/custom/runner.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ let's override a "testing" stage for the :ref:`unit_testing_frameworks_unity`:
5151
# 1. Gather test results from Serial, HTTP, Socket, or other sources
5252
# 2. Report test results (add cases)
5353
54-
# Exmaple: Report succeed result with duration (optional)
54+
# Example: Report succeed result with duration (optional)
5555
self.test_suite.add_case(
5656
TestCase(name="test_connectivity", status=TestStatus.PASSED, duration=1.34)
5757
)
@@ -65,7 +65,7 @@ let's override a "testing" stage for the :ref:`unit_testing_frameworks_unity`:
6565
stdout="test/test_desktop/test_calculator.cpp:43:test_calculator_division:FAIL: Expected 32 Was 33",
6666
duration=0.44,
6767
source=TestCaseSource(
68-
file="test/test_desktop/test_calculator.cpp", line=43
68+
filename="test/test_desktop/test_calculator.cpp", line=43
6969
),
7070
)
7171
)

‎en/stable/_sources/boards/atmelsam/adafruit_metro_m0.rst.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
1212
.. _board_atmelsam_adafruit_metro_m0:
1313

14-
Adafruit Metro M0 Expresss
15-
==========================
14+
Adafruit Metro M0 Express
15+
=========================
1616

1717
.. contents::
1818

@@ -46,7 +46,7 @@ Please use ``adafruit_metro_m0`` ID for :ref:`projectconf_env_board` option in :
4646
platform = atmelsam
4747
board = adafruit_metro_m0
4848
49-
You can override default Adafruit Metro M0 Expresss settings per build environment using
49+
You can override default Adafruit Metro M0 Express settings per build environment using
5050
``board_***`` option, where ``***`` is a JSON object path from
5151
board manifest `adafruit_metro_m0.json <https://github.com/platformio/platform-atmelsam/blob/master/boards/adafruit_metro_m0.json>`_. For example,
5252
``board_build.mcu``, ``board_build.f_cpu``, etc.
@@ -66,7 +66,7 @@ board manifest `adafruit_metro_m0.json <https://github.com/platformio/platform-a
6666
6767
Uploading
6868
---------
69-
Adafruit Metro M0 Expresss supports the following uploading protocols:
69+
Adafruit Metro M0 Express supports the following uploading protocols:
7070

7171
* ``atmel-ice``
7272
* ``blackmagic``
@@ -98,7 +98,7 @@ Debugging
9898
You can switch between debugging :ref:`debugging_tools` using
9999
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.
100100

101-
Adafruit Metro M0 Expresss 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.
101+
Adafruit Metro M0 Express 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.
102102

103103
.. list-table::
104104
:header-rows: 1
@@ -107,14 +107,14 @@ Adafruit Metro M0 Expresss does not have on-board debug probe and **IS NOT READY
107107
- On-board
108108
- Default
109109
* - :ref:`debugging_tool_atmel-ice`
110-
-
110+
-
111111
- Yes
112112
* - :ref:`debugging_tool_blackmagic`
113-
-
114-
-
113+
-
114+
-
115115
* - :ref:`debugging_tool_jlink`
116-
-
117-
-
116+
-
117+
-
118118

119119
Frameworks
120120
----------

‎en/stable/_sources/boards/espressif32/freenove_esp32_s3_wroom.rst.txt

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
.. Copyright (c) 2014-present PlatformIO <contact@platformio.org>
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
Unless required by applicable law or agreed to in writing, software
7+
distributed under the License is distributed on an "AS IS" BASIS,
8+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
See the License for the specific language governing permissions and
10+
limitations under the License.
11+
12+
.. _board_espressif32_freenove_esp32_s3_wroom:
13+
14+
Freenove ESP32-S3 WROOM N8R8 (8MB Flash / 8MB PSRAM)
15+
====================================================
16+
17+
.. contents::
18+
19+
Hardware
20+
--------
21+
22+
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.
23+
24+
.. list-table::
25+
26+
* - **Microcontroller**
27+
- ESP32S3
28+
* - **Frequency**
29+
- 240MHz
30+
* - **Flash**
31+
- 8MB
32+
* - **RAM**
33+
- 320KB
34+
* - **Vendor**
35+
- `Freenove <https://github.com/Freenove/Freenove_ESP32_S3_WROOM_Board?utm_source=platformio.org&utm_medium=docs>`__
36+
37+
38+
Configuration
39+
-------------
40+
41+
Please use ``freenove_esp32_s3_wroom`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
42+
43+
.. code-block:: ini
44+
45+
[env:freenove_esp32_s3_wroom]
46+
platform = espressif32
47+
board = freenove_esp32_s3_wroom
48+
49+
You can override default Freenove ESP32-S3 WROOM N8R8 (8MB Flash / 8MB PSRAM) settings per build environment using
50+
``board_***`` option, where ``***`` is a JSON object path from
51+
board manifest `freenove_esp32_s3_wroom.json <https://github.com/platformio/platform-espressif32/blob/master/boards/freenove_esp32_s3_wroom.json>`_. For example,
52+
``board_build.mcu``, ``board_build.f_cpu``, etc.
53+
54+
.. code-block:: ini
55+
56+
[env:freenove_esp32_s3_wroom]
57+
platform = espressif32
58+
board = freenove_esp32_s3_wroom
59+
60+
; change microcontroller
61+
board_build.mcu = esp32s3
62+
63+
; change MCU frequency
64+
board_build.f_cpu = 240000000L
65+
66+
67+
Uploading
68+
---------
69+
Freenove ESP32-S3 WROOM N8R8 (8MB Flash / 8MB PSRAM) supports the following uploading protocols:
70+
71+
* ``cmsis-dap``
72+
* ``esp-bridge``
73+
* ``esp-builtin``
74+
* ``esp-prog``
75+
* ``espota``
76+
* ``esptool``
77+
* ``iot-bus-jtag``
78+
* ``jlink``
79+
* ``minimodule``
80+
* ``olimex-arm-usb-ocd``
81+
* ``olimex-arm-usb-ocd-h``
82+
* ``olimex-arm-usb-tiny-h``
83+
* ``olimex-jtag-tiny``
84+
* ``tumpa``
85+
86+
Default protocol is ``esptool``
87+
88+
You can change upload protocol using :ref:`projectconf_upload_protocol` option:
89+
90+
.. code-block:: ini
91+
92+
[env:freenove_esp32_s3_wroom]
93+
platform = espressif32
94+
board = freenove_esp32_s3_wroom
95+
96+
upload_protocol = esptool
97+
98+
Debugging
99+
---------
100+
101+
:ref:`piodebug` - "1-click" solution for debugging with a zero configuration.
102+
103+
.. warning::
104+
You will need to install debug tool drivers depending on your system.
105+
Please click on compatible debug tool below for the further
106+
instructions and configuration information.
107+
108+
You can switch between debugging :ref:`debugging_tools` using
109+
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.
110+
111+
Freenove ESP32-S3 WROOM N8R8 (8MB Flash / 8MB PSRAM) has on-board debug probe and **IS READY** for debugging. You don't need to use/buy external debug probe.
112+
113+
.. list-table::
114+
:header-rows: 1
115+
116+
* - Compatible Tools
117+
- On-board
118+
- Default
119+
* - :ref:`debugging_tool_cmsis-dap`
120+
-
121+
-
122+
* - ``esp-bridge``
123+
-
124+
-
125+
* - ``esp-builtin``
126+
- Yes
127+
- Yes
128+
* - :ref:`debugging_tool_esp-prog`
129+
-
130+
-
131+
* - :ref:`debugging_tool_iot-bus-jtag`
132+
-
133+
-
134+
* - :ref:`debugging_tool_jlink`
135+
-
136+
-
137+
* - :ref:`debugging_tool_minimodule`
138+
-
139+
-
140+
* - :ref:`debugging_tool_olimex-arm-usb-ocd`
141+
-
142+
-
143+
* - :ref:`debugging_tool_olimex-arm-usb-ocd-h`
144+
-
145+
-
146+
* - :ref:`debugging_tool_olimex-arm-usb-tiny-h`
147+
-
148+
-
149+
* - :ref:`debugging_tool_olimex-jtag-tiny`
150+
-
151+
-
152+
* - :ref:`debugging_tool_tumpa`
153+
-
154+
-
155+
156+
Frameworks
157+
----------
158+
.. list-table::
159+
:header-rows: 1
160+
161+
* - Name
162+
- Description
163+
164+
* - :ref:`framework_arduino`
165+
- 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.
166+
167+
* - :ref:`framework_espidf`
168+
- Espressif IoT Development Framework. Official development framework for ESP32 chip

0 commit comments

Comments
 (0)