Commit Graph

811 Commits

Author SHA1 Message Date
muhaidong
91a315f7c0 docs: update wifi beacon timeout docs 2022-07-14 15:38:33 +08:00
Linda
5b816c8551 docs:update linker script generation 2022-07-14 10:27:49 +08:00
wangziyan
def63b6ec7 docs: update 404.rst 2022-07-11 16:18:34 +08:00
muhaidong
f9d96d28bf docs: modify some Chinese expressions related to CSI 2022-07-08 14:42:12 +08:00
muhaidong
ef9eaae48c docs:update wifi sci subcarrier index docs 2022-07-08 14:34:46 +08:00
Jiang Jiang Jian
afc6f7f932 Merge branch 'docs/update_wifi_api_doc_v4.4' into 'release/v4.4'
DOC: update wifi api docs ( backport v4.4)

See merge request espressif/esp-idf!18076
2022-07-07 10:57:36 +08:00
Marius Vikhammer
27cd55dca1 docs: fix broken links 2022-07-04 11:05:49 +08:00
Dai Zi Yan
ea13b4ed8b Apply 1 suggestion(s) to 1 file(s) 2022-07-01 17:39:53 +08:00
Marius Vikhammer
db85519413 Apply 2 suggestions by Marius Vikhammer 2022-07-01 17:39:53 +08:00
muhaidong
795c4a4b2a docs: update wifi multiple antennas docs 2022-07-01 17:39:53 +08:00
Jack Farley
15845ff47b DOC:Correct IP_EVENT_STA_LOST_IP name
Fix the name of the IP_EVENT_STA_LOST_IP event (was IP_STA_LOST_IP)

Signed-off-by: xueyunfei <xueyunfei@espressif.com>

Closes https://github.com/espressif/esp-idf/pull/8347
2022-07-01 17:39:53 +08:00
zhangyanjiao
e04b4d9b81 modify API-reference using Sphinx directives 2022-07-01 17:39:53 +08:00
zhangyanjiao
254ec47ae4 update wifi api docs 2022-07-01 17:39:53 +08:00
intern
74d745a80b docs: update cn trans for upl docs 2022-06-29 11:56:59 +08:00
Sudeep Mohanty
886c2d742d docs: Updated ULP documentation
This commit updates documentation for ULP.
2022-06-28 12:09:33 +08:00
Sudeep Mohanty
b72f987c5c ulp: Added ULP RISC-V support for esp32s3
This commit adds support for ULP RISC-V for esp32s3.

Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2022-06-22 13:33:14 +08:00
Adam Múdry
12dfcdd1d9 spiffs: Add esp_spiffs_check() function
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
2022-05-27 21:14:33 +00:00
Fu Hanxi
f16e21aa9d docs(idf.py): add IDF Clang Tidy chapter 2022-05-24 16:08:40 +08:00
mofeifei
91315de70c docs: fix a command in partition-tables 2022-05-07 15:15:22 +08:00
Krzysztof Budzynski
4b2098bc58 Merge branch 'docs/update_cn_trans_jtag_debugging_docs_4.4' into 'release/v4.4'
docs: update jtag_debugging docs and get-started-devkitc.rst (backport v4.4)

See merge request espressif/esp-idf!17493
2022-04-20 16:21:04 +08:00
Krzysztof Budzynski
3d6f7f7fe0 Merge branch 'docs/mr16635_backport_v4.4' into 'release/v4.4'
docs: Update CN translation for !16635, !16702, !17043 (v4.4)

See merge request espressif/esp-idf!17465
2022-04-20 16:20:42 +08:00
intern
cc054605a0 docs: backport jtag_debugging docs 2022-03-15 18:59:21 +08:00
Shang Zhou
e9e77e3598 docs: backport cn translation for mr16635 2022-03-14 11:36:43 +08:00
Shang Zhou
5da4a79b04 docs: backport cn translation for mr16425 2022-03-11 15:25:52 +08:00
Shang Zhou
d7f8526207 docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback 2022-03-03 16:54:18 +08:00
Marius Vikhammer
cdfd59cc0e docs: update copyright date for docs automatically 2022-02-18 12:59:12 +08:00
Zim Kalinowski
118478cd51 Merge branch 'docs/add_an_example_list_for_esp32-wrover-kit_v4.4' into 'release/v4.4'
docs: add an example list for esp-wrover-kit (v4.4)

See merge request espressif/esp-idf!16691
2022-02-16 02:39:04 +00:00
Krzysztof Budzynski
257d95fc22 Merge branch 'docs/pinlayout_image_update_backport_v4.4' into 'release/v4.4'
docs: Update ESP32-DevKitC Pin Layout figure of higher resolution (backport v4.4)

See merge request espressif/esp-idf!16364
2022-01-28 03:22:51 +00:00
Shang Zhou
26a876e63f docs:update ESP32-DevKitC Pin Layout figure of higher resolution 2022-01-27 17:05:01 +08:00
Shang Zhou
3c76a058aa docs: update CN translation for MR15221 for v4.4 2022-01-27 08:27:04 +00:00
Wang Fang
81936fd2b6 docs: add an example list for esp-wrover-kit 2022-01-07 16:47:54 +08:00
Darian Leung
65e9385d0a docs: Update Power Management and Sleep Modes docs for ESP32-S3 2022-01-06 10:14:57 +08:00
Marius Vikhammer
02bf07a1a0 docs: update docs with S3 specific information. 2022-01-06 10:14:54 +08:00
xueyunfei
2e4c95c1ee update s3 doc 2022-01-06 10:09:51 +08:00
Jiang Jiang Jian
7d7f91e1d8 Merge branch 'docs/update_the_pinout_figure_of_esp32_devkitc_v4.4' into 'release/v4.4'
docs: update the module on esp32-devkitc from esp32-wrover to esp32-wroom (v4.4)

See merge request espressif/esp-idf!15963
2021-12-08 10:15:54 +00:00
Lv Xin Yue
c25408a009 docs:update the link to esp32-s3-wroom-1 datasheet 2021-12-02 16:51:23 +08:00
Wang Fang
1d4fda8890 docs: replace the module on esp32-devkitc from esp32-wrover to esp32-wroom 2021-11-15 14:48:54 +01:00
Wei Tian Hua
397e148049 Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32_4.4' into 'release/v4.4'
Doc/make classic bt api ref only for esp32 [backport v4.4]

See merge request espressif/esp-idf!15727
2021-11-08 09:14:24 +00:00
Armando
cc8214c59d doc: add flash and psram configuration doc in programming guide 2021-11-08 04:32:18 +00:00
weitianhua
8153b43705 Make ESP32 Bluetooth stack architecture Doc only visible for ESP32 2021-10-29 14:21:18 +08:00
weitianhua
f4aad85f8b Make Classic BT related document links only visible for ESP32 2021-10-29 14:21:12 +08:00
Alexey Gerenkov
3af4c22f29 Merge branch 'bugfix/oocd_config_file_for_esp32s3' into 'master'
docs/esp32s3: Fixes OpenOCD configuration files names

See merge request espressif/esp-idf!15478
2021-10-19 19:07:54 +00:00
Wang Ning
d1ae534250 Merge branch 'docs/fix_typos_in_esp32-s2-saola-1_user_guide' into 'master'
Docs: Fixed typos in ESP32-S2-Saola-1 user guide

See merge request espressif/esp-idf!15552
2021-10-19 06:06:56 +00:00
Ivan Grokhotkov
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
Wang Ning
c0eaa1d99d docs/fixed_typos_in_esp32-s2-saola-1_user_guide 2021-10-18 16:54:44 +08:00
Shang Zhou
3ffc5f0c67 docs:update CN translation for API reference storage(fatfs and index) 2021-10-15 18:59:22 +08:00
Juraj Sadel
eb86d39136 Merge branch 'feature/xtensa-esp32-elf-clang' into 'master'
tools: LLVM for Xtensa (ESP32-S2) based on clang

See merge request espressif/esp-idf!15094
2021-10-14 06:40:48 +00:00
Marek Fiala
582a39126a Merge branch 'feature/idfpy_dashes_replace' into 'master'
tools: replace _ with - in idf.py

Closes IDFGH-3105

See merge request espressif/esp-idf!14752
2021-10-13 13:14:06 +00:00
Juraj Sadel
1a88d5a736 LLVM for Xtensa (ESP32, ESP32-S2) based on clang 2021-10-13 13:45:56 +02:00
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
chenjianxing
2a09234957 esp_phy: rename esp_phy component prefix 2021-10-13 13:10:49 +08:00
Kevin (Lao Kaiyao)
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
Alexey Gerenkov
6d9fbc3726 docs/esp32s3: Fixes OpenOCD configuration files names 2021-10-11 22:15:31 +03:00
WangShichang
9f37cfc7fc add docs "How to improve Wi-Fi performance" in api-guides for esp32s3. 2021-10-11 15:08:02 +08:00
Jakob Hasse
f86e154a56 Merge branch 'feature/removed_hyphens_from_examples' into 'master'
[examples]: Project names consistent with their directories

Closes IDFGH-3673

See merge request espressif/esp-idf!13570
2021-10-11 03:43:37 +00:00
Jakob Hasse
81e9266204 [examples]: removed hyphens
Replaced hyphens with underscores in examples
project definition for all examples which had
hyphens in their project name. dpp-enrollee is
an exceptions because the name matches the
project directory name while the project
directory also contains hyphens.
2021-10-09 13:58:24 +08:00
laokaiyao
a1cadba191 touch_sensor: apply general check 2021-10-08 11:32:12 +08:00
laokaiyao
fc73e2b7bd doc/touch: update touch sensor doc for S3 2021-10-08 10:39:46 +08:00
suda-morris
aa73e423d4 lcd: initial build of API docs 2021-10-02 14:23:31 +08:00
Darian
23a03a3bdb Merge branch 'docs/update_CN_trans_i2c_ledc' into 'master'
docs:update CN translation for bootloader, partition-tables, i2c, and ledc

See merge request espressif/esp-idf!15118
2021-09-23 18:13:54 +00:00
Wang Ning
5b339fefdc docs/update_esp32-s2_devkit_user_guides 2021-09-22 14:59:06 +08:00
daiziyan
aca4a18c50 docs:update CN translation for bootloader, partition-tables, i2c, and ledc 2021-09-18 19:25:38 +08:00
Wang Ning
769a9fa28f docs/update_two_esp32-c3_devkit_user_guides 2021-09-18 18:46:42 +08:00
Wang Fang
e43df5fce9 Merge branch 'docs/update_devkitc_and_wrover_kit_boards' into 'master'
docs: udpate devkitc and wrover-kit boards

Closes DOC-1241, DOC-1195, and DOC-1927

See merge request espressif/esp-idf!14945
2021-09-15 07:27:55 +00:00
Wang Fang
781d760873 docs: udpate devkitc and wrover-kit boards 2021-09-13 18:58:45 +08:00
Marius Vikhammer
0daa30c02c docs: remove "invisible" unicode character that failed PDF build. 2021-09-13 10:11:08 +08:00
daiziyan
c9e5b02c18 docs: update CN trans for blufi and build-system 2021-09-10 15:09:50 +08:00
Ivan Grokhotkov
19a75177a8 docs: fix syntax errors in only:: blocks 2021-09-07 14:00:53 +08:00
Shang Zhou
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
Darian
c8aab00fdb Merge branch 'feature/usb_host_docs' into 'master'
Add USB Host Library API docs

See merge request espressif/esp-idf!15013
2021-09-02 14:05:08 +00:00
Darian Leung
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
Ivan Grokhotkov
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
Sergei Silnov
8202c12a83 docs: Add component manager documentation 2021-08-30 13:23:23 +02:00
intern
45925c28fd docs: update translation for jtag-debugging/index.rst and power_management.rst 2021-08-26 12:21:19 +08:00
Zim Kalinowski
f65c8249af Merge branch 'feature/esp_docs' into 'master'
docs: update to use esp-docs

Closes IDF-3105

See merge request espressif/esp-idf!13333
2021-08-24 00:56:57 +00:00
Marius Vikhammer
7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
Ivan Grokhotkov
6cf25ce43f Merge branch 'doc/size_opt_vfs' into 'master'
docs: describe code size optimizations possible in VFS component

See merge request espressif/esp-idf!14783
2021-08-23 07:32:14 +00:00
Krzysztof Budzynski
b4bfebaeec Merge branch 'docs/windows_installer_optimize_download' into 'master'
docs: Instructions for Windows download optimization

See merge request espressif/esp-idf!14707
2021-08-23 06:43:08 +00:00
Ivan Grokhotkov
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
Krzysztof Budzynski
6b9cc71931 Merge branch 'docs/update_CN_trans_FatalErrors_UnitTests' into 'master'
update CN translation for fatal-errors and unit-tests

See merge request espressif/esp-idf!14598
2021-08-23 04:07:07 +00:00
Wang Ning
baf8e4694c docs/update_module_flash_size_in_ESP32-S2-DevKitC-1_user_guide 2021-08-19 17:01:58 +08:00
daiziyan
65961ea892 docs: update CN trans for fatal-errors and unit-tests 2021-08-18 19:28:16 +08:00
Juraj Sadel
85f9aa1062 docs: Instructions for Windows download optimization 2021-08-16 12:32:21 +02:00
daiziyan
c399251eda docs: update CN trans for flash-encryption 2021-08-16 16:46:04 +08:00
Pedro Minatel
d4bd603745 Merge branch 'docs/frameworks_and_libs_update' into 'master'
Docs Frameworks and libraries update

See merge request espressif/esp-idf!14284
2021-08-12 10:25:22 +00:00
pedro.minatel
1e14b495b8 Added libraries and frameworks to the docs reference
Added libs-frameworks file for Espressifs libraries and frameworks
Added file on zh_CH
Added description about ESP-MESH
Changes according to the MR revision
Fix on the CSI description
Suggestions applied according to the MR review
2021-08-12 09:21:58 +01:00
Nachiket Kukade
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
Wang Fang
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
Wang Fang
0ba73ee7e2 docs: provide APB clock frequency in api-reference/timers 2021-08-06 11:05:32 +08:00
Shu Chen
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
Jiacheng Guo
ba5b7ddded docs: add OpenThread docs 2021-08-02 17:17:38 +08:00
Armando (Dou Yiwen)
0dad76329f Merge branch 'feature/support_noinit_section_in_psram_on_esp32' into 'master'
memory: support noinit section in psram on esp32

Closes IDFGH-2621

See merge request espressif/esp-idf!14088
2021-07-31 09:58:59 +00:00
Armando
e0acefbb78 docs: add docs to .bss and .noinit segments on spiram 2021-07-31 11:02:13 +08:00
Wang Ning
baebf74342 docs/add_esp32-s2-devkitc-1_user_guide 2021-07-30 14:00:45 +08:00
Wang Fang
8a6fa2f86c Merge branch 'docs/add_a_note_and_module_variants_to_esp32-devkitm-1_pico-devkitm-02u' into 'master'
Add a note to ESP32-DevKitM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally

Closes DOC-1620, DOC-1741, and DOC-1774

See merge request espressif/esp-idf!14479
2021-07-30 03:23:08 +00:00
Wang Fang
03669abead Add a note to ESP32-DevKtiM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
2021-07-29 18:44:30 +08:00
Michael (XIAO Xufeng)
18bee2380a Merge branch 'refactor/usb_device_driver' into 'master'
tiny_usb: support on esp32-s3

Closes IDF-3234

See merge request espressif/esp-idf!14293
2021-07-26 16:21:55 +00:00
daiziyan
ce916db7ed docs: update all documents in get started section and keep line number consistent 2021-07-22 15:54:47 +08:00
morris
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
Cao Sen Miao
69ad24c943 temp_sensor: add docs for esp32c3 2021-07-21 13:34:52 +08:00