4ae714c43c
docs: update using usb_serial_jtag documents
2021-11-23 14:12:13 +08:00
b6a06b7533
docs: remove invalid symbol from ota.rst file
2021-11-18 11:37:09 +08:00
0ff2776b1e
docs: update CN translation for ota.rst and console.rst
2021-11-16 19:23:09 +08:00
9c1d4f5b54
Build & config: Remove the "make" build system
...
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
497eaca1a3
Make ESP32 Bluetooth stack architecture Doc only visible for ESP32
2021-10-27 20:47:50 +08:00
64aa94d823
Make Classic BT related document links only visible for ESP32
2021-10-27 15:28:47 +08:00
c77950e9fe
Merge branch 'doc/api_stability' into 'master'
...
docs: add a section about API conventions and stability
Closes IDFGH-2658
See merge request espressif/esp-idf!14449
2021-10-18 14:19:12 +00:00
3ffc5f0c67
docs:update CN translation for API reference storage(fatfs and index)
2021-10-15 18:59:22 +08:00
ff18a96f7d
tools: replace _ with - in idf.py
...
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
a9faafee3c
Merge branch 'feature/touch_sensor_driver_support_for_esp32s3' into 'master'
...
driver(touch): support touch sensor for esp32s3 platform
Closes IDF-1784 and IDF-3302
See merge request espressif/esp-idf!14102
2021-10-12 05:50:58 +00:00
a1cadba191
touch_sensor: apply general check
2021-10-08 11:32:12 +08:00
fc73e2b7bd
doc/touch: update touch sensor doc for S3
2021-10-08 10:39:46 +08:00
aa73e423d4
lcd: initial build of API docs
2021-10-02 14:23:31 +08:00
aca4a18c50
docs:update CN translation for bootloader, partition-tables, i2c, and ledc
2021-09-18 19:25:38 +08:00
19a75177a8
docs: fix syntax errors in only:: blocks
2021-09-07 14:00:53 +08:00
be189b1cfd
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title
2021-09-03 16:27:14 +08:00
963836f491
Add USB Host Library API docs
...
- This commit adds the API documentation for the USB Host Library.
- Warnings about the beta API are also added.
- usb_host_misc.h renamed to usb_helpers.h
2021-09-02 18:40:24 +08:00
c8640d38a7
docs: add a section about API conventions and stability
...
Closes https://github.com/espressif/esp-idf/issues/4732
2021-08-31 14:41:48 +02:00
45925c28fd
docs: update translation for jtag-debugging/index.rst and power_management.rst
2021-08-26 12:21:19 +08:00
a005e9bfbc
docs: move VFS documentation into the component directory
...
These files were added into the component directory back when we
didn't have the documentation directory, and weren't moved once the
documentation directory was created.
2021-08-23 07:02:19 +02:00
f38b18f046
docs: Separate Doc on WiFi security, added DPP Doc
...
1. Add new Doc on WiFi security
2. Add DPP related Doc under WiFi
3. Add Supplicant public headers in Doxyfile
2021-08-10 12:35:43 +05:30
59aa60d52a
Merge branch 'docs/provide_apb_clock_frequency_in_api-reference_timers' into 'master'
...
docs: provide APB clock frequency in api-reference/timers
Closes DOC-1689
See merge request espressif/esp-idf!14593
2021-08-06 06:50:26 +00:00
0ba73ee7e2
docs: provide APB clock frequency in api-reference/timers
2021-08-06 11:05:32 +08:00
ee6b1736c6
Merge branch 'feature/add-openthread-docs' into 'master'
...
docs: add OpenThread docs
See merge request espressif/esp-idf!14488
2021-08-05 03:56:43 +00:00
ba5b7ddded
docs: add OpenThread docs
2021-08-02 17:17:38 +08:00
2218204aa7
doc: update tinyusb document to support esp32s3
...
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
2021-07-22 10:43:10 +08:00
69ad24c943
temp_sensor: add docs for esp32c3
2021-07-21 13:34:52 +08:00
a68fd59b02
Merge branch 'docs/rename_ESP-MESH_to_ESP-WIFI-MESH' into 'master'
...
docs: rename ESP-MESH to ESP-WIFI-MESH
Closes DOC-7
See merge request espressif/esp-idf!14252
2021-07-13 02:23:43 +00:00
e95893bb1b
docs: rename ESP-MESH to ESP-WIFI-MESH
2021-07-12 19:25:18 +08:00
fecf27e54c
spi_flash: add support for 32Mbit address GD flash, for GD25Q256
2021-07-02 17:13:51 +08:00
5e5ddb1ffb
docs:fixthe number of general purpose timers for ESP32-C3
2021-06-29 14:33:06 +08:00
e1ad9a1d20
docs:update CN translation for fatal-errors, external-ram, and idf-monitor
2021-06-21 18:05:18 +08:00
2c31ac24c1
docs/add_how_to_debug_ota_failure_to_api_references
2021-06-16 19:28:01 +08:00
228fc04646
Merge branch 'example/ledc_pwm_basic' into 'master'
...
Example: Added LEDC basic PWM example
Closes DO-70
See merge request espressif/esp-idf!13114
2021-06-15 11:12:46 +00:00
bdfda351bd
build docs: enable building of S3 docs
...
* Added suport for building esp32s3 docs
* Fixed all related warnings
* Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00
71141a326d
docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc
2021-05-24 03:46:40 +00:00
e14edecf5f
docs: Add random number generation to the API Reference System section
2021-05-18 16:05:42 +10:00
b7ad39f694
Merge branch 'bugfix/pthread_docs' into 'master'
...
Fix and improve pthread docs, create pthread example
Closes IDF-731 and IDFGH-5085
See merge request espressif/esp-idf!13314
2021-05-14 01:19:02 +00:00
e6d15a0975
docs: Rename esp_pthread docs to pthread, expand details of supported APIs
...
- Move the code that was in the document out to an example
2021-05-14 10:03:11 +10:00
fd477fa60e
docs: remove front page C3 docs not updated warning
2021-05-13 09:58:20 +08:00
a6798eac98
Added LEDC basic PWM example
...
Changes on the ledc_init function
Review on the README, docs and example functions
Added how to set freq and duty on README
Fix on the ledc.rst docs in the App Example
Added new example reference in the Chinese docs
2021-04-28 11:11:07 +01:00
26585b4b4b
esp_flash: support override default chip driver list
2021-04-26 16:05:42 +08:00
4aa52da0c1
update CN translation for I2C
2021-04-22 16:05:01 +08:00
75dfd970b4
dac: added DAC support macro
...
Remove DAC support on ESP32-S3
2021-04-12 12:04:46 +08:00
cb7de3659a
Merge branch 'bugfix/fix_timergroup_doc_unparsed_variable' into 'master'
...
doc: fix uninterpreted variables in timer.rst
Closes IDF-3064
See merge request espressif/esp-idf!13047
2021-04-12 00:38:53 +00:00
cef3b26a91
Merge branch 'refactor/move_from_esp_system' into 'master'
...
Movements from esp_system
Closes IDF-2165
See merge request espressif/esp-idf!12695
2021-04-08 10:16:08 +00:00
925dacd7fb
Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master'
...
spi: remove HSPI macros on esp32c3 and esp32s3
Closes IDF-2535
See merge request espressif/esp-idf!12637
2021-04-08 09:33:18 +00:00
c112bd8b57
esp_system: move intr_alloc
2021-04-07 17:53:37 +08:00
4980a764fe
doc: fix uninterpreted variables in timer.rst
2021-04-07 13:49:57 +08:00
9b9ea71ff9
spi: remove HSPI macro on esp32c3 and esp32s3
2021-04-06 13:42:49 +08:00
540e9c57e4
docs:update CN translation for spiffs and touch_pad
2021-03-31 20:08:22 +08:00
78090d24e4
Merge branch 'bugfix/flash_suspend_restriction' into 'master'
...
spi_flash: make suspend off by default and add more information for using suspend
See merge request espressif/esp-idf!12812
2021-03-29 04:47:34 +00:00
d25d3789e9
Merge branch 'doc/update_dead_url_links_to_iot_solution_repo' into 'master'
...
fix dead links directed to ESP-IoT-Solution repo
Closes DOC-1101 and IDFCI-472
See merge request espressif/esp-idf!12535
2021-03-26 14:23:06 +00:00
c140e8b547
Merge branch 'doc/update_openssl_docs' into 'master'
...
docs: Migrated OpenSSL APIs from components/openssl/* to the API reference
Closes IDF-2541
See merge request espressif/esp-idf!12515
2021-03-26 11:49:57 +00:00
80da446be7
fix dead links directed to iot solution repo
...
resolve confilcts
modify a board name
rebase master
fix ota example link in readme
2021-03-26 15:19:10 +08:00
c54ea54d98
spi_flash: make suspend off by default and add more information for using suspend
2021-03-26 13:57:14 +08:00
1953af4fb2
Merge branch 'doc/c3_system_api' into 'master'
...
docs: update system api reference chapters for C3
Closes IDF-2327 and IDF-2320
See merge request espressif/esp-idf!12730
2021-03-24 10:28:19 +00:00
8ae944e26c
docs:update CN translation for documenting-code and LEDC
2021-03-23 10:52:50 +08:00
cc78923d23
docs: Update OpenSSL API documents
...
Closes IDF-2541
2021-03-18 10:42:29 +04:00
fe70d18bb5
doc: update doc of general purpose timer
2021-03-16 17:56:37 +08:00
91439e3818
docs: updated system api-reference chapters for C3
2021-03-15 18:51:12 +08:00
b7155a161b
otatool: Fixes read_ota_partition cmd, required output arg
...
Closes: https://github.com/espressif/esp-idf/issues/6559
2021-03-04 06:02:54 +00:00
6334b5e56f
docs: update api-reference chapters for C3
...
Checked and updated the following chapters:
* api-reference/network
* api-reference/protocols
* api-reference/provisioning
* api-reference/storage
* api-reference/peripherals/ds
* api-reference/peripherals/hmac
* api-reference/peripherals/secure_element
2021-03-01 14:58:08 +08:00
268289eade
Merge branch 'docs/spi_flash_auto_suspend' into 'master'
...
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND
See merge request espressif/esp-idf!12290
2021-02-25 09:16:10 +00:00
84b33b9dba
Merge branch 'feature/update_efuse_doc' into 'master'
...
doc/efuse: Adds efuse doc for ESP32-C3
Closes IDF-2328
See merge request espressif/esp-idf!12365
2021-02-24 22:30:18 +00:00
476fdcba68
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND
2021-02-24 20:20:18 +08:00
5a5f5ad031
doc/efuse: Adds efuse doc for ESP32-C3
2021-02-22 15:51:45 +08:00
78a1cd3643
touch_element: add touch element api-reference doc
2021-02-22 12:16:49 +08:00
916f02164e
[doc]: NVS documentation updates
...
* Move nvs flash README to common doc directory
* correct markup of functions and types in text
from old README
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* Used target instead of hard code ESP32
* Note that strings can only span one page
* Reflect that item types have been moved
* Some clarification about nvs_commit()
* Improved reference to the ESP Partition API
* fixed little mistake in documenting-code.rst
* Change of nvs_open_from_part() to
nvs_open_from_partition() reflected in docs
* Corrected documentation of
NVSHandle::get_string(), NVSHandle::get_blob()
and NVSHandle::get_item_size().
* Closes DOC-165
* Closes IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
2021-02-08 09:31:23 +08:00
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
3d2d0e2247
update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides
2021-01-28 19:42:54 +08:00
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
1be923acb4
rmt: rename always_on to aware_dfs
2020-11-05 19:00:55 +08:00
79887fdc6c
soc: descriptive part occupy whole component
2020-10-28 07:21:29 +08:00
91cf7cc58d
doc: dedicated gpio api reference
2020-10-20 21:06:10 +08:00
840efc2f54
docs: describe power management logic for ESP32-S2, fix translation
2020-10-14 09:05:10 +02:00
e0261f18ce
Merge branch 'feature/add_esp_rom_printf_to_api_reference' into 'master'
...
docs: Add esp_rom_printf to API Reference
Closes DOC-454
See merge request espressif/esp-idf!10251
2020-10-09 04:06:10 +08:00
2e826b7a8f
intr_alloc: split interrupt allocator into common-code and platform-code
...
esp_system: removed repeated interrupt allocator code and moved common code to esp_system
xtens: moved xtensa specific code from freertos to the xtensa component
hal/interrupt_controller: added interrupt controller hal and ll files
docs: update the doxyfile with new location of esp_itr_alloc.h file
xtensa: fixed dangerous relocation problem after moving xtensa interrupt files out of freertos
docs: removed Xtensa reference from intr_allocator api-reference
xtensa: pushed the interrupt function that manages non iram interrupts to the xtensa layer
esp_system/test: fixed platform dependent setting for intr_allocator tests
hal: rename the functions used to manage non iram interrupt mask.
2020-09-30 07:44:12 +08:00
db0c6d7921
docs: Add esp_rom_printf to API Reference
2020-09-10 22:55:43 +08:00
c863b4c777
docs: tinyusb documentation
2020-08-27 13:49:33 +02:00
7bc6662184
Add Chinese translation to I2C.rst
2020-08-26 22:08:50 +08:00
b30bd7a2ef
esp32s2: add CP_DMA driver
2020-08-04 15:28:32 +08:00
938a73756c
esp_common/shared_stack: modifed the stack switch procedure to a simpler way
...
esp_common/shared_stack: refactored the implemenation of shared stack function (still not working properly)
esp_expression_with_stack: refactored the shared stack function calling mechanism and updated the documentation
2020-07-14 12:56:02 +00:00
6673407f98
httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible
2020-07-13 05:34:56 +00:00
f6dd63d03d
spi_slave_hd: new driver for spi slave in half duplex mode
2020-07-11 00:00:50 +08:00
29f8aecfc0
console_repl: change config structure to support different devices
2020-07-02 07:39:46 +00:00
97721d469c
TWAI: Add ESP32-S2 support
...
This commit adds TWAI driver support for the
ESP32-S2. The following features were added:
- Expanded BRP support
- Expanded CLKOUT Divider Support
- Updated example READMEs
2020-06-30 16:56:03 +08:00
516680a4ff
Doc: DS documentation for S2
2020-06-04 10:49:22 +08:00
56635f22b8
Merge branch 'doc/add_types_api_ref' into 'master'
...
doc: add peripheral_types.h as API reference for peripheral docs
Closes DOC-136 and IDF-1673
See merge request espressif/esp-idf!8528
2020-05-25 03:22:22 +08:00
423e600d46
secure_element: atecc608_ecdsa example
...
* Replaced crypotoauthlib with esp-cryptoauthlib
* Added menuconfig option for esp-tls about using HSM
* Added error codes for HSM in esp-tls,
* Added support to select different type of ATECC608A chips
* Added README, updated docs
* tcp_transport: Added option to enable secure_element for ssl
Closes https://github.com/espressif/esp-idf/issues/4432
2020-05-21 13:08:30 +05:30
7099c2b444
Merge branch 'doc/generate_idf_project_tags' into 'master'
...
doc: add generation of tags from sdkconfig and x_caps.h headers
Closes IDF-1484
See merge request espressif/esp-idf!8577
2020-05-20 23:46:47 +08:00
e58c0ac3e7
Provide a brief description of SmartConfig and add link to example
2020-05-18 01:02:04 +08:00
fbb54184ef
doc: add generation of tags from sdkconfig and x_caps.h headers
...
Also updates the way we handle exclude_patterns to use the new tags
Closes IDF-1484
2020-05-13 07:09:01 +00:00
27fa1dc0dd
doc: add peripheral_types.h as API reference for peripheral docs
...
Closes DOC-136
Closes IDF-1673
2020-05-11 11:20:39 +08:00
c5c026557e
Merge branch 'doc/hmac_S2' into 'master'
...
Doc: Documentation for HMAC module
See merge request espressif/esp-idf!8383
2020-04-27 19:03:01 +08:00
2da7e65646
Doc: S2 HMAC documentation
2020-04-27 12:25:46 +08:00
7ec4d64b80
spi: Update documents about the bus lock and how to use SPI Master on SPI1 bus
2020-04-23 12:27:25 +08:00
6d3f35f651
Fix a typo error based on DOC-111
2020-04-15 09:08:43 +00:00
9759aa4ad2
Fixed syntax error in esp_http_server.rst
...
Merges: https://github.com/espressif/esp-idf/pull/5021
2020-03-31 14:59:27 +00:00
3784d499af
Add translation for ota tool and partation tool
2020-03-25 21:44:33 +08:00
Cao Sen Miao