Skip to content

Commit bbf4d27

Browse files
committed
Merge branch 'release/v5.2.5'
2 parents f04040a + 4de1b83 commit bbf4d27

File tree

410 files changed

+3908
-4308
lines changed

Some content is hidden

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

410 files changed

+3908
-4308
lines changed

_static/css/extra.css

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,9 +522,28 @@ fieldset[disabled] .navbar-inverse .btn-link:focus {
522522
left: 0;
523523
}
524524
}
525+
.badge {
526+
display: inline-block;
527+
min-width: 10px;
528+
padding: 3px 7px;
529+
font-size: 12px;
530+
font-weight: 700;
531+
line-height: 1;
532+
color: #fff;
533+
text-align: center;
534+
white-space: nowrap;
535+
vertical-align: middle;
536+
background-color: #777;
537+
border-radius: 10px;
538+
}
525539

526540
/* Misc */
527541

542+
.nav .badge {
543+
background-color: #5cb85c;
544+
margin-left: 5px;
545+
}
546+
528547
.wy-nav-content {
529548
max-width: 1000px !important;
530549
}

_templates/navbar.html

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div>\
1616
<ul class="nav navbar-nav">\
1717
<li class="dropdown">\
18-
<a role="button" data-target="#" href="https://platformio.org/platformio-ide" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><i class="fa fa-rocket fa-lg"></i>Get Started<span class="caret"></span>\
18+
<a role="button" data-target="#" href="https://platformio.org/platformio-ide" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Get Started<span class="caret"></span>\
1919
</a>\
2020
<ul class="dropdown-menu" role="menu">\
2121
<li role="menuitem"><a href="https://docs.platformio.org/page/what-is-platformio.html"><i class="fa fa-heart"></i>What is PlatformIO?</a></li>\
@@ -30,8 +30,7 @@
3030
</ul>\
3131
</li>\
3232
<li class="dropdown">\
33-
<a role="button" data-target="#" href="https://docs.platformio.org/page/plus/pio-remote.html" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><i class="fa fa-lightbulb-o fa-lg"></i>\
34-
Solutions<span class="caret"></span>\
33+
<a role="button" data-target="#" href="https://docs.platformio.org/page/plus/pio-remote.html" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Solutions<span class="caret"></span>\
3534
</a>\
3635
<ul class="dropdown-menu" role="menu">\
3736
<li role="menuitem"><a href="https://platformio.org/platformio-ide"><i class="fa fa-cube"></i>PlatformIO IDE</a></li>\
@@ -49,23 +48,13 @@
4948
<li role="menuitem"><a href="https://docs.platformio.org/page/ci/index.html"><i class="fa fa-refresh"></i>Continuous Integration</a></li>\
5049
</ul>\
5150
</li>\
52-
<li class="dropdown">\
53-
<a role="button" data-target="#" href="https://platformio.org/lib" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><i class="fa fa-code fa-lg"></i>Registry<span class="caret"></span>\
54-
</a>\
55-
<ul class="dropdown-menu" role="menu">\
56-
<li role="menuitem"><a href="https://platformio.org/lib"><i class="fa fa-code"></i>Libraries</a></li>\
57-
<li role="separator" class="divider"></li>\
58-
<li role="menuitem"><a href="https://platformio.org/platforms"><i class="fa fa-laptop"></i>Platforms</a></li>\
59-
<li role="menuitem"><a href="https://platformio.org/frameworks"><i class="fa fa-cog"></i>Frameworks</a></li>\
60-
<li role="menuitem"><a href="https://platformio.org/boards"><i class="fa fa-microchip"></i>Boards</a></li>\
61-
</ul>\
62-
</li>\
51+
<li><a href="https://registry.platformio.org/">Registry<sup class="badge"><small>NEW</small></sup></a></li>\
6352
</ul>\
6453
<ul class="nav navbar-nav navbar-right">\
65-
<li class="active"><a href="https://docs.platformio.org"><i class="fa fa-book fa-lg"></i>Docs</a></li>\
66-
<li><a href="https://community.platformio.org/"><i class="fa fa-comments-o fa-lg"></i>Community</a></li>\
67-
<li><a href="https://platformio.org/support"><i class="fa fa-question-circle fa-lg"></i>Support</a></li>\
68-
<li class="nav-pio-tech"><a href="https://piolabs.com/"><i class="fa fa-heart-o fa-lg"></i>TECHNOLOGY</a></li>\
54+
<li class="active"><a href="https://docs.platformio.org">Docs</a></li>\
55+
<li><a href="https://community.platformio.org/">Community</a></li>\
56+
<li><a href="https://platformio.org/support">Support</a></li>\
57+
<li class="nav-pio-tech"><a href="https://piolabs.com/"><i class="fa fa-rocket fa-lg"></i> FOR BUSINESS</a></li>\
6958
</ul>\
7059
</div>\
7160
</nav>\

_templates/versions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
</dl>
1616
<dl>
1717
<dt>{{ _('On Github') }}</dt>
18-
<dd><a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}"> {{ _('View') }}</a></dd>
19-
<dd><a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}"> {{ _('Edit') }}</a></dd>
18+
<dd><a href="https://{{ github_host|default('github.com') }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}"> {{ _('View') }}</a></dd>
19+
<dd><a href="https://{{ github_host|default('github.com') }}/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}"> {{ _('Edit') }}</a></dd>
2020
</dl>
2121
<dl>
2222
<dt>{{ _('Search') }}</dt>

boards/asrmicro650x/cubecell_board_pro.rst

Lines changed: 0 additions & 79 deletions
This file was deleted.

boards/atmelavr/controllino_maxi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
3232
* - **RAM**
3333
- 8KB
3434
* - **Vendor**
35-
- `Controllino <https://www.controllino.com/product/controllino-maxi/?utm_source=platformio.org&utm_medium=docs>`__
35+
- `Controllino <https://controllino.biz/controllino/maxi/?utm_source=platformio.org&utm_medium=docs>`__
3636

3737

3838
Configuration

boards/atmelavr/controllino_maxi_automation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
3232
* - **RAM**
3333
- 8KB
3434
* - **Vendor**
35-
- `Controllino <https://www.controllino.com/product/controllino-maxi-automation/?utm_source=platformio.org&utm_medium=docs>`__
35+
- `Controllino <https://controllino.biz/controllino/maxi-automation/?utm_source=platformio.org&utm_medium=docs>`__
3636

3737

3838
Configuration

boards/atmelavr/controllino_mega.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
3232
* - **RAM**
3333
- 8KB
3434
* - **Vendor**
35-
- `Controllino <https://www.controllino.com/product/controllino-mega/?utm_source=platformio.org&utm_medium=docs>`__
35+
- `Controllino <https://controllino.biz/controllino/mega/?utm_source=platformio.org&utm_medium=docs>`__
3636

3737

3838
Configuration

boards/atmelavr/controllino_mini.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
3232
* - **RAM**
3333
- 2KB
3434
* - **Vendor**
35-
- `Controllino <https://www.controllino.com/product/controllino-mini/?utm_source=platformio.org&utm_medium=docs>`__
35+
- `Controllino <https://controllino.biz/controllino/mini/?utm_source=platformio.org&utm_medium=docs>`__
3636

3737

3838
Configuration
Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
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_esp32-s2-franzininho:
13+
14+
Franzininho WiFi Board
15+
======================
16+
17+
.. contents::
18+
19+
Hardware
20+
--------
21+
22+
Platform :ref:`platform_espressif32`: Espressif Systems is a privately held fabless semiconductor company. They provide wireless communications and Wi-Fi chips which are widely used in mobile devices and the Internet of Things applications.
23+
24+
.. list-table::
25+
26+
* - **Microcontroller**
27+
- ESP32S2
28+
* - **Frequency**
29+
- 240MHz
30+
* - **Flash**
31+
- 4MB
32+
* - **RAM**
33+
- 320KB
34+
* - **Vendor**
35+
- `Franzininho <https://github.com/Franzininho/Franzininho-WIFI?utm_source=platformio.org&utm_medium=docs>`__
36+
37+
38+
Configuration
39+
-------------
40+
41+
Please use ``esp32-s2-franzininho`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
42+
43+
.. code-block:: ini
44+
45+
[env:esp32-s2-franzininho]
46+
platform = espressif32
47+
board = esp32-s2-franzininho
48+
49+
You can override default Franzininho WiFi Board settings per build environment using
50+
``board_***`` option, where ``***`` is a JSON object path from
51+
board manifest `esp32-s2-franzininho.json <https://github.com/platformio/platform-espressif32/blob/master/boards/esp32-s2-franzininho.json>`_. For example,
52+
``board_build.mcu``, ``board_build.f_cpu``, etc.
53+
54+
.. code-block:: ini
55+
56+
[env:esp32-s2-franzininho]
57+
platform = espressif32
58+
board = esp32-s2-franzininho
59+
60+
; change microcontroller
61+
board_build.mcu = esp32s2
62+
63+
; change MCU frequency
64+
board_build.f_cpu = 240000000L
65+
66+
67+
Uploading
68+
---------
69+
Franzininho WiFi Board supports the following uploading protocols:
70+
71+
* ``esp-prog``
72+
* ``espota``
73+
* ``esptool``
74+
* ``iot-bus-jtag``
75+
* ``jlink``
76+
* ``minimodule``
77+
* ``olimex-arm-usb-ocd``
78+
* ``olimex-arm-usb-ocd-h``
79+
* ``olimex-arm-usb-tiny-h``
80+
* ``olimex-jtag-tiny``
81+
* ``tumpa``
82+
83+
Default protocol is ``esptool``
84+
85+
You can change upload protocol using :ref:`projectconf_upload_protocol` option:
86+
87+
.. code-block:: ini
88+
89+
[env:esp32-s2-franzininho]
90+
platform = espressif32
91+
board = esp32-s2-franzininho
92+
93+
upload_protocol = esptool
94+
95+
Debugging
96+
---------
97+
98+
:ref:`piodebug` - "1-click" solution for debugging with a zero configuration.
99+
100+
.. warning::
101+
You will need to install debug tool drivers depending on your system.
102+
Please click on compatible debug tool below for the further
103+
instructions and configuration information.
104+
105+
You can switch between debugging :ref:`debugging_tools` using
106+
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.
107+
108+
Franzininho WiFi Board 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.
109+
110+
.. list-table::
111+
:header-rows: 1
112+
113+
* - Compatible Tools
114+
- On-board
115+
- Default
116+
* - :ref:`debugging_tool_esp-prog`
117+
-
118+
- Yes
119+
* - :ref:`debugging_tool_iot-bus-jtag`
120+
-
121+
-
122+
* - :ref:`debugging_tool_jlink`
123+
-
124+
-
125+
* - :ref:`debugging_tool_minimodule`
126+
-
127+
-
128+
* - :ref:`debugging_tool_olimex-arm-usb-ocd`
129+
-
130+
-
131+
* - :ref:`debugging_tool_olimex-arm-usb-ocd-h`
132+
-
133+
-
134+
* - :ref:`debugging_tool_olimex-arm-usb-tiny-h`
135+
-
136+
-
137+
* - :ref:`debugging_tool_olimex-jtag-tiny`
138+
-
139+
-
140+
* - :ref:`debugging_tool_tumpa`
141+
-
142+
-
143+
144+
Frameworks
145+
----------
146+
.. list-table::
147+
:header-rows: 1
148+
149+
* - Name
150+
- Description
151+
152+
* - :ref:`framework_espidf`
153+
- ESP-IDF is the official development framework for the ESP32 and ESP32-S Series SoCs.

0 commit comments

Comments
 (0)