mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'feature/improve_doc_link_check' into 'master'
docs: fix broken links and re-enable linkchecker Closes IDF-2640 See merge request espressif/esp-idf!17919
This commit is contained in:
Marius Vikhammer
commit
030e52f5d4
@ -233,5 +233,4 @@ check_doc_links:
|
||||
script:
|
||||
- cd docs
|
||||
- pip install -U -r requirements.txt
|
||||
# At the moment this check will always fail due to multiple known limitations, ignore result
|
||||
- build-docs -t $DOCTGT -l $DOCLANG linkcheck || { echo "THERE ARE ISSUES DUE TO KNOWN LIMITATIONS, PLEASE FIX THEM. Nowadays we're ignored them to pass pipeline."; true; }
|
||||
- build-docs -t $DOCTGT -l $DOCLANG linkcheck
|
||||
|
||||
@ -1447,7 +1447,7 @@ esp_err_t esp_ble_gap_config_local_privacy (bool privacy_enable);
|
||||
*
|
||||
*
|
||||
* @param[in] icon - External appearance value, these values are defined by the Bluetooth SIG, please refer to
|
||||
* https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml
|
||||
* https://specificationrefs.bluetooth.com/assigned-values/Appearance%20Values.pdf
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK : success
|
||||
|
||||
@ -196,6 +196,21 @@ google_analytics_id = os.environ.get('CI_GOOGLE_ANALYTICS_ID', None)
|
||||
|
||||
project_homepage = 'https://github.com/espressif/esp-idf'
|
||||
|
||||
linkcheck_anchors = False
|
||||
|
||||
linkcheck_exclude_documents = ['index', # several false positives due to the way we link to different sections
|
||||
'api-reference/protocols/esp_local_ctrl', # Fails due to `https://<mdns-hostname>.local`
|
||||
'api-reference/provisioning/wifi_provisioning', # Fails due to `https://<mdns-hostname>.local`
|
||||
]
|
||||
|
||||
|
||||
linkcheck_ignore = ['https://webhome.phy.duke.edu/~rgb/General/dieharder.php', # Certificate error
|
||||
'https://dl.espressif.com/dl/esp32s3_rom.elf', # Not published
|
||||
'https://docs.espressif.com/projects/esptool/en/latest/esp32c2/espefuse/index.html', # Not published
|
||||
'https://www.espressif.com/sites/default/files/documentation/esp32-c2_datasheet_en.pdf', # Not published
|
||||
]
|
||||
|
||||
|
||||
# Custom added feature to allow redirecting old URLs
|
||||
with open('../page_redirects.txt') as f:
|
||||
lines = [re.sub(' +', ' ', line.strip()) for line in f.readlines() if line.strip() != '' and not line.startswith('#')]
|
||||
|
||||
@ -152,7 +152,7 @@ Copyright (C) 2011, ChaN, all right reserved.
|
||||
.. _TinyBasic: https://github.com/BleuLlama/TinyBasicPlus
|
||||
.. _miniz: https://code.google.com/archive/p/miniz/
|
||||
.. _wpa_supplicant: https://w1.fi/wpa_supplicant/
|
||||
.. _FreeBSD net80211: https://github.com/freebsd/freebsd/tree/master/sys/net80211
|
||||
.. _FreeBSD net80211: https://github.com/freebsd/freebsd-src/tree/master/sys/net80211
|
||||
.. _TJpgDec: http://elm-chan.org/fsw/tjpgd/00index.html
|
||||
.. _argtable3: https://github.com/argtable/argtable3
|
||||
.. _linenoise: https://github.com/antirez/linenoise
|
||||
@ -160,7 +160,7 @@ Copyright (C) 2011, ChaN, all right reserved.
|
||||
.. _cJSON: https://github.com/DaveGamble/cJSON
|
||||
.. _micro-ecc: https://github.com/kmackay/micro-ecc
|
||||
.. _OpenBSD SD/MMC driver: https://github.com/openbsd/src/blob/f303646/sys/dev/sdmmc/sdmmc.c
|
||||
.. _Mbed TLS: https://github.com/ARMmbed/mbedtls
|
||||
.. _Mbed TLS: https://github.com/Mbed-TLS/mbedtls
|
||||
.. _spiffs: https://github.com/pellepl/spiffs
|
||||
.. _asio: https://github.com/chriskohlhoff/asio
|
||||
.. _mqtt: https://github.com/espressif/esp-mqtt
|
||||
|
||||
@ -4,7 +4,7 @@ About
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for `{IDF_TARGET_NAME} <https://espressif.com/en/products/hardware/esp32/overview>`_ chip by `Espressif <https://espressif.com>`_.
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for `{IDF_TARGET_NAME} <https://www.espressif.com/en/products/socs/esp32>`_ chip by `Espressif <https://espressif.com>`_.
|
||||
|
||||
The {IDF_TARGET_NAME} is 2.4 GHz Wi-Fi and Bluetooth combo, which integrates one or two Xtensa® 32-bit LX6 CPU, with up to 600 DMIPS processing power.
|
||||
|
||||
|
||||
@ -419,7 +419,7 @@ After trace data are collected, users can use a special tool to visualize the re
|
||||
|
||||
.. only:: not CONFIG_FREERTOS_UNICORE
|
||||
|
||||
Unfortunately, SystemView does not support tracing from multiple cores. So when tracing from {IDF_TARGET_NAME} with JTAG interfaces in the dual-core mode, two files are generated: one for PRO CPU and another for APP CPU. Users can load each file into separate instances of the tool. For tracing over UART, users can select ``Component config`` > ``Application Level Tracing`` > ``FreeRTOS SystemView Tracing`` in menuconfig Pro or App to choose which CPU has to be traced.
|
||||
Unfortunately, SystemView does not support tracing from multiple cores. So when tracing from {IDF_TARGET_NAME} with JTAG interfaces in the dual-core mode, two files are generated: one for PRO CPU and another for APP CPU. Users can load each file into separate instances of the tool. For tracing over UART, users can select ``Component config`` > ``Application Level Tracing`` > ``FreeRTOS SystemView Tracing`` in menuconfig Pro or App to choose which CPU has to be traced.
|
||||
|
||||
It is uneasy and awkward to analyze data for every core in separate instance of the tool. Fortunately, there is an Eclipse plugin called *Impulse* which can load several trace files, thus making it possible to inspect events from both cores in one view. Also, this plugin has no limitation of 1,000,000 events as compared to the free version of SystemView.
|
||||
|
||||
@ -444,7 +444,7 @@ Good instructions on how to install, configure, and visualize data in Impulse fr
|
||||
6. Double-click the created port. View for this port should open.
|
||||
7. Click the ``Start/Stop Streaming`` button. Data should be loaded.
|
||||
8. Use the ``Zoom Out``, ``Zoom In`` and ``Zoom Fit`` buttons to inspect data.
|
||||
9. For settings measurement cursors and other features, please see `Impulse documentation <https://toem.de/index.php/projects/impulse>`_).
|
||||
9. For settings measurement cursors and other features, please see `Impulse documentation <https://toem.de/index.php/products/impulse>`_).
|
||||
|
||||
.. note::
|
||||
|
||||
@ -459,7 +459,7 @@ Gcov (Source Code Coverage)
|
||||
Basics of Gcov and Gcovr
|
||||
""""""""""""""""""""""""
|
||||
|
||||
Source code coverage is data indicating the count and frequency of every program execution path that has been taken within a program's runtime. `Gcov <https://en.wikipedia.org/wiki/Gcov>`_ is a GCC tool that, when used in concert with the compiler, can generate log files indicating the execution count of each line of a source file. The `Gcovr <https://gcovr.com>`_ tool is a utility for managing Gcov and generating summarized code coverage results.
|
||||
Source code coverage is data indicating the count and frequency of every program execution path that has been taken within a program's runtime. `Gcov <https://en.wikipedia.org/wiki/Gcov>`_ is a GCC tool that, when used in concert with the compiler, can generate log files indicating the execution count of each line of a source file. The `Gcovr <https://gcovr.com/>`_ tool is a utility for managing Gcov and generating summarized code coverage results.
|
||||
|
||||
Generally, using Gcov to compile and run programs on the host will undergo these steps:
|
||||
|
||||
@ -516,7 +516,7 @@ The dumping of code coverage data can be done multiple times throughout an appli
|
||||
|
||||
ESP-IDF supports two methods of dumping code coverage data form the target to the host:
|
||||
|
||||
* Instant Run-Time Dumpgit
|
||||
* Instant Run-Time Dumpgit
|
||||
* Hard-coded Dump
|
||||
|
||||
Instant Run-Time Dump
|
||||
@ -553,7 +553,7 @@ Generating Coverage Report
|
||||
|
||||
Once the code coverage data has been dumped, the ``.gcno``, ``.gcda`` and the source files can be used to generate a code coverage report. A code coverage report is simply a report indicating the number of times each line in a source file has been executed.
|
||||
|
||||
Both Gcov and Gcovr can be used to generate code coverage reports. Gcov is provided along with the Xtensa toolchain, whilst Gcovr may need to be installed separately. For details on how to use Gcov or Gcovr, refer to `Gcov documentation <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_ and `Gcovr documentation <http://gcovr.com/>`_.
|
||||
Both Gcov and Gcovr can be used to generate code coverage reports. Gcov is provided along with the Xtensa toolchain, whilst Gcovr may need to be installed separately. For details on how to use Gcov or Gcovr, refer to `Gcov documentation <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_ and `Gcovr documentation <https://gcovr.com/>`_.
|
||||
|
||||
Adding Gcovr Build Target to Project
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -1016,7 +1016,7 @@ Importing a library might look like this for a hypothetical library ``foo`` to b
|
||||
|
||||
For an actual example, take a look at :example:`build_system/cmake/import_lib`. Take note that what needs to be done in order to import the library may vary. It is recommended to read up on the library's documentation for instructions on how to import it from other projects. Studying the library's CMakeLists.txt and build structure can also be helpful.
|
||||
|
||||
It is also possible to wrap a third-party library to be used as a component in this manner. For example, the :component:`mbedtls` component is a wrapper for Espressif's fork of `mbedtls <https://github.com/ARMmbed/mbedtls>`_. See its :component_file:`component CMakeLists.txt <mbedtls/CMakeLists.txt>`.
|
||||
It is also possible to wrap a third-party library to be used as a component in this manner. For example, the :component:`mbedtls` component is a wrapper for Espressif's fork of `mbedtls <https://github.com/Mbed-TLS/mbedtls>`_. See its :component_file:`component CMakeLists.txt <mbedtls/CMakeLists.txt>`.
|
||||
|
||||
The CMake variable ``ESP_PLATFORM`` is set to 1 whenever the ESP-IDF build system is being used. Tests such as ``if (ESP_PLATFORM)`` can be used in generic CMake code if special IDF-specific logic is required.
|
||||
|
||||
|
||||
@ -530,11 +530,13 @@ Generally, a Provisioner is used to provision unprovisioned devices and form a m
|
||||
3.2 Why is the Wi-Fi throughput so low when Wi-Fi and ESP-BLE-MESH coexist?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The `ESP32-DevKitC <../../hw-reference/esp32/get-started-devkitc>`_ board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1Mbps.
|
||||
.. only:: esp32
|
||||
|
||||
And some configurations in menuconfig shall be enabled to support PSRAM.
|
||||
The :doc:`ESP32-DevKitC <../../hw-reference/esp32/get-started-devkitc>` board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1Mbps.
|
||||
|
||||
- :code:`ESP32-specific --> Support for external,SPI-connected RAM --> Try to allocate memories of Wi-Fi and LWIP...`
|
||||
Some configurations in menuconfig shall be enabled to support PSRAM.
|
||||
|
||||
- :code:`{IDF_TARGET_NAME}-specific --> Support for external,SPI-connected RAM --> Try to allocate memories of Wi-Fi and LWIP...`
|
||||
- :code:`Bluetooth --> Bluedroid Enable --> BT/BLE will first malloc the memory from the PSRAM`
|
||||
- :code:`Bluetooth --> Bluedroid Enable --> Use dynamic memory allocation in BT/BLE stack.`
|
||||
- :code:`Bluetooth --> Bluetooth controller --> BLE full scan feature supported.`
|
||||
|
||||
@ -123,11 +123,11 @@ Mesh Applications
|
||||
* :example_file:`Fast Provisioning Client Model Tutorial <bluetooth/esp_ble_mesh/ble_mesh_fast_provision/fast_prov_client/tutorial/BLE_Mesh_Fast_Prov_Client_Example_Walkthrough.md>`
|
||||
* :example_file:`Fast Provisioning Server Model Tutorial <bluetooth/esp_ble_mesh/ble_mesh_fast_provision/fast_prov_server/tutorial/BLE_Mesh_Fast_Prov_Server_Example_Walkthrough.md>`
|
||||
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_fast_provision>`
|
||||
* `Demo Video <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`__
|
||||
* `Demo Video <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`__
|
||||
* ESP-BLE-MESH and Wi-Fi Coexistence
|
||||
* :example_file:`Tutorial <bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/BLE_Mesh_WiFi_Coexist_Example_Walkthrough.md>`
|
||||
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist>`
|
||||
* `Demo Video <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`__
|
||||
* `Demo Video <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`__
|
||||
* ESP-BLE-MESH Console Commands
|
||||
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_console>`
|
||||
|
||||
|
||||
@ -229,9 +229,9 @@ ESP-BLE-MESH Examples
|
||||
ESP-BLE-MESH Demo Videos
|
||||
========================
|
||||
|
||||
* `Provisioning of ESP-BLE-MESH nodes using Smartphone App <http://download.espressif.com/BLE_MESH/Docs4Customers/esp-ble-mesh-demo.mp4>`_
|
||||
* `Espressif Fast Provisioning using ESP-BLE-MESH App <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
|
||||
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`_
|
||||
* `Provisioning of ESP-BLE-MESH nodes using Smartphone App <https://download.espressif.com/BLE_MESH/Docs4Customers/esp-ble-mesh-demo.mp4>`_
|
||||
* `Espressif Fast Provisioning using ESP-BLE-MESH App <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
|
||||
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`_
|
||||
|
||||
|
||||
ESP-BLE-MESH FAQ
|
||||
@ -264,13 +264,13 @@ Bluetooth SIG Documentation
|
||||
|
||||
- `BLE Mesh Core Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=429633>`_
|
||||
- `BLE Mesh Model Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=429634>`_
|
||||
- `An Intro to Bluetooth Mesh Part 1 <https://blog.bluetooth.com/an-intro-to-bluetooth-mesh-part1>`_ / `Part 2 <https://blog.bluetooth.com/an-intro-to-bluetooth-mesh-part2>`__
|
||||
- `The Fundamental Concepts of Bluetooth Mesh Networking, Part 1 <https://blog.bluetooth.com/the-fundamental-concepts-of-bluetooth-mesh-networking-part-1>`_ / `Part 2 <https://blog.bluetooth.com/the-fundamental-concepts-of-bluetooth-mesh-networking-part-2>`__
|
||||
- `Bluetooth Mesh Networking: Friendship <https://blog.bluetooth.com/bluetooth-mesh-networking-series-friendship>`_
|
||||
- `Management of Devices in a Bluetooth Mesh Network <https://blog.bluetooth.com/management-of-devices-bluetooth-mesh-network>`_
|
||||
- `Bluetooth Mesh Security Overview <https://blog.bluetooth.com/bluetooth-mesh-security-overview>`_
|
||||
- `Provisioning a Bluetooth Mesh Network Part 1 <https://blog.bluetooth.com/provisioning-a-bluetooth-mesh-network-part-1>`_ / `Part 2 <https://blog.bluetooth.com/provisioning-a-bluetooth-mesh-network-part-2>`__
|
||||
- `An Intro to Bluetooth Mesh Part 1 <https://www.bluetooth.com/blog/an-intro-to-bluetooth-mesh-part1>`_ / `Part 2 <https://www.bluetooth.com/blog/an-intro-to-bluetooth-mesh-part2>`__
|
||||
- `The Fundamental Concepts of Bluetooth Mesh Networking, Part 1 <https://www.bluetooth.com/blog/the-fundamental-concepts-of-bluetooth-mesh-networking-part-1>`_ / `Part 2 <https://www.bluetooth.com/blog/the-fundamental-concepts-of-bluetooth-mesh-networking-part-2>`__
|
||||
- `Bluetooth Mesh Networking: Friendship <https://www.bluetooth.com/blog/bluetooth-mesh-networking-series-friendship>`_
|
||||
- `Management of Devices in a Bluetooth Mesh Network <https://www.bluetooth.com/blog/management-of-devices-bluetooth-mesh-network>`_
|
||||
- `Bluetooth Mesh Security Overview <https://www.bluetooth.com/blog/bluetooth-mesh-security-overview>`_
|
||||
- `Provisioning a Bluetooth Mesh Network Part 1 <https://www.bluetooth.com/blog/provisioning-a-bluetooth-mesh-network-part-1>`_ / `Part 2 <https://www.bluetooth.com/blog/provisioning-a-bluetooth-mesh-network-part-2>`__
|
||||
|
||||
|
||||
.. _ESP32-DevKitC: https://www.espressif.com/en/products/hardware/esp32-devkitc/overview
|
||||
.. _ESP32-DevKitC: https://www.espressif.com/en/products/devkits/esp32-devkitc/overview
|
||||
.. _ESP-WROVER-KIT: https://www.espressif.com/en/products/hardware/esp-wrover-kit/overview
|
||||
|
||||
@ -20,12 +20,12 @@ ESP-BLE-MESH Terminology
|
||||
- The role of unprovisioned device will change to node after being provisioned to ESP-BLE-MESH network. Nodes (such as lighting devices, temperature control devices, manufacturing equipments, and electric doors) are devices that can send, receive, or relay messages in ESP-BLE-MESH network, and they can optionally support one or more subnets.
|
||||
* - Relay Node
|
||||
- A node that supports the Relay feature and has the Relay feature enabled is known as a Relay node.
|
||||
- Relay nodes can receive and resend ESP-BLE-MESH messages, so the messages can be transferred further. Users can decide whether or not to enable forwarding function of nodes according to nodes' status. Messages can be relayed for multiple times, and each relay is considered as a "hop". Messages can hop up to 126 times, which is enough for message transmission in a wide area.
|
||||
- Relay nodes can receive and resend ESP-BLE-MESH messages, so the messages can be transferred further. Users can decide whether or not to enable forwarding function of nodes according to nodes' status. Messages can be relayed for multiple times, and each relay is considered as a "hop". Messages can hop up to 126 times, which is enough for message transmission in a wide area.
|
||||
* - Proxy Node
|
||||
- A node that supports the Proxy feature and has the Proxy feature enabled is known as a Proxy node.
|
||||
- Proxy nodes receive messages from one bearer (it generally includes advertising bearer and GATT bearer) and resend it from another one. The purpose is to connect communication equipments that only support GATT bearer to ESP-BLE-MESH network. Generally, mobile apps need a Proxy node to access Mesh network. Without Proxy nodes, mobile apps cannot communicate with members in Mesh network.
|
||||
* - Friend Node
|
||||
- A node that supports the Friend feature, has the Friend feature enabled, and has a friendship with a node that supports the Low Power feature is known as a Friend node.
|
||||
- A node that supports the Friend feature, has the Friend feature enabled, and has a friendship with a node that supports the Low Power feature is known as a Friend node.
|
||||
- Friend node, like the backup of Low Power node (LPN), can store messages that are sent to Low Power node and security updates; the stored information will be transferred to Low Power node when Low Power node needs it. Low Power node must establish "friendship" with another node that supports the Friend Feature to reduce duty cycle of its receiver, thus power consumption of Low Power node can be reduced. Low Power node needs to find a Friend node to establish a friendship with it. The process involved is called "friendship establishment". Cooperation between Low Power node and Friend nodes enables Low Power node to schedule the use of the radio, thus Low Power node can receive messages at an appropriate or lower frequency without the need of keeping listening. Low Power node will poll Friend node to see if there is new message.
|
||||
* - Low Power Node
|
||||
- A node that supports the Low Power feature and has a friendship with a node that supports the Friend feature is known as a Low Power node.
|
||||
@ -48,7 +48,7 @@ ESP-BLE-MESH Terminology
|
||||
- A value representing a condition of an element that is exposed by an element of a node.
|
||||
- Each node in a ESP-BLE-MESH network has an independent set of state values that indicate certain states of the device, like brightness, and color of lighting device. Change of state value will lead to change of the physical state of devices. For example, changing the on/off state of a device is actually turning on/off the device.
|
||||
* - Model
|
||||
- A model defines the basic functionality of a node.
|
||||
- A model defines the basic functionality of a node.
|
||||
- A node may contain multiple models, and each model defines basic functionalities of nodes, like the states needed by the nodes, the messages controlling the states, and actions resulted from messages handling. The function implementation of the nodes is based on models, which can be divided into SIG Model and Vendor Model, with the former defined by SIG and latter defined by users.
|
||||
* - Element
|
||||
- An addressable entity within a device.
|
||||
@ -72,7 +72,7 @@ ESP-BLE-MESH Terminology
|
||||
- Low Power feature reduces power consumption of nodes. When a Low Power node is searching for a Friend node, and there are multiple Friend nodes nearby, it selects the most suitable Friend node through algorithm.
|
||||
* - Friend Feature
|
||||
- The ability to help a node supporting the Low Power feature to operate by storing messages destined for those nodes.
|
||||
- By enabling friend feature, the node can help to store information for Low Power node. The nodes enabled with friend feature may cause more power and memory consumption.
|
||||
- By enabling friend feature, the node can help to store information for Low Power node. The nodes enabled with friend feature may cause more power and memory consumption.
|
||||
* - Relay Feature
|
||||
- The ability to receive and retransmit mesh messages over the advertising bearer to enable larger networks.
|
||||
- The relay feature enables ESP-BLE-MESH messages to hop among nodes for multiple times, and the transmission distance can exceed the range of direct radio transmission between two nodes, thereby covering the entire network. When a node is enabled with the relay feature to relay messages, it only relays the messages of its own subnet, and does not relay the messages of other subnets. The data integrity will not be considered when the node enabled with relay feature relays segmented messages. The node would relay every segmented message once it receives one rather than waiting for the complete message.
|
||||
@ -130,7 +130,7 @@ ESP-BLE-MESH Terminology
|
||||
- The addresses owned by elements which has not been configured yet or no address has been allocated are unassigned addresses. These elements will not be used for messages transfer because they have no fixed address. Unassigned address is recommended to set as the value of the address before setting the address of user code.
|
||||
* - Unicast Address
|
||||
- A unicast address is a unique address allocated to each element.
|
||||
- During provisioning, the Provisioner will assign a unicast address to each element of node within the life cycle of the nodes in the network. A unicast address may appear in the source/destination address field of a message. Messages sent to a unicast address can only be processed by the element that owns the unicast address.
|
||||
- During provisioning, the Provisioner will assign a unicast address to each element of node within the life cycle of the nodes in the network. A unicast address may appear in the source/destination address field of a message. Messages sent to a unicast address can only be processed by the element that owns the unicast address.
|
||||
* - Virtual Address
|
||||
- A virtual address represents a set of destination addresses. Each virtual address logically represents a Label UUID, which is a 128-bit value that does not have to be managed centrally.
|
||||
- Associated with specific UUID labels, a virtual address may serve as the publishing or subscription address of the model. A UUID label is a 128-bit value associated with elements of one or more nodes. For virtual addresses, the 15th and 14th bits are set to 1 and 0 respectively; bits from 13th to 0 are set to hash values (providing 16384 hash values). The hash is a derivation of the Label UUID. To use subscribing elements to check the full 128-bit UUID is very inefficient while hash values provide a more efficient way to determine which elements that which messages are finally sent to.
|
||||
@ -150,12 +150,12 @@ ESP-BLE-MESH Terminology
|
||||
- Detailed Explanation
|
||||
* - Device Key (DevKey)
|
||||
- There is also a device key, which is a special application key that is unique to each node, is known only to the node and a Configuration Client, and is used to secure communications between the node and a Configuration Client.
|
||||
- The device key enables you to provision the devices, configure the nodes. The device key is used to encrypt Configuration Messages, i.e. the message transferred between the Provisioner and the node when the device is configured.
|
||||
- The device key enables you to provision the devices, configure the nodes. The device key is used to encrypt Configuration Messages, i.e. the message transferred between the Provisioner and the node when the device is configured.
|
||||
* - Application Key (AppKey)
|
||||
- Application keys are used to secure communications at the upper transport layer.
|
||||
- Application key is used for decryption of application data before delivering application data to application layer and encryption of them during the delivery of application layer. Some nodes in the network have a specific purpose and can restrict access to potentially sensitive data based on the needs of the application. With specific application keys, these nodes are associated with specific applications. Generally speaking, the fields using different application keys include security (access control of buildings, machine rooms and CEO offices), lighting (plant, exterior building and sidewalks) and HVAC systems. Application keys are bound to Network keys. This means application keys are only used in a context of a Network key they are bound to. An application key shall only be bound to a single Network key.
|
||||
* - Master Security Material
|
||||
- The master security material is derived from the network key (NetKey) and can be used by other nodes in the same network. Messages encrypted with master security material can be decoded by any node in the same network.
|
||||
- The master security material is derived from the network key (NetKey) and can be used by other nodes in the same network. Messages encrypted with master security material can be decoded by any node in the same network.
|
||||
- The corresponding friendship messages encrypted with the friendship security material: 1. Friend Poll, 2. Friend Update, 3. Friend Subscription List, add/delete/confirm, 4. The Stored Messages" sent by friend nodes to Low Power node. The corresponding friendship messages encrypted with the master security material: 1. Friend Clear, 2. Friend Clear Confirm. Based on the setup of the applications, the messages sent from the Low Power node to the friend nodes will be encrypted with the friendship security material or master security material, with the former being used by the messages transmitted between Low Power node and friend nodes and the latter being used by other network messages.
|
||||
|
||||
|
||||
@ -213,9 +213,9 @@ ESP-BLE-MESH Terminology
|
||||
- Key Refresh Procedure is used to update network key and application key of ESP-BLE-MESH network. Key Refresh Procedure is used when the security of one or more network keys and/or one or more application keys is threatened or potentially threatened. Keys are usually updated after some nodes in the network are removed.
|
||||
* - IV (Initialisation Vector) Update Procedure
|
||||
- A node can also use an IV Update procedure to signal to peer nodes that it is updating the IV Index.
|
||||
- The IV Update procedure is used to update the value of ESP-BLE-MESH network's IV Index. This value is related to the random number required for message encryption. To ensure that the value of the random number is not repeated, this value is periodically incremented. IV Index is a 32-bit value and a shared network resource. For example, all nodes in a mesh network share the same IV Index value. Starting from 0x00000000, the IV Index increments during the IV Update procedure and maintained by a specific process, ensuring the IV Index shared in the mesh network is the same. This can be done when the node believes that it has the risk of exhausting its sequence number, or when it determines that another node is nearly exhausting its sequence number. Note: The update time must not be less than 96 hours. It can be triggered when a secure network beacon is received, or when the node determines that its sequence number is greater than a certain value.
|
||||
- The IV Update procedure is used to update the value of ESP-BLE-MESH network's IV Index. This value is related to the random number required for message encryption. To ensure that the value of the random number is not repeated, this value is periodically incremented. IV Index is a 32-bit value and a shared network resource. For example, all nodes in a mesh network share the same IV Index value. Starting from 0x00000000, the IV Index increments during the IV Update procedure and maintained by a specific process, ensuring the IV Index shared in the mesh network is the same. This can be done when the node believes that it has the risk of exhausting its sequence number, or when it determines that another node is nearly exhausting its sequence number. Note: The update time must not be less than 96 hours. It can be triggered when a secure network beacon is received, or when the node determines that its sequence number is greater than a certain value.
|
||||
|
||||
For more terms, please see: `ESP-BLE-MESH Glossary of Terms <https://www.bluetooth.com/learn-about-bluetooth/bluetooth-technology/topology-options/le-mesh/mesh-glossary/>`_.
|
||||
For more terms, please see: `ESP-BLE-MESH Glossary of Terms <https://www.bluetooth.com/learn-about-bluetooth/recent-enhancements/mesh/mesh-glossary/>`_.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ Windows
|
||||
|
||||
1. Using standard USB A / micro USB B cable connect |devkit-name| to the computer. Switch the |devkit-name| on.
|
||||
|
||||
2. Wait until USB ports of |devkit-name| are recognized by Windows and drives are installed. If they do not install automatically, then download them from https://www.ftdichip.com/Drivers/D2XX.htm and install manually.
|
||||
2. Wait until USB ports of |devkit-name| are recognized by Windows and drives are installed. If they do not install automatically, then download them from https://ftdichip.com/drivers/d2xx-drivers/ and install manually.
|
||||
|
||||
3. Download Zadig tool (Zadig_X.X.exe) from https://zadig.akeo.ie/ and run it.
|
||||
|
||||
@ -103,7 +103,7 @@ On macOS, using FT2232 for JTAG and serial port at the same time needs some addi
|
||||
Manually unloading the driver
|
||||
.............................
|
||||
|
||||
1. Install FTDI driver from https://www.ftdichip.com/Drivers/VCP.htm
|
||||
1. Install FTDI driver from https://ftdichip.com/drivers/vcp-drivers/
|
||||
|
||||
2. Connect USB cable to the |devkit-name|.
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
none separate
|
||||
adapter speed: 20000 kHz
|
||||
force hard breakpoints
|
||||
|
||||
@ -25,7 +25,7 @@
|
||||
Open On-Chip Debugger v0.10.0-esp32-20201202-26-g05a036c2 (2021-03-15-17:18)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
Info : only one transport option; autoselect 'jtag'
|
||||
Warn : Transport "jtag" was already selected
|
||||
force hard breakpoints
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
Open On-Chip Debugger v0.10.0-esp32-20200420 (2020-04-20-16:15)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
none separate
|
||||
adapter speed: 20000 kHz
|
||||
force hard breakpoints
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
Open On-Chip Debugger v0.10.0-esp32-20210902 (2021-10-05-23:44)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
debug_level: 2
|
||||
|
||||
Info : only one transport option; autoselect 'jtag'
|
||||
|
||||
@ -95,7 +95,7 @@ Selecting JTAG Adapter
|
||||
|
||||
If you decide to use separate JTAG adapter, look for one that is compatible with both the voltage levels on the {IDF_TARGET_NAME} as well as with the OpenOCD software. The JTAG port on the {IDF_TARGET_NAME} is an industry-standard JTAG port which lacks (and does not need) the TRST pin. The JTAG I/O pins all are powered from the VDD_3P3_RTC pin (which normally would be powered by a 3.3 V rail) so the JTAG adapter needs to be able to work with JTAG pins in that voltage range.
|
||||
|
||||
On the software side, OpenOCD supports a fair amount of JTAG adapters. See http://openocd.org/doc/html/Debug-Adapter-Hardware.html for an (unfortunately slightly incomplete) list of the adapters OpenOCD works with. This page lists SWD-compatible adapters as well; take note that the {IDF_TARGET_NAME} does not support SWD. JTAG adapters that are hardcoded to a specific product line, e.g. ST-LINK debugging adapters for STM32 families, will not work.
|
||||
On the software side, OpenOCD supports a fair amount of JTAG adapters. See https://openocd.org/doc/html/Debug-Adapter-Hardware.html for an (unfortunately slightly incomplete) list of the adapters OpenOCD works with. This page lists SWD-compatible adapters as well; take note that the {IDF_TARGET_NAME} does not support SWD. JTAG adapters that are hardcoded to a specific product line, e.g. ST-LINK debugging adapters for STM32 families, will not work.
|
||||
|
||||
The minimal signalling to get a working JTAG connection are TDI, TDO, TCK, TMS and GND. Some JTAG debuggers also need a connection from the {IDF_TARGET_NAME} power line to a line called e.g. Vtar to set the working voltage. SRST can optionally be connected to the CH_PD of the {IDF_TARGET_NAME}, although for now, support in OpenOCD for that line is pretty minimal.
|
||||
|
||||
@ -119,7 +119,7 @@ The output should be as follows (although the version may be more recent than li
|
||||
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
|
||||
You may also verify that OpenOCD knows where its configuration scripts are located by printing the value of ``OPENOCD_SCRIPTS`` environment variable, by typing ``echo $OPENOCD_SCRIPTS`` (for Linux and macOS) or ``echo %OPENOCD_SCRIPTS%`` (for Windows). If a valid path is printed, then OpenOCD is set up correctly.
|
||||
|
||||
|
||||
@ -285,4 +285,4 @@ In case you encounter a problem with OpenOCD or GDB programs itself and do not f
|
||||
4. Attach both ``openocd_log.txt`` and ``gdb_log.txt`` files to your issue report.
|
||||
|
||||
|
||||
.. _OpenOCD Manual: http://openocd.org/doc/html/index.html
|
||||
.. _OpenOCD Manual: https://openocd.org/doc/html/index.html
|
||||
|
||||
@ -9,7 +9,7 @@ ESP-IDF provides several kinds of programming interfaces:
|
||||
|
||||
* C functions, structures, enums, type definitions and preprocessor macros declared in public header files of ESP-IDF components. Various pages in the API Reference section of the programming guide contain descriptions of these functions, structures and types.
|
||||
* Build system functions, predefined variables and options. These are documented in the :ref:`build system guide<cmake_buildsystem_api>`.
|
||||
* `Kconfig <kconfig>`_ options can can be used in code and in the build system (CMakeLists.txt) files.
|
||||
* :doc:`Kconfig <kconfig>` options can can be used in code and in the build system (CMakeLists.txt) files.
|
||||
* :doc:`Host tools <../api-guides/tools/index>` and their command line parameters are also part of ESP-IDF interface.
|
||||
|
||||
ESP-IDF consists of components written specifically for ESP-IDF as well as third-party libraries. In some cases, an ESP-IDF-specific wrapper is added to the third-party library, providing an interface that is either simpler or better integrated with the rest of ESP-IDF facilities. In other cases, the original API of the third-party library is presented to the application developers.
|
||||
@ -96,7 +96,7 @@ It is not recommended to reference these components directly in custom projects
|
||||
API Stability
|
||||
-------------
|
||||
|
||||
ESP-IDF uses `Semantic Versioning <http://semver.org/>`_ as explained in the :ref:`versions page<versioning-scheme>`.
|
||||
ESP-IDF uses `Semantic Versioning <https://semver.org/>`_ as explained in the :ref:`versions page<versioning-scheme>`.
|
||||
|
||||
Minor and bugfix releases of ESP-IDF guarantee compatibility with previous releases. The sections below explain different aspects and limitations to compatibility.
|
||||
|
||||
@ -109,7 +109,7 @@ The following changes are allowed between minor versions and do not break source
|
||||
|
||||
* Deprecating functions (using the ``deprecated`` attribute) and header files (using a preprocessor ``#warning``). Deprecations are listed in ESP-IDF relese notes. It is recommended to update the source code to use the newer functions or files that replace the deprecated ones, however this is not mandatory. Deprecated functions and files can be removed in major versions of ESP-IDF.
|
||||
* Renaming components, moving source and header files between components — provided that the build system ensures that correct files are still found.
|
||||
* Renaming Kconfig options. Kconfig system `renaming mechanism <configuration-options-compatibility>`_ ensures that the original Kconfig option names can still be used by the application in ``sdkconfig`` file, CMake files and source code.
|
||||
* Renaming Kconfig options. Kconfig system :ref:`renaming mechanism <configuration-options-compatibility>` ensures that the original Kconfig option names can still be used by the application in ``sdkconfig`` file, CMake files and source code.
|
||||
|
||||
Lack of binary compatibility
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -132,7 +132,7 @@ While we try to make upgrading to a new ESP-IDF version easy, there are parts of
|
||||
* Changes made to mitigate security issues or to replace insecure default behaviors with a secure ones.
|
||||
* Features which were never functional. For example, if it was never possible to use a certain function or an enumeration value, it may get renamed (as part of fixing it) or removed. This includes software features which depend on non-functional chip hardware features.
|
||||
* Unexpected or undefined behavior (for example, due to missing validation of argument ranges) that is not documented explicitly may be fixed/changed.
|
||||
* Location of `Kconfig <kconfig>`_ options in menuconfig.
|
||||
* Location of :doc:`Kconfig <kconfig>` options in menuconfig.
|
||||
* Location and names of example projects.
|
||||
|
||||
.. _designated initializers: https://en.cppreference.com/w/c/language/struct_initialization
|
||||
|
||||
@ -12,7 +12,7 @@ Bluetooth API
|
||||
controller_vhci
|
||||
esp-ble-mesh
|
||||
nimble/index
|
||||
|
||||
|
||||
ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:
|
||||
|
||||
* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
|
||||
@ -22,7 +22,7 @@ ESP-IDF currently supports two host stacks. The Bluedroid based stack (default)
|
||||
|
||||
For the overview of the ESP32 Bluetooth stack architecture, follow the links below:
|
||||
|
||||
* `ESP32 Bluetooth Architecture (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
|
||||
* `ESP32 Bluetooth Architecture (PDF) <https://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
|
||||
|
||||
Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ NimBLE-based host APIs
|
||||
Overview
|
||||
========
|
||||
|
||||
Apache MyNewt NimBLE is a highly configurable and BT SIG qualifiable BLE stack providing both host and controller functionalities. ESP-IDF supports NimBLE host stack which is specifically ported for ESP32 platform and FreeRTOS. The underlying controller is still the same (as in case of Bluedroid) providing VHCI interface. Refer to `NimBLE user guide <http://mynewt.apache.org/latest/network/index.html#>`_ for a complete list of features and additional information on NimBLE stack. Most features of NimBLE including BLE Mesh are supported by ESP-IDF. The porting layer is kept cleaner by maintaining all the existing APIs of NimBLE along with a single ESP-NimBLE API for initialization, making it simpler for the application developers.
|
||||
Apache MyNewt NimBLE is a highly configurable and BT SIG qualifiable BLE stack providing both host and controller functionalities. ESP-IDF supports NimBLE host stack which is specifically ported for ESP32 platform and FreeRTOS. The underlying controller is still the same (as in case of Bluedroid) providing VHCI interface. Refer to `NimBLE user guide <https://mynewt.apache.org/latest/network/index.html>`_ for a complete list of features and additional information on NimBLE stack. Most features of NimBLE including BLE Mesh are supported by ESP-IDF. The porting layer is kept cleaner by maintaining all the existing APIs of NimBLE along with a single ESP-NimBLE API for initialization, making it simpler for the application developers.
|
||||
|
||||
Architecture
|
||||
============
|
||||
|
||||
@ -197,7 +197,7 @@ If you use a development board without pull-ups, you can do the following:
|
||||
|
||||
.. warning::
|
||||
|
||||
Burning eFuses is irreversible! The issue list above might be out of date, so please make sure that the module you are burning has a 3.3 V flash chip by checking the information on http://www.espressif.com/. If you burn the 3.3 V eFuses on a module with a 1.8 V flash chip, the module will stop functioning.
|
||||
Burning eFuses is irreversible! The issue list above might be out of date, so please make sure that the module you are burning has a 3.3 V flash chip by checking the information on https://www.espressif.com/. If you burn the 3.3 V eFuses on a module with a 1.8 V flash chip, the module will stop functioning.
|
||||
|
||||
If you are sure that you need to irreversibly burn eFuses, go to your ESP-IDF directory and run the following command:
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ In-depth design details of touch sensors and firmware development guidelines for
|
||||
|
||||
.. only:: SOC_TOUCH_VERSION_1
|
||||
|
||||
For more information about testing touch sensors in various configurations, please check the `Guide for ESP32-Sense-Kit <https://github.com/espressif/esp-dev-kits/blob/master/esp32-sense-kit/docs/esp32_sense_kit_guide_en.md>`_.
|
||||
For more information about testing touch sensors in various configurations, please check the `Guide for ESP32-Sense-Kit <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32/esp32-sense-kit/user_guide.html>`_.
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
@ -3,7 +3,7 @@ ASIO port
|
||||
|
||||
Overview
|
||||
--------
|
||||
Asio is a cross-platform C++ library, see https://think-async.com. It provides a consistent asynchronous model using a modern C++ approach.
|
||||
Asio is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach.
|
||||
|
||||
|
||||
ASIO documentation
|
||||
|
||||
@ -54,9 +54,9 @@ Generating the List of Root Certificates
|
||||
----------------------------------------
|
||||
The list of root certificates comes from Mozilla's NSS root certificate store, which can be found `here <https://wiki.mozilla.org/CA/Included_Certificates>`_
|
||||
The list can be downloaded and created by running the script ``mk-ca-bundle.pl`` that is distributed as a part of `curl <https://github.com/curl/curl>`_.
|
||||
Another alternative would be to download the finished list directly from the curl website: `CA certificates extracted from Mozilla <https://curl.haxx.se/docs/caextract.html>`_
|
||||
Another alternative would be to download the finished list directly from the curl website: `CA certificates extracted from Mozilla <https://curl.se/docs/caextract.html>`_
|
||||
|
||||
The common certificates bundle were made by selecting the authorities with a market share of more than 1 % from w3tech's `SSL Survey <https://w3techs.com/technologies/overview/ssl_certificate/all>`_.
|
||||
The common certificates bundle were made by selecting the authorities with a market share of more than 1 % from w3tech's `SSL Survey <https://w3techs.com/technologies/overview/ssl_certificate>`_.
|
||||
These authorities were then used to pick the names of the certificates for the filter list, `cmn_crt_authorities.csv`, from `this list <https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReportPEMCSV>`_ provided by Mozilla.
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Mbed TLS
|
||||
========
|
||||
|
||||
`Mbed TLS <https://github.com/ARMmbed/mbedtls>`_ is a C library that implements cryptographic primitives, X.509 certificate manipulation and the SSL/TLS and DTLS protocols. Its small code footprint makes it suitable for embedded systems.
|
||||
`Mbed TLS <https://github.com/Mbed-TLS/mbedtls>`_ is a C library that implements cryptographic primitives, X.509 certificate manipulation and the SSL/TLS and DTLS protocols. Its small code footprint makes it suitable for embedded systems.
|
||||
|
||||
.. note:: ESP-IDF uses a `fork <https://github.com/espressif/mbedtls>`_ of Mbed TLS which includes a few patches (related to hardware routines of certain modules like ``bignum (MPI)`` and ``ECC``) over vanilla Mbed TLS.
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Overview
|
||||
|
||||
mDNS is a multicast UDP service that is used to provide local network service and host discovery.
|
||||
|
||||
mDNS is installed by default on most operating systems or is available as separate package. On ``Mac OS`` it is installed by default and is called ``Bonjour``. Apple releases an installer for ``Windows`` that can be found `on Apple's support page <https://support.apple.com/downloads/bonjour%2520for%2520windows>`_. On ``Linux``, mDNS is provided by `avahi <https://github.com/lathiat/avahi>`_ and is usually installed by default.
|
||||
mDNS is installed by default on most operating systems or is available as separate package. On ``Mac OS`` it is installed by default and is called ``Bonjour``. Apple releases an installer for ``Windows`` that can be found `on Apple's support page <https://support.apple.com/downloads/bonjour-for-windows>`_. On ``Linux``, mDNS is provided by `avahi <https://github.com/lathiat/avahi>`_ and is usually installed by default.
|
||||
|
||||
mDNS Properties
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
@ -4,7 +4,7 @@ ESP-Modbus
|
||||
The Espressif ESP-Modbus Library (esp-modbus) supports Modbus communication in the networks based on RS485, Wi-Fi, Ethernet interfaces.
|
||||
The ESP-IDF component `freemodbus` has been moved from ESP-IDF since version v5.0 to a separate repository:
|
||||
|
||||
* `ESP-Modbus component on GitHub <https://www.github.com/espressif/esp-modbus>`__
|
||||
* `ESP-Modbus component on GitHub <https://github.com/espressif/esp-modbus>`__
|
||||
|
||||
Hosted Documentation
|
||||
--------------------
|
||||
|
||||
@ -127,7 +127,7 @@ Examples:
|
||||
Argument parsing
|
||||
----------------
|
||||
|
||||
For argument parsing, ``console`` component includes `argtable3 <http://www.argtable.org/>`_ library. Please see `tutorial <http://www.argtable.org/tutorial/>`_ for an introduction to `argtable3 <http://www.argtable.org/>`_. Github repository also includes `examples <https://github.com/argtable/argtable3/tree/master/examples>`_.
|
||||
For argument parsing, ``console`` component includes `argtable3 <https://www.argtable.org/>`_ library. Please see `tutorial <https://www.argtable.org/tutorial/>`_ for an introduction to `argtable3 <https://www.argtable.org/>`_. Github repository also includes `examples <https://github.com/argtable/argtable3/tree/master/examples>`_.
|
||||
|
||||
|
||||
Command registration and dispatching
|
||||
|
||||
@ -151,12 +151,14 @@ Implementation Notes
|
||||
|
||||
Knowledge about the regions of memory in the chip comes from the "soc" component, which contains memory layout information for the chip, and the different capabilities of each region. Each region's capabilities are prioritised, so that (for example) dedicated DRAM and IRAM regions will be used for allocations ahead of the more versatile D/IRAM regions.
|
||||
|
||||
Each contiguous region of memory contains its own memory heap. The heaps are created using the `multi_heap <API Reference - Multi Heap API>`_ functionality. multi_heap allows any contiguous region of memory to be used as a heap.
|
||||
Each contiguous region of memory contains its own memory heap. The heaps are created using the :ref:`multi_heap <multi-heap>` functionality. multi_heap allows any contiguous region of memory to be used as a heap.
|
||||
|
||||
The heap capabilities allocator uses knowledge of the memory regions to initialize each individual heap. Allocation functions in the heap capabilities API will find the most appropriate heap for the allocation (based on desired capabilities, available space, and preferences for each region's use) and then calling :cpp:func:`multi_heap_malloc` for the heap situated in that particular region.
|
||||
|
||||
Calling ``free()`` involves finding the particular heap corresponding to the freed address, and then calling :cpp:func:`multi_heap_free` on that particular multi_heap instance.
|
||||
|
||||
.. _multi-heap:
|
||||
|
||||
API Reference - Multi Heap API
|
||||
------------------------------
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ Overview
|
||||
|
||||
1. Provide overview where and how this API may be used.
|
||||
2. Where applicable include code snippets to illustrate functionality of particular functions.
|
||||
3. To distinguish between sections, use the following `heading levels <http://www.sphinx-doc.org/en/stable/rest.html#sections>`_:
|
||||
3. To distinguish between sections, use the following `heading levels <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`_:
|
||||
|
||||
* ``#`` with overline, for parts
|
||||
* ``*`` with overline, for chapters
|
||||
|
||||
@ -3,7 +3,7 @@ Copyright Header Guide
|
||||
|
||||
ESP-IDF is released under :project_file:`the Apache License 2.0 <LICENSE>` with some additional third-party copyrighted code released under various licenses. For further information please refer to :doc:`the list of copyrights and licenses <../../../COPYRIGHT>`.
|
||||
|
||||
This page explains how the source code should be properly marked with a copyright header. ESP-IDF uses `The Software Package Data Exchange (SPDX) <https://spdx.org>`_ format which is short and can be easily read by humans or processed by automated tools for copyright checks.
|
||||
This page explains how the source code should be properly marked with a copyright header. ESP-IDF uses `The Software Package Data Exchange (SPDX) <https://spdx.dev>`_ format which is short and can be easily read by humans or processed by automated tools for copyright checks.
|
||||
|
||||
How to Check the Copyright Headers
|
||||
----------------------------------
|
||||
|
||||
@ -11,7 +11,7 @@ Structure
|
||||
- If the example has additional functionality, split it logically into separate C or C++ source files under ``main`` and place a corresponding header file in the same directory.
|
||||
- If the example has a lot of additional functionality, consider adding a ``components`` directory to the example project and make some example-specific components with library functionality. Only do this if the components are specific to the example, if they're generic or common functionality then they should be added to ESP-IDF itself.
|
||||
- The example should have a ``README.md`` file. Use the :idf_file:`template example README <docs/TEMPLATE_EXAMPLE_README.md>` and adapt it for your particular example.
|
||||
- Examples should have a ``pytest_<example name>.py`` file for running an automated example test. If submitting a GitHub Pull Request which includes an example, it's OK not to include this file initially. The details can be discussed as part of the `Pull Request <https://help.github.com/articles/creating-a-pull-request/>`_. Please refer to :doc:`IDF Tests with Pytest Guide <esp-idf-tests-with-pytest>` for details.
|
||||
- Examples should have a ``pytest_<example name>.py`` file for running an automated example test. If submitting a GitHub Pull Request which includes an example, it's OK not to include this file initially. The details can be discussed as part of the `Pull Request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_. Please refer to :doc:`IDF Tests with Pytest Guide <esp-idf-tests-with-pytest>` for details.
|
||||
|
||||
General Guidelines
|
||||
------------------
|
||||
|
||||
@ -8,7 +8,7 @@ The purpose of this description is to provide quick summary on documentation sty
|
||||
Introduction
|
||||
------------
|
||||
|
||||
When documenting code for this repository, please follow `Doxygen style <http://doxygen.nl/manual/docblocks.html#specialblock>`_. You are doing it by inserting special commands, for instance ``@param``, into standard comments blocks, for example: ::
|
||||
When documenting code for this repository, please follow `Doxygen style <https://www.doxygen.nl/manual/docblocks.html#specialblock>`_. You are doing it by inserting special commands, for instance ``@param``, into standard comments blocks, for example: ::
|
||||
|
||||
/**
|
||||
* @param ratio this is oxygen to air ratio
|
||||
@ -22,7 +22,7 @@ Typical comment block, that contains documentation of a function, looks like bel
|
||||
:align: center
|
||||
:alt: Sample inline code documentation
|
||||
|
||||
Doxygen supports couple of formatting styles. It also gives you great flexibility on level of details to include in documentation. To get familiar with available features, please check data rich and very well organized `Doxygen Manual <http://doxygen.nl/manual/index.html>`_.
|
||||
Doxygen supports couple of formatting styles. It also gives you great flexibility on level of details to include in documentation. To get familiar with available features, please check data rich and very well organized `Doxygen Manual <https://www.doxygen.nl/manual/index.html>`_.
|
||||
|
||||
|
||||
Why we need it?
|
||||
@ -204,4 +204,4 @@ Related Documents
|
||||
|
||||
.. _interactive shell: http://interactive.blockdiag.com/?compression=deflate&src=eJxlUMFOwzAMvecrrO3aITYQQirlAIIzEseJQ5q4TUSIq8TVGIh_J2m7jbKc7Ge_5_dSO1Lv2soWvoVYgieNoMh7VGzJR9FJtugZ7lYQ0UcKEbYNOY36rRQHZHUPT68vV5tceGLbWCUzPfeaFFMoBZzecVc56vWwJFnWMmJ59CCZg617xpOFbTSyw0pmvT_HJ7hxtFNGBr6wvuu5SCkchcrZ1vAeXZomznh5YgTqfcpR02cBO6vZVDeXBRjMjKEcFRbLh8f18-Z2UUBDnqP9wmp9ncRmSSfND2ldGo2h_zse407g0Mxc1q7HzJ3-4jzYYTJjtQH3iSV-fgFzx50J
|
||||
|
||||
.. _Breathe: https://breathe.readthedocs.io
|
||||
.. _Breathe: https://breathe.readthedocs.io/en/latest/
|
||||
|
||||
@ -6,7 +6,7 @@ We welcome contributions to the esp-idf project!
|
||||
How to Contribute
|
||||
-----------------
|
||||
|
||||
Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_.
|
||||
Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_.
|
||||
|
||||
Before Contributing
|
||||
-------------------
|
||||
|
||||
@ -32,7 +32,7 @@ What's More?
|
||||
|
||||
For detailed usage, please refer to the documentation of pre-commit_.
|
||||
|
||||
.. _pre-commit: https://www.pre-commit.com/
|
||||
.. _pre-commit: https://pre-commit.com/
|
||||
|
||||
Common Problems For Windows Users
|
||||
---------------------------------
|
||||
|
||||
@ -13,8 +13,8 @@ Connect the {IDF_TARGET_NAME} board to the PC using the USB cable. If device dri
|
||||
|
||||
Below is the list of USB to serial converter chips installed on most of the {IDF_TARGET_NAME} boards produced by Espressif together with links to the drivers:
|
||||
|
||||
* CP210x: `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
* FTDI: `FTDI Virtual COM Port Drivers <https://www.ftdichip.com/Drivers/VCP.htm>`_
|
||||
* CP210x: `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers>`_
|
||||
* FTDI: `FTDI Virtual COM Port Drivers <https://ftdichip.com/drivers/vcp-drivers/>`_
|
||||
|
||||
Please check the board user guide for specific USB to serial converter chip used. The drivers above are primarily for reference. Under normal circumstances, the drivers should be bundled with an operating system and automatically installed upon connecting the board to the PC.
|
||||
|
||||
@ -82,7 +82,7 @@ Now verify that the serial connection is operational. You can do this using a se
|
||||
Windows and Linux
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
In this example we will use `PuTTY SSH Client <http://www.putty.org/>`_ that is available for both Windows and Linux. You can use other serial program and set communication parameters like below.
|
||||
In this example we will use `PuTTY SSH Client <https://www.putty.org/>`_ that is available for both Windows and Linux. You can use other serial program and set communication parameters like below.
|
||||
|
||||
Run terminal, set identified serial port, baud rate = 115200, data bits = 8, stop bits = 1, and parity = N. Below are example screen shots of setting the port and such transmission parameters (in short described as 115200-8-1-N) on Windows and Linux. Remember to select exactly the same serial port you have identified in steps above.
|
||||
|
||||
|
||||
@ -265,7 +265,7 @@ Related Documents
|
||||
.. _First Steps on ESP-IDF: ../get-started/first-steps.html
|
||||
.. _cmake: https://cmake.org/
|
||||
.. _ninja: https://ninja-build.org/
|
||||
.. _ccache: https://ccache.samba.org/
|
||||
.. _ccache: https://ccache.dev/
|
||||
.. _homebrew: https://brew.sh/
|
||||
.. _MacPorts: https://www.macports.org/install.php
|
||||
.. _Catalina 10.15 release notes: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes
|
||||
|
||||
@ -31,6 +31,6 @@ Supported Features
|
||||
Bugs & Feature Requests
|
||||
=======================
|
||||
|
||||
If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <http://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
|
||||
If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <https://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
|
||||
|
||||
We also welcome new feature requests. Most of the features we have today are a result of people asking for them to be implemented. To improve certain aspects of the extension, `raise your feature request on GitHub <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
|
||||
|
||||
@ -76,10 +76,10 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
- ✔️ Eight-way set associative, 32-bit data/instruction bus width
|
||||
- ✔️ Four-way or eight-way set associative for instruction cache; four-way set associative for data cache, 32-bit data/instruction bus width
|
||||
* - **Peripherals**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - ADC
|
||||
- Two 12-bit, 18 channels
|
||||
- Two 12-bit, 20 channels
|
||||
@ -88,13 +88,13 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
* - DAC
|
||||
- Two 8-bit channels
|
||||
- Two 8-bit channels
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
* - Timers
|
||||
- Four 64-bit general-purpose timers, and three watchdog timers
|
||||
- Four 64-bit general-purpose timers, and three watchdog timers
|
||||
- Two 54-bit general-purpose timers, and three watchdog timers
|
||||
- Four 54-bit general-purpose timers, and three watchdog timers
|
||||
- Two 54-bit general-purpose timers, and three watchdog timers
|
||||
- Four 54-bit general-purpose timers, and three watchdog timers
|
||||
* - Temperature sensor
|
||||
- ✖️
|
||||
- 1
|
||||
@ -167,13 +167,13 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
- 8 channels :sup:`1`
|
||||
* - MCPWM
|
||||
- 2, six PWM outputs
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
- 2, six PWM outputs
|
||||
* - USB OTG
|
||||
- ✖️
|
||||
- 1
|
||||
- ✖️
|
||||
- ✖️
|
||||
- 1
|
||||
* - TWAI® controller (compatible with ISO 11898-1)
|
||||
- 1
|
||||
@ -206,10 +206,10 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
- 1
|
||||
- ✖️
|
||||
* - **Security**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - Secure boot
|
||||
- ✔️
|
||||
- ✔️ Faster and safer, compared with ESP32
|
||||
@ -261,10 +261,10 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
- ✔️ XTS-AES-128
|
||||
- ✔️ XTS-AES-128, XTS-AES-256
|
||||
* - **Other**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - Deep-sleep (ULP sensor-monitored pattern)
|
||||
- 100 μA (when ADC work with a duty cycle of 1%)
|
||||
- 22 μA (when touch sensors work with a duty cycle of 1%)
|
||||
@ -272,7 +272,7 @@ The comparison below covers key features of chips supported by ESP-IDF. For the
|
||||
- TBD
|
||||
* - Size
|
||||
- QFN48 5*5, 6*6, depending on variants
|
||||
- QFN56 7*7
|
||||
- QFN56 7*7
|
||||
- QFN32 5*5
|
||||
- QFN56 7*7
|
||||
|
||||
@ -299,4 +299,4 @@ Related Documents
|
||||
- `ESP32-S2 Datasheet (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_
|
||||
- `ESP32-C3 Datasheet (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>`_
|
||||
- `ESP32-S3 Datasheet (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf>`_
|
||||
- `ESP Product Selector <http://products.espressif.com:8000/#/>`_
|
||||
- `ESP Product Selector <https://products.espressif.com/#/>`_
|
||||
@ -1,4 +1,4 @@
|
||||
ESP32-PICO-DevKitM-2
|
||||
ESP32-PICO-DevKitM-2
|
||||
*********************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
@ -10,7 +10,7 @@ ESP32-PICO-DevKitM-2 is an ESP32-based development board produced by `Espressif
|
||||
|
||||
The core of this board is `ESP32-PICO-MINI-02(02U) <https://www.espressif.com/en/products/modules>`_ module with complete Wi-Fi and Bluetooth functionalities. The development board features a USB-to-UART Bridge circuit which allows developers to connect the board to a computer's USB port for flashing and debugging.
|
||||
|
||||
All the IO signals and system power on ESP32-PICO-MINI-02(02U) are led out to two rows of 18 x 0.1" header pads on both sides of the development board for easy access. For compatibility with Dupont wires, all header pads are populated with two rows of male pin headers.
|
||||
All the IO signals and system power on ESP32-PICO-MINI-02(02U) are led out to two rows of 18 x 0.1" header pads on both sides of the development board for easy access. For compatibility with Dupont wires, all header pads are populated with two rows of male pin headers.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -24,7 +24,7 @@ ESP32-PICO-DevKitM-2 provides the users with hardware for development of applica
|
||||
:alt: ESP32-PICO-DevKitM-2 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-DevKitM-2 Overview (click to enlarge)
|
||||
ESP32-PICO-DevKitM-2 Overview (click to enlarge)
|
||||
|
||||
This guide covers:
|
||||
|
||||
@ -52,11 +52,11 @@ The following figure and the table below describe the key components, interfaces
|
||||
:alt: ESP32-PICO-DevKitM-2 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-DevKitM-2 board layout - front (click to enlarge)
|
||||
ESP32-PICO-DevKitM-2 board layout - front (click to enlarge)
|
||||
|
||||
Below is the description of the items identified in the figure starting from the top left corner and going clockwise.
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 10 25
|
||||
:header-rows: 1
|
||||
|
||||
@ -106,7 +106,7 @@ Retail Orders
|
||||
|
||||
If you order one or several samples of the board, each ESP32-PICO-DevKitM-2 development board comes in an individual package.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
Wholesale Orders
|
||||
------------------
|
||||
@ -129,7 +129,7 @@ The block diagram below shows the main components of ESP32-PICO-DevKitM-2 and th
|
||||
:alt: ESP32-PICO-DevKitM-2 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-DevKitM-2 Block Diagram (click to enlarge)
|
||||
ESP32-PICO-DevKitM-2 Block Diagram (click to enlarge)
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
@ -153,7 +153,7 @@ The two tables below provide the **Name** and **Function** of I/O header pins on
|
||||
Header J2
|
||||
""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -233,12 +233,12 @@ Header J2
|
||||
- VDD33 (3V3)
|
||||
- P
|
||||
- 3.3 V power supply
|
||||
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -318,7 +318,7 @@ Header J3
|
||||
- EXT_5V (5V)
|
||||
- P
|
||||
- 5V power supply
|
||||
|
||||
|
||||
|
||||
.. _get-started-pico-devkitm-2-pin-notes:
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
ESP32-PICO-KIT-1
|
||||
ESP32-PICO-KIT-1
|
||||
*****************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
@ -19,7 +19,7 @@ This setup reduces the costs of additional external components as well as the co
|
||||
|
||||
The development board features a USB-to-UART Bridge circuit which allows developers to connect the board to a computer's USB port for flashing and debugging.
|
||||
|
||||
All the IO signals and system power on ESP32-PICO-V3 are led out to two rows of 18 x 0.1" header pads on both sides of the development board for easy access. For compatibility with Dupont wires, all header pads are populated with two rows of male pin headers.
|
||||
All the IO signals and system power on ESP32-PICO-V3 are led out to two rows of 18 x 0.1" header pads on both sides of the development board for easy access. For compatibility with Dupont wires, all header pads are populated with two rows of male pin headers.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -33,7 +33,7 @@ ESP32-PICO-KIT-1 provides the users with hardware for development of application
|
||||
:alt: ESP32-PICO-KIT-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT-1 Overview (click to enlarge)
|
||||
ESP32-PICO-KIT-1 Overview (click to enlarge)
|
||||
|
||||
This guide covers:
|
||||
|
||||
@ -61,12 +61,12 @@ The following figure and the table below describe the key components, interfaces
|
||||
:alt: ESP32-PICO-KIT-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT-1 board layout - front (click to enlarge)
|
||||
ESP32-PICO-KIT-1 board layout - front (click to enlarge)
|
||||
|
||||
|
||||
Below is the description of the items identified in the figure starting from the top left corner and going clockwise.
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 10 25
|
||||
:header-rows: 1
|
||||
|
||||
@ -117,7 +117,7 @@ Retail Orders
|
||||
|
||||
If you order one or several samples of the board, each ESP32-PICO-KIT-1 development board comes in an individual package.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -141,7 +141,7 @@ The block diagram below shows the main components of ESP32-PICO-KIT-1 and their
|
||||
:alt: ESP32-PICO-KIT-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT-1 Block Diagram (click to enlarge)
|
||||
ESP32-PICO-KIT-1 Block Diagram (click to enlarge)
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
@ -165,7 +165,7 @@ The two tables below provide the **Name** and **Function** of I/O header pins on
|
||||
Header J2
|
||||
""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -245,12 +245,12 @@ Header J2
|
||||
- VDD33 (3V3)
|
||||
- P
|
||||
- 3.3 V power supply
|
||||
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -330,7 +330,7 @@ Header J3
|
||||
- EXT_5V (5V)
|
||||
- P
|
||||
- 5V power supply
|
||||
|
||||
|
||||
|
||||
.. _get-started-pico-kit-1-pin-notes:
|
||||
|
||||
@ -361,7 +361,7 @@ No previous versions available.
|
||||
Related Documents
|
||||
===================
|
||||
|
||||
* `ESP32-PICO-V3 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-v3_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-V3 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-pico-v3_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
|
||||
* `ESP32-PICO-KIT-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-PICO-KIT-1_V1_0_20200811A.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT-1 PCB Layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-PICO-KIT-1_V1.0_20200811.pdf>`_ (PDF)
|
||||
|
||||
@ -43,7 +43,7 @@ Below is the description of the items identified in the figure starting from the
|
||||
:widths: 25 75
|
||||
:header-rows: 1
|
||||
|
||||
* - Key Component
|
||||
* - Key Component
|
||||
- Description
|
||||
* - ESP32-PICO-D4
|
||||
- Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V3 board. The complete ESP32 system on a chip (ESP32 SoC) has been integrated into the SiP module, requiring only an external antenna with LC matching network, decoupling capacitors, and a pull-up resistor for EN signals to function properly.
|
||||
@ -75,5 +75,5 @@ Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V3 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../../hw-reference/index`
|
||||
|
||||
@ -225,7 +225,7 @@ Related Documents
|
||||
* `ESP32-PICO-KIT V4 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT V4.1 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4.1_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT Reference Design <https://www.espressif.com/sites/default/files/documentation/esp32-pico-kit_v4.1_20180314_en.zip>`_ containing OrCAD schematic, PCB layout, gerbers and BOM
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../../hw-reference/index`
|
||||
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ ESP32-DevKitM-1 is an ESP32-MINI-1(1U)-based development board produced by Espre
|
||||
|
||||
|
||||
+---------------------------+-------------------------------+
|
||||
| |ESP32-DevKitM-1 - front| | |ESP32-DevKitM-1 - isometric| |
|
||||
| |ESP32-DevKitM-1 - front| | |ESP32-DevKitM-1 - isometric| |
|
||||
+---------------------------+-------------------------------+
|
||||
| ESP32-DevKitM-1 - front | ESP32-DevKitM-1 - isometric |
|
||||
| ESP32-DevKitM-1 - front | ESP32-DevKitM-1 - isometric |
|
||||
+---------------------------+-------------------------------+
|
||||
|
||||
.. |ESP32-DevKitM-1 - front| image:: ../../../_static/esp32-DevKitM-1-front.png
|
||||
@ -27,13 +27,13 @@ The document consists of the following major sections:
|
||||
- `Related Documents`_: Gives links to related documentaiton.
|
||||
|
||||
|
||||
Getting Started
|
||||
Getting Started
|
||||
===================
|
||||
|
||||
This section describes how to get started with ESP32-DevKitM-1. It begins with a few introductory sections about the ESP32-DevKitM-1, then Section `Start Application Development`_ provides instructions on how to do the initial hardware setup and then how to flash firmware onto the ESP32-DevKitM-1.
|
||||
|
||||
|
||||
Overview
|
||||
Overview
|
||||
-------------
|
||||
|
||||
This is a small and convenient development board that features:
|
||||
@ -45,25 +45,25 @@ This is a small and convenient development board that features:
|
||||
- a few other components
|
||||
|
||||
|
||||
Contents and Packaging
|
||||
Contents and Packaging
|
||||
--------------------------
|
||||
|
||||
Retail orders
|
||||
Retail orders
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you order a few samples, each ESP32-DevKitM-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
Wholesale Orders
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you order in bulk, the boards come in large cardboard boxes.
|
||||
|
||||
For wholesale orders, please go to https://www.espressif.com/en/contact-us/sales-questions.
|
||||
|
||||
Description of Components
|
||||
Description of Components
|
||||
----------------------------
|
||||
|
||||
The following figure and the table below describe the key components, interfaces and controls of the ESP32-DevKitM-1 board. We take the board with a ESP32-MINI-1 module as an example in the following sections.
|
||||
@ -84,7 +84,7 @@ The following figure and the table below describe the key components, interfaces
|
||||
* - Key Component
|
||||
- Description
|
||||
* - On-board module
|
||||
- ESP32-MINI-1 module or ESP32-MINI-1U module. ESP32-MINI-1 comes with an on-board PCB antenna. ESP32-MINI-1U comes with an external antenna connector. The two modules both have a 4 MB flash in chip package. For details, please see `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_.
|
||||
- ESP32-MINI-1 module or ESP32-MINI-1U module. ESP32-MINI-1 comes with an on-board PCB antenna. ESP32-MINI-1U comes with an external antenna connector. The two modules both have a 4 MB flash in chip package. For details, please see `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_.
|
||||
* - 5 V to 3.3 V LDO
|
||||
- Power regulator converts 5 V to 3.3 V.
|
||||
* - Boot Button
|
||||
@ -102,21 +102,21 @@ The following figure and the table below describe the key components, interfaces
|
||||
|
||||
|
||||
|
||||
Start Application Development
|
||||
Start Application Development
|
||||
----------------------------------
|
||||
|
||||
Before powering up your ESP32-DevKitM-1, please make sure that it is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Required Hardware
|
||||
Required Hardware
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- ESP32-DevKitM-1
|
||||
- USB 2.0 cable (Standard-A to Micro-B)
|
||||
- Computer running Windows, Linux, or macOS
|
||||
- ESP32-DevKitM-1
|
||||
- USB 2.0 cable (Standard-A to Micro-B)
|
||||
- Computer running Windows, Linux, or macOS
|
||||
|
||||
|
||||
Software Setup
|
||||
Software Setup
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example onto your ESP32-DevKitM-1.
|
||||
@ -125,23 +125,23 @@ Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-starte
|
||||
|
||||
ESP32-DevKitM-1 is a board with a single core module, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in :ref:`menuconfig <get-started-configure>` before flashing your applications.
|
||||
|
||||
Hardware Reference
|
||||
Hardware Reference
|
||||
======================
|
||||
|
||||
Block Diagram
|
||||
Block Diagram
|
||||
----------------------
|
||||
|
||||
A block diagram below shows the components of ESP32-DevKitM-1 and their interconnections.
|
||||
|
||||
.. figure:: ../../../_static/esp32-DevKitM-1_v1_SystemBlock.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitM-1
|
||||
:alt: ESP32-DevKitM-1
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitM-1
|
||||
ESP32-DevKitM-1
|
||||
|
||||
|
||||
Power Source Select
|
||||
Power Source Select
|
||||
----------------------
|
||||
|
||||
There are three mutually exclusive ways to provide power to the board:
|
||||
@ -161,143 +161,143 @@ Pin Descriptions
|
||||
|
||||
The table below provides the Name and Function of pins on both sides of the board. For peripheral pin configurations, please refer to `ESP32 Datasheet`_.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 10 12 12 66
|
||||
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 10 12 12 66
|
||||
|
||||
|
||||
* - No.
|
||||
- Name
|
||||
- Type
|
||||
- Function
|
||||
- Name
|
||||
- Type
|
||||
- Function
|
||||
* - 1
|
||||
- GND
|
||||
- P
|
||||
- Ground
|
||||
- GND
|
||||
- P
|
||||
- Ground
|
||||
* - 2
|
||||
- 3V3
|
||||
- P
|
||||
- 3.3 V power supply
|
||||
- 3V3
|
||||
- P
|
||||
- 3.3 V power supply
|
||||
* - 3
|
||||
- I36
|
||||
- I
|
||||
- GPIO36, ADC1_CH0, RTC_GPIO0
|
||||
- I36
|
||||
- I
|
||||
- GPIO36, ADC1_CH0, RTC_GPIO0
|
||||
* - 4
|
||||
- I37
|
||||
- I
|
||||
- GPIO37, ADC1_CH1, RTC_GPIO1
|
||||
- I37
|
||||
- I
|
||||
- GPIO37, ADC1_CH1, RTC_GPIO1
|
||||
* - 5
|
||||
- I38
|
||||
- I
|
||||
- GPIO38, ADC1_CH2, RTC_GPIO2
|
||||
- I38
|
||||
- I
|
||||
- GPIO38, ADC1_CH2, RTC_GPIO2
|
||||
* - 6
|
||||
- I39
|
||||
- I
|
||||
- GPIO39, ADC1_CH3, RTC_GPIO3
|
||||
- I39
|
||||
- I
|
||||
- GPIO39, ADC1_CH3, RTC_GPIO3
|
||||
* - 7
|
||||
- RST
|
||||
- I
|
||||
- Reset; High: enable; Low: powers off
|
||||
- Reset; High: enable; Low: powers off
|
||||
* - 8
|
||||
- I34
|
||||
- I
|
||||
- GPIO34, ADC1_CH6, RTC_GPIO4
|
||||
- I34
|
||||
- I
|
||||
- GPIO34, ADC1_CH6, RTC_GPIO4
|
||||
* - 9
|
||||
- I35
|
||||
- I
|
||||
- GPIO35, ADC1_CH7, RTC_GPIO5
|
||||
- I35
|
||||
- I
|
||||
- GPIO35, ADC1_CH7, RTC_GPIO5
|
||||
* - 10
|
||||
- IO32
|
||||
- I/O
|
||||
- GPIO32, XTAL_32K_P (32.768 kHz crystal oscillator input), ADC1_CH4, TOUCH9, RTC_GPIO9
|
||||
- IO32
|
||||
- I/O
|
||||
- GPIO32, XTAL_32K_P (32.768 kHz crystal oscillator input), ADC1_CH4, TOUCH9, RTC_GPIO9
|
||||
* - 11
|
||||
- IO33
|
||||
- I/O
|
||||
- GPIO33, XTAL_32K_N (32.768 kHz crystal oscillator output), ADC1_CH5, TOUCH8, RTC_GPIO8
|
||||
- IO33
|
||||
- I/O
|
||||
- GPIO33, XTAL_32K_N (32.768 kHz crystal oscillator output), ADC1_CH5, TOUCH8, RTC_GPIO8
|
||||
* - 12
|
||||
- IO25
|
||||
- I/O
|
||||
- GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
|
||||
- IO25
|
||||
- I/O
|
||||
- GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
|
||||
* - 13
|
||||
- IO26
|
||||
- I/O
|
||||
- GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
|
||||
- IO26
|
||||
- I/O
|
||||
- GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
|
||||
* - 14
|
||||
- IO27
|
||||
- I/O
|
||||
- GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17, EMAC_RX_DV
|
||||
- IO27
|
||||
- I/O
|
||||
- GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17, EMAC_RX_DV
|
||||
* - 15
|
||||
- IO14
|
||||
- I/O
|
||||
- GPIO14, ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, HS2_CLK, SD_CLK, EMAC_TXD2
|
||||
- IO14
|
||||
- I/O
|
||||
- GPIO14, ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, HS2_CLK, SD_CLK, EMAC_TXD2
|
||||
* - 16
|
||||
- 5V
|
||||
- P
|
||||
- 5 V power supply
|
||||
- P
|
||||
- 5 V power supply
|
||||
* - 17
|
||||
- IO12
|
||||
- I/O
|
||||
- GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
|
||||
- IO12
|
||||
- I/O
|
||||
- GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
|
||||
* - 18
|
||||
- IO13
|
||||
- I/O
|
||||
- GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
|
||||
- IO13
|
||||
- I/O
|
||||
- GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
|
||||
* - 19
|
||||
- IO15
|
||||
- I/O
|
||||
- GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
|
||||
- IO15
|
||||
- I/O
|
||||
- GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
|
||||
* - 20
|
||||
- IO2
|
||||
- I/O
|
||||
- GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
|
||||
- IO2
|
||||
- I/O
|
||||
- GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
|
||||
* - 21
|
||||
- IO0
|
||||
- I/O
|
||||
- GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
|
||||
- IO0
|
||||
- I/O
|
||||
- GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
|
||||
* - 22
|
||||
- IO4
|
||||
- I/O
|
||||
- GPIO4, ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, HS2_DATA1, SD_DATA1, EMAC_TX_ER
|
||||
- IO4
|
||||
- I/O
|
||||
- GPIO4, ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, HS2_DATA1, SD_DATA1, EMAC_TX_ER
|
||||
* - 23
|
||||
- IO9
|
||||
- I/O
|
||||
- GPIO9, HS1_DATA2, U1RXD, SD_DATA2
|
||||
- IO9
|
||||
- I/O
|
||||
- GPIO9, HS1_DATA2, U1RXD, SD_DATA2
|
||||
* - 24
|
||||
- IO10
|
||||
- I/O
|
||||
- GPIO10, HS1_DATA3, U1TXD, SD_DATA3
|
||||
- IO10
|
||||
- I/O
|
||||
- GPIO10, HS1_DATA3, U1TXD, SD_DATA3
|
||||
* - 25
|
||||
- IO5
|
||||
- I/O
|
||||
- GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
|
||||
- IO5
|
||||
- I/O
|
||||
- GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
|
||||
* - 26
|
||||
- IO18
|
||||
- I/O
|
||||
- GPIO18, HS1_DATA7, VSPICLK
|
||||
- IO18
|
||||
- I/O
|
||||
- GPIO18, HS1_DATA7, VSPICLK
|
||||
* - 27
|
||||
- IO23
|
||||
- I/O
|
||||
- GPIO23, HS1_STROBE, VSPID
|
||||
- IO23
|
||||
- I/O
|
||||
- GPIO23, HS1_STROBE, VSPID
|
||||
* - 28
|
||||
- IO19
|
||||
- I/O
|
||||
- GPIO19, VSPIQ, U0CTS, EMAC_TXD0
|
||||
- IO19
|
||||
- I/O
|
||||
- GPIO19, VSPIQ, U0CTS, EMAC_TXD0
|
||||
* - 29
|
||||
- IO22
|
||||
- I/O
|
||||
- GPIO22, VSPIWP, U0RTS, EMAC_TXD1
|
||||
- IO22
|
||||
- I/O
|
||||
- GPIO22, VSPIWP, U0RTS, EMAC_TXD1
|
||||
* - 30
|
||||
- IO21
|
||||
- I/O
|
||||
- GPIO21, VSPIHD, EMAC_TX_EN
|
||||
- IO21
|
||||
- I/O
|
||||
- GPIO21, VSPIHD, EMAC_TX_EN
|
||||
* - 31
|
||||
- TXD0
|
||||
- I/O
|
||||
- GPIO1, U0TXD, CLK_OUT3, EMAC_RXD2
|
||||
- TXD0
|
||||
- I/O
|
||||
- GPIO1, U0TXD, CLK_OUT3, EMAC_RXD2
|
||||
* - 32
|
||||
- RXD0
|
||||
- I/O
|
||||
- GPIO3, U0RXD, CLK_OUT2
|
||||
- RXD0
|
||||
- I/O
|
||||
- GPIO3, U0RXD, CLK_OUT2
|
||||
|
||||
|
||||
Hardware Revision Details
|
||||
@ -306,10 +306,10 @@ Hardware Revision Details
|
||||
No previous versions available.
|
||||
|
||||
|
||||
Related Documents
|
||||
Related Documents
|
||||
============================
|
||||
|
||||
* `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-DevKitM-1 Schematics <https://dl.espressif.com/dl/schematics/SCH_ESP32-DEVKITM-1_V1_20200910A.pdf>`_ (PDF)
|
||||
* `ESP32-DevKitM-1 PCB layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-DevKitM-1_V1_20200910AE.pdf>`_ (PDF)
|
||||
* `ESP32-DevKitM-1 layout <https://dl.espressif.com/dl/schematics/ESP32-DevKitM-1_V1.dxf>`_ (DXF) - You can view it with `Autodesk Viewer <https://viewer.autodesk.com/>`_ online
|
||||
|
||||
@ -4,14 +4,14 @@ ESP32-DevKitS(-R)
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide provides information on ESP32-DevKitS(-R), an ESP32-based flashing board produced by Espressif.
|
||||
This user guide provides information on ESP32-DevKitS(-R), an ESP32-based flashing board produced by Espressif.
|
||||
|
||||
ESP32-DevKitS(-R) is a combination of two board names: ESP32-DevKitS and ESP32-DevKitS-R. S stands for springs, and R stands for WROVER.
|
||||
|
||||
+-----------------+-------------------+
|
||||
| |ESP32-DevKitS| | |ESP32-DevKitS-R| |
|
||||
+-----------------+-------------------+
|
||||
| ESP32-DevKitS | ESP32-DevKitS-R |
|
||||
| ESP32-DevKitS | ESP32-DevKitS-R |
|
||||
+-----------------+-------------------+
|
||||
|
||||
.. |ESP32-DevKitS| image:: ../../../_static/esp32-devkits-v1.1-layout-isometric-raw.png
|
||||
@ -37,7 +37,7 @@ Overview
|
||||
|
||||
ESP32-DevKitS(-R) is Espressif's flashing board designed specifically for ESP32. It can be used to flash an ESP32 module without soldering the module to the power supply and signal lines. With a module mounted, ESP32-DevKitS(-R) can also be used as a mini development board like ESP32-DevKitC.
|
||||
|
||||
ESP32-DevKitS and ESP32-DevKitS-R boards vary only in layout of spring pins to fit the following ESP32 modules.
|
||||
ESP32-DevKitS and ESP32-DevKitS-R boards vary only in layout of spring pins to fit the following ESP32 modules.
|
||||
|
||||
- ESP32-DevKitS:
|
||||
- ESP32-WROOM-32
|
||||
@ -117,7 +117,7 @@ Hardware Setup
|
||||
Please mount a module of your choice onto your ESP32-DevKitS(-R) according to the following steps:
|
||||
|
||||
- Gently put your module on the ESP32-DevKitS(-R) board. Make sure that castellated holes on your module are aligned with spring pins on the board.
|
||||
- Press your module down into the board until it clicks.
|
||||
- Press your module down into the board until it clicks.
|
||||
- Check whether all spring pins are inserted into castellated holes. If there are some misaligned spring pins, place them into castellated holes with tweezers.
|
||||
|
||||
|
||||
@ -147,14 +147,14 @@ Board Dimensions
|
||||
:align: center
|
||||
:alt: ESP32-DevKitS
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
ESP32-DevKitS board dimensions - back
|
||||
|
||||
.. figure:: ../../../_static/esp32-devkits-r-v1.1-dimensions-back.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitS-R
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
ESP32-DevKitS-R board dimensions - back
|
||||
|
||||
|
||||
@ -166,7 +166,7 @@ Retail orders
|
||||
|
||||
If you order a few samples, each ESP32-DevKitS(-R) comes in an individual package in either antistatic bag or any packaging depending on a retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -266,4 +266,4 @@ Related Documents
|
||||
- `ESP32-SOLO-1 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-solo-1_datasheet_en.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER-B Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf>`_ (PDF)
|
||||
- `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
|
||||
- `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
|
||||
|
||||
@ -16,7 +16,7 @@ Most of the I/O pins are broken out to the pin headers on both sides for easy in
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-C3-DevKitC-02
|
||||
|
||||
|
||||
The document consists of the following major sections:
|
||||
|
||||
- `Getting Started`_: Overview of ESP32-C3-DevKitC-02 and hardware/software setup instructions to get started.
|
||||
@ -98,7 +98,7 @@ Retail orders
|
||||
|
||||
If you order a few samples, each ESP32-C3-DevKitC-02 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -152,12 +152,12 @@ No. Name Type [1]_ Function
|
||||
3 3V3 P 3.3 V power supply
|
||||
4 RST I CHIP_PU
|
||||
5 G G Ground
|
||||
6 4 I/O/T GPIO4, ADC1_CH4, FSPIHD, MTMS
|
||||
6 4 I/O/T GPIO4, ADC1_CH4, FSPIHD, MTMS
|
||||
7 5 I/O/T GPIO5, ADC2_CH0, FSPIWP, MTDI
|
||||
8 6 I/O/T GPIO6, FSPICLK, MTCK
|
||||
9 7 I/O/T GPIO7, FSPID, MTDO
|
||||
10 G G Ground
|
||||
11 8 I/O/T GPIO8 [2]_, RGB LED
|
||||
11 8 I/O/T GPIO8 [2]_, RGB LED
|
||||
12 9 I/O/T GPIO9 [2]_
|
||||
13 5V P 5 V power supply
|
||||
14 5V P 5 V power supply
|
||||
@ -170,18 +170,18 @@ J3
|
||||
No. Name Type [1]_ Function
|
||||
=== ==== ========== ====================================
|
||||
1 G G Ground
|
||||
2 0 I/O/T GPIO0, ADC1_CH0, XTAL_32K_P
|
||||
3 1 I/O/T GPIO1, ADC1_CH1, XTAL_32K_N
|
||||
4 2 I/O/T GPIO2 [2]_, ADC1_CH2, FSPIQ
|
||||
5 3 I/O/T GPIO3, ADC1_CH3
|
||||
2 0 I/O/T GPIO0, ADC1_CH0, XTAL_32K_P
|
||||
3 1 I/O/T GPIO1, ADC1_CH1, XTAL_32K_N
|
||||
4 2 I/O/T GPIO2 [2]_, ADC1_CH2, FSPIQ
|
||||
5 3 I/O/T GPIO3, ADC1_CH3
|
||||
6 G G Ground
|
||||
7 10 I/O/T GPIO10, FSPICS0
|
||||
7 10 I/O/T GPIO10, FSPICS0
|
||||
8 G G Ground
|
||||
9 RX I/O/T GPIO20, U0RXD
|
||||
10 TX I/O/T GPIO21, U0TXD
|
||||
9 RX I/O/T GPIO20, U0RXD
|
||||
10 TX I/O/T GPIO21, U0TXD
|
||||
11 G G Ground
|
||||
12 18 I/O/T GPIO18
|
||||
13 19 I/O/T GPIO19
|
||||
12 18 I/O/T GPIO18
|
||||
13 19 I/O/T GPIO19
|
||||
14 G G Ground
|
||||
15 G G Ground
|
||||
=== ==== ========== ====================================
|
||||
@ -207,7 +207,7 @@ No previous versions available.
|
||||
Related Documents
|
||||
=================
|
||||
* `Build Secure and Cost-effective Connected Devices with ESP32-C3 <http://c3.espressif.com/>`_
|
||||
* `ESP32-C3 Datasheet`_ (PDF)
|
||||
* `ESP32-C3 Datasheet`_ (PDF)
|
||||
* `ESP32-C3-WROOM-02 Datasheet`_ (PDF)
|
||||
* `ESP32-C3-DevKitC-02 Schematic`_ (PDF)
|
||||
* `ESP32-C3-DevKitC-02 PCB Layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-C3-DevKitC-02_V1_1_20210121AA.pdf>`_ (PDF)
|
||||
|
||||
@ -8,7 +8,7 @@ This user guide will help you get started with ESP32-C3-DevKitM-1 and will also
|
||||
|
||||
ESP32-C3-DevKitM-1 is an entry-level development board based on `ESP32-C3-MINI-1 <https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_en.pdf>`_, a module named for its small size. This board integrates complete Wi-Fi and Bluetooth LE functions.
|
||||
|
||||
Most of the I/O pins on the ESP32-C3-MINI-1 module are broken out to the pin headers on both sides of this board for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-C3-DevKitM-1 on a breadboard.
|
||||
Most of the I/O pins on the ESP32-C3-MINI-1 module are broken out to the pin headers on both sides of this board for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-C3-DevKitM-1 on a breadboard.
|
||||
|
||||
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-isometric.png
|
||||
:align: center
|
||||
@ -16,7 +16,7 @@ Most of the I/O pins on the ESP32-C3-MINI-1 module are broken out to the pin hea
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-C3-DevKitM-1
|
||||
|
||||
|
||||
The document consists of the following major sections:
|
||||
|
||||
- `Getting Started`_: Overview of ESP32-C3-DevKitM-1 and hardware/software setup instructions to get started.
|
||||
@ -77,7 +77,7 @@ Before powering up your ESP32-C3-DevKitM-1, please make sure that it is in good
|
||||
Required Hardware
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
- ESP32-C3-DevKitM-1
|
||||
- ESP32-C3-DevKitM-1
|
||||
- USB 2.0 cable (Standard-A to Micro-B)
|
||||
- Computer running Windows, Linux, or macOS
|
||||
|
||||
@ -98,7 +98,7 @@ Retail Orders
|
||||
|
||||
If you order one or several samples, each ESP32-C3-DevKitM-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
|
||||
@ -11,9 +11,9 @@ ESP32-S2-DevKitM-1(U) is a general-purpose development board based on `ESP32-S2F
|
||||
ESP32-S2-DevKitM-1 is embedded with `ESP32-S2-MINI-1 <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (on-board PCB antenna), while ESP32-S2-DevKitM-1U with `ESP32-S2-MINI-1U <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (external antenna connector).
|
||||
|
||||
+----------------------+-----------------------+
|
||||
| |ESP32-S2-DevKitM-1| | |ESP32-S2-DevKitM-1U| |
|
||||
| |ESP32-S2-DevKitM-1| | |ESP32-S2-DevKitM-1U| |
|
||||
+----------------------+-----------------------+
|
||||
| ESP32-S2-DevKitM-1 | ESP32-S2-DevKitM-1U |
|
||||
| ESP32-S2-DevKitM-1 | ESP32-S2-DevKitM-1U |
|
||||
+----------------------+-----------------------+
|
||||
|
||||
.. |ESP32-S2-DevKitM-1| image:: ../../../_static/esp32-s2-devkitm-1-v1-isometric.png
|
||||
@ -35,7 +35,7 @@ This section describes how to get started with ESP32-S2-DevKitM-1(U). It begins
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-S2-DevKitM-1(U) is entry-level development board equipped with either ESP32-S2-MINI-1 or ESP32-S2-MINI-1U module. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1(U) on a breadboard.
|
||||
ESP32-S2-DevKitM-1(U) is entry-level development board equipped with either ESP32-S2-MINI-1 or ESP32-S2-MINI-1U module. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1(U) on a breadboard.
|
||||
|
||||
Contents and Packaging
|
||||
----------------------
|
||||
@ -45,7 +45,7 @@ Retail orders
|
||||
|
||||
If you order a few samples, each ESP32-S2-DevKitM-1(U) comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -74,7 +74,7 @@ Description of Components
|
||||
|
||||
ESP32-S2-DevKitM-1U - front
|
||||
|
||||
The key components of the board are described in a clockwise direction.
|
||||
The key components of the board are described in a clockwise direction.
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
@ -101,7 +101,7 @@ The key components of the board are described in a clockwise direction.
|
||||
* - 5 V to 3.3 V LDO
|
||||
- Power regulator that converts a 5 V supply into a 3.3 V output.
|
||||
* - External Antenna Connector
|
||||
- On **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_.
|
||||
- On **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_.
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
@ -114,7 +114,7 @@ Required Hardware
|
||||
- ESP32-S2-DevKitM-1(U)
|
||||
|
||||
+ For ESP32-S2-DevKitM-1U, an antenna is also required.
|
||||
|
||||
|
||||
- USB 2.0 cable (Standard-A to Micro-B)
|
||||
- Computer running Windows, Linux, or macOS
|
||||
|
||||
@ -128,7 +128,7 @@ Software Setup
|
||||
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example into your ESP32-S2-DevKitM-1(U).
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
ESP32-S2 series of chips only is only supported in ESP-IDF master or version v4.2 and higher.
|
||||
|
||||
Hardware Reference
|
||||
@ -168,7 +168,7 @@ The two tables below provide the **Name** and **Function** of the pin headers on
|
||||
J1
|
||||
^^^
|
||||
=== ==== ========== =============================================================
|
||||
No. Name Type [#]_ Function
|
||||
No. Name Type [#]_ Function
|
||||
=== ==== ========== =============================================================
|
||||
1 3V3 P 3.3 V power supply
|
||||
2 0 I/O/T RTC_GPIO0, GPIO0
|
||||
@ -221,7 +221,7 @@ No. Name Type Function
|
||||
21 18 I/O/T RTC_GPIO18, GPIO18, U1RXD, ADC2_CH7, DAC_2, CLK_OUT3, RGB LED
|
||||
=== ==== ===== ========================================================
|
||||
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
|
||||
Pin Layout
|
||||
^^^^^^^^^^^
|
||||
@ -232,7 +232,7 @@ Pin Layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-DevKitM-1(U) Pin Layout (click to enlarge)
|
||||
|
||||
|
||||
Hardware Revision Details
|
||||
=========================
|
||||
|
||||
@ -245,6 +245,6 @@ Related Documents
|
||||
* `ESP32-S2-DevKitM-1(U) Dimensions <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Dimensions.pdf>`_ (PDF)
|
||||
* `ESP32-S2 Series Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
|
||||
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
|
||||
|
||||
For other design documentation for the board, please contact us at `sales@espressif.com <sales@espressif.com>`_.
|
||||
|
||||
@ -114,7 +114,7 @@ Description of Components
|
||||
:scale: 70%
|
||||
:alt: ESP32-S2-Kaluga-1 - front
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
ESP32-S2-Kaluga-1 - front (click to enlarge)
|
||||
|
||||
|
||||
@ -236,7 +236,7 @@ If you order one or several samples of the kit, each ESP32-S2-Kaluga-1 developme
|
||||
- Screws (x4)
|
||||
- Nuts (x4)
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -296,7 +296,7 @@ If you want to use more than one extension board at the same time, please check
|
||||
- No ready solution for now.
|
||||
* - TouchA v1.1 + LCD32 v1.1
|
||||
- IO11, IO6
|
||||
- Touch actions cannot be triggered because of the multiplexed pin IO11. ESP-LyraP-LCD32 is also affected because its BK (BLCT) pin is connected to pin IO6.
|
||||
- Touch actions cannot be triggered because of the multiplexed pin IO11. ESP-LyraP-LCD32 is also affected because its BK (BLCT) pin is connected to pin IO6.
|
||||
- Do not initialize IO11 (NETWORK) and IO6 (PHOTO) for your ESP-LyraP-TouchA.
|
||||
* - 8311A v1.2 + LCD32 v1.1
|
||||
- IO6
|
||||
|
||||
@ -257,7 +257,7 @@ The contents are as follows:
|
||||
- Screws (x4)
|
||||
- Nuts (x4)
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -393,4 +393,3 @@ Related Documents
|
||||
For other design documentation for the board, please contact us at sales@espressif.com.
|
||||
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ Description of Components
|
||||
|
||||
ESP32-S2-DevKitC-1 - front
|
||||
|
||||
The key components of the board are described in a clockwise direction.
|
||||
The key components of the board are described in a clockwise direction.
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
@ -54,7 +54,7 @@ The key components of the board are described in a clockwise direction.
|
||||
* - 3.3 V Power On LED
|
||||
- Turns on when the USB power is connected to the board.
|
||||
* - USB-to-UART Bridge
|
||||
- Single USB-to-UART bridge chip provides transfer rates up to 3 Mbps.
|
||||
- Single USB-to-UART bridge chip provides transfer rates up to 3 Mbps.
|
||||
* - Pin Headers
|
||||
- All available GPIO pins (except for the SPI bus for flash) are broken out to the pin headers on the board. For details, please see :ref:`user-guide-s2-devkitc-1-v1-header-blocks`.
|
||||
* - ESP32-S2 USB Port
|
||||
@ -64,7 +64,7 @@ The key components of the board are described in a clockwise direction.
|
||||
* - Boot Button
|
||||
- Download button. Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
* - USB-to-UART Port
|
||||
- A Micro-USB port used for power supply to the board, for flashing applications to the chip, as well as the communication with the chip via the on-board USB-to-UART bridge.
|
||||
- A Micro-USB port used for power supply to the board, for flashing applications to the chip, as well as the communication with the chip via the on-board USB-to-UART bridge.
|
||||
* - RGB LED
|
||||
- Addressable RGB LED, driven by GPIO18.
|
||||
* - 5 V to 3.3 V LDO
|
||||
@ -105,7 +105,7 @@ Retail orders
|
||||
|
||||
If you order a few samples, each ESP32-S2-DevKitC-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
Wholesale Orders
|
||||
^^^^^^^^^^^^^^^^
|
||||
@ -141,15 +141,15 @@ There are three mutually exclusive ways to provide power to the board:
|
||||
|
||||
.. _user-guide-s2-devkitc-1-v1-header-blocks:
|
||||
|
||||
Header Block
|
||||
-------------
|
||||
|
||||
The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-s2-devkitc-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitC-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-S2-DEVKITC-1_V1_20210508.pdf>`_ (PDF).
|
||||
Header Block
|
||||
-------------
|
||||
|
||||
J1
|
||||
^^^
|
||||
The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-s2-devkitc-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitC-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-S2-DEVKITC-1_V1_20210508.pdf>`_ (PDF).
|
||||
|
||||
J1
|
||||
^^^
|
||||
=== ==== ========== ==========================================================================
|
||||
No. Name Type [#]_ Function
|
||||
No. Name Type [#]_ Function
|
||||
=== ==== ========== ==========================================================================
|
||||
1 3V3 P 3.3 V power supply
|
||||
2 3V3 P 3.3 V power supply
|
||||
@ -173,13 +173,13 @@ No. Name Type [#]_ Function
|
||||
20 14 I/O/T RTC_GPIO14, GPIO14, TOUCH14, ADC2_CH3, FSPIWP, FSPIDQS
|
||||
21 5V P 5 V power supply
|
||||
22 G G Ground
|
||||
=== ==== ========== ==========================================================================
|
||||
|
||||
|
||||
J3
|
||||
^^^
|
||||
=== ==== ===== ============================================================
|
||||
No. Name Type Function
|
||||
=== ==== ========== ==========================================================================
|
||||
|
||||
|
||||
J3
|
||||
^^^
|
||||
=== ==== ===== ============================================================
|
||||
No. Name Type Function
|
||||
=== ==== ===== ============================================================
|
||||
1 G G Ground
|
||||
2 TX I/O/T U0TXD, GPIO43, CLK_OUT1
|
||||
@ -204,8 +204,8 @@ No. Name Type Function
|
||||
21 G G Ground
|
||||
22 G G Ground
|
||||
=== ==== ===== ============================================================
|
||||
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
|
||||
Pin Layout
|
||||
^^^^^^^^^^^
|
||||
@ -216,7 +216,7 @@ Pin Layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-DevKitC-1 Pin Layout (click to enlarge)
|
||||
|
||||
|
||||
Hardware Revision Details
|
||||
=========================
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Retail orders
|
||||
|
||||
If you order a few samples, each ESP32-S2-Saola-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
Wholesale Orders
|
||||
^^^^^^^^^^^^^^^^
|
||||
@ -68,7 +68,7 @@ Description of Components
|
||||
|
||||
ESP32-S2-Saola-1 - front
|
||||
|
||||
The key components of the board are described in a clockwise direction.
|
||||
The key components of the board are described in a clockwise direction.
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
@ -115,7 +115,7 @@ Software Setup
|
||||
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example into your ESP32-S2-Saola-1.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
ESP32-S2 series of chips only supports ESP-IDF master or version v4.2 and higher.
|
||||
|
||||
Hardware Reference
|
||||
@ -153,7 +153,7 @@ The two tables below provide the **Name** and **Function** of the pin headers on
|
||||
J2
|
||||
^^^
|
||||
=== ==== ========== ======================================
|
||||
No. Name Type [#]_ Function
|
||||
No. Name Type [#]_ Function
|
||||
=== ==== ========== ======================================
|
||||
1 3V3 P 3.3 V power supply
|
||||
2 IO0 I/O GPIO0, Boot
|
||||
@ -206,7 +206,7 @@ No. Name Type Function
|
||||
21 IO18 I/O GPIO18, ADC2_CH7, DAC_2, RGB LED
|
||||
=== ==== ===== ====================================
|
||||
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
|
||||
|
||||
Pin Layout
|
||||
^^^^^^^^^^^
|
||||
|
||||
@ -173,7 +173,7 @@ Retail Orders
|
||||
|
||||
If you order a few samples, each board comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -260,9 +260,9 @@ No. Name Type Function
|
||||
1 G G Ground
|
||||
2 TX I/O/T U0TXD, GPIO43, CLK_OUT1
|
||||
3 RX I/O/T U0RXD, GPIO44, CLK_OUT2
|
||||
4 1 I/O/T RTC_GPIO1, GPIO1, TOUCH1, ADC1_CH0
|
||||
5 2 I/O/T RTC_GPIO2, GPIO2, TOUCH2, ADC1_CH1
|
||||
6 42 I/O/T MTMS, GPIO42
|
||||
4 1 I/O/T RTC_GPIO1, GPIO1, TOUCH1, ADC1_CH0
|
||||
5 2 I/O/T RTC_GPIO2, GPIO2, TOUCH2, ADC1_CH1
|
||||
6 42 I/O/T MTMS, GPIO42
|
||||
7 41 I/O/T MTDI, GPIO41, CLK_OUT1
|
||||
8 40 I/O/T MTDO, GPIO40, CLK_OUT2
|
||||
9 39 I/O/T MTCK, GPIO39, CLK_OUT3, SUBSPICS1
|
||||
|
||||
@ -111,7 +111,7 @@ Retail Orders
|
||||
|
||||
If you order a few samples, each board comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
@ -135,7 +135,7 @@ The block diagram below shows the components of ESP32-S3-DevKitM-1 and their int
|
||||
|
||||
.. figure:: ../../../_static/ESP32-S3-DevKitM-1_v1_SystemBlock.png
|
||||
:align: center
|
||||
:scale: 70%
|
||||
:scale: 70%
|
||||
:alt: ESP32-S3-DevKitM-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
@ -199,9 +199,9 @@ No. Name Type Function
|
||||
1 G G Ground
|
||||
2 RST I EN
|
||||
3 46 I/O/T GPIO46
|
||||
4 45 I/O/T GPIO45
|
||||
5 RX I/O/T U0RXD, GPIO44, CLK_OUT2
|
||||
6 TX I/O/T U0TXD, GPIO43, CLK_OUT1
|
||||
4 45 I/O/T GPIO45
|
||||
5 RX I/O/T U0RXD, GPIO44, CLK_OUT2
|
||||
6 TX I/O/T U0TXD, GPIO43, CLK_OUT1
|
||||
7 42 I/O/T MTMS, GPIO42
|
||||
8 41 I/O/T MTDI, GPIO41, CLK_OUT1
|
||||
9 40 I/O/T MTDO, GPIO40, CLK_OUT2
|
||||
|
||||
@ -8,7 +8,7 @@ ESP-IDF Programming Guide
|
||||
|
||||
The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
|
||||
|
||||
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
|
||||
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/socs>`_.
|
||||
|
||||
.. only:: html
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@ Tencent IoT
|
||||
Tencentyun IoT
|
||||
--------------
|
||||
|
||||
`https://github.com/espressif/esp-qcloud <https://github.com/espressif/esp-qcloud>`_ is an open source repository for {IDF_TARGET_NAME} based on Tencentyun's `qcloud-iot-sdk-embedded-c SDK <https://github.com/tencentyun/qcloud-iot-sdk-embedded-c>`_.
|
||||
`https://github.com/espressif/esp-qcloud <https://github.com/espressif/esp-qcloud>`_ is an open source repository for {IDF_TARGET_NAME} based on Tencentyun's `qcloud-iot-sdk-embedded-c SDK <https://github.com/TencentCloud/tencentcloud-iot-sdk-embedded-c>`_.
|
||||
|
||||
Baidu IoT
|
||||
---------
|
||||
|
||||
@ -6,7 +6,7 @@ Migration of Protocol Components to ESP-IDF 5.0
|
||||
Mbed TLS
|
||||
--------
|
||||
|
||||
For ESP-IDF v5.0, `Mbed TLS <https://github.com/ARMmbed/mbedtls>`_ has been updated from v2.x to v3.1.0.
|
||||
For ESP-IDF v5.0, `Mbed TLS <https://github.com/Mbed-TLS/mbedtls>`_ has been updated from v2.x to v3.1.0.
|
||||
|
||||
The official guide for Mbed TLS to migrate from version 2.x to version 3.0 or greater can be found `here <https://github.com/espressif/mbedtls/blob/9bb5effc3298265f829878825d9bd38478e67514/docs/3.0-migration-guide.md>`__.
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Useful Links
|
||||
|
||||
* To develop applications using Arduino platform, refer to `Arduino core for the ESP32, ESP32-S2 and ESP32-C3 <https://github.com/espressif/arduino-esp32#readme>`_.
|
||||
|
||||
* Several `books <https://www.espressif.com/en/support/iot-college/books-new>`_ have been written about ESP32 and they are listed on `Espressif <https://www.espressif.com/en/support/iot-college/books-new>`__ web site.
|
||||
* Several `books <https://www.espressif.com/en/ecosystem/community-engagement/books>`_ have been written about ESP32 and they are listed on `Espressif <https://www.espressif.com/en/ecosystem/community-engagement/books>`__ web site.
|
||||
|
||||
* If you're interested in contributing to ESP-IDF, please check the :doc:`contribute/index`.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ See :ref:`updating` if you already have a local copy of ESP-IDF and wish to upda
|
||||
Versioning Scheme
|
||||
-----------------
|
||||
|
||||
ESP-IDF uses `Semantic Versioning <http://semver.org/>`_. This means that:
|
||||
ESP-IDF uses `Semantic Versioning <https://semver.org/>`_. This means that:
|
||||
|
||||
- Major Releases, like ``v3.0``, add new functionality and may change functionality. This includes removing deprecated functionality.
|
||||
|
||||
@ -254,7 +254,7 @@ Each time you ``git pull`` this branch, ESP-IDF will be updated with fixes for t
|
||||
|
||||
There is no dedicated documentation for release branches. It is recommended to use the documentation for the closest version to the branch which is currently checked out.
|
||||
|
||||
.. _`Releases page`: http://github.com/espressif/esp-idf/releases
|
||||
.. _`Releases page`: https://github.com/espressif/esp-idf/releases
|
||||
.. _`list of branches`: https://github.com/espressif/esp-idf/branches
|
||||
.. _`list of tags`: https://github.com/espressif/esp-idf/tags
|
||||
.. _`current stable version`: https://docs.espressif.com/projects/esp-idf/en/stable/
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
本指南为 `乐鑫 <https://espressif.com>`_ 公司 `{IDF_TARGET_NAME} <https://espressif.com/en/products/hardware/esp32/overview>`_ 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
|
||||
本指南为 `乐鑫 <https://espressif.com>`_ 公司 `{IDF_TARGET_NAME} <https://www.espressif.com/en/products/socs/esp32>`_ 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
|
||||
|
||||
{IDF_TARGET_NAME} 芯片是一款 2.4 GHz Wi-Fi 和蓝牙双模芯片，内置 1 或 2 个 Xtensa® 32 位 LX6 处理器，运算能力最高可达 600 DMIPS。
|
||||
|
||||
|
||||
@ -444,7 +444,7 @@ Start 子命令语法：
|
||||
6. 双击创建的端口，会打开此端口的视图。
|
||||
7. 单击 ``Start/Stop Streaming`` 按钮，数据将会被加载。
|
||||
8. 使用 ``Zoom Out``，``Zoom In`` 和 ``Zoom Fit`` 按钮来查看数据。
|
||||
9. 有关设置测量光标和其他的功能，请参阅 `Impulse 官方文档 <http://toem.de/index.php/projects/impulse>`_ 。
|
||||
9. 有关设置测量光标和其他的功能，请参阅 `Impulse 官方文档 <https://toem.de/index.php/projects/impulse>`_ 。
|
||||
|
||||
.. note::
|
||||
|
||||
@ -459,7 +459,7 @@ Gcov（源代码覆盖）
|
||||
Gcov 和 Gcovr 简介
|
||||
""""""""""""""""""""""""
|
||||
|
||||
源代码覆盖率显示程序运行时间内执行的每一条程序执行路径的数量和频率。`Gcov <https://en.wikipedia.org/wiki/Gcov>`_ 是一款 GCC 工具，与编译器协同使用时，可生成日志文件，显示源文件每行的执行次数。`Gcovr <https://gcovr.com>`_ 是管理 Gcov 和生成代码覆盖率总结的工具。
|
||||
源代码覆盖率显示程序运行时间内执行的每一条程序执行路径的数量和频率。`Gcov <https://en.wikipedia.org/wiki/Gcov>`_ 是一款 GCC 工具，与编译器协同使用时，可生成日志文件，显示源文件每行的执行次数。`Gcovr <https://gcovr.com/>`_ 是管理 Gcov 和生成代码覆盖率总结的工具。
|
||||
|
||||
一般来说，使用 Gcov 在主机上编译和运行程序会经过以下步骤：
|
||||
|
||||
@ -553,7 +553,7 @@ GDB 可以用来在 :cpp:func:`esp_gcov_dump` 上设置断点，然后使用 ``g
|
||||
|
||||
一旦代码覆盖数据被转储，``.gcno``、``.gcda`` 和源文件可以用来生成代码覆盖报告。该报告会显示源文件中每行被执行的次数。
|
||||
|
||||
Gcov 和 Gcovr 都可以用来生成代码覆盖报告。安装 Xtensa 工具链时会一起安装 Gcov，但 Gcovr 可能需要单独安装。关于如何使用 Gcov 或 Gcovr，请参考 `Gcov 文档 <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_ 和 `Gcovr 文档 <http://gcovr.com/>`_。
|
||||
Gcov 和 Gcovr 都可以用来生成代码覆盖报告。安装 Xtensa 工具链时会一起安装 Gcov，但 Gcovr 可能需要单独安装。关于如何使用 Gcov 或 Gcovr，请参考 `Gcov 文档 <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_ 和 `Gcovr 文档 <https://gcovr.com/>`_。
|
||||
|
||||
在工程中添加 Gcovr 构建目标
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -1016,7 +1016,7 @@ CMake 在许多开源的 C/C++ 项目中广泛使用，用户可以在自己的
|
||||
|
||||
实际的案例请参考 :example:`build_system/cmake/import_lib`。请注意，导入第三方库所需要做的工作可能会因库的不同而有所差异。建议仔细阅读第三方库的文档，了解如何将其导入到其它项目中。阅读第三方库的 CMakeLists.txt 文件以及构建结构也会有所帮助。
|
||||
|
||||
用这种方式还可以将第三方库封装成 ESP-IDF 的组件。例如 :component:`mbedtls` 组件就是封装了 `mbedtls 项目 <https://github.com/ARMmbed/mbedtls>`_ 得到的。详情请参考 :component_file:`mbedtls 组件的 CMakeLists.txt 文件 <mbedtls/CMakeLists.txt>`。
|
||||
用这种方式还可以将第三方库封装成 ESP-IDF 的组件。例如 :component:`mbedtls` 组件就是封装了 `mbedtls 项目 <https://github.com/Mbed-TLS/mbedtls>`_ 得到的。详情请参考 :component_file:`mbedtls 组件的 CMakeLists.txt 文件 <mbedtls/CMakeLists.txt>`。
|
||||
|
||||
每当使用 ESP-IDF 构建系统时，CMake 变量 ``ESP_PLATFORM`` 都会被设置为 1。如果要在通用的 CMake 代码加入 IDF 特定的代码时，可以采用 ``if (ESP_PLATFORM)`` 的形式加以分隔。
|
||||
|
||||
@ -1454,7 +1454,7 @@ CMake 中不可用的功能
|
||||
- ``COMPONENT_OBJS``：以前，可以以目标文件列表的方式指定组件源，现在，可以通过 ``COMPONENT_SRCS`` 以源文件列表的形式指定组件源。
|
||||
- ``COMPONENT_OBJEXCLUDE``：已被 ``COMPONENT_SRCEXCLUDE`` 替换。用于指定源文件（绝对路径或组件目录的相对路径）。
|
||||
- ``COMPONENT_EXTRA_CLEAN``：已被 ``ADDITIONAL_MAKE_CLEAN_FILES`` 属性取代，注意，:ref:`CMake 对此项功能有部分限制 <ADDITIONAL_MAKE_CLEAN_FILES_note>`。
|
||||
- ``COMPONENT_OWNBUILDTARGET`` & ``COMPONENT_OWNCLEANTARGET``：已被 CMake `外部项目 <ExternalProject>`_ 替代，详细内容请参阅 :ref:`component-build-full-override`。
|
||||
- ``COMPONENT_OWNBUILDTARGET`` & ``COMPONENT_OWNCLEANTARGET``：已被 CMake `外部项目 <ExternalProject_>` 替代，详细内容请参阅 :ref:`component-build-full-override`。
|
||||
- ``COMPONENT_CONFIG_ONLY``：已被 ``register_config_only_component()`` 函数替代，请参阅 :ref:`config_only_component`。
|
||||
- ``CFLAGS``、``CPPFLAGS``、``CXXFLAGS``：已被相应的 CMake 命令替代，请参阅 :ref:`component_build_control`。
|
||||
|
||||
|
||||
@ -530,11 +530,13 @@ ESP-BLE-MESH 常见问题手册
|
||||
3.2 Wi-Fi 和 ESP-BLE-MESH 共存时，为什么 Wi-Fi 吞吐量很低？
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
未搭载 PSRAM 的 `ESP32-DevKitC <../../hw-reference/get-started-devkitc>`_ 开发板，Wi-Fi 和 ESP-BLE-MESH 共存可以正常运行，但是吞吐率较低。当 Wi-Fi 和 ESP-BLE-MESH 共存时，搭载 PSRAM 的 ESP32-DevKitC 速率可以稳定在 1 Mbps 以上。
|
||||
.. only:: esp32
|
||||
|
||||
未搭载 PSRAM 的 :doc:`ESP32-DevKitC <../../hw-reference/esp32/get-started-devkitc>` 开发板，Wi-Fi 和 ESP-BLE-MESH 共存可以正常运行，但是吞吐率较低。当 Wi-Fi 和 ESP-BLE-MESH 共存时，搭载 PSRAM 的 ESP32-DevKitC 速率可以稳定在 1 Mbps 以上。
|
||||
|
||||
应使能 menuconfig 中的一些配置来支持 PSRAM。
|
||||
|
||||
- :code:`ESP32-specific --> Support for external,SPI-connected RAM --> Try to allocate memories of Wi-Fi and LWIP...`
|
||||
- :code:`{IDF_TARGET_NAME}-specific --> Support for external,SPI-connected RAM --> Try to allocate memories of Wi-Fi and LWIP...`
|
||||
- :code:`Bluetooth --> Bluedriod Enable --> BT/BLE will first malloc the memory from the PSRAM`
|
||||
- :code:`Bluetooth --> Bluedriod Enable --> Use dynamic memory allocation in BT/BLE stack.`
|
||||
- :code:`Bluetooth --> Blutooth controller --> BLE full scan feature supported.`
|
||||
|
||||
@ -229,9 +229,9 @@ ESP-BLE-MESH 示例
|
||||
ESP-BLE-MESH 演示视频
|
||||
======================
|
||||
|
||||
* `Provisioning of ESP-BLE-MESH nodes using Smartphone App <http://download.espressif.com/BLE_MESH/Docs4Customers/esp-ble-mesh-demo.mp4>`_
|
||||
* `Espressif Fast Provisioning using ESP-BLE-MESH App <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
|
||||
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <http://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`_
|
||||
* `Provisioning of ESP-BLE-MESH nodes using Smartphone App <https://download.espressif.com/BLE_MESH/Docs4Customers/esp-ble-mesh-demo.mp4>`_
|
||||
* `Espressif Fast Provisioning using ESP-BLE-MESH App <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
|
||||
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`_
|
||||
|
||||
|
||||
ESP-BLE-MESH 常见问题手册
|
||||
@ -262,15 +262,15 @@ ESP-BLE-MESH 常见问题手册
|
||||
蓝牙 SIG 文档
|
||||
-------------
|
||||
|
||||
- `BLE Mesh Profile Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=457092>`_
|
||||
- `BLE Mesh Model Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=457091>`_
|
||||
- `An Intro to Bluetooth Mesh Part 1 <https://blog.bluetooth.com/an-intro-to-bluetooth-mesh-part1>`_ / `Part 2 <https://blog.bluetooth.com/an-intro-to-bluetooth-mesh-part2>`__
|
||||
- `The Fundamental Concepts of Bluetooth Mesh Networking, Part 1 <https://blog.bluetooth.com/the-fundamental-concepts-of-bluetooth-mesh-networking-part-1>`_ / `Part 2 <https://blog.bluetooth.com/the-fundamental-concepts-of-bluetooth-mesh-networking-part-2>`__
|
||||
- `Bluetooth Mesh Networking: Friendship <https://blog.bluetooth.com/bluetooth-mesh-networking-series-friendship>`_
|
||||
- `Management of Devices in a Bluetooth Mesh Network <https://blog.bluetooth.com/management-of-devices-bluetooth-mesh-network>`_
|
||||
- `Bluetooth Mesh Security Overview <https://blog.bluetooth.com/bluetooth-mesh-security-overview>`_
|
||||
- `Provisioning a Bluetooth Mesh Network Part 1 <https://blog.bluetooth.com/provisioning-a-bluetooth-mesh-network-part-1>`_ / `Part 2 <https://blog.bluetooth.com/provisioning-a-bluetooth-mesh-network-part-2>`__
|
||||
- `BLE Mesh Core Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=429633>`_
|
||||
- `BLE Mesh Model Specification <https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=429634>`_
|
||||
- `An Intro to Bluetooth Mesh Part 1 <https://www.bluetooth.com/blog/an-intro-to-bluetooth-mesh-part1>`_ / `Part 2 <https://www.bluetooth.com/blog/an-intro-to-bluetooth-mesh-part2>`__
|
||||
- `The Fundamental Concepts of Bluetooth Mesh Networking, Part 1 <https://www.bluetooth.com/blog/the-fundamental-concepts-of-bluetooth-mesh-networking-part-1>`_ / `Part 2 <https://www.bluetooth.com/blog/the-fundamental-concepts-of-bluetooth-mesh-networking-part-2>`__
|
||||
- `Bluetooth Mesh Networking: Friendship <https://www.bluetooth.com/blog/bluetooth-mesh-networking-series-friendship>`_
|
||||
- `Management of Devices in a Bluetooth Mesh Network <https://www.bluetooth.com/blog/management-of-devices-bluetooth-mesh-network>`_
|
||||
- `Bluetooth Mesh Security Overview <https://www.bluetooth.com/blog/bluetooth-mesh-security-overview>`_
|
||||
- `Provisioning a Bluetooth Mesh Network Part 1 <https://www.bluetooth.com/blog/provisioning-a-bluetooth-mesh-network-part-1>`_ / `Part 2 <https://www.bluetooth.com/blog/provisioning-a-bluetooth-mesh-network-part-2>`__
|
||||
|
||||
|
||||
.. _ESP32-DevKitC: https://www.espressif.com/en/products/hardware/esp32-devkitc/overview
|
||||
.. _ESP32-DevKitC: https://www.espressif.com/en/products/devkits/esp32-devkitc/overview
|
||||
.. _ESP-WROVER-KIT: https://www.espressif.com/en/products/hardware/esp-wrover-kit/overview
|
||||
|
||||
@ -214,7 +214,7 @@ ESP-BLE-MESH Terminology
|
||||
- "A node can also use an IV Update procedure to signal to peer nodes that it is updating the IV Index."
|
||||
- IV 更新程序用于更新 ESP-BLE-MESH 网络的 IV Index 的值，这个值和消息加密时所需的随机数相关。为了保证随机数的值不重复，所以将这个值定期增加。IV Index 是一个 32 位的值，是一种共享网络资源，比如一个 mesh 网中的所有节点共享一个 IV Index 值。IV Index 从 0x00000000 开始，在 IV 更新过程中递增，并由特定的进程维护，以保证整个 Mesh 网内共享一个 IV Index。当节点认为它有耗尽其序列号的风险，或它确定另一个节点即将耗尽其序列号时，可以启动该程序。注意：每次的更新时间不得低于 96 小时。节点接收到 secure network beacon 或者确定自己的序列号大于特定值时，会触发 IV 更新程序。
|
||||
|
||||
官方定义摘自 `ESP-BLE-MESH Glossary of Terms <https://www.bluetooth.com/bluetooth-technology/topology-options/le-mesh/mesh-glossary/>`_.
|
||||
官方定义摘自 `ESP-BLE-MESH Glossary of Terms <https://www.bluetooth.com/learn-about-bluetooth/recent-enhancements/mesh/mesh-glossary/>`_.
|
||||
查看更多术语，也请参照上述网址。
|
||||
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ Windows
|
||||
|
||||
1. 使用标准 USB A / micro USB B 线将 |devkit-name| 与计算机相连接，并打开板子的电源。
|
||||
|
||||
2. 等待 Windows 识别出 |devkit-name| 并且为其安装驱动。如果驱动没有被自动安装，请前往 `官网 <https://www.ftdichip.com/Drivers/D2XX.htm>`_ 下载并手动安装。
|
||||
2. 等待 Windows 识别出 |devkit-name| 并且为其安装驱动。如果驱动没有被自动安装，请前往 `官网 <https://ftdichip.com/drivers/d2xx-drivers/>`_ 下载并手动安装。
|
||||
|
||||
3. 从 `Zadig 官网 <http://zadig.akeo.ie/>`_ 下载 Zadig 工具（Zadig_X.X.exe）并运行。
|
||||
|
||||
@ -103,7 +103,7 @@ MacOS
|
||||
手动卸载驱动程序
|
||||
................
|
||||
|
||||
1. 从 `FTDI 官网 <https://www.ftdichip.com/Drivers/VCP.htm>`_ 安装驱动。
|
||||
1. 从 `FTDI 官网 <https://ftdichip.com/drivers/vcp-drivers/>`_ 安装驱动。
|
||||
|
||||
2. 使用 USB 线连接 |devkit-name|。
|
||||
|
||||
|
||||
@ -95,7 +95,7 @@ JTAG 调试
|
||||
|
||||
如果您想使用单独的 JTAG 适配器，请确保其与 {IDF_TARGET_NAME} 的电平电压和 OpenOCD 软件都兼容。{IDF_TARGET_NAME} 使用的是业界标准的 JTAG 接口，它未使用（实际上也并不需要）TRST 信号脚。JTAG 使用的 IO 管脚由 VDD_3P3_RTC 电源管脚供电（通常连接到外部 3.3 V 的电源轨），因此 JTAG 硬件适配器的管脚需要能够在该电压范围内正常工作。
|
||||
|
||||
在软件方面，OpenOCD 支持相当多数量的 JTAG 适配器，请参阅 `OpenOCD 支持的适配器列表 <http://openocd.org/doc/html/Debug-Adapter-Hardware.html>`_ （请注意这一列表并不完整），其中还列出了兼容 SWD 接口的适配器，但请注意，{IDF_TARGET_NAME} 目前并不支持 SWD。此外，硬编码为只支持特定产品线的 JTAG 适配器也无法在 {IDF_TARGET_NAME} 上工作，例如仅针对 STM32 系列产品的 ST-LINK 适配器。
|
||||
在软件方面，OpenOCD 支持相当多数量的 JTAG 适配器，请参阅 `OpenOCD 支持的适配器列表 <https://openocd.org/doc/html/Debug-Adapter-Hardware.html>`_ （请注意这一列表并不完整），其中还列出了兼容 SWD 接口的适配器，但请注意，{IDF_TARGET_NAME} 目前并不支持 SWD。此外，硬编码为只支持特定产品线的 JTAG 适配器也无法在 {IDF_TARGET_NAME} 上工作，例如仅针对 STM32 系列产品的 ST-LINK 适配器。
|
||||
|
||||
保证 JTAG 正常工作需要连接的信号线包括：TDI、TDO、TCK、TMS 和 GND。一些 JTAG 适配器还需要 {IDF_TARGET_NAME} 提供一路电源到适配器的某个管脚上（比如 Vtar），用于设置适配器的工作电压。您也可以选择将 SRST 信号线连接到 {IDF_TARGET_NAME} 的 CH_PD 管脚上，但请注意，目前 OpenOCD 对该信号线提供的支持相当有限。
|
||||
|
||||
@ -119,7 +119,7 @@ JTAG 调试
|
||||
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
|
||||
Licensed under GNU GPL v2
|
||||
For bug reports, read
|
||||
http://openocd.org/doc/doxygen/bugs.html
|
||||
https://openocd.org/doc/doxygen/bugs.html
|
||||
|
||||
您还可以检查 ``OPENOCD_SCRIPTS`` 环境变量的值，以确认 OpenOCD 配置文件的路径，Linux 和 macOS 用户可以在终端输入 ``echo $OPENOCD_SCRIPTS``，Windows 用户需要输入 ``echo %OPENOCD_SCRIPTS%``。如果终端输出了有效路径，则表明您已经正确安装 OpenOCD。
|
||||
|
||||
|
||||
@ -285,4 +285,4 @@ Kconfig 配置项 :ref:`CONFIG_SECURE_BOOT_ALLOW_JTAG` 可以改变这个默认
|
||||
4. 请将 ``openocd_log.txt`` 和 ``gdb_log.txt`` 文件附在你的问题报告中。
|
||||
|
||||
|
||||
.. _OpenOCD 参考手册: http://openocd.org/doc/html/index.html
|
||||
.. _OpenOCD 参考手册: https://openocd.org/doc/html/index.html
|
||||
|
||||
@ -22,7 +22,7 @@ ESP-IDF 目前支持两个主机堆栈。基于 Bluedroid 的堆栈（默认）
|
||||
|
||||
请点击下方链接，查看 ESP32 蓝牙架构：
|
||||
|
||||
* `ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
|
||||
* `ESP32 蓝牙架构 (PDF) <https://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
|
||||
|
||||
蓝牙 API 的示例代码存放于 ESP-IDF 示例项目的 :example:`bluetooth/bluedroid` 目录下。
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@
|
||||
|
||||
.. only:: SOC_TOUCH_VERSION_1
|
||||
|
||||
如果想评估触摸传感器的多种应用场景，请查看 `ESP32 触摸功能开发套件 <https://github.com/espressif/esp-dev-kits/blob/master/esp32-sense-kit/docs/esp32_sense_kit_guide_en.md>`_。
|
||||
如果想评估触摸传感器的多种应用场景，请查看 `ESP32 触摸功能开发套件 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32/esp32-sense-kit/user_guide.html>`_。
|
||||
|
||||
功能介绍
|
||||
----------------------
|
||||
|
||||
@ -7,7 +7,7 @@ mDNS 服务
|
||||
|
||||
mDNS 是一种组播 UDP 服务，用来提供本地网络服务和主机发现。
|
||||
|
||||
绝大多数的操作系统默认都会安装 mDNS 服务，或者提供单独的安装包。``Mac OS`` 默认会安装名为 ``Bonjour`` 的服务（该服务基于 mDNS），此外 Apple 还发布了适用于 Windows 系统的安装程序，可以在 `官方支持 <https://support.apple.com/downloads/bonjour%2520for%2520windows>`_ 找到。在 ``Linux`` 上，mDNS 服务由 `avahi <https://github.com/lathiat/avahi>`_ 提供，通常也会被默认安装。
|
||||
绝大多数的操作系统默认都会安装 mDNS 服务，或者提供单独的安装包。``Mac OS`` 默认会安装名为 ``Bonjour`` 的服务（该服务基于 mDNS），此外 Apple 还发布了适用于 Windows 系统的安装程序，可以在 `官方支持 <https://support.apple.com/downloads/bonjour-for-windows>`_ 找到。在 ``Linux`` 上，mDNS 服务由 `avahi <https://github.com/lathiat/avahi>`_ 提供，通常也会被默认安装。
|
||||
|
||||
mDNS 属性
|
||||
^^^^^^^^^
|
||||
|
||||
@ -6,13 +6,13 @@ ESP-IDF 提供了 ``console`` 组件，它包含了开发基于串口的交互
|
||||
|
||||
- 行编辑，由 `linenoise <https://github.com/antirez/linenoise>`_ 库具体实现，它支持处理退格键和方向键，支持回看命令的历史记录，支持命令的自动补全和参数提示。
|
||||
- 将命令行拆分为参数列表。
|
||||
- 参数解析，由 `argtable3 <http://www.argtable.org/>`_ 库具体实现，该库提供解析 GNU 样式的命令行参数的 API。
|
||||
- 参数解析，由 `argtable3 <https://www.argtable.org/>`_ 库具体实现，该库提供解析 GNU 样式的命令行参数的 API。
|
||||
- 用于注册和调度命令的函数。
|
||||
- 帮助创建 REPL (Read-Evaluate-Print-Loop) 环境的函数。
|
||||
|
||||
.. note::
|
||||
|
||||
这些功能模块可以一起使用也可以独立使用，例如仅使用行编辑和命令注册的功能，然后使用 ``getopt`` 函数或者自定义的函数来实现参数解析，而不是直接使用 `argtable3 <http://www.argtable.org/>`_ 库。同样地，还可以使用更简单的命令输入方法（比如 ``fgets`` 函数）和其他用于命令分割和参数解析的方法。
|
||||
这些功能模块可以一起使用也可以独立使用，例如仅使用行编辑和命令注册的功能，然后使用 ``getopt`` 函数或者自定义的函数来实现参数解析，而不是直接使用 `argtable3 <https://www.argtable.org/>`_ 库。同样地，还可以使用更简单的命令输入方法（比如 ``fgets`` 函数）和其他用于命令分割和参数解析的方法。
|
||||
|
||||
行编辑
|
||||
------
|
||||
@ -127,7 +127,7 @@ Linenoise 库不需要显式地初始化，但是在调用行编辑函数之前
|
||||
参数解析
|
||||
--------
|
||||
|
||||
对于参数解析，``console`` 组件使用 `argtable3 <http://www.argtable.org/>`_ 库。有关 `argtable3 <http://www.argtable.org/>`_ 的介绍请查看 `教程 <http://www.argtable.org/tutorial/>`_ 或者 Github 仓库中的 `示例代码 <https://github.com/argtable/argtable3/tree/master/examples>`_ 。
|
||||
对于参数解析，``console`` 组件使用 `argtable3 <https://www.argtable.org/>`_ 库。有关 `argtable3 <https://www.argtable.org/>`_ 的介绍请查看 `教程 <https://www.argtable.org/tutorial/>`_ 或者 Github 仓库中的 `示例代码 <https://github.com/argtable/argtable3/tree/master/examples>`_ 。
|
||||
|
||||
|
||||
命令的注册与调度
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
- 如果该示例项目的子任务比较多，请根据逻辑将其拆分为 ``main`` 目录下的多个 C 或者 C++ 源文件，并将对应的头文件也放在同一目录下。
|
||||
- 如果该示例项目具有多种功能，可以考虑在项目中增加一个 ``components`` 子目录，通过库功能，将示例项目的不同功能划分为不同的组件。注意，如果该组件提供的功能相对完整，且具有一定的通用性，则应该将它们添加到 ESP-IDF 的 ``components`` 目录中，使其成为 ESP-IDF 的一部分。
|
||||
- 示例项目需要包含一个 ``README.md`` 文件，建议使用 :idf_file:`示例项目 README 模板 <docs/TEMPLATE_EXAMPLE_README.md>` ，并根据项目实际情况进行修改。
|
||||
- 示例项目需要包含一个 ``example_test.py`` 文件，用于进行自动化测试。如果在 GitHub 上初次提交 Pull Request 时，可以先不包含这个脚本文件。具体细节，请见有关 `Pull Request <https://help.github.com/articles/creating-a-pull-request/>`_ 的相关内容。
|
||||
- 示例项目需要包含一个 ``example_test.py`` 文件，用于进行自动化测试。如果在 GitHub 上初次提交 Pull Request 时，可以先不包含这个脚本文件。具体细节，请见有关 `Pull Request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_ 的相关内容。
|
||||
|
||||
一般准则
|
||||
--------
|
||||
|
||||
@ -13,8 +13,8 @@
|
||||
|
||||
以下是乐鑫 {IDF_TARGET_NAME} 开发板驱动程序的链接：
|
||||
|
||||
* CP210x: `CP210x USB 至 UART 桥 VCP 驱动程序 <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
* FTDI: `FTDI 虚拟 COM 端口驱动程序 <https://www.ftdichip.com/Drivers/VCP.htm>`_
|
||||
* CP210x: `CP210x USB 至 UART 桥 VCP 驱动程序 <https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers>`_
|
||||
* FTDI: `FTDI 虚拟 COM 端口驱动程序 <https://ftdichip.com/drivers/vcp-drivers/>`_
|
||||
|
||||
以上驱动仅供参考，请参考开发板用户指南，查看开发板具体使用的 USB 转串口芯片。一般情况下，当 {IDF_TARGET_NAME} 开发板与 PC 连接时，对应驱动程序应该已经被打包在操作系统中，并已经自动安装。
|
||||
|
||||
|
||||
@ -31,6 +31,6 @@ VS Code IDE 快速入门
|
||||
Bugs 问题 & 功能请求
|
||||
=======================
|
||||
|
||||
如果您在使用 VS Code 或其某些功能上遇到问题，建议您在 `论坛 <http://esp32.com/viewforum.php?f=40>`_ 或是 `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ 上提出您的问题，我们开发团队会对问题进行解答。
|
||||
如果您在使用 VS Code 或其某些功能上遇到问题，建议您在 `论坛 <https://esp32.com/viewforum.php?f=40>`_ 或是 `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ 上提出您的问题，我们开发团队会对问题进行解答。
|
||||
|
||||
我们也欢迎您提出新的功能需求，正是由于用户要求新功能或是建议对现有功能进行改善，才成就我们今天所具备的大多数功能。欢迎您在 `Github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。
|
||||
|
||||
@ -76,10 +76,10 @@
|
||||
- ✔️ 8 路组相连，32 位数据/指令总线宽度
|
||||
- ✔️ 指令 cache 可配置为 4 路组相连或 8 路组相连，数据 cache 固定为 4 路组相连，32 位数据/指令总线宽度
|
||||
* - **外设**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - 模/数转换器 (ADC)
|
||||
- 两个 12 位 SAR ADC，多达 18 个通道
|
||||
- 两个 12 位 SAR ADC，多达 20 个通道
|
||||
@ -88,13 +88,13 @@
|
||||
* - 数/模转换器 (DAC)
|
||||
- 两个 8 位通道
|
||||
- 两个 8 位通道
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
* - 定时器
|
||||
- 4 个 64 位通用定时器，3 个看门狗定时器
|
||||
- 4 个 64 位通用定时器，3 个看门狗定时器
|
||||
- 2 个 54 位通用定时器，3 个看门狗定时器
|
||||
- 4 个 54 位通用定时器，3 个看门狗定时器
|
||||
- 2 个 54 位通用定时器，3 个看门狗定时器
|
||||
- 4 个 54 位通用定时器，3 个看门狗定时器
|
||||
* - 温度传感器
|
||||
- ✖️
|
||||
- 1
|
||||
@ -146,7 +146,7 @@
|
||||
- ✖️
|
||||
- 1
|
||||
* - DMA
|
||||
- UART、SPI、I2S、SDIO 从机、SD/MMC 主机、EMAC、BT 和 Wi-Fi 都有专用的 DMA 控制器
|
||||
- UART、SPI、I2S、SDIO 从机、SD/MMC 主机、EMAC、BT 和 Wi-Fi 都有专用的 DMA 控制器
|
||||
- UART、SPI、AES、SHA、I2S 和 ADC 控制器都有专用的 DMA 控制器
|
||||
- 通用 DMA 控制器，3 个接收通道和 3 个发送通道
|
||||
- 通用 DMA 控制器，5 个接收通道和 5 个发送通道
|
||||
@ -167,13 +167,13 @@
|
||||
- 8 通道 [#one]_
|
||||
* - MCPWM
|
||||
- 2，提供六个 PWM 输出
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
- ✖️
|
||||
- 2，提供六个 PWM 输出
|
||||
* - USB OTG
|
||||
- ✖️
|
||||
- 1
|
||||
- ✖️
|
||||
- ✖️
|
||||
- 1
|
||||
* - TWAI® 控制器（兼容 ISO 11898-1 协议）
|
||||
- 1
|
||||
@ -206,10 +206,10 @@
|
||||
- 1
|
||||
- ✖️
|
||||
* - **安全机制**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - 安全启动
|
||||
- ✔️
|
||||
- ✔️ 比 ESP32 更快更安全
|
||||
@ -227,14 +227,14 @@
|
||||
- 4096 位
|
||||
* - AES
|
||||
- ✔️ AES-128, AES-192, AES-256 (FIPS PUB 197)
|
||||
- ✔️ AES-128, AES-192, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
- ✔️ AES-128, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
- ✔️ AES-128, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
- ✔️ AES-128, AES-192, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
- ✔️ AES-128, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
- ✔️ AES-128, AES-256 (FIPS PUB 197); 支持 DMA
|
||||
* - HASH
|
||||
- SHA-1, SHA-256, SHA-384, SHA-512 (FIPS PUB 180-4)
|
||||
- SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SHA-512/t (FIPS PUB 180-4); 支持 DMA
|
||||
- SHA-1, SHA-224, SHA-256 (FIPS PUB 180-4); 支持 DMA
|
||||
- SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SHA-512/t (FIPS PUB 180-4); 支持 DMA
|
||||
- SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SHA-512/t (FIPS PUB 180-4); 支持 DMA
|
||||
- SHA-1, SHA-224, SHA-256 (FIPS PUB 180-4); 支持 DMA
|
||||
- SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SHA-512/t (FIPS PUB 180-4); 支持 DMA
|
||||
* - RSA
|
||||
- 高达 4096 位
|
||||
- 高达 4096 位
|
||||
@ -261,10 +261,10 @@
|
||||
- ✔️ XTS-AES-128
|
||||
- ✔️ XTS-AES-128, XTS-AES-256
|
||||
* - **其它**
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
-
|
||||
* - Deep-sleep 功耗（超低功耗传感器监测方式）
|
||||
- 100 μA（ADC 以 1% 占空比工作时）
|
||||
- 22 μA（触摸传感器以 1% 占空比工作时）
|
||||
@ -272,15 +272,15 @@
|
||||
- TBD
|
||||
* - 封装尺寸
|
||||
- QFN48 5*5、6*6，不同型号有差异
|
||||
- QFN56 7*7
|
||||
- QFN56 7*7
|
||||
- QFN32 5*5
|
||||
- QFN56 7*7
|
||||
- QFN56 7*7
|
||||
|
||||
.. note::
|
||||
|
||||
.. [#one] 与 ESP32 相比，减小了芯片面积
|
||||
.. [#one] 与 ESP32 相比，减小了芯片面积
|
||||
|
||||
.. [#two] 与 ESP32 和 ESP32-S2 相比，减小了芯片面积
|
||||
.. [#two] 与 ESP32 和 ESP32-S2 相比，减小了芯片面积
|
||||
|
||||
.. note::
|
||||
|
||||
@ -299,4 +299,4 @@
|
||||
- `ESP32-S2 技术规格书 (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf>`_
|
||||
- `ESP32-C3 技术规格书 (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_cn.pdf>`_
|
||||
- `ESP32-S3 技术规格书 (PDF) <https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_cn.pdf>`_
|
||||
- `ESP 产品选型 <http://products.espressif.com:8000/#/>`_
|
||||
- `ESP 产品选型 <https://products.espressif.com/#/>`_
|
||||
@ -1,4 +1,4 @@
|
||||
ESP32-PICO-DevKitM-2
|
||||
ESP32-PICO-DevKitM-2
|
||||
**********************
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
@ -56,7 +56,7 @@ ESP32-PICO-DevKitM-2 开发板的主要组件、接口及控制方式见下图
|
||||
|
||||
从左上角开始，按顺时针顺序，开发板主要组件的描述见下表。
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 10 25
|
||||
:header-rows: 1
|
||||
|
||||
@ -69,7 +69,7 @@ ESP32-PICO-DevKitM-2 开发板的主要组件、接口及控制方式见下图
|
||||
* - USB-to-UART
|
||||
- CP2102N：单芯片 USB-to-UART 桥接器，数据传输速率可达 3 Mbps。
|
||||
* - Micro-B USB 接口
|
||||
- USB 接口。可为开发板供电，或连接 PC 进行 USB 通信。
|
||||
- USB 接口。可为开发板供电，或连接 PC 进行 USB 通信。
|
||||
* - 5V Power On LED
|
||||
- 开发板上电后，红色指示灯亮起。更多信息，见 `相关文档`_ 中提供的原理图。
|
||||
* - I/O Connector
|
||||
@ -106,7 +106,7 @@ ESP32-PICO-DevKitM-2 开发板的主要组件、接口及控制方式见下图
|
||||
|
||||
如购买样品，每个 ESP32-PICO-DevKitM-2 将单独包装。
|
||||
|
||||
零售订单，请前往 https://www.espressif.com/en/company/contact/buy-a-sample。
|
||||
零售订单，请前往 https://www.espressif.com/en/contact-us/get-samples。
|
||||
|
||||
批量订单
|
||||
-----------
|
||||
@ -153,7 +153,7 @@ ESP32-PICO-DevKitM-2 的主要组件和连接方式如下图所示。
|
||||
Header J2
|
||||
""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -233,12 +233,12 @@ Header J2
|
||||
- VDD33 (3V3)
|
||||
- P
|
||||
- 3.3 V 供电
|
||||
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -318,7 +318,7 @@ Header J3
|
||||
- EXT_5V (5V)
|
||||
- P
|
||||
- 5V 供电
|
||||
|
||||
|
||||
|
||||
.. _get-started-pico-devkitm-2-pin-notes:
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
ESP32-PICO-KIT-1
|
||||
ESP32-PICO-KIT-1
|
||||
*****************
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
@ -33,7 +33,7 @@ ESP32-PICO-KIT-1 为用户提供了基于 ESP32 芯片应用开发的硬件，
|
||||
:alt: ESP32-PICO-KIT-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT-1 外观图（点击放大）
|
||||
ESP32-PICO-KIT-1 外观图（点击放大）
|
||||
|
||||
本指南包括以下几个章节：
|
||||
|
||||
@ -66,7 +66,7 @@ ESP32-PICO-KIT-1 开发板的主要组件、接口及控制方式见下图。
|
||||
|
||||
从左上角开始，按顺时针顺序，开发板主要组件的描述见下表。
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 10 25
|
||||
:header-rows: 1
|
||||
|
||||
@ -79,7 +79,7 @@ ESP32-PICO-KIT-1 开发板的主要组件、接口及控制方式见下图。
|
||||
* - USB-to-UART
|
||||
- CP2102N：单芯片 USB-to-UART 桥接器，数据传输速率可达 3 Mbps。
|
||||
* - Micro-B USB
|
||||
- USB 接口。可为开发板供电，或连接 PC 进行 USB 通信。
|
||||
- USB 接口。可为开发板供电，或连接 PC 进行 USB 通信。
|
||||
* - 5V Power On LED
|
||||
- 开发板上电后，红色指示灯亮起。更多信息，见 `相关文档`_ 中提供的原理图。
|
||||
* - I/O Connector
|
||||
@ -117,7 +117,7 @@ ESP32-PICO-KIT-1 开发板的主要组件、接口及控制方式见下图。
|
||||
|
||||
如购买样品，每个 ESP32-PICO-KIT-1 将单独包装。
|
||||
|
||||
零售订单，请前往 https://www.espressif.com/en/company/contact/buy-a-sample。
|
||||
零售订单，请前往 https://www.espressif.com/en/contact-us/get-samples。
|
||||
|
||||
|
||||
批量订单
|
||||
@ -165,7 +165,7 @@ ESP32-PICO-KIT-1 的主要组件和连接方式如下图所示。
|
||||
Header J2
|
||||
""""""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -245,12 +245,12 @@ Header J2
|
||||
- VDD33 (3V3)
|
||||
- P
|
||||
- 3.3V 供电
|
||||
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""
|
||||
|
||||
.. list-table::
|
||||
.. list-table::
|
||||
:widths: 5 5 5 35
|
||||
:header-rows: 1
|
||||
|
||||
@ -329,8 +329,8 @@ Header J3
|
||||
* - 18
|
||||
- EXT_5V (5V)
|
||||
- P
|
||||
- 5V 供电
|
||||
|
||||
- 5V 供电
|
||||
|
||||
|
||||
.. _get-started-pico-kit-1-pin-notes:
|
||||
|
||||
@ -361,8 +361,8 @@ Header J3
|
||||
相关文档
|
||||
=========
|
||||
|
||||
* `ESP32-PICO-V3 技术规格书 <http://espressif.com/sites/default/files/documentation/esp32-pico-v3_datasheet_cn.pdf>`_ (PDF)
|
||||
* `乐鑫产品选型工具 <https://products.espressif.com/#/product-selector?names=>`__
|
||||
* `ESP32-PICO-V3 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-pico-v3_datasheet_cn.pdf>`_ (PDF)
|
||||
* `乐鑫产品选型工具 <https://products.espressif.com/#/product-selector?names=>`__
|
||||
* `ESP32-PICO-KIT-1 原理图 <https://dl.espressif.com/dl/schematics/SCH_ESP32-PICO-KIT-1_V1_0_20200811A.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT-1 PCB 布局图 <https://dl.espressif.com/dl/schematics/PCB_ESP32-PICO-KIT-1_V1.0_20200811.pdf>`_ (PDF)
|
||||
|
||||
|
||||
@ -75,5 +75,5 @@ ESP32-PICO-KIT V3 上电前，请首先确认开发板完好无损。
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V3 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
|
||||
* `《ESP32-PICO-D4 技术规格书》 <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
|
||||
* `《ESP32-PICO-D4 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
|
||||
* :doc:`../../hw-reference/index`
|
||||
|
||||
@ -225,7 +225,7 @@ ESP32-PICO-KIT 的尺寸为 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4")。
|
||||
* `ESP32-PICO-KIT V4 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT V4.1 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4.1_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-KIT 参考设计 <https://www.espressif.com/sites/default/files/documentation/esp32-pico-kit_v4.1_20180314_cn.zip>`_ ，内含 OrCAD 原理图、PCB 布局、Gerbers 和 BOM 表
|
||||
* `《ESP32-PICO-D4 技术规格书》 <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
|
||||
* `《ESP32-PICO-D4 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
|
||||
* :doc:`../../hw-reference/index`
|
||||
|
||||
|
||||
|
||||
@ -9,9 +9,9 @@ ESP32-DevKitS(-R)
|
||||
ESP32-DevKitS(-R) 包括两款开发板，分别是 ESP32-DevKitS 和 ESP32-DevKitS-R。S 代表弹簧 (spring)，R 代表 WROVER 模组。
|
||||
|
||||
+-----------------+-------------------+
|
||||
| |ESP32-DevKitS| | |ESP32-DevKitS-R| |
|
||||
| |ESP32-DevKitS| | |ESP32-DevKitS-R| |
|
||||
+-----------------+-------------------+
|
||||
| ESP32-DevKitS | ESP32-DevKitS-R |
|
||||
| ESP32-DevKitS | ESP32-DevKitS-R |
|
||||
+-----------------+-------------------+
|
||||
|
||||
.. |ESP32-DevKitS| image:: ../../../_static/esp32-devkits-v1.1-layout-isometric-raw.png
|
||||
@ -147,14 +147,14 @@ Windows 用户也可以使用 `Flash 下载工具 <https://www.espressif.com/zh-
|
||||
:align: center
|
||||
:alt: ESP32-DevKitS - 背面
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
ESP32-DevKitS 尺寸 - 背面
|
||||
|
||||
.. figure:: ../../../_static/esp32-devkits-r-v1.1-dimensions-back.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitS-R - 背面
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
ESP32-DevKitS-R 尺寸 - 背面
|
||||
|
||||
|
||||
@ -264,6 +264,6 @@ R19 CLK SD_CLK
|
||||
- `ESP32-WROOM-32 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
|
||||
- `ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
|
||||
- `ESP32-SOLO-1 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-solo-1_datasheet_cn.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_cn.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER-B 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)
|
||||
- `乐鑫产品选型工具 <https://products.espressif.com/#/product-selector?names=>`__
|
||||
- `乐鑫产品选型工具 <https://products.espressif.com/#/product-selector?names=>`__
|
||||
@ -8,7 +8,7 @@ ESP-IDF 编程指南
|
||||
|
||||
快速预览中不包括 API 函数文档。如需生成完整的文档，请在 MR 中添加 docs_full 标签。
|
||||
|
||||
这里是乐鑫 IoT 开发框架 (`esp-idf <https://github.com/espressif/esp-idf>`_) 的文档中心。ESP-IDF 是 `ESP32、ESP32-S 和 ESP32-C <https://www.espressif.com/en/products/hardware/socs>`_ 系列芯片的官方开发框架。
|
||||
这里是乐鑫 IoT 开发框架 (`esp-idf <https://github.com/espressif/esp-idf>`_) 的文档中心。ESP-IDF 是 `ESP32、ESP32-S 和 ESP32-C <https://www.espressif.com/en/products/socs>`_ 系列芯片的官方开发框架。
|
||||
|
||||
.. only:: html
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ ESP-IDF 在 GitHub 平台上的完整发布历史请见 `发布说明页面`_。
|
||||
版本管理
|
||||
-----------------
|
||||
|
||||
ESP-IDF 采用了 `语义版本管理方法 <http://semver.org/>`_，即您可以从字面含义理解每个版本的差异。其中
|
||||
ESP-IDF 采用了 `语义版本管理方法 <https://semver.org/>`_，即您可以从字面含义理解每个版本的差异。其中
|
||||
|
||||
- 主要版本（例 ``v3.0``）代表有重大更新，包括增加新特性、改变现有特性及移除已弃用的特性。
|
||||
|
||||
@ -254,7 +254,7 @@ Git 工作流
|
||||
|
||||
发布分支并不会有专门的配套文档，建议您使用与本分支最接近版本的文档。
|
||||
|
||||
.. _`发布说明页面`: http://github.com/espressif/esp-idf/releases
|
||||
.. _`发布说明页面`: https://github.com/espressif/esp-idf/releases
|
||||
.. _`分支列表`: https://github.com/espressif/esp-idf/branches
|
||||
.. _`标签列表`: https://github.com/espressif/esp-idf/tags
|
||||
.. _`最新稳定版本`: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user