title stringlengths 3 56 | author stringclasses 3
values | hostname stringclasses 1
value | date stringclasses 3
values | fingerprint stringlengths 15 16 | id null | license null | comments stringclasses 1
value | raw_text stringlengths 518 796k | text stringlengths 514 592k | language null | image null | pagetype null | source stringlengths 68 116 | source-hostname stringclasses 1
value | excerpt null | categories stringclasses 1
value | tags stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
API Conventions | null | espressif.com | 2016-01-01 | bc127268662167db | null | null | API Conventions This document describes conventions and assumptions common to ESP-IDF Application Programming Interfaces (APIs). 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. ... | API Conventions
This document describes conventions and assumptions common to ESP-IDF Application Programming Interfaces (APIs).
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. Vari... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/api-conventions.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-MQTT | null | espressif.com | 2016-01-01 | 6e59fd1e6a0bfa18 | null | null | ESP-MQTT Overview ESP-MQTT is an implementation of MQTT protocol client, which is a lightweight publish/subscribe messaging protocol. Now ESP-MQTT supports MQTT v5.0. Features Support MQTT over TCP, SSL with Mbed TLS, MQTT over WebSocket, and MQTT over WebSocket Secure Easy to setup with URI Multiple insta... | ESP-MQTT
Overview
ESP-MQTT is an implementation of MQTT protocol client, which is a lightweight publish/subscribe messaging protocol. Now ESP-MQTT supports MQTT v5.0.
Features
-
Support MQTT over TCP, SSL with Mbed TLS, MQTT over WebSocket, and MQTT over WebSocket Secure
-
Easy to setup with URI
-
Multiple instances (m... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/mqtt.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-TLS | null | espressif.com | 2016-01-01 | 745bfc5af690d090 | null | null | ESP-TLS Overview The ESP-TLS component provides a simplified API interface for accessing the commonly used TLS functions. It supports common scenarios like CA certification validation, SNI, ALPN negotiation, and non-blocking connection among others. All the configurations can be specified in the esp_tls_cfg_t dat... | ESP-TLS
Overview
The ESP-TLS component provides a simplified API interface for accessing the commonly used TLS functions. It supports common scenarios like CA certification validation, SNI, ALPN negotiation, and non-blocking connection among others. All the configurations can be specified in the
esp_tls_cfg_t data stru... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_tls.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP HTTP Client | Int Max Authorization Retries | espressif.com | 2016-01-01 | b25bfd1e6219ee90 | null | null | ESP HTTP Client Overview esp_http_client component provides a set of APIs for making HTTP/S requests from ESP-IDF applications. The steps to use these APIs are as follows: esp_http_client_init() : Creates an esp_http_client_handle_t instance, i.e., an HTTP client handle based on the given esp_http_client_confi... | ESP HTTP Client
Overview
esp_http_client component provides a set of APIs for making HTTP/S requests from ESP-IDF applications. The steps to use these APIs are as follows:
-
esp_http_client_init(): Creates an
esp_http_client_handle_tinstance, i.e., an HTTP client handle based on the given
esp_http_client_config_tconfig... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_http_client.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP Local Control | null | espressif.com | 2016-01-01 | 2289ac90e489fa49 | null | null | ESP Local Control Overview ESP Local Control (esp_local_ctrl) component in ESP-IDF provides capability to control an ESP device over HTTPS or Bluetooth® Low Energy. It provides access to application defined properties that are available for reading/writing via a set of configurable handlers. Initialization of the ... | ESP Local Control
Overview
ESP Local Control (esp_local_ctrl) component in ESP-IDF provides capability to control an ESP device over HTTPS or Bluetooth® Low Energy. It provides access to application defined properties that are available for reading/writing via a set of configurable handlers.
Initialization of the esp_l... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_local_ctrl.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP Serial Slave Link | null | espressif.com | 2016-01-01 | 9edb9e9ee3429119 | null | null | ESP Serial Slave Link Overview Espressif provides several chips that can work as slaves. These slave devices rely on some common buses, and have their own communication protocols over those buses. The esp_serial_slave_link component is designed for the master to communicate with ESP slave devices through those pr... | ESP Serial Slave Link
Overview
Espressif provides several chips that can work as slaves. These slave devices rely on some common buses, and have their own communication protocols over those buses. The
esp_serial_slave_link component is designed for the master to communicate with ESP slave devices through those protocol... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_serial_slave_link.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP x509 Certificate Bundle | null | espressif.com | 2016-01-01 | 2d29627b1e191694 | null | null | ESP x509 Certificate Bundle Overview The ESP x509 Certificate Bundle API provides an easy way to include a bundle of custom x509 root certificates for TLS server verification. Note The bundle is currently not available when using WolfSSL. The bundle comes with the complete list of root certificates from Mozilla'... | ESP x509 Certificate Bundle
Overview
The ESP x509 Certificate Bundle API provides an easy way to include a bundle of custom x509 root certificates for TLS server verification.
Note
The bundle is currently not available when using WolfSSL.
The bundle comes with the complete list of root certificates from Mozilla's NSS r... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_crt_bundle.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
HTTP Server | null | espressif.com | 2016-01-01 | e753bdcbfc02d09f | null | null | HTTP Server Overview The HTTP Server component provides an ability for running a lightweight web server on ESP32. Following are detailed steps to use the API exposed by HTTP Server: httpd_start() : Creates an instance of HTTP server, allocate memory/resources for it depending upon the specified configuration a... | HTTP Server
Overview
The HTTP Server component provides an ability for running a lightweight web server on ESP32. Following are detailed steps to use the API exposed by HTTP Server:
-
httpd_start(): Creates an instance of HTTP server, allocate memory/resources for it depending upon the specified configuration and outpu... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_http_server.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
HTTPS Server | null | espressif.com | 2016-01-01 | cc52bd4bb812f89d | null | null | HTTPS Server Overview This component is built on top of HTTP Server. The HTTPS server takes advantage of hook registration functions in the regular HTTP server to provide callback function for SSL session. All documentation for HTTP Server applies also to a server you create this way. Used APIs The following AP... | HTTPS Server
Overview
This component is built on top of HTTP Server. The HTTPS server takes advantage of hook registration functions in the regular HTTP server to provide callback function for SSL session.
All documentation for HTTP Server applies also to a server you create this way.
Used APIs
The following APIs of HT... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/esp_https_server.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ICMP Echo | null | espressif.com | 2016-01-01 | a4f8bdb0a61cb1f1 | null | null | ICMP Echo Overview ICMP (Internet Control Message Protocol) is used for diagnostic or control purposes or generated in response to errors in IP operations. The common network util ping is implemented based on the ICMP packets with the type field value of 0, also called Echo Reply . During a ping session, the sou... | ICMP Echo
Overview
ICMP (Internet Control Message Protocol) is used for diagnostic or control purposes or generated in response to errors in IP operations. The common network util
ping is implemented based on the ICMP packets with the type field value of 0, also called
Echo Reply.
During a ping session, the source host... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/icmp_echo.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Mbed TLS | null | espressif.com | 2016-01-01 | 6e16f81f49428ad4 | null | null | Mbed TLS Mbed TLS 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 of Mbed TLS which includes a few patches (related to hardware routines of certain mo... | Mbed TLS
Mbed TLS 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 of Mbed TLS which includes a few patches (related to hardware routines of certain module... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/protocols/mbedtls.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® Generic Defines | null | espressif.com | 2016-01-01 | 758f3be2c2aa841 | null | null | Bluetooth® Generic Defines API Reference Header File This header file can be included with: #include "esp_bt_defs.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLists.txt: REQUIRES bt or PRIV_REQUIRES bt Struc... | Bluetooth® Generic Defines
API Reference
Header File
This header file can be included with:
#include "esp_bt_defs.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
PRIV_REQUIRES bt
Structures
-
str... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_bt_defs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® Main API | null | espressif.com | 2016-01-01 | 9563e01dde360111 | null | null | Bluetooth® Main API API Reference Header File This header file can be included with: #include "esp_bt_main.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLists.txt: REQUIRES bt or PRIV_REQUIRES bt Functions ... | Bluetooth® Main API
API Reference
Header File
This header file can be included with:
#include "esp_bt_main.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
PRIV_REQUIRES bt
Functions
-
esp_bluedro... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_bt_main.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® Device APIs | null | espressif.com | 2016-01-01 | b6052215eb0fd350 | null | null | Bluetooth® Device APIs Overview Bluetooth device reference APIs. API Reference Header File components/bt/host/bluedroid/api/include/api/esp_bt_device.h This header file can be included with: #include "esp_bt_device.h" This header file is a part of the API provided by the bt component. To declare that your co... | Bluetooth® Device APIs
Overview
Bluetooth device reference APIs.
API Reference
Header File
components/bt/host/bluedroid/api/include/api/esp_bt_device.h
This header file can be included with:
#include "esp_bt_device.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depe... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_bt_device.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
GAP API | Esp Err T Esp Gap Ble Set Authorization Esp Bd Addr T Bd Addr; Bool Authorize | espressif.com | 2016-01-01 | ce249c99a32fb941 | null | null | GAP API Application Example Check the bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials: The following shows an SMP security client demo with its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security reque... | GAP API
Application Example
Check the bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials:
The following shows an SMP security client demo with its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security request to... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_gap_ble.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
GATT Defines | null | espressif.com | 2016-01-01 | 758f3be2c2aa841 | null | null | GATT Defines API Reference Header File components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h This header file can be included with: #include "esp_gatt_defs.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMake... | GATT Defines
API Reference
Header File
components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h
This header file can be included with:
#include "esp_gatt_defs.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_gatt_defs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
GATT Server API | null | espressif.com | 2016-01-01 | def83c57aa07b905 | null | null | GATT Server API Application Examples Check bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials: This is a GATT server demo and its tutorial. This demo creates a GATT service with an attribute table, which releases the user from the operation of adding attribut... | GATT Server API
Application Examples
Check bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials:
This is a GATT server demo and its tutorial. This demo creates a GATT service with an attribute table, which releases the user from the operation of adding attributes on... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_gatts.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
GATT Client API | null | espressif.com | 2016-01-01 | c638ec563a0f9b41 | null | null | GATT Client API Application Example Check bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials: This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services. This is a multiple connection dem... | GATT Client API
Application Example
Check bluetooth/bluedroid/ble folder in ESP-IDF examples, which contains the following demos and their tutorials:
This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services.
This is a multiple connection demo and ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_gattc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
BluFi API | null | espressif.com | 2016-01-01 | 4eb8a65da20ba941 | null | null | BluFi API Overview BluFi is a profile based GATT to config ESP32 Wi-Fi to connect/disconnect AP or setup a softap and etc. Use should concern these things: The event sent from profile. Then you need to do something as the event indicate. Security reference. You can write your own Security functions such as symmet... | BluFi API
Overview
BluFi is a profile based GATT to config ESP32 Wi-Fi to connect/disconnect AP or setup a softap and etc.
Use should concern these things:
The event sent from profile. Then you need to do something as the event indicate.
Security reference. You can write your own Security functions such as symmetrical ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_blufi.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Classic Bluetooth® GAP API | null | espressif.com | 2016-01-01 | 2668e01dea239b40 | null | null | Classic Bluetooth® GAP API API Reference Header File components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h This header file can be included with: #include "esp_gap_bt_api.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the followi... | Classic Bluetooth® GAP API
API Reference
Header File
components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h
This header file can be included with:
#include "esp_gap_bt_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_gap_bt.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® A2DP API | null | espressif.com | 2016-01-01 | 2450341eee239b51 | null | null | Bluetooth® A2DP API Application Example Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application: This is a A2DP sink client demo. This demo can be discovered and connected by A2DP source device and receive the audio stream from remote device - bluetooth/bluedroid/c... | Bluetooth® A2DP API
Application Example
Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application:
This is a A2DP sink client demo. This demo can be discovered and connected by A2DP source device and receive the audio stream from remote device - bluetooth/bluedroid/classi... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_a2dp.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® AVRCP APIs | null | espressif.com | 2016-01-01 | 758f7be2c2bb801 | null | null | Bluetooth® AVRCP APIs Overview Bluetooth AVRCP reference APIs. API Reference Header File This header file can be included with: #include "esp_avrc_api.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLists.txt... | Bluetooth® AVRCP APIs
Overview
Bluetooth AVRCP reference APIs.
API Reference
Header File
This header file can be included with:
#include "esp_avrc_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_avrc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SPP API | null | espressif.com | 2016-01-01 | d678aed2aa239b0b | null | null | SPP API Application Example Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application: This is a SPP demo. This demo can discover the service, connect, send and recive SPP data bluetooth/bluedroid/classic_bt/bt_spp_acceptor, bluetooth/bluedroid/classic_bt/bt_spp_init... | SPP API
Application Example
Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application:
This is a SPP demo. This demo can discover the service, connect, send and recive SPP data bluetooth/bluedroid/classic_bt/bt_spp_acceptor, bluetooth/bluedroid/classic_bt/bt_spp_initiator... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_spp.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
HFP Defines | null | espressif.com | 2016-01-01 | 758f3be2c2aa841 | null | null | HFP Defines API Reference Header File This header file can be included with: #include "esp_hf_defs.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLists.txt: REQUIRES bt or PRIV_REQUIRES bt Enumerations
enum... | HFP Defines
API Reference
Header File
This header file can be included with:
#include "esp_hf_defs.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
PRIV_REQUIRES bt
Enumerations
-
enum esp_hf_in_b... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_hf_defs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
HFP Client API | null | espressif.com | 2016-01-01 | 2451445c6a229a51 | null | null | HFP Client API API Reference Header File components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h This header file can be included with: #include "esp_hf_client_api.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to ... | HFP Client API
API Reference
Header File
components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h
This header file can be included with:
#include "esp_hf_client_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMake... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_hf_client.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
HFP AG API | null | espressif.com | 2016-01-01 | 24a1c05d68239b61 | null | null | HFP AG API API Reference Header File components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h This header file can be included with: #include "esp_hf_ag_api.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLi... | HFP AG API
API Reference
Header File
components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h
This header file can be included with:
#include "esp_hf_ag_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
R... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_hf_ag.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® HID Device API | null | espressif.com | 2016-01-01 | e2caa5a2e23b941 | null | null | Bluetooth® HID Device API Overview A Bluetooth HID device is a device providing the service of human or other data input and output to and from a Bluetooth HID Host. Users can use the Bluetooth HID Device APIs to make devices like keyboards, mice, joysticks and so on. Application Example Check bluetooth/bluedroi... | Bluetooth® HID Device API
Overview
A Bluetooth HID device is a device providing the service of human or other data input and output to and from a Bluetooth HID Host. Users can use the Bluetooth HID Device APIs to make devices like keyboards, mice, joysticks and so on.
Application Example
Check bluetooth/bluedroid/class... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_hidd.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Classic Bluetooth® L2CAP API | null | espressif.com | 2016-01-01 | c63cac5aae238906 | null | null | Classic Bluetooth® L2CAP API Application Example Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application: This is a BT_L2CAP demo. This demo can connect, send and receive L2CAP data bluetooth/bluedroid/classic_bt/bt_l2cap_client, bluetooth/bluedroid/classic_bt/bt_l... | Classic Bluetooth® L2CAP API
Application Example
Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application:
This is a BT_L2CAP demo. This demo can connect, send and receive L2CAP data bluetooth/bluedroid/classic_bt/bt_l2cap_client, bluetooth/bluedroid/classic_bt/bt_l2cap_... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_l2cap_bt.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Bluetooth® SDP APIs | null | espressif.com | 2016-01-01 | c678f657ae4b9947 | null | null | Bluetooth® SDP APIs Overview Bluetooth SDP reference APIs. API Reference Header File This header file can be included with: #include "esp_sdp_api.h" This header file is a part of the API provided by the bt component. To declare that your component depends on bt , add the following to your CMakeLists.txt: REQ... | Bluetooth® SDP APIs
Overview
Bluetooth SDP reference APIs.
API Reference
Header File
This header file can be included with:
#include "esp_sdp_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
P... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp_sdp.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Controller && VHCI | null | espressif.com | 2016-01-01 | 965afe94aa2a9049 | null | null | Controller && VHCI Application Example Check bluetooth/hci folder in ESP-IDF examples, which contains the following application: This is a Bluetooth® Low Energy (Bluetooth LE) advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for Bluetooth Low Energy advertising - bl... | Controller && VHCI
Application Example
Check bluetooth/hci folder in ESP-IDF examples, which contains the following application:
This is a Bluetooth® Low Energy (Bluetooth LE) advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for Bluetooth Low Energy advertising - bluetoo... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/controller_vhci.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-BLE-MESH | Uint | espressif.com | 2018-04-03 | 23509b5ea42b8818 | null | null | ESP-BLE-MESH Note The current ESP-BLE-MESH v1.1 related code is a preview version, so the Mesh Protocol v1.1 related Structures, MACROs, and APIs involved in the code may be changed. With various features of ESP-BLE-MESH, users can create a managed flooding mesh network for several scenarios, such as lighting, sens... | ESP-BLE-MESH
Note
The current ESP-BLE-MESH v1.1 related code is a preview version, so the Mesh Protocol v1.1 related Structures, MACROs, and APIs involved in the code may be changed.
With various features of ESP-BLE-MESH, users can create a managed flooding mesh network for several scenarios, such as lighting, sensor a... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/esp-ble-mesh.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
NimBLE-based Host APIs | null | espressif.com | 2016-01-01 | 3a0cd604aef8f560 | null | null | NimBLE-based Host APIs Overview Apache MyNewt NimBLE is a highly configurable and Bluetooth® SIG qualifiable Bluetooth Low Energy (Bluetooth LE) stack providing both host and controller functionalities. ESP-IDF supports NimBLE host stack which is specifically ported for ESP32 platform and FreeRTOS. The underlying c... | NimBLE-based Host APIs
Overview
Apache MyNewt NimBLE is a highly configurable and Bluetooth® SIG qualifiable Bluetooth Low Energy (Bluetooth LE) stack providing both host and controller functionalities. ESP-IDF supports NimBLE host stack which is specifically ported for ESP32 platform and FreeRTOS. The underlying contr... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/bluetooth/nimble/index.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Error Codes Reference | null | espressif.com | 2016-01-01 | 3c4eca5986848dcc | null | null | Error Codes Reference This section lists various error code constants defined in ESP-IDF. For general information about error codes in ESP-IDF, see Error Handling. ESP_FAIL (-1): Generic esp_err_t code indicating failure ESP_OK (0): esp_err_t value indicating success (no error) ESP_ERR_NO_MEM (0x101): Out of mem... | Error Codes Reference
This section lists various error code constants defined in ESP-IDF.
For general information about error codes in ESP-IDF, see Error Handling.
ESP_FAIL (-1): Generic esp_err_t code indicating failure
ESP_OK (0): esp_err_t value indicating success (no error)
ESP_ERR_NO_MEM (0x101): Out of memory
ESP... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/error-codes.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-NOW | null | espressif.com | 2016-01-01 | 82a5fac4c32e935b | null | null | ESP-NOW Overview ESP-NOW is a kind of connectionless Wi-Fi communication protocol that is defined by Espressif. In ESP-NOW, application data is encapsulated in a vendor-specific action frame and then transmitted from one Wi-Fi device to another without connection. CTR with CBC-MAC Protocol (CCMP) is used to protec... | ESP-NOW
Overview
ESP-NOW is a kind of connectionless Wi-Fi communication protocol that is defined by Espressif. In ESP-NOW, application data is encapsulated in a vendor-specific action frame and then transmitted from one Wi-Fi device to another without connection.
CTR with CBC-MAC Protocol (CCMP) is used to protect the... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_now.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-WIFI-MESH Programming Guide | null | espressif.com | 2016-01-01 | b641f911f429bbc3 | null | null | ESP-WIFI-MESH Programming Guide This is a programming guide for ESP-WIFI-MESH, including the API reference and coding examples. This guide is split into the following parts: For documentation regarding the ESP-WIFI-MESH protocol, please see the ESP-WIFI-MESH API Guide. For more information about ESP-WIFI-MESH Develo... | ESP-WIFI-MESH Programming Guide
This is a programming guide for ESP-WIFI-MESH, including the API reference and coding examples. This guide is split into the following parts:
For documentation regarding the ESP-WIFI-MESH protocol, please see the ESP-WIFI-MESH API Guide. For more information about ESP-WIFI-MESH Developme... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp-wifi-mesh.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SmartConfig | null | espressif.com | 2016-01-01 | 168055ceee2c6296 | null | null | SmartConfig The SmartConfigTM is a provisioning technology developed by TI to connect a new Wi-Fi device to a Wi-Fi network. It uses a mobile application to broadcast the network credentials from a smartphone, or a tablet, to an un-provisioned Wi-Fi device. The advantage of this technology is that the device does no... | SmartConfig
The SmartConfigTM is a provisioning technology developed by TI to connect a new Wi-Fi device to a Wi-Fi network. It uses a mobile application to broadcast the network credentials from a smartphone, or a tablet, to an un-provisioned Wi-Fi device.
The advantage of this technology is that the device does not n... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_smartconfig.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Wi-Fi Easy ConnectTM (DPP) | null | espressif.com | 2016-01-01 | a78e8b4fab29eb48 | null | null | Wi-Fi Easy ConnectTM (DPP) Wi-Fi Easy ConnectTM, also known as Device Provisioning Protocol (DPP) or Easy Connect, is a provisioning protocol certified by Wi-Fi Alliance. It is a secure and standardized provisioning protocol for configuration of Wi-Fi Devices. With Easy Connect, adding a new device to a network is as... | Wi-Fi Easy ConnectTM (DPP)
Wi-Fi Easy ConnectTM, also known as Device Provisioning Protocol (DPP) or Easy Connect, is a provisioning protocol certified by Wi-Fi Alliance. It is a secure and standardized provisioning protocol for configuration of Wi-Fi Devices. With Easy Connect, adding a new device to a network is as s... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_dpp.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Wi-Fi AwareTM (NAN) | null | espressif.com | 2016-01-01 | 86a4f9cde544c3e7 | null | null | Wi-Fi AwareTM (NAN) Wi-Fi AwareTM or NAN (Neighbor Awareness Networking) is a protocol that allows Wi-Fi devices to discover services in their proximity. Typically, location-based services are based on querying servers for information about the environment and the location knowledge is based on GPS or other location ... | Wi-Fi AwareTM (NAN)
Wi-Fi AwareTM or NAN (Neighbor Awareness Networking) is a protocol that allows Wi-Fi devices to discover services in their proximity. Typically, location-based services are based on querying servers for information about the environment and the location knowledge is based on GPS or other location re... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_nan.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Ethernet | null | espressif.com | 2016-01-01 | ee7cda19a526db94 | null | null | Ethernet Overview ESP-IDF provides a set of consistent and flexible APIs to support both internal Ethernet MAC (EMAC) controller and external SPI-Ethernet modules. This programming guide is split into the following sections: Basic Ethernet Concepts Ethernet is an asynchronous Carrier Sense Multiple Access with ... | Ethernet
Overview
ESP-IDF provides a set of consistent and flexible APIs to support both internal Ethernet MAC (EMAC) controller and external SPI-Ethernet modules.
This programming guide is split into the following sections:
Basic Ethernet Concepts
Ethernet is an asynchronous Carrier Sense Multiple Access with Collisio... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_eth.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Thread | null | espressif.com | 2016-01-01 | 9756f2f82c1391c1 | null | null | Thread Introduction Thread is an IP-based mesh networking protocol. It is based on the 802.15.4 physical and MAC layer. Application Examples The openthread directory of ESP-IDF examples contains the following applications: The OpenThread interactive shell openthread/ot_cli The Thread Border Router openthread/ot... | Thread
Introduction
Thread is an IP-based mesh networking protocol. It is based on the 802.15.4 physical and MAC layer.
Application Examples
The openthread directory of ESP-IDF examples contains the following applications:
The OpenThread interactive shell openthread/ot_cli
The Thread Border Router openthread/ot_br
The ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_openthread.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-NETIF | null | espressif.com | 2016-01-01 | b204fc5bf01399c2 | null | null | ESP-NETIF The purpose of the ESP-NETIF library is twofold: It provides an abstraction layer for the application on top of the TCP/IP stack. This allows applications to choose between IP stacks in the future. The APIs it provides are thread-safe, even if the underlying TCP/IP stack APIs are not. ESP-IDF currently imp... | ESP-NETIF
The purpose of the ESP-NETIF library is twofold:
It provides an abstraction layer for the application on top of the TCP/IP stack. This allows applications to choose between IP stacks in the future.
The APIs it provides are thread-safe, even if the underlying TCP/IP stack APIs are not.
ESP-IDF currently implem... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_netif.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP-NETIF Custom I/O Driver | null | espressif.com | 2016-01-01 | bf9bda1bd012ba84 | null | null | ESP-NETIF Custom I/O Driver This section outlines implementing a new I/O driver with ESP-NETIF connection capabilities. By convention, the I/O driver has to register itself as an ESP-NETIF driver, and thus holds a dependency on ESP-NETIF component and is responsible for providing data path functions, post-attach cal... | ESP-NETIF Custom I/O Driver
This section outlines implementing a new I/O driver with ESP-NETIF connection capabilities.
By convention, the I/O driver has to register itself as an ESP-NETIF driver, and thus holds a dependency on ESP-NETIF component and is responsible for providing data path functions, post-attach callba... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_netif_driver.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Analog to Digital Converter (ADC) Oneshot Mode Driver | null | espressif.com | 2016-01-01 | 875a9bb63e1ed141 | null | null | Analog to Digital Converter (ADC) Oneshot Mode Driver Introduction The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pins. ESP32 has two ADC unit(s), which can be used in scenario(s) like: Generate one-shot ADC conversion result Generate c... | Analog to Digital Converter (ADC) Oneshot Mode Driver
Introduction
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pins.
ESP32 has two ADC unit(s), which can be used in scenario(s) like:
Generate one-shot ADC conversion result
Generate continu... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/adc_oneshot.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Analog to Digital Converter (ADC) Continuous Mode Driver | null | espressif.com | 2016-01-01 | 9ed19a11b2369101 | null | null | Analog to Digital Converter (ADC) Continuous Mode Driver Introduction The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pads. Additionally, the Direct Memory Access (DMA) functionality is utilized to efficiently retrieve ADC conversion resul... | Analog to Digital Converter (ADC) Continuous Mode Driver
Introduction
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pads. Additionally, the Direct Memory Access (DMA) functionality is utilized to efficiently retrieve ADC conversion results.
... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/adc_continuous.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Analog to Digital Converter (ADC) Calibration Driver | null | espressif.com | 2016-01-01 | deb38c77a61b01d3 | null | null | Analog to Digital Converter (ADC) Calibration Driver Introduction In ESP32, the digital-to-analog converter (ADC) compares the input analog voltage to the reference, and determines each bit of the output digital result. By design, the ADC reference voltage for ESP32 is 1100 mV. However, the true reference voltage c... | Analog to Digital Converter (ADC) Calibration Driver
Introduction
In ESP32, the digital-to-analog converter (ADC) compares the input analog voltage to the reference, and determines each bit of the output digital result. By design, the ADC reference voltage for ESP32 is 1100 mV. However, the true reference voltage can r... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/adc_calibration.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Clock Tree | null | espressif.com | 2016-01-01 | 8770ba38260aa866 | null | null | Clock Tree The clock subsystem of ESP32 is used to source and distribute system/module clocks from a range of root clocks. The clock tree driver maintains the basic functionality of the system clock and the intricate relationship among module clocks. This document starts with the introduction to root and module cloc... | Clock Tree
The clock subsystem of ESP32 is used to source and distribute system/module clocks from a range of root clocks. The clock tree driver maintains the basic functionality of the system clock and the intricate relationship among module clocks.
This document starts with the introduction to root and module clocks.... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/clk_tree.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Digital To Analog Converter (DAC) | null | espressif.com | 2016-01-01 | 9cda9c1e2654d793 | null | null | Digital To Analog Converter (DAC) Overview ESP32 has two 8-bit DAC (digital to analog converter) channels respectively connected to GPIO25 (Channel 1) and GPIO26 (Channel 2). Each DAC channel can convert the digital value 0~255 to the analog voltage 0~Vref (The reference voltage 'Vref' here is input from the pin VD... | Digital To Analog Converter (DAC)
Overview
ESP32 has two 8-bit DAC (digital to analog converter) channels respectively connected to GPIO25 (Channel 1) and GPIO26 (Channel 2). Each DAC channel can convert the digital value 0~255 to the analog voltage 0~Vref (The reference voltage 'Vref' here is input from the pin VDD3P3... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/dac.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
GPIO & RTC GPIO | null | espressif.com | 2016-01-01 | 9247da07153cb842 | null | null | GPIO & RTC GPIO GPIO Summary The ESP32 chip features 34 physical GPIO pins (GPIO0 ~ GPIO19, GPIO21 ~ GPIO23, GPIO25 ~ GPIO27, and GPIO32 ~ GPIO39). Each pin can be used as a general-purpose I/O, or be connected to an internal peripheral signal. Through IO MUX, RTC IO MUX and the GPIO matrix, peripheral input signal... | GPIO & RTC GPIO
GPIO Summary
The ESP32 chip features 34 physical GPIO pins (GPIO0 ~ GPIO19, GPIO21 ~ GPIO23, GPIO25 ~ GPIO27, and GPIO32 ~ GPIO39). Each pin can be used as a general-purpose I/O, or be connected to an internal peripheral signal. Through IO MUX, RTC IO MUX and the GPIO matrix, peripheral input signals ca... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/gpio.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
General Purpose Timer (GPTimer) | null | espressif.com | 2016-01-01 | 6e55bc12b407b389 | null | null | General Purpose Timer (GPTimer) Introduction GPTimer (General Purpose Timer) is the driver of ESP32 Timer Group peripheral. The hardware timer features high resolution and flexible alarm action. The behavior when the internal counter of a timer reaches a specific target value is called a timer alarm. When a timer a... | General Purpose Timer (GPTimer)
Introduction
GPTimer (General Purpose Timer) is the driver of ESP32 Timer Group peripheral. The hardware timer features high resolution and flexible alarm action. The behavior when the internal counter of a timer reaches a specific target value is called a timer alarm. When a timer alarm... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/gptimer.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Inter-Integrated Circuit (I2C) | null | espressif.com | 2016-01-01 | 2ed9b813e24eb321 | null | null | Inter-Integrated Circuit (I2C) Introduction I2C is a serial, synchronous, multi-device, half-duplex communication protocol that allows co-existence of multiple masters and slaves on the same bus. I2C uses two bidirectional open-drain lines: serial data line (SDA) and serial clock line (SCL), pulled up by resistors.... | Inter-Integrated Circuit (I2C)
Introduction
I2C is a serial, synchronous, multi-device, half-duplex communication protocol that allows co-existence of multiple masters and slaves on the same bus. I2C uses two bidirectional open-drain lines: serial data line (SDA) and serial clock line (SCL), pulled up by resistors.
ESP... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/i2c.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Inter-IC Sound (I2S) | null | espressif.com | 2016-01-01 | 945a9c3e3a5edbc9 | null | null | Inter-IC Sound (I2S) Introduction I2S (Inter-IC Sound) is a synchronous serial communication protocol usually used for transmitting audio data between two digital audio devices. ESP32 contains two I2S peripheral(s). These peripherals can be configured to input and output sample data via the I2S driver. An I2S bus... | Inter-IC Sound (I2S)
Introduction
I2S (Inter-IC Sound) is a synchronous serial communication protocol usually used for transmitting audio data between two digital audio devices.
ESP32 contains two I2S peripheral(s). These peripherals can be configured to input and output sample data via the I2S driver.
An I2S bus that ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/i2s.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
LCD | null | espressif.com | 2016-01-01 | 8e895c98ae1fd0d9 | null | null | LCD Introduction ESP chips can generate various kinds of timings that needed by common LCDs on the market, like SPI LCD, I80 LCD (a.k.a Intel 8080 parallel LCD), RGB/SRGB LCD, I2C LCD, etc. The esp_lcd component is officially to support those LCDs with a group of universal APIs across chips. Functional Overview ... | LCD
Introduction
ESP chips can generate various kinds of timings that needed by common LCDs on the market, like SPI LCD, I80 LCD (a.k.a Intel 8080 parallel LCD), RGB/SRGB LCD, I2C LCD, etc. The
esp_lcd component is officially to support those LCDs with a group of universal APIs across chips.
Functional Overview
In
esp_... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/lcd.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
LED Control (LEDC) | null | espressif.com | 2016-01-01 | 940698e61a0ccf8d | null | null | LED Control (LEDC) Introduction The LED control (LEDC) peripheral is primarily designed to control the intensity of LEDs, although it can also be used to generate PWM signals for other purposes. It has 8 channels which can generate independent waveforms that can be used, for example, to drive RGB LED devices. LEDC... | LED Control (LEDC)
Introduction
The LED control (LEDC) peripheral is primarily designed to control the intensity of LEDs, although it can also be used to generate PWM signals for other purposes. It has 8 channels which can generate independent waveforms that can be used, for example, to drive RGB LED devices.
LEDC chan... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/ledc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Motor Control Pulse Width Modulator (MCPWM) | null | espressif.com | 2016-01-01 | 2f2c1d93b23c9da1 | null | null | Motor Control Pulse Width Modulator (MCPWM) The MCPWM peripheral is a versatile PWM generator, which contains various submodules to make it a key element in power electronic applications like motor control, digital power, and so on. Typically, the MCPWM peripheral can be used in the following scenarios: Digital moto... | Motor Control Pulse Width Modulator (MCPWM)
The MCPWM peripheral is a versatile PWM generator, which contains various submodules to make it a key element in power electronic applications like motor control, digital power, and so on. Typically, the MCPWM peripheral can be used in the following scenarios:
Digital motor c... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/mcpwm.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Pulse Counter (PCNT) | null | espressif.com | 2016-01-01 | 2c4e3c91246e9be9 | null | null | Pulse Counter (PCNT) Introduction The PCNT (Pulse Counter) module is designed to count the number of rising and/or falling edges of input signals. The ESP32 contains multiple pulse counter units in the module. 1 Each unit is in effect an independent counter with multiple channels, where each channel can increment/d... | Pulse Counter (PCNT)
Introduction
The PCNT (Pulse Counter) module is designed to count the number of rising and/or falling edges of input signals. The ESP32 contains multiple pulse counter units in the module. 1 Each unit is in effect an independent counter with multiple channels, where each channel can increment/decre... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/pcnt.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Remote Control Transceiver (RMT) | null | espressif.com | 2016-01-01 | 244ebc93381e10e1 | null | null | Remote Control Transceiver (RMT) Introduction The RMT (Remote Control Transceiver) peripheral was designed to act as an infrared transceiver. However, due to the flexibility of its data format, RMT can be extended to a versatile and general-purpose transceiver, transmitting or receiving many other types of signals.... | Remote Control Transceiver (RMT)
Introduction
The RMT (Remote Control Transceiver) peripheral was designed to act as an infrared transceiver. However, due to the flexibility of its data format, RMT can be extended to a versatile and general-purpose transceiver, transmitting or receiving many other types of signals. Fro... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/rmt.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SD SPI Host Driver | null | espressif.com | 2016-01-01 | 8e49cc11e213b299 | null | null | SD SPI Host Driver Overview The SD SPI host driver allows communication with one or more SD cards using the SPI Master driver, which utilizes the SPI host. Each card is accessed through an SD SPI device, represented by an SD SPI handle sdspi_dev_handle_t , which returns when the device is attached to an SPI bus by... | SD SPI Host Driver
Overview
The SD SPI host driver allows communication with one or more SD cards using the SPI Master driver, which utilizes the SPI host. Each card is accessed through an SD SPI device, represented by an SD SPI handle
sdspi_dev_handle_t, which returns when the device is attached to an SPI bus by calli... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/sdspi_host.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SDIO Card Slave Driver | null | espressif.com | 2016-01-01 | 8edafa5fe432bd9b | null | null | SDIO Card Slave Driver Overview The ESP32 SDIO Card host and slave peripherals share two sets of pins, as shown in the table below. The first set is usually occupied by the SPI0 bus, which is responsible for the SPI flash holding the code to run. This means the SDIO slave driver can only run on the second set of pi... | SDIO Card Slave Driver
Overview
The ESP32 SDIO Card host and slave peripherals share two sets of pins, as shown in the table below. The first set is usually occupied by the SPI0 bus, which is responsible for the SPI flash holding the code to run. This means the SDIO slave driver can only run on the second set of pins w... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/sdio_slave.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Sigma-Delta Modulation (SDM) | null | espressif.com | 2016-01-01 | 140e9c941ade06e9 | null | null | Sigma-Delta Modulation (SDM) Introduction ESP32 has a second-order sigma-delta modulator, which can generate independent PDM pulses to multiple channels. Please refer to the TRM to check how many hardware channels are available. 1 Delta-sigma modulation converts an analog voltage signal into a pulse frequency, or ... | Sigma-Delta Modulation (SDM)
Introduction
ESP32 has a second-order sigma-delta modulator, which can generate independent PDM pulses to multiple channels. Please refer to the TRM to check how many hardware channels are available. 1
Delta-sigma modulation converts an analog voltage signal into a pulse frequency, or pulse... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/sdm.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SPI Flash API | null | espressif.com | 2016-01-01 | 96c6d95f86138949 | null | null | SPI Flash API Overview The spi_flash component contains API functions related to reading, writing, erasing, and memory mapping for data in the external flash. For higher-level API functions which work with partitions defined in the partition table, see Partitions API Note esp_partition_* APIs are recommended to... | SPI Flash API
Overview
The spi_flash component contains API functions related to reading, writing, erasing, and memory mapping for data in the external flash.
For higher-level API functions which work with partitions defined in the partition table, see Partitions API
Note
esp_partition_* APIs are recommended to be used... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/spi_flash/index.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SPI Master Driver | null | espressif.com | 2016-01-01 | be4afbdea372b389 | null | null | SPI Master Driver SPI Master driver is a program that controls ESP32's General Purpose SPI (GP-SPI) peripheral(s) when it functions as a master. Note SPI1 is not a GP-SPI. SPI Master driver also supports SPI1 but with quite a few limitations, see Notes on Using the SPI Master Driver on SPI1 Bus. For more hardware ... | SPI Master Driver
SPI Master driver is a program that controls ESP32's General Purpose SPI (GP-SPI) peripheral(s) when it functions as a master.
Note
SPI1 is not a GP-SPI. SPI Master driver also supports SPI1 but with quite a few limitations, see Notes on Using the SPI Master Driver on SPI1 Bus.
For more hardware infor... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/spi_master.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SPI Slave Driver | null | espressif.com | 2016-01-01 | be8e83dc82729189 | null | null | SPI Slave Driver SPI Slave driver is a program that controls ESP32's General Purpose SPI (GP-SPI) peripheral(s) when it functions as a slave. For more hardware information about the GP-SPI peripheral(s), see ESP32 Technical Reference Manual > SPI Controller [PDF]. Terminology The terms used in relation to the SPI... | SPI Slave Driver
SPI Slave driver is a program that controls ESP32's General Purpose SPI (GP-SPI) peripheral(s) when it functions as a slave.
For more hardware information about the GP-SPI peripheral(s), see ESP32 Technical Reference Manual > SPI Controller [PDF].
Terminology
The terms used in relation to the SPI slave... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/spi_slave.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP32-WROOM-32SE (Secure Element) | null | espressif.com | 2016-01-01 | 2f4b6c2c30b36f75 | null | null | ESP32-WROOM-32SE (Secure Element) Overview ESP32-WROOM-32SE integrates Microchip's ATECC608A cryptoauth chip in the module. ATECC608A is a secure element, which would generate and store ECC private key in the hardware. The ECC private key can be used to enhance security to connect to IoT cloud services with the use... | ESP32-WROOM-32SE (Secure Element)
Overview
ESP32-WROOM-32SE integrates Microchip's ATECC608A cryptoauth chip in the module. ATECC608A is a secure element, which would generate and store ECC private key in the hardware. The ECC private key can be used to enhance security to connect to IoT cloud services with the use of ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/secure_element.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Touch Sensor | null | espressif.com | 2016-01-01 | 9a065a1ca87ed353 | null | null | Touch Sensor Introduction A touch sensor system is built on a substrate which carries electrodes and relevant connections under a protective flat surface. When the surface is touched, the capacitance variation is used to evaluate if the touch was valid. The sensing pads can be arranged in different combinations (e... | Touch Sensor
Introduction
A touch sensor system is built on a substrate which carries electrodes and relevant connections under a protective flat surface. When the surface is touched, the capacitance variation is used to evaluate if the touch was valid.
The sensing pads can be arranged in different combinations (e.g., ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/touch_pad.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Two-Wire Automotive Interface (TWAI) | null | espressif.com | 2016-01-01 | aeddf81e68a6f9cb | null | null | Two-Wire Automotive Interface (TWAI) Overview The Two-Wire Automotive Interface (TWAI) is a real-time serial communication protocol suited for automotive and industrial applications. It is compatible with ISO11898-1 Classical frames, thus can support Standard Frame Format (11-bit ID) and Extended Frame Format (29-b... | Two-Wire Automotive Interface (TWAI)
Overview
The Two-Wire Automotive Interface (TWAI) is a real-time serial communication protocol suited for automotive and industrial applications. It is compatible with ISO11898-1 Classical frames, thus can support Standard Frame Format (11-bit ID) and Extended Frame Format (29-bit I... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/twai.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Universal Asynchronous Receiver/Transmitter (UART) | null | espressif.com | 2016-01-01 | 4a5fda051038ac4b | null | null | Universal Asynchronous Receiver/Transmitter (UART) Introduction A Universal Asynchronous Receiver/Transmitter (UART) is a hardware feature that handles communication (i.e., timing requirements and data framing) using widely-adopted asynchronous serial communication interfaces, such as RS232, RS422, and RS485. A UAR... | Universal Asynchronous Receiver/Transmitter (UART)
Introduction
A Universal Asynchronous Receiver/Transmitter (UART) is a hardware feature that handles communication (i.e., timing requirements and data framing) using widely-adopted asynchronous serial communication interfaces, such as RS232, RS422, and RS485. A UART pr... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/uart.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Project Configuration | null | espressif.com | 2016-01-01 | ec57685903926148 | null | null | Project Configuration Introduction The esp-idf-kconfig package that ESP-IDF uses is based on kconfiglib, which is a Python extension to the Kconfig system. Kconfig provides a compile-time project configuration mechanism and offers configuration options of several types (e.g., integers, strings, and boolens). Kconfi... | Project Configuration
Introduction
The esp-idf-kconfig package that ESP-IDF uses is based on kconfiglib, which is a Python extension to the Kconfig system. Kconfig provides a compile-time project configuration mechanism and offers configuration options of several types (e.g., integers, strings, and boolens). Kconfig fi... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Protocol Communication | null | espressif.com | 2016-01-01 | b700bd5bc237f49c | null | null | Protocol Communication Overview The Protocol Communication (protocomm) component manages secure sessions and provides the framework for multiple transports. The application can also use the protocomm layer directly to have application-specific extensions for the provisioning or non-provisioning use cases. Followin... | Protocol Communication
Overview
The Protocol Communication (protocomm) component manages secure sessions and provides the framework for multiple transports. The application can also use the protocomm layer directly to have application-specific extensions for the provisioning or non-provisioning use cases.
Following fea... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/provisioning/protocomm.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Unified Provisioning | null | espressif.com | 2016-01-01 | f730dc1f48a283cd | null | null | Unified Provisioning Overview The unified provisioning support in the ESP-IDF provides an extensible mechanism to the developers to configure the device with the Wi-Fi credentials and/or other custom configuration using various transports and different security schemes. Depending on the use case, it provides a comp... | Unified Provisioning
Overview
The unified provisioning support in the ESP-IDF provides an extensible mechanism to the developers to configure the device with the Wi-Fi credentials and/or other custom configuration using various transports and different security schemes. Depending on the use case, it provides a complete... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/provisioning/provisioning.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Wi-Fi Provisioning | null | espressif.com | 2016-01-01 | 365df5db0022e80c | null | null | Wi-Fi Provisioning Overview This component provides APIs that control the Wi-Fi provisioning service for receiving and configuring Wi-Fi credentials over SoftAP or Bluetooth LE transport via secure Protocol Communication sessions. The set of wifi_prov_mgr_ APIs help quickly implement a provisioning service that h... | Wi-Fi Provisioning
Overview
This component provides APIs that control the Wi-Fi provisioning service for receiving and configuring Wi-Fi credentials over SoftAP or Bluetooth LE transport via secure Protocol Communication sessions. The set of
wifi_prov_mgr_ APIs help quickly implement a provisioning service that has nec... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/provisioning/wifi_provisioning.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
FAT Filesystem Support | null | espressif.com | 2016-01-01 | 8e45da4bb6add0b3 | null | null | FAT Filesystem Support ESP-IDF uses the FatFs library to work with FAT filesystems. FatFs resides in the fatfs component. Although the library can be used directly, many of its features can be accessed via VFS using the C standard library and POSIX API functions. Additionally, FatFs has been modified to support the... | FAT Filesystem Support
ESP-IDF uses the FatFs library to work with FAT filesystems. FatFs resides in the
fatfs component. Although the library can be used directly, many of its features can be accessed via VFS using the C standard library and POSIX API functions.
Additionally, FatFs has been modified to support the run... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/fatfs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Manufacturing Utility | null | espressif.com | 2016-01-01 | be97185984470f89 | null | null | Manufacturing Utility Introduction This utility is designed to create instances of factory NVS partition images on a per-device basis for mass manufacturing purposes. The NVS partition images are created from CSV files containing user-provided configurations and values. Please note that this utility only creates m... | Manufacturing Utility
Introduction
This utility is designed to create instances of factory NVS partition images on a per-device basis for mass manufacturing purposes. The NVS partition images are created from CSV files containing user-provided configurations and values.
Please note that this utility only creates manufa... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/mass_mfg.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Non-Volatile Storage Library | null | espressif.com | 2016-01-01 | dc43b013868cd599 | null | null | Non-Volatile Storage Library Introduction Non-volatile storage (NVS) library is designed to store key-value pairs in flash. This section introduces some concepts used by NVS. Underlying Storage Currently, NVS uses a portion of main flash memory through the esp_partition API. The library uses all the partitions w... | Non-Volatile Storage Library
Introduction
Non-volatile storage (NVS) library is designed to store key-value pairs in flash. This section introduces some concepts used by NVS.
Underlying Storage
Currently, NVS uses a portion of main flash memory through the esp_partition API. The library uses all the partitions with
dat... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/nvs_flash.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
NVS Encryption | null | espressif.com | 2016-01-01 | 9e87d40bb27ca9c1 | null | null | NVS Encryption Overview This guide provides an overview of the NVS encryption feature. NVS encryption helps to achieve secure storage on the device flash memory. Data stored in NVS partitions can be encrypted using XTS-AES in the manner similar to the one mentioned in disk encryption standard IEEE P1619. For the p... | NVS Encryption
Overview
This guide provides an overview of the NVS encryption feature. NVS encryption helps to achieve secure storage on the device flash memory.
Data stored in NVS partitions can be encrypted using XTS-AES in the manner similar to the one mentioned in disk encryption standard IEEE P1619. For the purpos... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/nvs_encryption.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
NVS Partition Generator Utility | null | espressif.com | 2016-01-01 | be9d381b84c71ac0 | null | null | NVS Partition Generator Utility Introduction The utility nvs_flash/nvs_partition_generator/nvs_partition_gen.py creates a binary file, compatible with the NVS architecture defined in Non-Volatile Storage Library, based on the key-value pairs provided in a CSV file. This utility is ideally suited for generating a b... | NVS Partition Generator Utility
Introduction
The utility nvs_flash/nvs_partition_generator/nvs_partition_gen.py creates a binary file, compatible with the NVS architecture defined in Non-Volatile Storage Library, based on the key-value pairs provided in a CSV file.
This utility is ideally suited for generating a binary... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/nvs_partition_gen.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SD/SDIO/MMC Driver | null | espressif.com | 2016-01-01 | 8e41da12a0123033 | null | null | SD/SDIO/MMC Driver Overview The SD/SDIO/MMC driver currently supports SD memory, SDIO cards, and eMMC chips. This is a protocol level driver built on top of SDMMC and SD SPI host drivers. SDMMC and SD SPI host drivers (driver/sdmmc/include/driver/sdmmc_host.h and driver/spi/include/driver/sdspi_host.h) provide API... | SD/SDIO/MMC Driver
Overview
The SD/SDIO/MMC driver currently supports SD memory, SDIO cards, and eMMC chips. This is a protocol level driver built on top of SDMMC and SD SPI host drivers.
SDMMC and SD SPI host drivers (driver/sdmmc/include/driver/sdmmc_host.h and driver/spi/include/driver/sdspi_host.h) provide API func... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/sdmmc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Partitions API | null | espressif.com | 2016-01-01 | 8c65c01ba6ace8df | null | null | Partitions API Overview The esp_partition component has higher-level API functions which work with partitions defined in the Partition Tables. These APIs are based on lower level API provided by SPI Flash API. Partition Table API ESP-IDF projects use a partition table to maintain information about various regio... | Partitions API
Overview
The
esp_partition component has higher-level API functions which work with partitions defined in the Partition Tables. These APIs are based on lower level API provided by SPI Flash API.
Partition Table API
ESP-IDF projects use a partition table to maintain information about various regions of SP... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/partition.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
SPIFFS Filesystem | null | espressif.com | 2016-01-01 | 9c05d21386f49cd3 | null | null | SPIFFS Filesystem Overview SPIFFS is a file system intended for SPI NOR flash devices on embedded targets. It supports wear levelling, file system consistency checks, and more. Notes Currently, SPIFFS does not support directories, it produces a flat structure. If SPIFFS is mounted under /spiffs , then creati... | SPIFFS Filesystem
Overview
SPIFFS is a file system intended for SPI NOR flash devices on embedded targets. It supports wear levelling, file system consistency checks, and more.
Notes
-
Currently, SPIFFS does not support directories, it produces a flat structure. If SPIFFS is mounted under
/spiffs, then creating a file ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/spiffs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Virtual Filesystem Component | null | espressif.com | 2016-01-01 | a6479e1770ab9242 | null | null | Virtual Filesystem Component Overview Virtual filesystem (VFS) component provides a unified interface for drivers which can perform operations on file-like objects. These can be real filesystems (FAT, SPIFFS, etc.) or device drivers which provide a file-like interface. This component allows C library functions, su... | Virtual Filesystem Component
Overview
Virtual filesystem (VFS) component provides a unified interface for drivers which can perform operations on file-like objects. These can be real filesystems (FAT, SPIFFS, etc.) or device drivers which provide a file-like interface.
This component allows C library functions, such as... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/storage/vfs.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Page Not Found | null | espressif.com | 2016-01-01 | 7c7a989a6f8437ed | null | null | Page Not Found Note We are sorry. The page you requested could not be found. This error occurs maybe because the current chip or version you choose does not support the feature you are looking for. If you want to provide feedback about this document, please let us know what exact document you want to access, so that... | Page Not Found
Note
We are sorry. The page you requested could not be found. This error occurs maybe because the current chip or version you choose does not support the feature you are looking for. If you want to provide feedback about this document, please let us know what exact document you want to access, so that we... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/404.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Application Level Tracing | null | espressif.com | 2016-01-01 | b043ef4ee899f6d3 | null | null | Application Level Tracing Overview ESP-IDF provides a useful feature for application behavior analysis called Application Level Tracing. The feature can be enabled in menuconfig and allows transfer of arbitrary data between the host and ESP32 via JTAG interface with minimal overhead on program execution. Developer... | Application Level Tracing
Overview
ESP-IDF provides a useful feature for application behavior analysis called Application Level Tracing. The feature can be enabled in menuconfig and allows transfer of arbitrary data between the host and ESP32 via JTAG interface with minimal overhead on program execution.
Developers can... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/app_trace.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Call Function with External Stack | null | espressif.com | 2016-01-01 | 5a876032ef12b215 | null | null | Call Function with External Stack Overview A given function can be executed with a user-allocated stack space which is independent of current task stack. This mechanism can be used to save stack space wasted by tasks which call a common function with intensive stack usage such as printf . The given function can be... | Call Function with External Stack
Overview
A given function can be executed with a user-allocated stack space which is independent of current task stack. This mechanism can be used to save stack space wasted by tasks which call a common function with intensive stack usage such as
printf. The given function can be calle... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/esp_function_with_shared_stack.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Chip Revision | null | espressif.com | 2016-01-01 | be07eaa4ad83a7dc | null | null | Chip Revision Overview ESP32 may have different revisions. These revisions mainly fix some issues, and sometimes also bring new features to the chip. Versioning Scheme describes the versioning of these chip revisions, and the APIs to read the versions at runtime. There are some considerations of compatibility amon... | Chip Revision
Overview
ESP32 may have different revisions. These revisions mainly fix some issues, and sometimes also bring new features to the chip. Versioning Scheme describes the versioning of these chip revisions, and the APIs to read the versions at runtime.
There are some considerations of compatibility among app... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/chip_revision.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Console | null | espressif.com | 2016-01-01 | d6d9dfd12217bbb9 | null | null | Console ESP-IDF provides console component, which includes building blocks needed to develop an interactive console over serial port. This component includes the following features: Line editing, provided by linenoise library. This includes handling of backspace and arrow keys, scrolling through command history, co... | Console
ESP-IDF provides
console component, which includes building blocks needed to develop an interactive console over serial port. This component includes the following features:
Line editing, provided by linenoise library. This includes handling of backspace and arrow keys, scrolling through command history, comman... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/console.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
eFuse Manager | null | espressif.com | 2016-01-01 | e9afcdee450ea41 | null | null | eFuse Manager Introduction The eFuse Manager library is designed to structure access to eFuse bits and make using these easy. This library operates eFuse bits by a structure name which is assigned in eFuse table. This sections introduces some concepts used by eFuse Manager. Hardware Description The ESP32 has a n... | eFuse Manager
Introduction
The eFuse Manager library is designed to structure access to eFuse bits and make using these easy. This library operates eFuse bits by a structure name which is assigned in eFuse table. This sections introduces some concepts used by eFuse Manager.
Hardware Description
The ESP32 has a number o... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/efuse.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Error Code and Helper Functions | null | espressif.com | 2016-01-01 | a80eea12e48ca1dc | null | null | Error Code and Helper Functions This section lists definitions of common ESP-IDF error codes and several helper functions related to error handling. For general information about error codes in ESP-IDF, see Error Handling. For the full list of error codes defined in ESP-IDF, see Error Codes Reference. API Referenc... | Error Code and Helper Functions
This section lists definitions of common ESP-IDF error codes and several helper functions related to error handling.
For general information about error codes in ESP-IDF, see Error Handling.
For the full list of error codes defined in ESP-IDF, see Error Codes Reference.
API Reference
Hea... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/esp_err.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
ESP HTTPS OTA | null | espressif.com | 2016-01-01 | 86439c131610d092 | null | null | ESP HTTPS OTA Overview esp_https_ota provides simplified APIs to perform firmware upgrades over HTTPS. It is an abstraction layer over the existing OTA APIs. Application Example esp_err_t do_firmware_upgrade() { esp_http_client_config_t config = { .url = CONFIG_FIRMWARE_UPGRADE_URL, .cert_pem = (char *)server_... | ESP HTTPS OTA
Overview
esp_https_ota provides simplified APIs to perform firmware upgrades over HTTPS. It is an abstraction layer over the existing OTA APIs.
Application Example
esp_err_t do_firmware_upgrade() { esp_http_client_config_t config = { .url = CONFIG_FIRMWARE_UPGRADE_URL, .cert_pem = (char *)server_cert_pem_... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/esp_https_ota.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Event Loop Library | null | espressif.com | 2016-01-01 | f36eb6cf09f29f0e | null | null | Event Loop Library Overview The event loop library allows components to declare events so that other components can register handlers -- codes that executes when those events occur. This allows loosely-coupled components to attach desired behavior to state changes of other components without application involvement... | Event Loop Library
Overview
The event loop library allows components to declare events so that other components can register handlers -- codes that executes when those events occur. This allows loosely-coupled components to attach desired behavior to state changes of other components without application involvement. Th... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/esp_event.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
FreeRTOS Overview | null | espressif.com | 2016-01-01 | b4ad3f751413431c | null | null | FreeRTOS Overview Overview FreeRTOS is an open source RTOS (real-time operating system) kernel that is integrated into ESP-IDF as a component. Thus, all ESP-IDF applications and many ESP-IDF components are written based on FreeRTOS. The FreeRTOS kernel is ported to all architectures (i.e., Xtensa and RISC-V) availa... | FreeRTOS Overview
Overview
FreeRTOS is an open source RTOS (real-time operating system) kernel that is integrated into ESP-IDF as a component. Thus, all ESP-IDF applications and many ESP-IDF components are written based on FreeRTOS. The FreeRTOS kernel is ported to all architectures (i.e., Xtensa and RISC-V) available ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/freertos.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
FreeRTOS (IDF) | null | espressif.com | 2016-01-01 | 78c49d46e0a2978b | null | null | FreeRTOS (IDF) This document provides information regarding the dual-core SMP implementation of FreeRTOS inside ESP-IDF. This document is split into the following sections: Sections Overview The original FreeRTOS (hereinafter referred to as Vanilla FreeRTOS) is a compact and efficient real-time operating system s... | FreeRTOS (IDF)
This document provides information regarding the dual-core SMP implementation of FreeRTOS inside ESP-IDF. This document is split into the following sections:
Sections
Overview
The original FreeRTOS (hereinafter referred to as Vanilla FreeRTOS) is a compact and efficient real-time operating system support... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/freertos_idf.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
FreeRTOS (Supplemental Features) | null | espressif.com | 2016-01-01 | 8893ba47e432b7ba | null | null | FreeRTOS (Supplemental Features) ESP-IDF provides multiple features to supplement the features offered by FreeRTOS. These supplemental features are available on all FreeRTOS implementations supported by ESP-IDF (i.e., ESP-IDF FreeRTOS and Amazon SMP FreeRTOS). This document describes these supplemental features and i... | FreeRTOS (Supplemental Features)
ESP-IDF provides multiple features to supplement the features offered by FreeRTOS. These supplemental features are available on all FreeRTOS implementations supported by ESP-IDF (i.e., ESP-IDF FreeRTOS and Amazon SMP FreeRTOS). This document describes these supplemental features and is ... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/freertos_additions.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Heap Memory Allocation | null | espressif.com | 2016-01-01 | a2fffd90f4b380e8 | null | null | Heap Memory Allocation Stack and Heap ESP-IDF applications use the common computer architecture patterns of stack (dynamic memory allocated by program control flow), heap (dynamic memory allocated by function calls), and static memory (memory allocated at compile time). Because ESP-IDF is a multi-threaded RTOS env... | Heap Memory Allocation
Stack and Heap
ESP-IDF applications use the common computer architecture patterns of stack (dynamic memory allocated by program control flow), heap (dynamic memory allocated by function calls), and static memory (memory allocated at compile time).
Because ESP-IDF is a multi-threaded RTOS environm... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/mem_alloc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Memory Management for MMU Supported Memory | null | espressif.com | 2016-01-01 | a6a3fc9bf4f38841 | null | null | Memory Management for MMU Supported Memory Introduction ESP32 Memory Management Unit (MMU) is relatively simple. It can do memory address translation between physical memory addresses and virtual memory addresses. So CPU can access physical memories via virtual addresses. There are multiple types of virtual memory ... | Memory Management for MMU Supported Memory
Introduction
ESP32 Memory Management Unit (MMU) is relatively simple. It can do memory address translation between physical memory addresses and virtual memory addresses. So CPU can access physical memories via virtual addresses. There are multiple types of virtual memory addr... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/mm.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Heap Memory Debugging | null | espressif.com | 2018-11-05 | 2ad3ff91e0b382c9 | null | null | Heap Memory Debugging Overview ESP-IDF integrates tools for requesting heap information, heap corruption detection, and heap tracing. These can help track down memory-related bugs. For general information about the heap memory allocator, see Heap Memory Allocation. Heap Information To obtain information about t... | Heap Memory Debugging
Overview
ESP-IDF integrates tools for requesting heap information, heap corruption detection, and heap tracing. These can help track down memory-related bugs.
For general information about the heap memory allocator, see Heap Memory Allocation.
Heap Information
To obtain information about the state... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/heap_debug.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
High Resolution Timer (ESP Timer) | null | espressif.com | 2016-01-01 | bd05d5ea30168f89 | null | null | High Resolution Timer (ESP Timer) Overview Although FreeRTOS provides software timers, FreeRTOS software timers have a few limitations: Maximum resolution is equal to the RTOS tick period Timer callbacks are dispatched from a low-priority timer service (i.e., daemon) task. This task can be preempted by other tasks... | High Resolution Timer (ESP Timer)
Overview
Although FreeRTOS provides software timers, FreeRTOS software timers have a few limitations:
Maximum resolution is equal to the RTOS tick period
Timer callbacks are dispatched from a low-priority timer service (i.e., daemon) task. This task can be preempted by other tasks, lea... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/esp_timer.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Internal and Unstable APIs | null | espressif.com | 2016-01-01 | a205da143370b4bb | null | null | Internal and Unstable APIs This section is listing some APIs that are internal or likely to be changed or removed in the next releases of ESP-IDF. API Reference Header File This header file can be included with: #include "esp_rom_sys.h" Functions
void esp_rom_software_reset_system(void) Software Reset digit... | Internal and Unstable APIs
This section is listing some APIs that are internal or likely to be changed or removed in the next releases of ESP-IDF.
API Reference
Header File
This header file can be included with:
#include "esp_rom_sys.h"
Functions
-
void esp_rom_software_reset_system(void)
Software Reset digital core in... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/internal-unstable.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Inter-Processor Call (IPC) | null | espressif.com | 2016-01-01 | 8a033a13e87db369 | null | null | Inter-Processor Call (IPC) Note IPC stands for an "Inter-Processor Call" and NOT "Inter-Process Communication" as found on other operating systems. Overview Due to the dual core nature of the ESP32, there are some scenarios where a certain callback must be executed from a particular core such as: When allocating... | Inter-Processor Call (IPC)
Note
IPC stands for an "Inter-Processor Call" and NOT "Inter-Process Communication" as found on other operating systems.
Overview
Due to the dual core nature of the ESP32, there are some scenarios where a certain callback must be executed from a particular core such as:
When allocating an ISR... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/ipc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Interrupt Allocation | null | espressif.com | 2016-01-01 | 22aeb31cb7609693 | null | null | Interrupt Allocation Overview The ESP32 has two cores, with 32 interrupts each. Each interrupt has a fixed priority, most (but not all) interrupts are connected to the interrupt matrix. Because there are more interrupt sources than interrupts, sometimes it makes sense to share an interrupt in multiple drivers. The... | Interrupt Allocation
Overview
The ESP32 has two cores, with 32 interrupts each. Each interrupt has a fixed priority, most (but not all) interrupts are connected to the interrupt matrix.
Because there are more interrupt sources than interrupts, sometimes it makes sense to share an interrupt in multiple drivers. The
esp_... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/intr_alloc.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Logging library | null | espressif.com | 2016-01-01 | cd3b355f406f0aa | null | null | Logging library Overview The logging library provides three ways for setting log verbosity: At compile time: in menuconfig, set the verbosity level using the option CONFIG_LOG_DEFAULT_LEVEL. Optionally, also in menuconfig, set the maximum verbosity level using the option CONFIG_LOG_MAXIMUM_LEVEL. By default, this ... | Logging library
Overview
The logging library provides three ways for setting log verbosity:
At compile time: in menuconfig, set the verbosity level using the option CONFIG_LOG_DEFAULT_LEVEL.
Optionally, also in menuconfig, set the maximum verbosity level using the option CONFIG_LOG_MAXIMUM_LEVEL. By default, this is th... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/log.html | ESP-IDF Programming Guide v5.2.1 documentation | null | |||
Miscellaneous System APIs | null | espressif.com | 2016-01-01 | e295f997a061b9c3 | null | null | Miscellaneous System APIs Software Reset To perform software reset of the chip, the esp_restart() function is provided. When the function is called, execution of the program stops, both CPUs are reset, the application is loaded by the bootloader and starts execution again. Additionally, the esp_register_shutdown... | Miscellaneous System APIs
Software Reset
To perform software reset of the chip, the
esp_restart() function is provided. When the function is called, execution of the program stops, both CPUs are reset, the application is loaded by the bootloader and starts execution again.
Additionally, the
esp_register_shutdown_handle... | null | null | null | https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/misc_system_api.html | ESP-IDF Programming Guide v5.2.1 documentation | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.