Skip to content

Commit

Permalink
Sync dev-platforms
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed Mar 31, 2021
1 parent daa72bc commit 76504f8
Show file tree
Hide file tree
Showing 34 changed files with 1,591 additions and 251 deletions.
102 changes: 102 additions & 0 deletions boards/espressif32/heltec_wifi_kit_32_v2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.. 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_heltec_wifi_kit_32_v2:

Heltec WiFi Kit 32 (V2)
=======================

.. contents::

Hardware
--------

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.

.. list-table::

* - **Microcontroller**
- ESP32
* - **Frequency**
- 240MHz
* - **Flash**
- 8MB
* - **RAM**
- 320KB
* - **Vendor**
- `Heltec Automation <http://www.heltec.cn/project/wifi-kit-32/?lang=en&utm_source=platformio.org&utm_medium=docs>`__


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

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

.. code-block:: ini
[env:heltec_wifi_kit_32_v2]
platform = espressif32
board = heltec_wifi_kit_32_v2
You can override default Heltec WiFi Kit 32 (V2) settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `heltec_wifi_kit_32_v2.json <https://github.com/platformio/platform-espressif32/blob/master/boards/heltec_wifi_kit_32_v2.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini
[env:heltec_wifi_kit_32_v2]
platform = espressif32
board = heltec_wifi_kit_32_v2
; change microcontroller
board_build.mcu = esp32
; change MCU frequency
board_build.f_cpu = 240000000L
Uploading
---------
Heltec WiFi Kit 32 (V2) supports the next uploading protocols:

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

Default protocol is ``esptool``

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

.. code-block:: ini
[env:heltec_wifi_kit_32_v2]
platform = espressif32
board = heltec_wifi_kit_32_v2
upload_protocol = esptool
Debugging
---------
:ref:`piodebug` currently does not support Heltec WiFi Kit 32 (V2) 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`
- ESP-IDF is the official development framework for the ESP32 and ESP32-S Series SoCs.
6 changes: 6 additions & 0 deletions boards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,7 @@ Espressif 32
espressif32/frogboard
espressif32/honeylemon
espressif32/heltec_wifi_kit_32
espressif32/heltec_wifi_kit_32_v2
espressif32/heltec_wifi_lora_32
espressif32/heltec_wifi_lora_32_V2
espressif32/heltec_wireless_stick
Expand Down Expand Up @@ -939,6 +940,8 @@ ST STM32
ststm32/b96b_neonkey
ststm32/adafruit_feather_f405
ststm32/afroflight_f103cb
ststm32/portenta_h7_m4
ststm32/portenta_h7_m7
ststm32/armstrap_eagle1024
ststm32/armstrap_eagle2048
ststm32/armstrap_eagle512
Expand Down Expand Up @@ -1171,7 +1174,10 @@ ST STM8
.. toctree::
:maxdepth: 1

ststm8/nucleo_8s207k8
ststm8/nucleo_8s208rb
ststm8/stm8sdisco
ststm8/stm8s003f3
ststm8/stm8sblue
ststm8/stm8sblack
ststm8/mb208
Expand Down
7 changes: 5 additions & 2 deletions boards/nordicnrf52/bbcmicrobit_v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Platform :ref:`platform_nordicnrf52`: The nRF52 Series are built for speed to ca
* - **Flash**
- 512KB
* - **RAM**
- 64KB
- 128KB
* - **Vendor**
- `BBC <https://microbit.org/new-microbit/?utm_source=platformio.org&utm_medium=docs>`__

Expand Down Expand Up @@ -130,4 +130,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_zephyr`
- The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple hardware architectures, optimized for resource constrained devices, and built with safety and security in mind
10 changes: 5 additions & 5 deletions boards/ststm32/genericSTM32F407VGT6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.. _board_ststm32_genericSTM32F407VGT6:

STM32F407VG (192k RAM. 1024k Flash)
STM32F407VG (128k RAM. 1024k Flash)
===================================

.. contents::
Expand All @@ -30,7 +30,7 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
* - **Flash**
- 1MB
* - **RAM**
- 192KB
- 128KB
* - **Vendor**
- `Generic <https://www.st.com/content/st_com/en/products/microcontrollers/stm32-32-bit-arm-cortex-mcus/stm32-high-performance-mcus/stm32f4-series/stm32f407-417/stm32f407vg.html?utm_source=platformio.org&utm_medium=docs>`__

Expand All @@ -46,7 +46,7 @@ Please use ``genericSTM32F407VGT6`` ID for :ref:`projectconf_env_board` option i
platform = ststm32
board = genericSTM32F407VGT6
You can override default STM32F407VG (192k RAM. 1024k Flash) settings per build environment using
You can override default STM32F407VG (128k RAM. 1024k Flash) settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `genericSTM32F407VGT6.json <https://github.com/platformio/platform-ststm32/blob/master/boards/genericSTM32F407VGT6.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.
Expand All @@ -66,7 +66,7 @@ board manifest `genericSTM32F407VGT6.json <https://github.com/platformio/platfor
Uploading
---------
STM32F407VG (192k RAM. 1024k Flash) supports the next uploading protocols:
STM32F407VG (128k RAM. 1024k Flash) supports the next uploading protocols:

* ``dfu``
* ``jlink``
Expand Down Expand Up @@ -97,7 +97,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

STM32F407VG (192k RAM. 1024k 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.
STM32F407VG (128k RAM. 1024k 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
Expand Down
12 changes: 8 additions & 4 deletions boards/ststm32/nucleo_g071rb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ Nucleo G071RB supports the next uploading protocols:
* ``cmsis-dap``
* ``jlink``
* ``mbed``
* ``stlink``

Default protocol is ``mbed``
Default protocol is ``stlink``

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

Expand All @@ -83,7 +84,7 @@ You can change upload protocol using :ref:`projectconf_upload_protocol` option:
platform = ststm32
board = nucleo_g071rb
upload_protocol = mbed
upload_protocol = stlink
Debugging
---------
Expand All @@ -98,7 +99,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Nucleo G071RB 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.
Nucleo G071RB 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
Expand All @@ -108,13 +109,16 @@ Nucleo G071RB does not have on-board debug probe and **IS NOT READY** for debugg
- Default
* - :ref:`debugging_tool_blackmagic`
-
- Yes
-
* - :ref:`debugging_tool_cmsis-dap`
-
-
* - :ref:`debugging_tool_jlink`
-
-
* - :ref:`debugging_tool_stlink`
- Yes
- Yes

Frameworks
----------
Expand Down
12 changes: 8 additions & 4 deletions boards/ststm32/nucleo_g431kb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ Nucleo G431KB supports the next uploading protocols:
* ``cmsis-dap``
* ``jlink``
* ``mbed``
* ``stlink``

Default protocol is ``mbed``
Default protocol is ``stlink``

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

Expand All @@ -83,7 +84,7 @@ You can change upload protocol using :ref:`projectconf_upload_protocol` option:
platform = ststm32
board = nucleo_g431kb
upload_protocol = mbed
upload_protocol = stlink
Debugging
---------
Expand All @@ -98,7 +99,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Nucleo G431KB 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.
Nucleo G431KB 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
Expand All @@ -108,13 +109,16 @@ Nucleo G431KB does not have on-board debug probe and **IS NOT READY** for debugg
- Default
* - :ref:`debugging_tool_blackmagic`
-
- Yes
-
* - :ref:`debugging_tool_cmsis-dap`
-
-
* - :ref:`debugging_tool_jlink`
-
-
* - :ref:`debugging_tool_stlink`
- Yes
- Yes

Frameworks
----------
Expand Down
12 changes: 8 additions & 4 deletions boards/ststm32/nucleo_g431rb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ Nucleo G431RB supports the next uploading protocols:
* ``cmsis-dap``
* ``jlink``
* ``mbed``
* ``stlink``

Default protocol is ``mbed``
Default protocol is ``stlink``

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

Expand All @@ -83,7 +84,7 @@ You can change upload protocol using :ref:`projectconf_upload_protocol` option:
platform = ststm32
board = nucleo_g431rb
upload_protocol = mbed
upload_protocol = stlink
Debugging
---------
Expand All @@ -98,7 +99,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Nucleo G431RB 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.
Nucleo G431RB 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
Expand All @@ -108,13 +109,16 @@ Nucleo G431RB does not have on-board debug probe and **IS NOT READY** for debugg
- Default
* - :ref:`debugging_tool_blackmagic`
-
- Yes
-
* - :ref:`debugging_tool_cmsis-dap`
-
-
* - :ref:`debugging_tool_jlink`
-
-
* - :ref:`debugging_tool_stlink`
- Yes
- Yes

Frameworks
----------
Expand Down
12 changes: 8 additions & 4 deletions boards/ststm32/nucleo_g474re.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ Nucleo G474RE supports the next uploading protocols:
* ``cmsis-dap``
* ``jlink``
* ``mbed``
* ``stlink``

Default protocol is ``mbed``
Default protocol is ``stlink``

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

Expand All @@ -83,7 +84,7 @@ You can change upload protocol using :ref:`projectconf_upload_protocol` option:
platform = ststm32
board = nucleo_g474re
upload_protocol = mbed
upload_protocol = stlink
Debugging
---------
Expand All @@ -98,7 +99,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Nucleo G474RE 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.
Nucleo G474RE 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
Expand All @@ -108,13 +109,16 @@ Nucleo G474RE does not have on-board debug probe and **IS NOT READY** for debugg
- Default
* - :ref:`debugging_tool_blackmagic`
-
- Yes
-
* - :ref:`debugging_tool_cmsis-dap`
-
-
* - :ref:`debugging_tool_jlink`
-
-
* - :ref:`debugging_tool_stlink`
- Yes
- Yes

Frameworks
----------
Expand Down
Loading

0 comments on commit 76504f8

Please sign in to comment.