Commit Graph

2288 Commits

Author SHA1 Message Date
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
Angus Gratton
bc7e00896e docs: Add docs for Secure Boot V2 "verify on update without secure boot" 2021-03-15 12:30:20 +00:00
Marius Vikhammer
91439e3818 docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
Krzysztof Budzynski
aa3791b929 Merge branch 'doc/update_CN_translation_for_API_guides' into 'master'
updated CN translation for api-guides

See merge request espressif/esp-idf!12506
2021-03-15 05:01:24 +00: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
Renz Bagaporo
0cbf662ca3 docs: fix error on ldgen generated symbol with SURROUND 2021-03-13 19:37:04 +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
Marius Vikhammer
4e9d810dfb Docs: build doc with new layout for target and version select 2021-03-12 16:15:56 +08:00
Krzysztof Budzynski
4e06cbb1b3 Merge branch 'doc/c3_ledc_programming_guide' into 'master'
[doc]: Adjusted LEDC docs for C3

See merge request espressif/esp-idf!12509
2021-03-12 03:24:14 +00: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
fd164b82b6 Merge branch 'refactor/move_from_xtensa' into 'master'
Movements from xtensa

Closes IDF-2164

See merge request espressif/esp-idf!10556
2021-03-11 00:24:25 +00:00
Angus Gratton
49a52ec991 Merge branch 'feature/ldgen_flags_internals_doc' into 'master'
ldgen: additional docs

Closes IDF-2821

See merge request espressif/esp-idf!12599
2021-03-10 23:51:05 +00:00
Krzysztof Budzynski
9a240c5ac7 Merge branch 'bugfix/fix-typo-esp32-wrover-kit-docs' into 'master'
docs: Fix typo in ESP32-WROVER-KIT documentation

See merge request espressif/esp-idf!12458
2021-03-10 06:06:48 +00:00
Renz Bagaporo
ed186e22e7 docs: ldgen flags docs
Closes https://github.com/espressif/esp-idf/issues/4612
2021-03-09 18:57:53 +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
Angus Gratton
738b07fe63 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:28:52 +11:00
Gustavo Henrique Nihei
68b66aeee9 docs: Fix typo in ESP32-WROVER-KIT documentation 2021-03-08 14:41:20 -03:00
Angus Gratton
70e13752ae Merge branch 'feature/rtc_time_get' into 'master'
rtc: Clean up for S2,S3,C3

Closes IDF-2569

See merge request espressif/esp-idf!12336
2021-03-05 01:16:15 +00: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
Jakob Hasse
5e5e5c8753 [doc]: Corrected C3 LEDC docs 2021-03-03 16:49:05 +08:00
Angus Gratton
772b218c38 docs: Add section about assertions to the style guide 2021-03-03 10:31:05 +11: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
Shubham Kulkarni
7f8541ff47 esp_https_ota: Add support for partial image download
Fix issue where binary_file_length field is greater than original image length
2021-03-01 14:00:27 +00:00
KonstantinKondrashov
b31bf01484 rtc: Clean up for S2,S3,C3 2021-03-01 16:51:15 +08: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
David Čermák
00432fa2c3 Merge branch 'feature/update_mqtt_test_url' into 'master'
Feature/update mqtt test url

See merge request espressif/esp-idf!12473
2021-02-26 16:09:38 +00:00
Renz Bagaporo
0f03f450ff esp_hw_support: create esp_cpu
Create a esp_cpu header that contains CPU-related functions and
utilities.
2021-02-26 13:34:29 +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
Angus Gratton
501af6dfa2 Merge branch 'feature/secure_boot_revoke_check' into 'master'
secure_boot: Checks secure boot efuses

Closes IDF-2609

See merge request espressif/esp-idf!12148
2021-02-25 22:38:42 +00:00
Michael (XIAO Xufeng)
eb29d8dbda Merge branch 'feature/support_invert_rmt_signal_in_gpio_matrix' into 'master'
rmt: support inverting signal in gpio matrix

Closes IDF-2762

See merge request espressif/esp-idf!12420
2021-02-25 11:14:19 +00: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
morris
efa92cb204 rmt: support invert RMT signal by GPIO matrix 2021-02-25 12:42:23 +08: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
David Čermák
5f0aa46cbf Merge branch 'feature/seperate_ipv6_function_from_ipv4' into 'master'
Add LWIP_IPV6 macro to strip IPv6 function

See merge request espressif/esp-idf!11977
2021-02-24 11:20:53 +00:00
Krzysztof Budzynski
d91192db95 Merge branch 'docs/windows_unit_testing' into 'master'
Add note about unit testing on Windows

See merge request espressif/esp-idf!12385
2021-02-24 08:29:04 +00:00
Renz Bagaporo
f2561f6360 docs: update list of common component requirements 2021-02-24 12:16:37 +08:00
Renz Bagaporo
813044c6db docs, ci: update docs and ci with movements from esp_common 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
Michael (XIAO Xufeng)
db1c635db4 Merge branch 'feature/esp32c3_rtc_temp_calibration' into 'master'
temperature_sensor: calibration for esp32c3

Closes IDF-2502

See merge request espressif/esp-idf!12158
2021-02-24 03:27:49 +00:00
Michael (XIAO Xufeng)
26be097431 Merge branch 'feature/touch_sense_api_reference' into 'master'
touch_element: add touch element lib api-reference doc

Closes IDF-2666

See merge request espressif/esp-idf!11827
2021-02-24 03:00:10 +00:00
yuanjm
f430e54c5a doc: Add description for CONFIG_LWIP_IPV6 in api-guides 2021-02-23 18:28:47 +08:00
yuanjm
6019c22092 doc: Update mqtt open source test server address 2021-02-23 15:30:06 +08:00
Omar Chebib
33deabb3ab doc: update "Fatal Errors" chapter for ESP32C3 board 2021-02-23 14:54:26 +08:00
Angus Gratton
fb1488abba Merge branch 'feature/esp_timer_isr_dispatch_method_restore' into 'master'
esp timer: Add ISR dispatch method

Closes IDF-1172 and IDF-1173

See merge request espressif/esp-idf!11572
2021-02-23 06:21:14 +00:00
Cao Sen Miao
85855ad8a6 temp_sensor: add calibration for esp32c3 2021-02-23 10:48:17 +08:00
KonstantinKondrashov
90f2d3199a secure_boot: Checks secure boot efuses
ESP32 V1 and V2 - protection bits.
ESP32xx V2: revoke bits, protection bits

- refactor efuse component
- adds some APIs for esp32 chips as well as for esp32xx chips
2021-02-23 03:56:21 +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
Krzysztof Budzynski
7fde891681 Merge branch 'doc/win_inst_offline' into 'master'
docs: add links to Windows installer 2.5 Offline and Online versions

Closes DOC-1046

See merge request espressif/esp-idf!12242
2021-02-19 02:58:10 +00:00
Krzysztof Budzynski
6fc1a7e5e9 Merge branch 'doc/twai_time_quatum' into 'master'
TWAI: Fix doc grammar of time quantum

Closes IDFGH-4748

See merge request espressif/esp-idf!12406
2021-02-19 02:10:44 +00:00
Dai Zi Yan
97ec83fa78 Provide CN translation for get-started section in MR12242 2021-02-18 15:16:58 +01:00
Juraj Michálek
419673fa96 docs: add links to Windows installer 2.5 Offline and Online versions 2021-02-18 15:16:58 +01:00
Krzysztof Budzynski
a845b1bb51 Merge branch 'feature/add_links_to_new_documentation' into 'master'
docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips

See merge request espressif/esp-idf!12344
2021-02-18 10:48:57 +00: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
Krzysztof
5a8a6c8fff docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips 2021-02-18 18:08:58 +08:00
Christoph Rackwitz
c2e940e04c
singular form of quanta is quantum
it's like bacteria/bacterium, phenomena/phenomenon
2021-02-16 18:02:30 +01:00
Michael (XIAO Xufeng)
4f1ef535c1 Merge branch 'docs/reorder_public_headers' into 'master'
docs: reorder the sequence of headers

See merge request espressif/esp-idf!12310
2021-02-16 13:52:28 +00:00
Angus Gratton
8c195a7a17 Merge branch 'feature/ulp_c3_not_exists_update_doc' into 'master'
doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc

Closes IDF-2318 and IDF-2331

See merge request espressif/esp-idf!12347
2021-02-15 23:09:54 +00:00
Tomas Rezucha
1814a1d9f6 Add note about unit testing on Windows 2021-02-15 13:36:59 +01: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
David Cermak
4051922885 esp_netif: Update documentation on deinitialization of wifi default netif
Closes https://github.com/espressif/esp-idf/issues/6504
2021-02-10 13:28:36 +00:00
KonstantinKondrashov
aa581aba0f doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc 2021-02-10 18:15:04 +08:00
KonstantinKondrashov
63d4911cdb esp_timer: Add ESP_TIMER_ISR dispatch method
Using own spinlock for each list (TASK and ISR disp method)
Reduced the dependency of ISR on the TASK dispatch method
2021-02-08 19:10:11 +08: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
Michael (XIAO Xufeng)
2c661df09d docs: reorder the sequence of headers
This can makes the public headers more obvious
2021-02-06 20:52:28 +08: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