mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-11-03 00:21:44 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			78 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			78 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
ESP-IDF Programming Guide
 | 
						|
=========================
 | 
						|
:link_to_translation:`zh_CN:[中文]`
 | 
						|
 | 
						|
.. only:: fast_build
 | 
						|
 | 
						|
    .. warning::
 | 
						|
 | 
						|
        The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
 | 
						|
 | 
						|
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
 | 
						|
 | 
						|
.. only:: html
 | 
						|
 | 
						|
    This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, choose target from the dropdown in the upper left.
 | 
						|
 | 
						|
.. only:: latex
 | 
						|
 | 
						|
    This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC.
 | 
						|
 | 
						|
.. only:: esp32s3
 | 
						|
 | 
						|
    .. warning::
 | 
						|
 | 
						|
        Not all documents are updated for ESP32-S3 yet.
 | 
						|
 | 
						|
==================  ==================  ==================
 | 
						|
|Get Started|_      |API Reference|_    |H/W Reference|_
 | 
						|
------------------  ------------------  ------------------
 | 
						|
`Get Started`_      `API Reference`_    `H/W Reference`_
 | 
						|
------------------  ------------------  ------------------
 | 
						|
|API Guides|_       |Contribute|_       |Resources|_
 | 
						|
------------------  ------------------  ------------------
 | 
						|
`API Guides`_       `Contribute`_       `Resources`_
 | 
						|
==================  ==================  ==================
 | 
						|
 | 
						|
.. |Get Started| image:: ../_static/get-started.png
 | 
						|
.. _Get Started: get-started/index.html
 | 
						|
 | 
						|
.. |API Reference| image:: ../_static/api-reference.png
 | 
						|
.. _API Reference: api-reference/index.html
 | 
						|
 | 
						|
.. |H/W Reference| image:: ../_static/hw-reference.png
 | 
						|
.. _H/W Reference: hw-reference/index.html
 | 
						|
 | 
						|
.. |API Guides| image:: ../_static/api-guides.png
 | 
						|
.. _API Guides: api-guides/index.html
 | 
						|
 | 
						|
.. _Libraries and Frameworks: libraries-and-frameworks/index.html
 | 
						|
 | 
						|
.. |Contribute| image:: ../_static/contribute.png
 | 
						|
.. _Contribute: contribute/index.html
 | 
						|
 | 
						|
.. |Resources| image:: ../_static/resources.png
 | 
						|
.. _Resources: resources.html
 | 
						|
 | 
						|
 | 
						|
.. toctree::
 | 
						|
   :hidden:
 | 
						|
 | 
						|
   Get Started <get-started/index>
 | 
						|
   API Reference <api-reference/index>
 | 
						|
   H/W Reference <hw-reference/index>
 | 
						|
   API Guides <api-guides/index>
 | 
						|
   ESP-IDF 5.0 Migration Guides <migration-guides/index>
 | 
						|
   Libraries and Frameworks <libraries-and-frameworks/index>
 | 
						|
   Contribute <contribute/index>
 | 
						|
   Versions <versions>
 | 
						|
   Resources <resources>
 | 
						|
   Copyrights <COPYRIGHT>
 | 
						|
   About <about>
 | 
						|
   语言/Languages <languages>
 | 
						|
 | 
						|
* :ref:`genindex`
 | 
						|
 | 
						|
 | 
						|
 |