|
| 1 | +.. Copyright (c) 2014-present PlatformIO <[email protected]> |
| 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