Commit Graph

763 Commits

Author SHA1 Message Date
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
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
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00: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
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
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
daiziyan
2e3367b97e update api-guides/build-system.rst to keep EN and CN in sync 2021-01-13 19:23:30 +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
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
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