Commit Graph

2386 Commits

Author SHA1 Message Date
Wang Fang
1903d8587a docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task 2021-06-15 15:26:10 +08:00
Jakob Hasse
5395f451a2 [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-06-02 13:34:35 +08:00
Wang Ning
9dafde59b1 docs/update_strapping_pins_in_c3_devkit_user_guides 2021-06-01 10:10:45 +00:00
Angus Gratton
58a3e08895 paritition_table: Verify the partition table md5sum when loading the app
Additionally, always enable the partition MD5 check if flash encryption is on in
Release mode. This ensures the partition table ciphertext has not been modified
(CVE-2021-27926).

The exception is pre-V3.1 ESP-IDF bootloaders and partition tables, which
don't have support for the MD5 entry.
2021-05-30 23:21:14 +00:00
Angus Gratton
2b19bd0c2f Merge branch 'doc/timer_group_update_for_esp32c3' into 'release/v4.3'
timer: clean up example and api reference (v4.3)

See merge request espressif/esp-idf!13279
2021-05-14 01:48:37 +00:00
Angus Gratton
798aab5097 Merge branch 'docs/remove_c3_not_updated_warning_v4.3' into 'release/v4.3'
docs: remove c3 not updated warning (v4.3)

See merge request espressif/esp-idf!13443
2021-05-14 01:39:55 +00:00
Jiang Jiang Jian
effee74b2f Merge branch 'doc/backport_iot_solution_link_updates_to_v4.3' into 'release/v4.3'
fix dead links directed to ESP-IoT-Solution repo (backport v4.3)

See merge request espressif/esp-idf!13347
2021-05-13 04:15:28 +00:00
Michael (XIAO Xufeng)
d95e2c63ca Merge branch 'doc/update_i2c_on_esp32c3_v4.3' into 'release/v4.3'
i2c: update api reference and example pin definition (backport v4.3)

See merge request espressif/esp-idf!13451
2021-05-13 03:09:02 +00:00
Marius Vikhammer
5ec69efafa docs: remove front page C3 docs not updated warning 2021-05-13 10:04:27 +08:00
Cao Sen Miao
dca229df07 i2c: update api reference and example pin defination 2021-05-06 12:33:55 +08:00
Angus Gratton
467c7af33e Merge branch 'doc/general_notes_v4.3' into 'release/v4.3'
doc: Update docs about startup sequence and memory types (v4.3)

See merge request espressif/esp-idf!13316
2021-05-03 06:48:07 +00:00
Michael (XIAO Xufeng)
64de7ee38c Merge branch 'feature/spi_slave_hd_segment_example_v4.3' into 'release/v4.3'
spi_slave_hd: add an spi slave hd segment example (4.3)

See merge request espressif/esp-idf!13312
2021-04-28 17:39:25 +00:00
Armando
31c396c127 spi_slave_hd: add segment mode example 2021-04-28 08:20:55 +00:00
chenjianxing
e4d84804c1 update esp32c3 iperf config 2021-04-28 15:50:41 +08:00
Hao Ning
819ac7f847 backport link updates to v4.3 2021-04-26 11:33:22 +00:00
Angus Gratton
5fa34f6a30 Merge branch 'docs/add_esp32-c3-devkitc-02_user_guide' into 'release/v4.3'
Add ESP32-C3-DevKitC-02 User Guide (backport master)

See merge request espressif/esp-idf!13284
2021-04-24 00:36:24 +00:00
Angus Gratton
2c153af57a Merge branch 'doc/c3_ledc_programming_guide_v4.3' into 'release/v4.3'
[doc]: Corrected C3 LEDC docs (backport 4.3)

See merge request espressif/esp-idf!13276
2021-04-24 00:35:12 +00:00
Angus Gratton
18d7d9497a Merge branch 'bugfix/doc_jtag_c3_v4.3' into 'release/v4.3'
docs: Update JTAG debugging guides for ESP32-C3 (v4.3)

See merge request espressif/esp-idf!13290
2021-04-24 00:35:03 +00:00
Michael (XIAO Xufeng)
eff7fd9052 Merge branch 'feature/update_adc_programming_guide_on_c3_v4.3' into 'release/v4.3'
adc: add adc programming guide on c3 (4.3)

See merge request espressif/esp-idf!13281
2021-04-23 12:53:04 +00:00
Angus Gratton
275743ab1c doc: Add notes that vTaskStartScheduler() is called during startup
Closes https://github.com/espressif/esp-idf/issues/1457
2021-04-23 22:48:47 +10:00
Angus Gratton
8a39b5237d doc: update the memory types and startup docs 2021-04-23 22:48:47 +10:00
Angus Gratton
6f3b1a0554 docs: split the 'general notes' page into two 2021-04-23 19:12:06 +10:00
Angus Gratton
ecb01b28c4 Merge branch 'doc/guide_uart_esp32c3_v4.3' into 'release/v4.3'
doc: update programming guide to include ESP32-C3 updates

See merge request espressif/esp-idf!13277
2021-04-23 09:09:11 +00:00
Roland Dobai
50e3f9f66c docs: Update JTAG debugging guides for ESP32-C3 2021-04-22 13:58:22 +02:00
Wang Ning
613201c24d Add ESP32-C3-DevKitC-02 User Guide and fix some typos 2021-04-22 15:34:45 +08:00
Armando
d7a793f406 spi_master: enable spi speed test on c3 and update the programming guide
accordingly
2021-04-22 06:31:49 +00:00
Armando
85e0728700 spi: update esp32c3 programming guide 2021-04-22 06:31:49 +00:00
Armando
3fb1165e4e adc: add adc programming guide on c3 2021-04-22 06:28:37 +00:00
morris
5f1887b3ca doc: update general purpose timer for esp32-c3 2021-04-22 11:19:18 +08:00
Omar Chebib
d8c4ab482b doc: update programming guide to include ESP32-C3 updates 2021-04-22 10:41:51 +08:00
Jakob Hasse
94ed8f8606 [doc]: Corrected C3 LEDC docs 2021-04-22 09:38:26 +08:00
Angus Gratton
6f47a4e0a6 Merge branch 'feature/add_c3_trm_link_v4.3' into 'release/v4.3'
docs: add C3 TRM links (v4.3)

See merge request espressif/esp-idf!13091
2021-04-16 05:33:29 +00:00
yuanjm
e490fdafbe doc: Add description for CONFIG_LWIP_IPV6 in api-guides 2021-04-12 05:42:50 +00:00
Krzysztof Budzynski
bda9e1fda7 Merge branch 'bugfix/doxygen_input_file_bug_v4.3' into 'release/v4.3'
docs: fix doxygen compile warnings for doxygen 1.9.1 (v4.3)

See merge request espressif/esp-idf!13075
2021-04-12 00:46:11 +00:00
Marius Vikhammer
97df333a3b 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-12 08:46:06 +08:00
Angus Gratton
e4dd9053c2 Merge branch 'feature/secure_bootv2_c3_v4.3' into 'release/v4.3'
secure_boot_v2: Support SB_V2 for ESP32-C3 ECO3 (v4.3)

See merge request espressif/esp-idf!13062
2021-04-09 13:06:46 +00:00
Marius Vikhammer
626964beae docs: add C3 TRM links 2021-04-09 15:14:16 +08:00
Michael (XIAO Xufeng)
76ff1724b3 Merge branch 'feature/remove_hspi_macor_on_chips_later_than_s2_v4.3' into 'release/v4.3'
spi: remove hspi macor on chips later than s2 (v4.3)

See merge request espressif/esp-idf!12956
2021-04-08 09:37:07 +00:00
KonstantinKondrashov
19b90e8ba9 docs: Adds secure_boot_v2 for ESP32-C3 ECO3 2021-04-08 14:35:35 +08:00
Armando
670b057b04 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 15:30:28 +08:00
Omar Chebib
ae3b4819da esp_system: add VDD_SDIO power domain configuration to documentation
Add a warning in `sleep_modes` doc page to explain how to keep
VDD_SDIO power domain ON.
2021-04-06 14:04:22 +08:00
Jiang Jiang Jian
319eecc793 Merge branch 'doc/c3_system_api_v4.3' into 'release/v4.3'
docs: updated system api-reference chapters for C3 (v.4.3)

See merge request espressif/esp-idf!12892
2021-03-31 17:57:41 +00:00
Angus Gratton
278cfc2047 Merge branch 'doc/embed_example_v4.3' into 'release/v4.3'
doc: Update the link to an example that embeds a file (v4.3)

See merge request espressif/esp-idf!12655
2021-03-31 01:31:12 +00:00
Michael (XIAO Xufeng)
b75a5fd03a Merge branch 'bugfix/adc_power_issue_4.3' into 'release/v4.3'
adc: fix adc power issue (v4.3)

See merge request espressif/esp-idf!12921
2021-03-30 17:15:09 +00:00
Michael (XIAO Xufeng)
868c96c59f Merge branch 'bugfix/flash_suspend_restriction_v4.3' into 'release/v4.3'
spi_flash: make suspend off by default and add more information for using suspend(backport v4.3)

See merge request espressif/esp-idf!12932
2021-03-30 11:00:53 +00:00
Marius Vikhammer
c9087c205b docs: updated system api-reference chapters for C3 2021-03-30 14:28:02 +08:00
Cao Sen Miao
4906779d50 spi_flash: make suspend off by default and add more information for using suspend 2021-03-29 12:02:43 +08:00
Jiang Jiang Jian
7c5e920c37 Merge branch 'feature/temp_v4.3' into 'release/v4.3'
temp_sensor: add calibration for esp32c3(backport v4.3)

See merge request espressif/esp-idf!12703
2021-03-26 05:51:47 +00:00
Jiang Jiang Jian
d4ac30a978 Merge branch 'fix/dont_disable_uart_dl_mode_by_default_v4.3' into 'release/v4.3'
bootloader/ ESP32_ECO3: Do not disable UART download mode by default (v4.3)

See merge request espressif/esp-idf!12907
2021-03-26 05:50:48 +00:00
Armando
4866027391 adc: update adc programming guide to avoid build fail 2021-03-26 13:26:19 +08:00
KonstantinKondrashov
26d362040e secure_boot/SIGNED_ON_UPDATE_NO_SECURE_BOOT: Only the first position of signature blocks is used to verify any update 2021-03-25 15:40:24 +08:00
Aditya Patwardhan
f6a794cf51 bootloader/ ESP32_ECO3: Do not disable UART download mode by default 2021-03-25 10:32:37 +05:30
Angus Gratton
802a01c0b7 docs: Add docs for Secure Boot V2 "verify on update without secure boot" 2021-03-17 17:08:59 +08:00
Angus Gratton
9fd12182de Merge branch 'docs/esp32c3_fatal_errors_v4.3' into 'release/v4.3'
doc: update "Fatal Errors" chapter for ESP32C3 board (backport v4.3)

See merge request espressif/esp-idf!12678
2021-03-11 10:48:03 +00:00
Krzysztof Budzynski
d42958439d Merge branch 'doc/c3_api_ref_update_v4.3' into 'release/v4.3'
docs: update api-reference chapters for C3 (v4.3)

See merge request espressif/esp-idf!12583
2021-03-11 09:36:44 +00:00
Omar Chebib
9393a402eb doc: update "Fatal Errors" chapter for ESP32C3 board 2021-03-11 06:37:30 +00:00
Cao Sen Miao
d92ac450a2 temp_sensor: add calibration for esp32c3 2021-03-11 14:25:18 +08:00
daiziyan
fd93c475b6 update CN translation based on reviewers' comments 2021-03-09 10:31:33 +11:00
daiziyan
27c72a4105 api-guides: update CN translation for build-system and build-system-legacy,and fix line break in the EN version 2021-03-09 10:30:49 +11:00
Angus Gratton
5c8b1d6ab8 doc: Update the link to an example that embeds a file
Since we have the CA Certificate Store feature, https_request no longer needs to
embed any certs.
2021-03-09 10:30:49 +11:00
Marius Vikhammer
fb82bdb9da 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-02 15:00:56 +08:00
Kang Zuoling
b639514793 touch_element: add touch element api-reference doc 2021-03-01 18:02:53 +08:00
Michael (XIAO Xufeng)
24f3341a2d Merge branch 'docs/spi_flash_auto_suspend_v4.3' into 'release/v4.3'
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND (v4.3)

See merge request espressif/esp-idf!12512
2021-02-26 08:53:48 +00:00
Angus Gratton
0c77299c34 Merge branch 'feature/update_efuse_doc_v4.3' into 'release/v4.3'
doc/efuse: Adds efuse doc for ESP32-C3 (v4.3)

See merge request espressif/esp-idf!12516
2021-02-25 23:22:51 +00:00
KonstantinKondrashov
ea2eb9d833 doc(esp32c3): Updates secure features doc 2021-02-25 21:08:55 +08:00
KonstantinKondrashov
dec52a93d4 doc/efuse: Adds efuse doc for ESP32-C3 2021-02-25 21:07:27 +08:00
Michael (XIAO Xufeng)
1de12526eb spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND 2021-02-25 18:08:23 +08:00
Ivan Grokhotkov
57fb076590 Merge branch 'feature/prefer_python3_in_installer_v4.3' into 'release/v4.3'
tools: Prefer python3 during install and export (v4.3)

See merge request espressif/esp-idf!12376
2021-02-19 15:52:32 +00:00
KonstantinKondrashov
33820657c5 doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc 2021-02-16 15:37:26 +08:00
Roland Dobai
33892aadb9 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-14 18:49:21 +01:00
Krzysztof Budzynski
d9c004ad94 Merge branch 'docs/c3-devkitm-1' into 'master'
Add ESP32-C3-DevKitM-1 User Guide

See merge request espressif/esp-idf!12163
2021-02-05 14:00:21 +08:00
Wang Ning
aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +08:00
Angus Gratton
fe44643808 Merge branch 'bugfix/doc_freertos_smp_macros' into 'master'
docs: Update SMP descriptions for taskENTER_CRITICAL/taskEXIT_CRITICAL

Closes IDFGH-4428

See merge request espressif/esp-idf!12219
2021-02-05 08:14:50 +08:00
Angus Gratton
bc09dda0f4 docs: Update SMP descriptions for taskENTER_CRITICAL/taskEXIT_CRITICAL
Closes https://github.com/espressif/esp-idf/issues/6259
2021-02-05 10:18:23 +11:00
Jiang Jiang Jian
27100cc50e Merge branch 'docs/wifi_doc_update' into 'master'
update wifi docs

See merge request espressif/esp-idf!12232
2021-02-04 16:37:31 +08:00
Krzysztof Budzynski
cee0f466f0 Merge branch 'doc/extend_and_update_chip_series_comparison' into 'master'
Update chip series comparison by adding ESP32-C3 and fixing typos

Closes DOC-776

See merge request espressif/esp-idf!11964
2021-02-03 14:46:41 +08:00
Lv Xin Yue
48f806a54b Update chip series comparison by adding ESP32-C3 and fixing typos 2021-02-03 14:46:36 +08:00
Krzysztof Budzynski
213b5911a5 Merge branch 'bugfix/lwip_docs_delete_while_select' into 'master'
lw-IP: Add docs about not supported delete of task while blocked on select

Closes IDF-2675

See merge request espressif/esp-idf!12145
2021-02-02 16:16:34 +08:00
dongyou
fe76c53fec update wifi docs 2021-02-02 11:42:00 +08:00
Dai Zi Yan
5aaa0c9ca3 Provide CN translation for part of documents in MR11884 2021-02-02 09:19:58 +08:00
David Cermak
c17960312b lwip: Add docs about not supported delete of task while blocked on select 2021-02-01 09:50:59 +00: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
Michael (XIAO Xufeng)
9ff04b2e79 Merge branch 'feature/musical_buzzer' into 'master'
RMT example: musical buzzer

See merge request espressif/esp-idf!10346
2021-01-28 01:04:24 +08:00
Nachiket Kukade
8de3b31d2d FTM support for ESP32-C3 and connectionless mode
1. Support for FTM to work without any connection
1. Support for ESP32-C3 chip
3. Fix error case handling if FTM fails
4. Fix asynchronization, re-transmission related issues
2021-01-27 20:49:07 +05:30
Nachiket Kukade
acb1143409 Add support for FTM operation
Add FTM support for below configuration -
1. Station(connected) as Initiator with AP as responder
2. SoftAP as responder with the connected Station
Added Station example with runtime FTM configurations.
2021-01-27 10:57:41 +05:30
Angus Gratton
f7a8593a3b Merge branch 'style/python_isort_double_quote_fixer' into 'master'
style: format python files with isort and double-quote-string-fixer

See merge request espressif/esp-idf!12149
2021-01-27 12:25:39 +08:00
Krzysztof Budzynski
1faff89ff6 Merge branch 'feature/update_jtag_translation' into 'master'
doc: update JTAG translation

Closes IDF-2069

See merge request espressif/esp-idf!12107
2021-01-27 10:37:10 +08:00
Krzysztof Budzynski
9a5bd86d54 Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'
docs: update documents based on doc-855, doc-885, doc-889, doc-897

See merge request espressif/esp-idf!12124
2021-01-26 16:21:26 +08:00
Krzysztof Budzynski
5ca85248e3 Merge branch 'docs/update_docs_based_on_several_customer_feedbacks' into 'master'
docs: update documents based on doc-881, doc-856, doc-902, and doc-943

See merge request espressif/esp-idf!12118
2021-01-26 16:18:13 +08:00
Krzysztof Budzynski
6df0b98b8e Merge branch 'doc/api-guides-add-hypertargets' into 'master'
Add hypertargets to all TRM references

Closes DOC-713

See merge request espressif/esp-idf!11952
2021-01-26 16:15:29 +08:00
Krzysztof Budzynski
c9a4604fe2 Merge branch 'feature/update_esp32c3_rmt_doc' into 'master'
Update RMT/Sigma-Delta doc for ESP32-C3

Closes IDF-2341 and IDF-2345

See merge request espressif/esp-idf!12091
2021-01-26 14:29:33 +08:00
kirill.chalov
f634c59289 Add hypertargets to all TRM references 2021-01-26 05:51:52 +00:00
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00:00
Fu Hanxi
0146f258d7 style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
Wang Fang
7df1cad1d6 docs: This MR does the following updates:
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
morris
9788721de6 doc: update JTAG translation 2021-01-25 18:59:19 +08:00
Nachiket Kukade
1a85d64da8 Add QR Code display support
Add a component to support QR Code display required for
different types of provisioning.
2021-01-25 13:24:21 +05:30
Marius Vikhammer
3fd37d0b59 adc: change the way data is formattted in adc_dma_demo
The way the adc_dma_demo data was formatted caused it go get parsed as markdown syntax.

Changed it be more "human" readable as well as put all ADC examples in a common folder
2021-01-25 04:51:40 +00:00
morris
5fe6c9f8ab doc: update sigma-delta doc for esp32c3 2021-01-25 11:10:19 +08:00
morris
f1c7a3e06d doc: update rmt doc for esp32c3 2021-01-25 11:08:53 +08:00
Angus Gratton
a7da0c894b Merge branch 'feature/c3_master_flash_enc_support' into 'master'
flash encryption: merge C3 flash encryption changes to master

See merge request espressif/esp-idf!12040
2021-01-22 12:58:38 +08:00
Krzysztof Budzynski
18c441d798 Merge branch 'doc/uart_num_fix' into 'master'
docs: fix uart number naming error

Closes DOC-946

See merge request espressif/esp-idf!12067
2021-01-21 17:33:21 +08:00
Angus Gratton
fe8a891de9 Merge branch 'feature/support_esp32c3_master_cmake_secure_boot' into 'master'
bootloader/esp32c3: Support secure boot

Closes IDF-2115

See merge request espressif/esp-idf!11797
2021-01-21 08:42:49 +08:00
Marius Vikhammer
7a8a026b1d docs: fix uart number naming error 2021-01-20 15:48:34 +08:00
KonstantinKondrashov
98f726fa4b bootloader/esp32c3: Adds secure boot (not yet supported) 2021-01-19 20:51:13 +08:00
Ivan Grokhotkov
76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master'
tools: support for embedded Python

Closes IDF-322

See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
Juraj Michálek
1427b3a6d8 tools: support for embedded python 2021-01-18 08:10:56 +01:00
Marius Vikhammer
03fa63b0c9 bootloader: add flash encryption support for C3
Adds flash encryption support for C3 and updates docs for S2 & C3
2021-01-18 14:10:54 +08:00
Jiang Jiang Jian
8b33695495 Merge branch 'feature/support_esp32c3_s3_ble_5.0_and_bug_fix' into 'master'
Feature/support esp32c3 s3 ble 5.0 and bug fix

See merge request espressif/esp-idf!12007
2021-01-17 17:06:12 +08:00
zwj
7c1c669799 component/bt: add BLE v5.0 feature for bluedroid host 2021-01-15 17:55:12 +08:00
Angus Gratton
f0cfbc32c2 Merge branch 'bugfix/doc_cairo2svg_version' into 'master'
docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs

Closes IDFGH-4546

See merge request espressif/esp-idf!11894
2021-01-15 06:26:27 +08:00
morris
1969313b6f rmt: add musical buzzer example 2021-01-14 21:32:49 +08:00
Ivan Grokhotkov
8dcdca8d76 Merge branch 'feature/add-ability-to-disable-address-decoding' into 'master'
Add ability to disable address decoding using environment variable

Closes IDFGH-180

See merge request espressif/esp-idf!11795
2021-01-14 16:12:35 +08:00
daiziyan
2e3367b97e update api-guides/build-system.rst to keep EN and CN in sync 2021-01-13 19:23:30 +08:00
dependabot[bot]
88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs
Bumps [cairosvg](https://github.com/Kozea/CairoSVG) from 2.4.2 to 2.5.1.
- [Release notes](https://github.com/Kozea/CairoSVG/releases)
- [Changelog](https://github.com/Kozea/CairoSVG/blob/master/NEWS.rst)
- [Commits](https://github.com/Kozea/CairoSVG/compare/2.4.2...2.5.1)

Signed-off-by: dependabot[bot] <support@github.com>

Closes https://github.com/espressif/esp-idf/pull/6365
2021-01-13 19:41:16 +11:00
Michael (XIAO Xufeng)
3729a33c90 Merge branch 'docs/dac_dma_esp32s2' into 'master'
docs: updates the dac part on ESP32S2.

See merge request espressif/esp-idf!11821
2021-01-13 16:03:57 +08:00
Michael (XIAO Xufeng)
da2be51868 docs: updates the dac part on ESP32S2.
Closes https://github.com/espressif/esp-idf/issues/6333
2021-01-13 14:00:03 +08:00
Angus Gratton
e2910d2ff5 doc: Add libusb package dependencies for Arch, CentOS
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible

Related to https://github.com/espressif/esp-idf/issues/4095
2021-01-13 05:15:27 +00:00
mjdr
f12544a04e doc: Add libusb dependency for Ubuntu
Patch from https://github.com/espressif/esp-idf/pull/4669

Closes https://github.com/espressif/esp-idf/issues/4095
Related to https://github.com/espressif/esp-idf/issues/5181
2021-01-13 05:15:27 +00:00
Krzysztof Budzynski
e277d8ef23 Merge branch 'bugfix/esp_sntp_header' into 'master'
docs: Add esp_sntp to API reference as it's default idf header

Closes DOC-854

See merge request espressif/esp-idf!11796
2021-01-13 10:28:39 +08:00
David Čermák
76f6dd6214 lwip: Moved default SNTP API to esp_sntp.h
and make sntp.h in port folders of lwip component obsoleted
2021-01-13 10:28:34 +08:00
Martin Gaňo
8c0a3aa006 Add ability to disable address decoding using evironment variable
Closes https://github.com/espressif/esp-idf/issues/1679
2021-01-08 15:13:50 +01:00
Dai Zi Yan
694dd2767a update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 17:49:09 +08:00
Aditya Patwardhan
ca964dfbcc esp-tls: Changed default behaviour for esp-tls client ( for security
purpose)
        By default esp-tls client will now return error if no server verify option
        is provided, earlier it used to skip the verification by
        default.
        Added config option to skip server verification by default (for testing
        purpose)
        Updated required docs
2021-01-05 07:33:32 +00:00
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08:00
Wang Fang
cf505d0ead docs: update the documents based on customer feedbacks 2020-12-31 05:40:43 +00:00
Angus Gratton
641b92da75 Merge branch 'feature/add_c3_target_master' into 'master'
tools: merge C3 changes into master

Closes IDF-2364 and IDF-2564

See merge request espressif/esp-idf!11800
2020-12-30 10:39:14 +08:00
Marius Vikhammer
7fe16bae25 tools: merge C3 changes into master 2020-12-30 07:04:12 +08:00
Ivan Grokhotkov
de798541dc tools: use riscv32-esp-elf toolchain for ESP32-S2 RISC-V ULP
riscv32-esp-elf toolchain (used for ESP32-C3) can also be used for
ESP32-S2 RISC-V ULP coprocessor.

This removes the riscv-none-embed-gcc toolchain which was originally
used for the ULP, and updates the docs and CMake files to use
riscv32-esp-elf.

Some flags are cleaned up and workarounds removed from CMake toolchain
file.
2020-12-29 19:19:18 +00:00
Ivan Grokhotkov
7f3b16a99d freertos: always enable static allocation
to use it for newlib locks
2020-12-29 16:18:04 +01:00
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
Jiang Jiang Jian
1fdd83b1da Merge branch 'docs/wifi_wpa2-enterprise' into 'master'
docs:wifi: Add wifi_guide for wpa2_enterprise.

Closes WIFI-987

See merge request espressif/esp-idf!10402
2020-12-23 12:50:46 +08:00
Krzysztof Budzynski
8e4c73b1d1 Merge branch 'bugfix/minor_docs_fixes' into 'master'
minor docs fixes

See merge request espressif/esp-idf!11430
2020-12-21 11:31:00 +08:00
Michael (XIAO Xufeng)
35f82a3b30 Merge branch 'doc/clk_allocator_doc' into 'master'
I2C: update documents for introduction for clock allocator

Closes IDF-2377

See merge request espressif/esp-idf!11520
2020-12-18 00:35:38 +08:00
daiziyan
75c15293cc update CN translation 2020-12-17 19:26:05 +08:00
Krzysztof
37dc6044c3 docs: Add link to layout of ESP-WROVER-KIT board in DXF format 2020-12-17 19:26:05 +08:00
Cao Sen Miao
9a3f8edd95 i2c: update documents for introduction for clock allocator 2020-12-17 15:07:40 +08:00
aditi_lonkar
cd85c79d30 docs:wifi: Add wifi_guide for wpa2_enterprise.
Closes https://github.com/espressif/esp-idf/issues/2698
2020-12-17 10:41:41 +05:30
Wang Fang
8dbd5a48a8 provide user guide for the development board ESP32-PICO-DevKitM-2 2020-12-14 18:26:44 +08:00
Ivan Grokhotkov
46cfc436ad Merge branch 'feature/idf_tools_github_mirror' into 'master'
Add GitHub mirror option for IDF tools installs

Closes IDF-2028

See merge request espressif/esp-idf!10616
2020-12-14 15:58:51 +08:00
Krzysztof Budzynski
75d32ec051 Merge branch 'docs/upload_user_guide_for_esp32-pico-kit-1' into 'master'
ESP32-PICO-KIT-1 User Guide

See merge request espressif/esp-idf!10817
2020-12-11 20:41:43 +08:00
Angus Gratton
7472d76db0 Merge branch 'bugfix/after_ligth_sleep_esp_timer_forms_one_event' into 'master'
esp_timer: Add an option skip_unhandled_events

See merge request espressif/esp-idf!10969
2020-12-11 06:04:58 +08:00
KonstantinKondrashov
aa96c9a4d8 esp_timer: Add an option to skip unhandled events for periodic timers
- Added an option to skip unhandled events for periodic timers. Useful for light sleep.
- Added doc about this case
- Added Test a latency between a call of callback and real event (14-16us). and UT to check skip_unhandled_events.
- Fixed for esp_timer_dump() if name of timer is NULL
- Refactored timer_process_alarm()
- Added the delete function after using in UTs
2020-12-09 17:19:19 +08:00
Wang Fang
bdeb3a2fb6 upload user guide for development board: ESP32-PICO-KIT-1 2020-12-09 08:27:25 +00:00
daiziyan
0f3595b1e8 add CN translation for index.rst in get started section for MR10616 2020-12-07 16:36:37 +11:00
Sachin Parekh
be5563207d esp32: Provision to redirect .bss to external ram through linker fragments
Include external ram section in the linker template to process it
through linker script generation mechanism. This enables redirection of .bss section to external memory using linker fragments

libnet80211, libpp, libbt, liblwip: Redirect .bss through fragments
2020-12-04 06:32:38 +00:00
Krzysztof
1c184bd0be docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support 2020-12-03 16:21:16 +08:00
Angus Gratton
291af6e766 tools: Use GitHub download URLs for all files that can be downloaded from GitHub 2020-12-03 17:50:42 +11:00
Angus Gratton
4a738721f1 idf_tools: Add option to replace all GitHub tools download URLs with dl.espressif.com
Via new IDF_GITHUB_ASSETS environment variable.
2020-12-03 17:49:37 +11:00
Angus Gratton
820e092a8d Merge branch 'doc/remove_psram32' into 'master'
doc: Remove specific details about PSRAM32 & ESP32-D0

Closes IDF-2381

See merge request espressif/esp-idf!11352
2020-12-03 14:35:32 +08:00
Angus Gratton
d3dcde7fe1 doc: Remove specific details about PSRAM32 & ESP32-D0
There are now new variants of both PSRAM and ESP32 that are configured
differently, so refer users to the hardware datasheets for more information.
2020-12-03 16:25:22 +11:00
Krzysztof Budzynski
5f5ae17bc8 Merge branch 'feature/python2-deprecation-warn' into 'master'
Tools: Add Python 2 deprecation warning

Closes IDF-1677

See merge request espressif/esp-idf!11115
2020-12-02 19:26:46 +08:00
Ivan Grokhotkov
11ae1dcebe docs: fatal errors: mention another reason for LoadStoreError 2020-12-02 11:58:56 +01:00
daiziyan
33c414087b add CN translation for adding python2 deprecation warning(MR 11115) 2020-12-02 11:11:57 +01:00
martin.gano
f4ea2dcb74 Tools: add Python 2 deprecation warning 2020-12-02 11:08:48 +01:00
daiziyan
62f7a1b545 fix merge conflicts 2020-12-02 16:50:07 +08:00
Juraj Michálek
5a2d84324d docs: add ESP-IDF Windows Installation limitations. 2020-12-01 07:33:47 +01:00
Krzysztof Budzynski
b6645c7379 Merge branch 'doc/update_Chinese_translation_for_four_files_in_get-started_folder' into 'master'
updated Chinese translation for  four files in get-started folder

See merge request espressif/esp-idf!10927
2020-11-30 18:06:10 +08:00
Dai Zi Yan
8b63b35005 updated Chinese translation for eclipse-setup linux-setup macos-setup and windows-setup to get EN and CN in sync 2020-11-30 18:06:05 +08:00
Dai Zi Yan
c7bebb0413 Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 17:58:27 +08:00
dongyou
070eaea67e Add description for esp_wifi_set_inactive_time()
Add documentation to avoid using WiFi modem sleep for WiFi/BT coexistence
Remove description of unusable API esp_wifi_restart()
Update esp_now_fetch_peer discription
Update table format prblm for esp_wifi_set_max_tx_power()
Update description for ssid and password

Closes https://github.com/espressif/esp-idf/issues/6049
Closes https://github.com/espressif/esp-idf/issues/5759
Closes https://github.com/espressif/esp-idf/issues/5719
Closes https://github.com/espressif/esp-idf/issues/3762
2020-11-26 20:52:36 +08:00
Krzysztof Budzynski
82161dbdb5 Merge branch 'doc/update_Chinese_translation_for_index_in_get-started_folder' into 'master'
update CN translation for index & establish-serial-connection and add CN translation for VScode-setup to get EN and CN in sync

See merge request espressif/esp-idf!10903
2020-11-25 14:45:31 +08:00
Dai Zi Yan
c2818e775c Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync 2020-11-25 14:45:26 +08:00
Hao Ning
720e228dde add a chinese translation for wifi driver
add the first part translated by joy

add the last part translated by huizi

solved some formatting issues and typos in en text

add updated cn translation based on peer review comments

updated based on technical review comments

add links to api functions

solve pipeline errors

convert line endings in cn file

solve some build errors

reedit a table
2020-11-20 10:33:04 +08:00
Angus Gratton
6ce34a227e Merge branch 'feature/fatfs_fast_seek' into 'master'
feature/fatfs: enable the usage of fast-seek algorithm

See merge request espressif/esp-idf!9916
2020-11-17 07:17:31 +08:00
Krzysztof Budzynski
90c53b1a62 docs: Provide comparison of key features of ESP32 and ESP32-S2 chips 2020-11-16 19:08:24 +08:00
Renz Bagaporo
4cc6b5571b esp_system: support riscv panic 2020-11-13 07:49:11 +11:00
Angus Gratton
66fb5a29bb Whitespace: Automated whitespace fixes (large commit)
Apply the pre-commit hook whitespace fixes to all files in the repo.

(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
Krzysztof Budzynski
a1aed140a9 Merge branch 'doc/bluetooth_format_fix' into 'master'
docs: fix broken bullet list in BT chapter

See merge request espressif/esp-idf!11044
2020-11-09 12:16:53 +08:00
Angus Gratton
3882c2b8ed Merge branch 'feature/bringup_esp32s3_fpga_update_rmt_driver' into 'master'
rmt: support esp32s3

Closes IDF-1773

See merge request espressif/esp-idf!10292
2020-11-07 07:15:53 +08:00
Felipe Neves
ac6ce5ddbd docs: added some fast-seek documentation to the fatfs.rst 2020-11-06 13:18:16 -03:00
Ivan Grokhotkov
256333ca13 Merge branch 'ci/add_pre_commit_for_some_pre_check_jobs' into 'master'
CI: Add pre-commit for IDF project

See merge request espressif/esp-idf!10682
2020-11-06 20:16:27 +08:00
Ivan Grokhotkov
e9e6d970f3 Merge branch 'feature/add-shell-autocompletion' into 'master'
idf.py: Enable autocompletion for command idf.py

Closes IDF-1540

See merge request espressif/esp-idf!10742
2020-11-06 20:14:38 +08:00
Wang Ning
f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide
Update 1 based on comments

Fix typo

Add annotation to UFL connector

Add UFL connector to description table
2020-11-06 00:50:33 +00:00
morris
1be923acb4 rmt: rename always_on to aware_dfs 2020-11-05 19:00:55 +08:00
Krzysztof Budzynski
5a7f2ec81b Merge branch 'doc/target_specifc_doxygen_header' into 'master'
docs: change some header path to use IDF_TARGET

See merge request espressif/esp-idf!11016
2020-11-05 07:53:35 +08:00
Fu Hanxi
7ab18c7571 Fix windows error by upgrading pre-commit-hook version.
drop python 2.7 support. Now we only support python 3.6.1+
2020-11-04 10:24:42 +08:00
martin.gano
346b002d9a enable autocompletion for command idf.py 2020-11-03 23:27:58 +01:00
Fu Hanxi
e8dc27add2 add contributing docs 2020-11-03 18:33:11 +08:00
Angus Gratton
0fb8f86705 Merge branch 'doc/bootloader_compat' into 'master'
doc: Add note about bootloader version compatibility

Closes IDFGH-1692

See merge request espressif/esp-idf!10952
2020-10-30 15:10:27 +08:00
Marius Vikhammer
509d10b835 docs: fix broken bullet list in BT chapter 2020-10-29 16:05:06 +08:00
Marius Vikhammer
40012f6648 docs: change some header path to use IDF_TARGET
Some header path were using hardcoded esp32 paths, when they should be
target dependent.
2020-10-29 12:20:16 +08:00
Renz Bagaporo
79887fdc6c soc: descriptive part occupy whole component 2020-10-28 07:21:29 +08:00
Renz Bagaporo
988be69466 esp_hw_support: create component 2020-10-28 07:21:29 +08:00
Angus Gratton
ca7e777ed5 Merge branch 'doc/bootloader_override' into 'master'
doc: Add note about moving components or bootloader in an existing project

See merge request espressif/esp-idf!10819
2020-10-27 07:32:42 +08:00
Michael (XIAO Xufeng)
bcb5c3506d Merge branch 'feature/dedicated_gpio' into 'master'
Dedicated GPIO driver on ESP32-S2 and ESP32-S3

Closes IDF-1672

See merge request espressif/esp-idf!8716
2020-10-26 15:33:33 +08:00
Angus Gratton
52676974e4 doc: Add note about moving components or bootloader in an existing project
Based on some forum questions, i.e. https://esp32.com/viewtopic.php?f=13&t=16731&sid=107a5d613c97b68cf156b49579534c51
2020-10-26 16:41:24 +11:00
Angus Gratton
982d4be760 Merge branch 'bugfix/freertos_include_coreid' into 'master'
freertos: Fix include coreid regression, add new UT configs

See merge request espressif/esp-idf!10864
2020-10-22 16:58:51 +08:00
Angus Gratton
9a9af61cec doc: Add note about bootloader version compatibility 2020-10-22 19:47:45 +11:00
Angus Gratton
c51dca618a Merge branch 'feature/update_key_name_of_secure_boot' into 'master'
bootloader: Secure_boot name replaced by secure_boot_v1 & secure_boot_v2

Closes ESPTOOL-55

See merge request espressif/esp-idf!10849
2020-10-22 13:41:13 +08:00
Angus Gratton
8a70b1cdc9 ci freertos: Add test configs for some of the optional FreeRTOS 10 configurations
Also unit tests for the legacy hook functions.
2020-10-21 14:04:01 +11:00
morris
91cf7cc58d doc: dedicated gpio api reference 2020-10-20 21:06:10 +08:00
morris
153e819e8a pcnt: add rotary encoder example 2020-10-19 11:56:18 +08:00
Krzysztof Budzynski
bd7fecd396 Merge branch 'bugfix/ulp_doc_fixes' into 'master'
ULP: Update instruction set documentation for Esp32 and Esp32s2.

See merge request espressif/esp-idf!8560
2020-10-17 02:44:47 +08:00
Dmitry Yakovlev
0a8afd13a2 Udate instruction set documentation for Esp32 and Esp32s2.
Sleep instruction removed from S2 instruction set.
LDx/STx instructions descritioin fix offset range to 13 bits (11 bits signed 32 bit words offset).
Remove I2C RD/WR operations from S2.
2020-10-17 02:44:47 +08:00
Krzysztof Budzynski
114e4c220f Merge branch 'doc/power_management_esp32s2' into 'master'
docs: describe power management logic for ESP32-S2, fix translation

See merge request espressif/esp-idf!10525
2020-10-16 05:38:28 +08:00
KonstantinKondrashov
b19c4739c3 bootloader: Secure_boot name replaced by secure_boot_v1 & secure_boot_v2
- espefuse.py burn_key secure_boot is no longer used.
- Secure boot V1: espefuse.py burn_key secure_boot_v1 file.bin
- Secure boot V2: espefuse.py burn_key secure_boot_v2 file.bin
2020-10-15 16:48:23 +08:00
Krzysztof Budzynski
86d9428ae9 Merge branch 'feature/check_serial_macos' into 'master'
docs: Clarify how to establish a serial connection to the device using macOS

Closes DOC-574

See merge request espressif/esp-idf!10710
2020-10-15 15:26:46 +08:00
Krzysztof Budzynski
077bbb8647 docs: Clarify how to establish a serial connection to the device using macOS 2020-10-15 15:26:46 +08:00