alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-21 06:56:11 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
27,085 Commits 19 Branches 147 Tags 378 MiB
5822cdf93b
Commit Graph

1177 Commits

Author SHA1 Message Date
xueyunfei
26fa8260b1 Doc:update wifi api docs 
* Add documents related to espnow config rate

* Optimization set dns server api description
 2022-04-24 21:20:54 +08:00
daiziyan
406f5c6b78 docs: fix the format for DPP 2022-04-24 21:20:54 +08:00
Marius Vikhammer
45c1d1cba2 Merge branch 'feature/move_target_kconfig_2' into 'master' 
system: move kconfig options out of target component

See merge request espressif/esp-idf!17321
 2022-04-24 13:29:43 +08:00
Djordje Nedic
181618ab70 docs: Move the documentation about idf.py out from the build system documentation 
This moves all the documentation relating to using idf.py out of the build system documentation in order to declutter and more logically group the documentation.
It is now present in the tools page under IDF Frontend - idf.py.
Additionally there has been lots of rewriting and some minor fixes on the way.
 2022-04-22 17:38:04 +02:00
Ivan Grokhotkov
1be9b4ab2e
docs: note that choice of IDF version may depend on downstream project 
As in the case with esp-iot-solution here:
https://github.com/espressif/esp-idf/issues/8763

Signed-off-by: Ivan Grokhotkov <ivan@espressif.com>
 2022-04-21 13:35:35 +02:00
Marius Vikhammer
d2872095f9 soc: moved kconfig options out of the target component. 
Moved the following kconfig options out of the target component:
 * CONFIG_ESP*_DEFAULT_CPU_FREQ* -> esp_system
 * ESP*_REV_MIN -> esp_hw_support
 * ESP*_TIME_SYSCALL -> newlib
 * ESP*_RTC_* -> esp_hw_support

Where applicable these target specific konfig names were merged into
a single common config, e.g;
CONFIG_ESP*_DEFAULT_CPU_FREQ -> CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ
 2022-04-21 12:09:43 +08:00
mofeifei
3a35ed7cfa docs:change system.rst name 2022-04-20 13:11:02 +08:00
mofeifei
485cdd9a74 docs: add cn trans for system.rst 2022-04-20 13:07:38 +08:00
Armando (Dou Yiwen)
5bb59b00e7 Merge branch 'feature/support_bss_on_psram' into 'master' 
psram: support .bss on psram on esp32s3

Closes IDF-4814, IDF-4396, IDFGH-7148, and IDFGH-7153

See merge request espressif/esp-idf!17557
 2022-04-20 11:16:28 +08:00
Armando
b5de3ec953 esp_common: rename EXT_RAM_ATTR to EXT_RAM_BSS_ATTR to make it clearer 
EXT_RAM_ATTR is deprecated. To put .bss on PSRAM, use this new macro EXT_RAM_BSS_ATTR
 2022-04-19 19:48:00 +08:00
songruojing
534346f4bb ledc: Provide support for esp32c2 and esp32h2 
LEDC examples, unit test, and programming guide are all updated.
 2022-04-14 08:15:14 +00:00
Wang Fang
91a82c352c Merge branch 'docs/update_documents_in_hw_reference' into 'master' 
Docs: Update Hardware-Related Documents

Closes DOC-2696, DOC-2911, DOC-2877, DOC-2920, and DOC-2627

See merge request espressif/esp-idf!17712
 2022-04-14 11:19:46 +08:00
Wang Fang
e1ce61ea91 docs: updated hardware-related documents 2022-04-14 11:08:13 +08:00
mofeifei
6b2d551ecc docs: add cn trans for sleep-modes 2022-04-13 10:37:59 +00:00
Martin Vychodil
3b3bfc1971 Merge branch 'vfs_fat/improve_mount_function_names' into 'master' 
vfs: renamed FATFS convenience mounting functions

Closes IDF-4370

See merge request espressif/esp-idf!17369
 2022-04-13 17:52:10 +08:00
mofeifei
4bd411d254 docs: update app trace cn trans 2022-04-12 03:17:12 +00:00
Matus Fabo
24268d47a2 change: renamed FATFS convenience mounting functions 
change: renamed every instance of these functions
add: deprecation notice with old functions
change: CC0 licence to CC0-1.0 in fatfsgen_example_main.c
 2022-04-11 08:44:40 +00:00
wangmengyang
0760a969a8 component/docs: enable generation of API-reference documents for Bluetooth HID device 2022-04-11 02:50:50 +00:00
Adam Múdry
36db6a6681 spiffs: Add esp_spiffs_check() function 
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
 2022-04-08 19:40:56 +00:00
morris
32464d2fcb Merge branch 'docs/update_api-guides' into 'master' 
docs: updated CN trans for fatal-errors and unit-tests

Closes DOC-2773

See merge request espressif/esp-idf!17505
 2022-04-08 16:30:17 +08:00
Dai Zi Yan
3bcef014b9 docs: updated CN trans for fatal-errors and unit-tests 2022-04-08 16:30:16 +08:00
morris
df18bc03c9 Merge branch 'docs/update_CN_trans_api-guides' into 'master' 
docs: updated CN trans for linker-script-generation and external-ram

Closes DOC-2803

See merge request espressif/esp-idf!17510
 2022-04-07 11:15:16 +08:00
Dai Zi Yan
0896e19840 docs: updated CN trans for linker-script-generation and external-ram 2022-04-07 11:15:16 +08:00
Anton Maklakov
a2c8a676a0 Merge branch 'bugfix/explicit_use_bsd_string_in_linux_target' into 'master' 
docs, spi_flash: explicit use bsd string in linux target

Closes IDF-3267

See merge request espressif/esp-idf!17635
 2022-04-06 14:00:36 +08:00
Marius Vikhammer
36b83fcb98 Merge branch 'docs/cpp_function_ref_fixes' into 'master' 
docs: fix broken references to misc API functions and types.

Closes IDF-3184 and DOC-2806

See merge request espressif/esp-idf!17569
 2022-03-31 16:22:23 +08:00
Anton Maklakov
5213ec8b33 docs: add libbsd-dev to linux host requirements list 2022-03-29 13:59:53 +07:00
mofeifei
57ac6d4673 docs: update s3-devkitc-1 user guide 2022-03-29 11:24:20 +08:00
Marius Vikhammer
a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Dmitry
1ee7953ebe app_trace: add support for UART to the app trace module. 
Add support for UART to the SystemView.
 2022-03-23 17:51:14 +03:00
Laukik Hase
660134b1a3
docs: Add documentation for mbedtls 2022-03-16 17:22:33 +05:30
intern
9a28504eea docs:update cn trans for jtag-debugging 2022-03-15 02:40:36 +00:00
Krzysztof Budzynski
b485e96714 Merge branch 'bugfix/update_lose_ip_docs' into 'master' 
DOC:Correct IP_EVENT_STA_LOST_IP name

Closes IDFGH-6718

See merge request espressif/esp-idf!17449
 2022-03-14 12:46:35 +08:00
Martin Gaňo
fea2b5b64e fatfsgen.py: enabled long names support 
Closes https://github.com/espressif/esp-idf/issues/8171
 2022-03-11 11:20:31 +01:00
Jack Farley
1273353f70 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-03-10 17:54:40 +08:00
Shang Zhou
83fcf44e65 docs: provide CN translation for MR17066 2022-03-10 08:26:12 +01:00
David Cermak
795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 2022-03-10 08:19:43 +01:00
Krzysztof Budzynski
6249b3d671 Merge branch 'bugfix/vscode_docs' into 'master' 
docs: Update vscode-setup.rst, merges https://github.com/espressif/esp-idf/pull/8437

Closes IDFGH-6810

See merge request espressif/esp-idf!17269
 2022-03-10 12:37:38 +08:00
Dai Zi Yan
1462367eeb Merge branch 'docs/translate_coexist' into 'master' 
docs/ translate coexist

Closes DOC-2479

See merge request espressif/esp-idf!16830
 2022-03-10 10:59:18 +08:00
Jiang Jiang Jian
7c7e8a83b9 Merge branch 'refactor/wifi_remove_legacy_evts' into 'master' 
Remove legacy system event framework.

Closes IDF-3608

See merge request espressif/esp-idf!16240
 2022-03-10 10:30:10 +08:00
Simon
fb4ee8e31f Merge branch 'feature/support_hpm_on_flash' into 'master' 
spi_flash: Building a framework to enable HPM when flash works under high speed mode, take GD as an example.

Closes IDF-4537

See merge request espressif/esp-idf!16660
 2022-03-10 03:04:21 +08:00
morris
b841332aa5 Merge branch 'component/esp_websocket_migration' into 'master' 
websocket: Remove internal component, examples and test

Closes IDF-4076

See merge request espressif/esp-idf!17273
 2022-03-09 19:12:55 +08:00
Cao Sen Miao
a0bd06af54 spi_flash: Add documents for flash optional features 2022-03-09 18:49:34 +08:00
Sagar Bijwe
6501eff7f5 Remove legacy system event framework. 2022-03-09 15:53:45 +05:30
daiziyan
9f4de1c9a5 docs: update CN translation for vscode-setup 2022-03-09 17:04:16 +08:00
intern
e43bf8510b docs: update readme and power management cn trans 2022-03-09 14:22:36 +08:00
xiongweichao
6514f9e94c docs: translate coexist from CN to EN 2022-03-09 02:50:00 +00:00
Fu Hanxi
6ddd6e6d29 Merge branch 'docs/pytest_in_idf' into 'master' 
docs: add README about pytest in IDF

See merge request espressif/esp-idf!17250
 2022-03-07 15:34:28 +08:00
gabsuren
f3c7215565 websocket: Remove internal component, examples and test 2022-03-07 11:07:40 +04:00
Anton Maklakov
97c830aedf docs: fix mention of python version 2022-03-04 11:03:19 +07:00
Sudeep Mohanty
bc82613847 Merge branch 'docs/ulp_documentation_updates' into 'master' 
docs: Updated ULP documentation

Closes IDF-3306

See merge request espressif/esp-idf!17225
 2022-03-03 19:16:27 +08:00
Shang Zhou
dc8ec7904c Merge branch 'docs/add_note_for_malloc_cap_dma' into 'master' 
docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback

Closes DOC-2476

See merge request espressif/esp-idf!16751
 2022-03-03 16:32:16 +08:00
Fu Hanxi
5ccb5eeebd docs: add README about pytest in IDF 2022-03-03 14:36:50 +08:00
Mahavir Jain
035d7df1a0 Merge branch 'feature/mbedtls-3.1' into 'master' 
Update to mbedtls-3.1

Closes IDF-3723

See merge request espressif/esp-idf!16656
 2022-03-03 11:27:48 +08:00
Marius Vikhammer
29db173536 Merge branch 'feature/move_target_kconfig' into 'master' 
system: move kconfig options out of target component

See merge request espressif/esp-idf!16893
 2022-03-03 09:39:54 +08:00
Laukik Hase
d61c51058d docs: Added migration guide for mbedTLS-3.1.0 
- Removed references to deprecated options
 2022-03-03 01:37:10 +05:30
intern
6151cc8b68 docs: update cn trans for upl docs 2022-03-02 19:03:20 +08:00
Shang Zhou
4d9db3382e docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback 2022-03-02 16:57:21 +08:00
Omar Chebib
2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
Marius Vikhammer
bb88338118 system: move kconfig options out of target component 
Moved the following kconfig options out of the target component:
 * ESP32_X_BROWNOUT_* -> esp_system
 * ESP32_X_DEBUG_OCDAWARE -> esp_system
 * APP_NO_BLOBS -> build type (main kconfig)
 2022-03-02 01:22:26 +00:00
Sudeep Mohanty
4067bc40fc docs: Updated ULP documentation 
This commit updates documentation for ULP.
 2022-03-01 09:02:41 +05:30
Mo Fei Fei
5b1e9fc710 Merge branch 'docs/update_pico_kit_user_guide' into 'master' 
Docs: Add pin header version information in ESP32-PICO-KIT user guide

Closes DOC-2765

See merge request espressif/esp-idf!17290
 2022-03-01 11:06:54 +08:00
Roland Dobai
7936a04c3e Tools: Make target-specific installation clearer in the getting started guide 
Closes https://github.com/espressif/esp-idf/issues/8254
 2022-02-28 17:18:23 +01:00
intern
e2274f31ee docs:add pin header version information 2022-02-28 17:05:30 +08:00
Dai Zi Yan
7c8c7e8b83 Merge branch 'docs/updated_CN_Trans_api-guides' into 'master' 
Docs/updated CN trans for api-guides

See merge request espressif/esp-idf!17224
 2022-02-28 16:00:37 +08:00
Kevin (Lao Kaiyao)
cc1d89ebba Merge branch 'feature/i2c_support_on_esp8684_esp32h2' into 'master' 
i2c: support i2c on esp32c2 and esp32h2

Closes IDF-3918

See merge request espressif/esp-idf!16444
 2022-02-28 13:59:02 +08:00
daiziyan
6b8420e877 docs: updated CN translation for using-debugger, windows-setup, resources and index 2022-02-25 10:44:22 +00:00
intern
4cfe6cfb4d docs: update esp wrover kit user guide 2022-02-24 15:14:38 +08:00
David Cermak
0630834bc3 openssl: Remove deprecated component 2022-02-23 13:08:12 +01:00
laokaiyao
cf353c505a i2c: support esp32h2 2022-02-23 15:19:37 +08:00
Shang Zhou
33a00cf197 docs: Updated CN translation for index files in api-guides and api-reference 2022-02-23 14:48:26 +08:00
Sudeep Mohanty
f163ab26a9 Merge branch 'feature/ulp_fsm_support_on_esp32s3' into 'master' 
ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2

See merge request espressif/esp-idf!17197
 2022-02-23 02:20:39 +00:00
Sudeep Mohanty
4d8a0cce29 ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2 
This commit enables ULP FSM support for esp32s3 and updates ULP FSM code
flow for other chips.
It adds C Macro support for the ULP FSM instruction set on esp32s2 and
esp32s3.
The unit tests are also updated to test ULP FSM on ep32s2 and esp32s3.
 2022-02-22 12:25:57 +05:30
Adam Múdry
bb8587a139 fatfs: Update to version 0.14b 
Updated FATFS to 0.14b from 0.13c and patched for ESP32
 2022-02-21 14:54:55 +01:00
Mahavir Jain
39744f2e32 Fix regression in docs build failure 2022-02-20 14:15:43 +05:30
daiziyan
60741e3be8 docs: make line number consistent for build-system, configure-ft2232h-jtag, ble-mesh-architecture, building-openocd-macos, error-handling" 2022-02-18 11:18:40 +08:00
Krzysztof Budzynski
349aa001bc Merge branch 'docs/new_getting_started' into 'master' 
New Getting Started install procedures by OS

Closes DOC-1849

See merge request espressif/esp-idf!15432
 2022-02-17 12:22:15 +00:00
daiziyan
a4704d37e6 docs: updated CN translation for new get started 2022-02-17 10:50:59 +00:00
pedro.minatel
e4a766051c [Docs] Rebase conlicts fixed 
[Docs] New getting started based on the ide and os selection
Missing file on zh_CN folder added
Added hidden toctree for missing files in CN version
docs: Added steps summary to the macOS procedures
[Docs] Changes on the titles and heading levels
[Docs] Review according to MR 15432
[Docs] Fixed the start a new project secction
 2022-02-17 10:50:51 +00:00
Marius Vikhammer
6d50a8dd7a docs: remove peripherals that are not supported from C2 docs 2022-02-16 10:22:46 +08:00
Tomas Sebestik
fb12d03dc3 Drop Python 3.6 2022-02-10 07:20:52 +01:00
Darian Leung
57fd78f5ba freertos: Remove legacy data types 
This commit removes the usage of all legacy FreeRTOS data types that
are exposed via configENABLE_BACKWARD_COMPATIBILITY. Legacy types can
still be used by enabling CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY.
 2022-02-09 23:05:45 +08:00
Sudeep Mohanty
1c393a32c4 Merge branch 'refactor/refactor_ulp_component' into 'master' 
ulp: refactor ulp component

Closes IDF-4520

See merge request espressif/esp-idf!16886
 2022-01-28 10:23:56 +00:00
morris
0f11a17678 Merge branch 'docs/add_cb_to_ledc_rst' into 'master' 
ledc: Mention source clock and fade end callback in LEDC API reference

Closes IDFGH-5637 and IDF-3293

See merge request espressif/esp-idf!14683
 2022-01-28 03:12:10 +00:00
Shang Zhou
3d6ca69312 Merge branch 'docs/update_distorted_figure' into 'master' 
docs: update distorted figures and delete unnecessary align commands

Closes DOC-2591

See merge request espressif/esp-idf!16918
 2022-01-28 03:11:13 +00:00
songruojing
31f9a69454 ledc: Update LEDC programming guide 
Add source clock in timer config
Add fade end callback and ledc_fade_stop usage
Explain ledc_fade_mode_t difference and limitation
 2022-01-27 19:13:53 +08:00
Sudeep Mohanty
2fc9bd61bf ulp: refactor ulp component 
This commit refactors the ulp component.
Files are now divided based on type of ulp, viz., fsm or risc-v.
Files common to both are maintained in the ulp_common folder.

This commit also adds menuconfig options for ULP within the ulp
component instead of presenting target specific configuations for ulp.
 2022-01-27 11:54:42 +05:30
Hao Ning
c2b8535205 Merge branch 'doc/update_pin_layout_figures_for_s3_user_guides' into 'master' 
docs:update pin layout diagrams for two s3 boards

Closes DOC-2483

See merge request espressif/esp-idf!16786
 2022-01-26 06:16:56 +00:00
Hao Ning
60aa03bde0 docs:update pin layout diagrams for two s3 boards 2022-01-26 06:16:55 +00:00
Omar Chebib
08b1d7544b Merge branch 'breaking/remove_custom_uart_isr' into 'master' 
UART & I2C: remove custom ISR registration function

See merge request espressif/esp-idf!16798
 2022-01-26 03:54:14 +00:00
Zim Kalinowski
67f51a4ce5 Merge branch 'bugfix/riscv_i2c_description' into 'master' 
i2c: fix the controller count in the header description

Closes IDFGH-6476

See merge request espressif/esp-idf!16718
 2022-01-26 03:13:07 +00:00
Shang Zhou
dd32376228 docs:update distorted figures and delete unneccessary align commands 2022-01-25 16:47:13 +08:00
Omar Chebib
473974c8f6 UART & I2C: remove custom ISR registration function 
Breaking change for v5.0: custom UART ISR and I2C ISR cannot be installed anymore.
 2022-01-25 14:46:43 +08:00
Roland Dobai
aedb846a20 Tools: IDF Monitor follows the UART console baud rate by default 2022-01-24 18:13:38 +01:00
Armando (Dou Yiwen)
7967a317d6 Merge branch 'feature/add_flash_suspend_example' into 'master' 
system: add an example showing how to run non-iram ISR when operating Flash

Closes IDF-4501

See merge request espressif/esp-idf!16658
 2022-01-24 07:40:00 +00:00
Armando
49658faaf0 doc: add flash suspend feature to iram usage doc 2022-01-24 12:59:29 +08:00
intern
eca400028d docs: sync up hw reference line count 2022-01-20 17:55:36 +08:00
laokaiyao
cf049e15ed esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
Sudeep Mohanty
2ed15d8b1e 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-01-18 10:58:00 +05:30
David Cermak
10dc8543c5 vfs/lwip: Fix docs on select() referencing wrong config 
CONFIG_LWIP_USE_ONLY_LWIP_SELECT was deprecated long time ago and removed (~ in v4.x).
Used CONFIG_VFS_SUPPORT_SELECT instead (and reverted the logic as this
is ON by default and needs to be explicitly turned off for socket only
select)
 2022-01-14 16:41:38 +01:00
Omar Chebib
bb730292d4 i2c: fix the controller count in the header description 
Closes https://github.com/espressif/esp-idf/issues/8133
 2022-01-13 18:25:41 +08:00
Marius Vikhammer
6c8426ea92 Merge branch 'docs/dynamic_copyright_date' into 'master' 
docs: update copyright date for docs automatically

Closes IDF-4548

See merge request espressif/esp-idf!16727
 2022-01-11 01:48:04 +00:00
Fu Hanxi
60c5b37bfe Merge branch 'refactor/ldgen' into 'master' 
refactor: ldgen

Closes IDF-605 and IDFGH-6271

See merge request espressif/esp-idf!16509
 2022-01-10 09:15:44 +00:00
Marius Vikhammer
93430c9eab docs: update copyright date for docs automatically 2022-01-10 15:05:33 +08:00
Marius Vikhammer
cf123b2071 docs: fix invalid symbol in chinese translation 2022-01-10 14:42:07 +08:00
daiziyan
9e7f31337d docs: updated CN trans for memory-types and external-ram 2022-01-08 15:21:17 +08:00
morris
5145183947 Merge branch 'refactor/timer_group_new_api' into 'master' 
⛵ GPTimer driver (previous Timer Group)

Closes IDF-2082 and IDF-2883

See merge request espressif/esp-idf!8317
 2022-01-07 10:54:32 +00:00
Dai Zi Yan
3278cdd21d Merge branch 'docs/update_CN_trans_spi-flash_BLE-MESH' into 'master' 
docs: Updated CN translation for wifi, spi_flash and fatal-errors

Closes DOC-2423

See merge request espressif/esp-idf!16543
 2022-01-07 09:02:41 +00:00
Fu Hanxi
0282cedd0b docs: drop support for v3.x grammar 2022-01-07 16:18:32 +08:00
daiziyan
20374161a6 docs: Updated CN translation for esp-ble-mesh, wifi, spi_flash and fata-errors; And keep line number consistency for en/index and versions 2022-01-07 16:05:16 +08:00
morris
e36f47a153 doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
Marius Vikhammer
7255497146 freertos: remove FREERTOS_ASSERT option 
Freertos asserts are now configured the same way as all other asserts in IDF,
i.e. by configuring COMPILER_OPTIMIZATION_ASSERTION_LEVEL.
 2022-01-07 09:16:48 +08:00
Darian Leung
3b29030e10 docs: Update Power Management and Sleep Modes docs for ESP32-S3 2022-01-06 10:04:29 +08:00
Marius Vikhammer
3e756e809e docs: update docs with S3 specific information. 2022-01-06 10:04:25 +08:00
intern
b0a2dda075 docs: add application example for esp-now 2022-01-05 16:17:28 +08:00
xueyunfei
ec993af322 update s3 doc 2022-01-04 17:50:37 +08:00
Jakob Hasse
39f3e082e1 Merge branch 'docs/update_CN_trans_get_started' into 'master' 
docs:update CN transalation for get-started section and sdmmc

Closes DOC-2383 and DOC-2380

See merge request espressif/esp-idf!16369
 2021-12-27 07:11:40 +00:00
Michael (XIAO Xufeng)
54dcd4d4d6 docs/sdspi: add documentation about sharing SPI bus among SD card and other devices 2021-12-27 04:39:32 +00:00
daiziyan
a98212015f docs:update CN transalation for get-started section and sdmmc 2021-12-21 18:43:56 +08:00
Marius Vikhammer
82325f6037 docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
Mo Fei Fei
2934010950 Merge branch 'docs/sync_up_cn_trans_user_guides' into 'master' 
docs: sync up cn trans for esp32-devkitc and esp32-s2-kaluga-1-kit user guides

Closes DOC-2403 and DOC-2388

See merge request espressif/esp-idf!16360
 2021-12-13 06:36:33 +00:00
intern
59a721e8a5 docs: update cn trans for user guides 2021-12-10 19:21:25 +08:00
daiziyan
c82881eaee docs: update CN translation for vfs and nvs_flash 2021-12-10 17:02:47 +08:00
daiziyan
c642661411 docs: update CN translation for esp_wifi and jtag-dubugging/index, and fix typos in esp_spi_slave_protocol 2021-12-07 15:36:50 +08:00
daiziyan
c34ccb1bdf docs: update CN translation for fatfs.rst 2021-12-02 11:47:06 +08:00
Tomas Rezucha
ebaca79557 other: Move cbor, jsmn and libsodium to idf-component-manager 
Marginal components are being carved out from esp-idf and moved to
https://github.com/espressif/idf-extra-components.
They are distributed via idf-component-manager, see
https://components.espressif.com.
 2021-11-30 21:44:48 +01:00
Wang Fang
7b5232f687 Merge branch 'docs/add_an_example_list_for_esp32-wrover-kit' into 'master' 
docs: add an example list for esp-wrover-kit

Closes DOC-2264

See merge request espressif/esp-idf!16141
 2021-11-30 11:44:24 +00:00
Wang Fang
a27dfe3874 docs: add an example list for esp-wrover-kit 2021-11-30 18:49:09 +08:00
radim.karnis
5d55d34481 docs: Update references to esptool docs 2021-11-24 10:28:39 +01:00
Simon
fc14d3f9aa Merge branch 'doc/update_usj_docs' into 'master' 
docs: update usb_serial_jtag documents

Closes IDF-3202 and DOC-2301

See merge request espressif/esp-idf!15922
 2021-11-23 07:41:53 +00:00
Dai Zi Yan
1ca83a5bc9 Update CN trans for timers.rst and ota.rst 2021-11-23 07:16:11 +00:00
Cao Sen Miao
4ae714c43c docs: update using usb_serial_jtag documents 2021-11-23 14:12:13 +08:00
Roland Dobai
3ce9bd995e Docs: Add migration guide for Windows environment (Msys/Mingw was removed) 2021-11-18 14:08:48 +01:00
Roland Dobai
460f3ad7b6 Merge branch 'feat/drop_msys' into 'master' 
Tools: Remove MSYS/Mingw support

Closes IDF-3954

See merge request espressif/esp-idf!15862
 2021-11-18 10:58:43 +00:00
Marius Vikhammer
b6a06b7533 docs: remove invalid symbol from ota.rst file 2021-11-18 11:37:09 +08:00
Lv Xin Yue
2059280445 Doc/add esp32s3 kevkitm 1 user guide cn and en 2021-11-17 11:13:34 +00:00
Fu Hanxi
cca43f5a2d Merge branch 'feature/idf_py_clang_tidy_check' into 'master' 
feat(idf.py): add `idf.py clang-check` and `idf.py clang-html-report`

Closes IDF-1909

See merge request espressif/esp-idf!15848
 2021-11-17 07:02:16 +00:00
Dai Zi Yan
004ef822b7 Merge branch 'docs/update_CN_trans_api_reference_system' into 'master' 
docs: update CN translation for ota.rst and console.rst

See merge request espressif/esp-idf!15634
 2021-11-17 02:44:09 +00:00
Ondrej Kosta
6d4ff2c05e Merge branch 'feature/eth_ioctl_speed_duplex' into 'master' 
esp_eth:  esp_eth_ioctl update

Closes IDF-1240 and IDF-4060

See merge request espressif/esp-idf!15607
 2021-11-16 11:56:18 +00:00
daiziyan
0ff2776b1e docs: update CN translation for ota.rst and console.rst 2021-11-16 19:23:09 +08:00
Ondrej Kosta
d91bbdf7b9 esp_eth: esp_eth_ioctl v5.0 migration guide 2021-11-16 08:34:07 +01:00
Fu Hanxi
a081a67f8e docs(idf.py): add IDF Clang Tidy chapter 2021-11-16 14:43:39 +08:00
Krzysztof Budzynski
612c5172f0 Merge branch 'doc/update_link_to_module_datasheet' into 'master' 
docs:update the link to esp32-s3-wroom-1 datasheet

See merge request espressif/esp-idf!15741
 2021-11-15 05:58:58 +00:00
Omar Chebib
9d5923a13e IPC: Move ipc sources to esp_system 
IPC shall be put back into esp_system as it is an 'OS additions'.
 2021-11-11 10:30:01 +08:00
Roland Dobai
a1d0d1ffbe Tools: Remove MSYS/Mingw support 
MSYS/Mingw was deprecated since v4.0 and it is removed in v5.0. Please
follow the getting started guide of the documentation to set up a
Windows Command Line or Power Shell based environment.
 2021-11-10 17:25:07 +01:00
Roland Dobai
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
Dai Zi Yan
f8f49de735 Merge branch 'docs/update_CN_trans_flashEncryption_externalRam' into 'master' 
docs: update CN trans for external-ram and flash-encryption

See merge request espressif/esp-idf!15693
 2021-11-08 07:36:15 +00:00
morris
2a948cd09b doc: initial migration guides 2021-11-08 10:37:47 +08:00
daiziyan
e79b8c1b6a docs: update CN trans for external-ram and flash-encryption 2021-11-05 19:23:10 +08:00
Roland Dobai
4d149f070c Docs: Add copyright header guide for contributions 2021-11-04 11:55:26 +01:00
daiziyan
8db579e716 docs:update CN translation for wifi 2021-11-03 14:11:53 +08:00
Krzysztof
cc8413a330 docs: Update 'Hardware Reference' section for ESP32-S3 2021-11-02 06:56:12 +01:00
Lv Xin Yue
48f7ae266d docs:update the link to esp32-s3-wroom-1 datasheet 2021-10-29 20:05:12 +08:00
Wei Tian Hua
347e04cf73 Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32' into 'master' 
Doc/Make Classic BT related document links only visible for ESP32

Closes IDFGH-5008, IDFGH-6022, and AUD-3378

See merge request espressif/esp-idf!15635
 2021-10-29 02:27:24 +00:00
Wang Fang
ba09586a24 docs: replace the module on esp32-devkitc from esp32-wrover to esp32-wroom 2021-10-28 17:29:17 +08:00
weitianhua
497eaca1a3 Make ESP32 Bluetooth stack architecture Doc only visible for ESP32 2021-10-27 20:47:50 +08:00
weitianhua
64aa94d823 Make Classic BT related document links only visible for ESP32 2021-10-27 15:28:47 +08:00
Armando
d41da2792a doc: add flash and psram configuration doc in programming guide 2021-10-26 11:49:36 +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
Hao Ning
54e1c52beb docs：fix wrong event names in wifi driver 2021-07-20 19:21:43 +08:00
Angus Gratton
c1ca7a35b0 ldgen: Remove some remaining references to TARGET.project.ld.in 2021-07-16 20:14:27 +08:00
Angus Gratton
c01da712f6 docs: Move the bootloader size section into the Bootloader guide 2021-07-13 17:35:04 +10:00
morris
1560d6f1ba soc: add reset reasons in soc component 2021-07-13 10:45:38 +08:00
Dai Zi Yan
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
daiziyan
e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08:00
Cao Sen Miao
fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 2021-07-02 17:13:51 +08:00
Krzysztof Budzynski
4a87be3ecd Merge branch 'doc/add_esp32-s3-devkitc-1_user_guide_en' into 'master' 
docs:add esp32-s3-devkitc-1 user guide

See merge request espressif/esp-idf!14096
 2021-07-02 08:14:57 +00:00
Lv Xin Yue
faee145a61 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +08:00
Krzysztof Budzynski
22d4b24000 Merge branch 'docs/windows_installer_path_limitation' into 'master' 
docs: add limitation of path lenght for Windows Installer

See merge request espressif/esp-idf!14194
 2021-07-02 03:15:24 +00:00
Krzysztof Budzynski
f0b2926d70 Merge branch 'docs/s3_get_started' into 'master' 
docs: updated getting started for S3

Closes IDF-3281 and IDF-3282

See merge request espressif/esp-idf!14174
 2021-07-01 14:33:55 +00:00
Juraj Michálek
494dd6ea01 docs: add limitation of path lenght for Windows Installer 2021-07-01 12:29:37 +02:00
daiziyan
317ee67c2a docs: translate ESP32-S3 get started 2021-07-01 15:54:19 +08:00
Dai Zi Yan
5e5ddb1ffb docs:fixthe number of general purpose timers for ESP32-C3 2021-06-29 14:33:06 +08:00
Alexey Gerenkov
821869d98d apptrace: Refactors apptrace for better support various tracing HW 2021-06-24 13:16:13 +03:00
Marius Vikhammer
2b995a37eb docs: fix table in WifI guide not being rendered 2021-06-24 14:54:38 +08:00
Roland Dobai
b22fcbef96 Merge branch 'feature/drop_py2_support' into 'master' 
Drop support for unsupported Python versions

Closes IDF-1676

See merge request espressif/esp-idf!13622
 2021-06-22 09:28:49 +00:00
Krzysztof Budzynski
ed428ab811 Merge branch 'docs/windows_installer_2.9' into 'master' 
docs: update Windows Tools 2.9 installation

See merge request espressif/esp-idf!14019
 2021-06-22 03:27:18 +00:00
Roland Dobai
407053592e Drop support for unsupported Python versions 2021-06-21 21:48:49 +02:00
Juraj Michálek
bd749ad8be docs: update Windows Tools 2.9 installation 2021-06-21 14:19:40 +02:00
daiziyan
e1ad9a1d20 docs:update CN translation for fatal-errors, external-ram, and idf-monitor 2021-06-21 18:05:18 +08:00
Ivan Grokhotkov
c576c1414b Merge branch 'bugfix/fix-autocomplete-bash' into 'master' 
Replaced broken link to shell autocompletion

See merge request espressif/esp-idf!13938
 2021-06-18 10:24:00 +00:00
Wang Ning
2c31ac24c1 docs/add_how_to_debug_ota_failure_to_api_references 2021-06-16 19:28:01 +08:00
Ivan Grokhotkov
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
Martin Gaňo
330d1cf2ae Fix autocomplete for bash 2021-06-11 01:59:36 +02:00
Marius Vikhammer
fbd6e9e320 docs: remove duplicate label 2021-06-09 09:30:42 +08:00
Marius Vikhammer
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
Krzysztof Budzynski
93334ea73a Merge branch 'docs/update_CN_trans_startup_debugging-example' into 'master' 
docs:update CN translation for startup and debugging-example

See merge request espressif/esp-idf!13791
 2021-06-08 07:09:27 +00:00
daiziyan
bb6a02ae53 docs:update CN translation for startup and debugging-example 2021-06-08 11:18:27 +08:00
Angus Gratton
dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage 
Closes https://github.com/espressif/esp-idf/issues/7007
Closes https://github.com/espressif/esp-idf/issues/6715
Closes https://github.com/espressif/esp-idf/issues/3781
Closes https://github.com/espressif/esp-idf/issues/2566
 2021-06-03 13:55:34 +10:00
Marius Vikhammer
c7ead8cd73 docs: document contained an invalid character which couldnt be rendered in the PDF 2021-06-01 09:34:52 +08:00
Krzysztof Budzynski
c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 
remove modules and boards section

Closes DOC-45 and DOC-355

See merge request espressif/esp-idf!12846
 2021-05-31 11:12:51 +00:00
Krzysztof Budzynski
997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' 
docs: introduce new rules for formatting documents

See merge request espressif/esp-idf!13642
 2021-05-31 10:07:19 +00:00
Hao Ning
fc0eba4101 remove modules and boards section 
doc: add redirections

docs: rebase master and add redirect links

docs: delete invalid links labeled in modules-and-boards

docs:installed pre-commit config

docs:retry

docs: separate links of modules and boards

docs: removed original files and added one more redirection

docs:deleted invalid links in jtag-debugging

docs:replaced old links in jtag-debugging

docs:fixd pipeline failures
 2021-05-31 16:19:15 +08:00
daiziyan
8149eda0a9 docs: introduce new rules for writing documents 2021-05-31 10:56:18 +08:00
pedro.minatel
03cb5f8af8 Merge conflict fixed 
Fixed the scale image on click to enlarge
 2021-05-28 15:16:02 +01:00
Wang Ning
86a7d4c483 docs/update_strapping_pins_in_c3_devkit_user_guides 2021-05-28 03:56:22 +00:00
Marius Vikhammer
0c17973d54 docs: add rf calibration docs for S2 and C3 2021-05-26 10:09:50 +08:00
Krzysztof Budzynski
99e7aa1700 Merge branch 'docs/update_chip_comparsion_table' into 'master' 
docs:translate chip series comparison table and update adc_types.h

Closes DOC-1278

See merge request espressif/esp-idf!13596
 2021-05-25 10:44:01 +00:00
Wang Fang
71141a326d docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc 2021-05-24 03:46:40 +00:00
Angus Gratton
e928d57663 Merge branch 'doc/include_bootloader_random' into 'master' 
docs: Add RNG functions to API reference

See merge request espressif/esp-idf!13519
 2021-05-20 09:14:55 +00:00
daiziyan
611ecc619b docs:translate chip series comparison table and update adc_types.h 2021-05-19 16:25:27 +08:00
Wang Ning
19a407ed1a doc/remove_romconsole_since_it_is_no_longer_supported_from_ESP32_ECO3 2021-05-18 07:51:56 +00:00
Angus Gratton
e14edecf5f docs: Add random number generation to the API Reference System section 2021-05-18 16:05:42 +10:00
Angus Gratton
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
Angus Gratton
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
Krzysztof Budzynski
cc22768863 Merge branch 'docs/remove_c3_not_updated_warning' into 'master' 
docs: remove front page C3 docs not updated warning

See merge request espressif/esp-idf!13442
 2021-05-13 02:25:38 +00:00
Marius Vikhammer
fd477fa60e docs: remove front page C3 docs not updated warning 2021-05-13 09:58:20 +08:00
Roland Dobai
c68781c269 docs: Generate JTAG debugging guide based on feature instead of chip 
It is better to check feature SOC_USB_SERIAL_JTAG_SUPPORTED which will
support other chip targets beside ESP32-C3.
 2021-05-11 11:01:53 +02:00
Angus Gratton
ca89608f22 Merge branch 'feature/doc_fast_build' into 'master' 
docs: add fast build feature and activate it in CI

See merge request espressif/esp-idf!13352
 2021-05-06 03:56:56 +00:00
Marius Vikhammer
41b3043cb4 Add warning to docs output if fastbuild 2021-05-06 09:17:41 +08:00
Krzysztof Budzynski
b455299bb0 Merge branch 'feature/add_link_to_c3_page' into 'master' 
docs: Add a link to ESP32-C3 page for developers on espressif.com

See merge request espressif/esp-idf!12349
 2021-04-30 06:12:23 +00:00
Michael (XIAO Xufeng)
859f7e3664 Merge branch 'feature/support_eon_flash_qaud_mode_esp_flash' into 'master' 
esp_flash: support override default chip driver list

Closes IDF-2907

See merge request espressif/esp-idf!12565
 2021-04-29 04:03:56 +00:00
pedro.minatel
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
Krzysztof
34a16c9d93 docs: Add a link to ESP32-C3 page for developers on espressif.com 2021-04-28 10:42:09 +02:00
Jeroen Domburg
644f430a31 Merge branch 'feature/esp32c3_usbjtagserial_console' into 'master' 
USB serial/jtag controller: Add vfs (logging/printf), panic handler, gdb support.

See merge request espressif/esp-idf!12925
 2021-04-28 08:38:31 +00:00
Jeroen Domburg
2c75f63f89 * ets_delay_us(1) has too much overhead; change logic 
* Fix MR comments
 2021-04-28 16:38:24 +08:00
chenjianxing
c66b1aeda7 update esp32c3 iperf config 2021-04-27 14:41:08 +08:00
Michael (XIAO Xufeng)
26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08:00
Brian Alberto Ignacio Reyes
b630c45d91 docs: Fix vscode extension setup links 2021-04-23 20:45:24 +08:00
Jakob Hasse
68393c41c4 doc: linux host test documentation 2021-04-23 09:27:35 +08:00
Krzysztof Budzynski
58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master' 
docs: Update JTAG debugging guides for ESP32-C3

Closes IDF-2133

See merge request espressif/esp-idf!13102
 2021-04-22 11:58:34 +00:00
Krzysztof Budzynski
2f8ccd5e3b Merge branch 'docs/update_CN_trans_buildsystem' into 'master' 
update CN translation for build-system and linker-script-generation

See merge request espressif/esp-idf!13168
 2021-04-22 08:08:38 +00:00
Dai Zi Yan
e91861253f docs:updated CN tranlation for build-system, ulp, unit-tests, idf-monitor and linker-script-generation 2021-04-22 16:08:31 +08:00
Dai Zi Yan
4aa52da0c1 update CN translation for I2C 2021-04-22 16:05:01 +08:00
Ivan Grokhotkov
bf49917233 Merge branch 'doc/macos_ftdi_jtag' into 'master' 
docs: jtag debugging: add macOS 10.15 FTDI details (Github PR)

Closes IDFGH-4078

See merge request espressif/esp-idf!13104
 2021-04-14 11:36:12 +00:00
Roland Dobai
a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3 2021-04-13 12:48:50 +02:00
Michael (XIAO Xufeng)
7e06a60c0d Merge branch 'refactor/no_dac_on_esp32s3' into 'master' 
dac: added DAC support macro

Closes IDF-1777

See merge request espressif/esp-idf!13038
 2021-04-12 10:52:33 +00:00
Eli
9ec19163ed docs: jtag debugging: add macOS 10.15 FTDI details 
Merges https://github.com/espressif/esp-idf/pull/5949
 2021-04-12 09:15:08 +02:00
Ivan Grokhotkov
b51a7e0cc7 Merge branch 'feature/win_inst_offline' into 'master' 
Feature/win inst offline

Closes IDF-2636, IDF-2664, IDFGH-4549, IDFGH-3424, IDFGH-4260, IDFGH-4664, IDFGH-2202, IDFGH-4697, IDF-2742, and IDF-2955

See merge request espressif/esp-idf!12003
 2021-04-12 06:54:24 +00:00
morris
75dfd970b4 dac: added DAC support macro 
Remove DAC support on ESP32-S3
 2021-04-12 12:04:46 +08:00
Krzysztof Budzynski
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
Marius Vikhammer
0633ee3e18 docs: fix doxygen compile warnings for doxygen 1.9.1 
Newer versions of doxygen will give warnings for comments in
INPUT lists

Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
 2021-04-09 11:57:03 +08:00
Angus Gratton
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
Michael (XIAO Xufeng)
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
Renz Bagaporo
c112bd8b57 esp_system: move intr_alloc 2021-04-07 17:53:37 +08:00
morris
4980a764fe doc: fix uninterpreted variables in timer.rst 2021-04-07 13:49:57 +08:00
Armando
9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
Angus Gratton
94ac251091 Merge branch 'doc/general_notes' into 'master' 
doc: Update docs about startup sequence and memory types

Closes IDF-2321, IDF-2409, and IDFGH-1540

See merge request espressif/esp-idf!12636
 2021-04-05 23:51:25 +00:00
Angus Gratton
6b57f33858 Merge branch 'refactor/movements_from_target_components' into 'master' 
Movement from target components 1

See merge request espressif/esp-idf!12482
 2021-04-05 02:37:21 +00:00
Krzysztof Budzynski
7702060967 Merge branch 'docs/update_CN_trans_spiffs_touchpad' into 'master' 
docs:update CN translation for spiffs and touch_pad

See merge request espressif/esp-idf!12914
 2021-04-02 09:29:18 +00:00
daiziyan
540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +08:00
Renz Bagaporo
bbc599493e esp32: move common fragment definitions 2021-03-31 19:17:33 +08:00
Angus Gratton
793771e744 Merge branch 'feature/esp_error_check_return' into 'master' 
esp_common: add generic check macros

Closes IDF-2271

See merge request espressif/esp-idf!12602
 2021-03-31 07:08:27 +00:00
Wang Fang
c303333f52 docs: Correct uart default pin names and provid more information about ESP-Prog board 2021-03-29 14:04:13 +08:00
Angus Gratton
2e98a5d796 docs: split the 'general notes' page into two 2021-03-29 16:32:54 +11:00
Michael (XIAO Xufeng)
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
Krzysztof Budzynski
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
Krzysztof Budzynski
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
Hao Ning
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
Cao Sen Miao
c54ea54d98 spi_flash: make suspend off by default and add more information for using suspend 2021-03-26 13:57:14 +08:00
Juraj Michalek
70e06a46ba tools: IDF Windows installer offline mode support 2021-03-24 12:27:46 +01:00
Krzysztof Budzynski
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
Krzysztof Budzynski
5b4132cddf Merge branch 'docs/update_kaluga_user_guide' into 'master' 
Update kaluga user guides for v1.3

Closes DOC-118 and DOC-207

See merge request espressif/esp-idf!11616
 2021-03-24 08:39:37 +00:00
Krzysztof Budzynski
15c3a42dcf Merge branch 'doc/update_CN_translation_for_API_guides_and_Contribute' into 'master' 
update CN translation for api-guides and contribute

See merge request espressif/esp-idf!12662
 2021-03-23 08:05:28 +00:00
daiziyan
abb89b9a9c docs: update CN translation for app_trace,linker-script-generation and add-ons-reference.rst 2021-03-23 11:24:23 +08:00
Dai Zi Yan
8ae944e26c docs:update CN translation for documenting-code and LEDC 2021-03-23 10:52:50 +08:00
Natasha
8fed580df6 update kaluga user guides for v1.3 2021-03-22 22:53:43 +08:00
Michael (XIAO Xufeng)
3a90d51831 Merge branch 'refactor/using_isr_callback_in_timer_example' into 'master' 
TIMG: clean up timer example and add example test

Closes IDF-2722, IDF-2766, and IDF-2347

See merge request espressif/esp-idf!12218
 2021-03-22 06:36:32 +00:00
suren.gabrielyan
cc78923d23 docs: Update OpenSSL API documents 
Closes IDF-2541
 2021-03-18 10:42:29 +04:00
Wang Ning
424fe73a23 Add ESP32-C3-DevKitC-02 User Guide 2021-03-17 06:40:33 +00:00
morris
fe70d18bb5 doc: update doc of general purpose timer 2021-03-16 17:56:37 +08:00
Krzysztof Budzynski
15561c9e77 Merge branch 'doc/version_select' into 'master' 
docs: Build new doc layout with theme from pypi test

Closes IDF-1972

See merge request espressif/esp-idf!9862
 2021-03-16 05:05:17 +00:00
Marius Vikhammer
91439e3818 docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
Dai Zi Yan
85a016dbf6 api-guides: updated CN translation for unit-tests, jtag-debugging/index, and jtag-debugging/using-debugger 2021-03-15 13:01:15 +08:00
Dai Zi Yan
b3b559e75f doc:updated cn translation for language.rst and version.rst to provide new layout for version/target select 2021-03-12 16:15:56 +08:00
Shu Chen
6792024add esp_common: add generic check macros 
Add four check maros:
* ESP_RETURN_ON_ERROR()
* ESP_GOTO_ON_ERROR()
* ESP_RETURN_ON_FALSE()
* ESP_GOTO_ON_FALSE()

Also add a `xx_ISR` version for each of them, which can be used in ISR.
 2021-03-11 17:38:22 +08:00
Angus Gratton
4f406d7a35 Merge branch 'bugfix/read_ota_partition_required_output_arg' into 'master' 
otatool: Fixes read_ota_partition cmd, required output arg

Closes IDFGH-4756

See merge request espressif/esp-idf!12601
 2021-03-09 06:29:34 +00:00
daiziyan
123e540b2f update CN translation based on reviewers' comments 2021-03-09 10:28:52 +11:00
daiziyan
8c7fd31984 api-guides: update CN translation for build-system and build-system-legacy,and fix line break in the EN version 2021-03-09 10:28:52 +11:00
KonstantinKondrashov
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
Krzysztof Budzynski
ac776657c9 Merge branch 'docs/provide_link_to_pcb_layout_for_ethernet_board_v1.2' into 'master' 
docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task

See merge request espressif/esp-idf!12522
 2021-03-02 11:42:59 +00:00
Marius Vikhammer
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
Wang Fang
776684fa84 docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task 2021-02-26 10:35:21 +08:00
Michael (XIAO Xufeng)
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
Angus Gratton
a0eb455ec3 Merge branch 'refactor/misc_move_from_esp_common' into 'master' 
Movements from esp_common

Closes IDF-1947

See merge request espressif/esp-idf!9692
 2021-02-24 23:16:52 +00:00
Angus Gratton
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
Angus Gratton
c7f8001701 Merge branch 'feature/doc_update_security_chapters' into 'master' 
doc/secure features: Updates doc esp32c3

Closes IDF-2322

See merge request espressif/esp-idf!12374
 2021-02-24 22:28:36 +00:00
Michael (XIAO Xufeng)
476fdcba68 spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND 2021-02-24 20:20:18 +08:00
Renz Bagaporo
f2561f6360 docs: update list of common component requirements 2021-02-24 12:16:37 +08:00
Angus Gratton
eb736985ef Merge branch 'docs/esp32c3_fatal_errors' into 'master' 
doc: update "Fatal Errors" chapter for ESP32C3 board

Closes IDF-2323

See merge request espressif/esp-idf!12437
 2021-02-24 04:14:40 +00:00
Omar Chebib
33deabb3ab doc: update "Fatal Errors" chapter for ESP32C3 board 2021-02-23 14:54:26 +08:00
KonstantinKondrashov
70dd884fee doc(esp32c3): Updates secure features doc 2021-02-22 18:01:35 +08:00
KonstantinKondrashov
5a5f5ad031 doc/efuse: Adds efuse doc for ESP32-C3 2021-02-22 15:51:45 +08:00
Kang Zuoling
78a1cd3643 touch_element: add touch element api-reference doc 2021-02-22 12:16:49 +08:00
Marius Vikhammer
8c729fb55b docs: fix broken ref in external-ram.rst 2021-02-20 12:37:59 +08:00
Dai Zi Yan
97ec83fa78 Provide CN translation for get-started section in MR12242 2021-02-18 15:16:58 +01:00
Krzysztof Budzynski
9274abf5c9 Merge branch 'doc/nvs_get_used_entry_count__clarify' into 'master' 
[doc]: NVS documentation updates

Closes IDF-1563, DOC-165, and IDF-859

See merge request espressif/esp-idf!12056
 2021-02-18 10:36:16 +00:00
Roland Dobai
47f67f8b81 tools: Prefer python3 during install and export 
Install and export script should work on systems without "python"
executable.

Closes https://github.com/espressif/esp-idf/pull/6471

Closes https://github.com/espressif/esp-idf/issues/6532

Related to https://github.com/espressif/esp-idf/issues/6421 and
https://github.com/espressif/arduino-esp32/issues/4717
 2021-02-13 11:34:40 +01:00
Jakob Hasse
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
Wang Ning
aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +08:00
Dai Zi Yan
5aaa0c9ca3 Provide CN translation for part of documents in MR11884 2021-02-02 09:19:58 +08:00
Marius Vikhammer
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
daiziyan
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