API Reference

[中文]

• API Conventions
  • Error Handling
  • Configuration Structures
  • Private APIs
  • Components in Example Projects
  • API Stability
• Application Protocols
  • ASIO Port
  • ESP-Modbus
  • ESP-MQTT
  • ESP-TLS
  • ESP HTTP Client
  • ESP Local Control
  • ESP Serial Slave Link
  • ESP x509 Certificate Bundle
  • HTTP Server
  • HTTPS Server
  • ICMP Echo
  • mDNS Service
  • Mbed TLS
  • IP Network Layer
• Bluetooth® API
  • Bluetooth® Common
  • Bluetooth® Low Energy (Bluetooth LE)
  • Controller && VHCI
  • ESP-BLE-MESH
  • NimBLE-based Host APIs
• Error Codes Reference
• Networking APIs
  • Wi-Fi
  • Ethernet
  • Thread
  • ESP-NETIF
  • IP Network Layer
  • Application Layer
• Peripherals API
  • Analog to Digital Converter (ADC) Oneshot Mode Driver
  • Analog to Digital Converter (ADC) Continuous Mode Driver
  • Analog to Digital Converter (ADC) Calibration Driver
  • Clock Tree
  • GPIO & RTC GPIO
  • General Purpose Timer (GPTimer)
  • Dedicated GPIO
  • Hash-Based Message Authentication Code (HMAC)
  • Digital Signature (DS)
  • Inter-Integrated Circuit (I2C)
  • Inter-IC Sound (I2S)
  • LCD
  • LED Control (LEDC)
  • Motor Control Pulse Width Modulator (MCPWM)
  • Pulse Counter (PCNT)
  • Remote Control Transceiver (RMT)
  • SD Pull-up Requirements
  • SDMMC Host Driver
  • SD SPI Host Driver
  • Sigma-Delta Modulation (SDM)
  • SPI Flash API
  • SPI Master Driver
  • SPI Slave Driver
  • SPI Slave Half Duplex
  • Temperature Sensor
  • Capacitive Touch Sensor
  • Two-Wire Automotive Interface (TWAI)
  • Universal Asynchronous Receiver/Transmitter (UART)
  • USB Device Stack
  • USB Host
• Provisioning API
  • Protocol Communication
  • Unified Provisioning
  • Wi-Fi Provisioning
  • SmartConfig
  • Wi-Fi Easy Connect^TM (DPP)
• Storage API
  • FAT Filesystem Support
  • Generating and Parsing FATFS on Host
  • Manufacturing Utility
  • Non-Volatile Storage Library
  • NVS Bootloader
  • NVS Encryption
  • NVS Partition Generator Utility
  • NVS Partition Parser Utility
  • SD/SDIO/MMC Driver
  • Partitions API
  • SPIFFS Filesystem
  • Virtual Filesystem Component
  • Wear Levelling API
  • Storage Security
  • Examples
• System API
  • App Image Format
  • Bootloader Image Format
  • Application Level Tracing
  • Call Function with External Stack
  • Chip Revision
  • Console
  • eFuse Manager
  • Error Code and Helper Functions
  • ESP HTTPS OTA
  • Event Loop Library
  • FreeRTOS Overview
  • FreeRTOS (IDF)
  • FreeRTOS (Supplemental Features)
  • Heap Memory Allocation
  • Memory Management for MMU Supported Memory
  • Memory Synchronization
  • Heap Memory Debugging
  • ESP Timer (High Resolution Timer)
  • Internal and Unstable APIs
  • Inter-Processor Call (IPC)
  • Interrupt Allocation
  • Logging library
  • Miscellaneous System APIs
  • Over The Air Updates (OTA)
  • Performance Monitor
  • Power Management
  • POSIX Support (Including POSIX Threads Support)
  • Random Number Generation
  • Sleep Modes
  • SoC Capabilities
  • System Time
  • Asynchronous Memory Copy
  • ULP Coprocessor Programming
  • ULP RISC-V Coprocessor Programming
  • Watchdogs
• Configuration Options Reference
  • Build type
  • Bootloader config
  • Security features
  • Application manager
  • Boot ROM Behavior
  • Serial flasher config
  • Partition Table
  • Compiler options
  • Component config
  • CONFIG_IDF_EXPERIMENTAL_FEATURES
  • Deprecated options and their replacements

---

Was this page helpful?

• Thank you! We received your feedback.
• If you have any comments, fill in Espressif Documentation Feedback Form.

• We value your feedback.
• Let us know how we can improve this page by filling in Espressif Documentation Feedback Form.