daiziyan
65961ea892
docs: update CN trans for fatal-errors and unit-tests
2021-08-18 19:28:16 +08: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
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
e0acefbb78
docs: add docs to .bss and .noinit segments on spiram
2021-07-31 11:02:13 +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
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
daiziyan
e95893bb1b
docs: rename ESP-MESH to ESP-WIFI-MESH
2021-07-12 19:25:18 +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
daiziyan
e1ad9a1d20
docs:update CN translation for fatal-errors, external-ram, and idf-monitor
2021-06-21 18:05:18 +08: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
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
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
Marius Vikhammer
0c17973d54
docs: add rf calibration docs for S2 and C3
2021-05-26 10:09:50 +08: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
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
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
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
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
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
Roland Dobai
a2cf1a7d38
docs: Update JTAG debugging guides for ESP32-C3
2021-04-13 12:48:50 +02: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
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
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
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
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
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
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
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
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
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
Renz Bagaporo
f2561f6360
docs: update list of common component requirements
2021-02-24 12:16:37 +08:00
Omar Chebib
33deabb3ab
doc: update "Fatal Errors" chapter for ESP32C3 board
2021-02-23 14:54:26 +08:00
Marius Vikhammer
8c729fb55b
docs: fix broken ref in external-ram.rst
2021-02-20 12:37:59 +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
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
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
daiziyan
2e3367b97e
update api-guides/build-system.rst to keep EN and CN in sync
2021-01-13 19:23:30 +08: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
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
Marius Vikhammer
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
Ivan Grokhotkov
11ae1dcebe
docs: fatal errors: mention another reason for LoadStoreError
2020-12-02 11:58:56 +01: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
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
Mahavir Jain
20af94ff53
Coredump config option rename throughout IDF
2020-09-30 20:22:27 +05:30
Krzysztof Budzynski
068690e604
Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master'
...
docs: fix formatting issues in api-guides
Closes DOC-489, DOC-406, and DOC-487
See merge request espressif/esp-idf!10459
2020-09-24 15:30:33 +08:00
Wang Fang
00a99cfb9d
docs: fix formatting issues in api-guides
2020-09-24 15:30:28 +08:00
Angus Gratton
50e79e6763
Merge branch 'feature/switch_to_kconfiglib_package' into 'master'
...
tools: Use kconfiglib from package
Closes IDF-989
See merge request espressif/esp-idf!10535
2020-09-24 12:27:31 +08:00
Roland Dobai
883cbc416e
tools: Use kconfiglib from package
2020-09-22 11:29:30 +02:00
morris
9fa06719fa
global: enable build uinit test for esp32-s3
2020-09-22 15:15:03 +08:00
Lu Chang Jie
cd3cf630a5
Test: merge ble mesh node and provioner in console
2020-08-21 11:01:37 +08:00
He Hui Zi
dfa59e3d22
docs: translate api-guides/ulp-risc-v from EN to CN
2020-08-13 19:44:46 +08:00
Angus Gratton
a2dc60b254
Merge branch 'feature/secure_boot_esp32s2' into 'master'
...
Feature/secure boot esp32s2
See merge request espressif/esp-idf!8254
2020-07-28 16:39:34 +08:00
Supreet Deshpande
33979a9361
Docs: Secure boot v2 support for ESP32-S2
2020-07-27 00:01:10 +00:00
morris
e6a94e982c
docs: translate idf.py debug target
2020-07-24 15:59:11 +02:00
Ivan Grokhotkov
a3eb4d85d4
docs: jtag-debugging: update Chinese version
2020-07-24 15:58:59 +02:00
Ivan Grokhotkov
4ff2750d9f
docs: add placeholders for {esp32,esp32s2}.inc in JTAG debugging guide
2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
962ea8b9f2
docs: repurpose WROVER-KIT debugging guide for Kaluga-1
2020-07-24 15:54:47 +02:00
Felipe Neves
b6dba84323
ulp: added support to building code for riscv ULP coprocessor
2020-07-15 15:28:49 -03:00
Ivan Grokhotkov
5985c07ab7
docs: add section about USB CDC console
2020-06-26 15:38:49 +02:00
Wang Fang
256571a4f4
fix the formatting issues described in DOC-257
2020-06-24 02:47:12 +00:00
Darian Leung
e61bbbcb61
Add HAL and LL documentation
...
This commit adds docuemntation regarding Hardware
Abstraction in ESP-IDF.
2020-06-04 15:02:49 +08:00
Marius Vikhammer
67ea59d605
docs: fix check_docs not working for multiple builders
...
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.
Closes IDF-1659
2020-05-29 20:10:18 +08:00
Krzysztof Budzynski
95ed99671b
Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
...
espcoredump: apply documentation changes in core_dump.rst file
See merge request espressif/esp-idf!5697
2020-05-28 02:25:47 +08:00
Alex Lisitsyn
e649a4f017
espcoredump: apply temporary documentation changes in core_dump.rst file
...
added picture to describe bin and elf format of core dump
added link to core_dump_internals.rst file from main one
added the diagram to describe logic structure of core dump modules and dependencies
2020-05-28 02:25:46 +08:00
Island
fbf2088fc8
Merge branch 'example/ble_mesh_structural_adjust' into 'master'
...
Example/ble mesh structural adjustment
Closes BLEMESH-200
See merge request espressif/esp-idf!8719
2020-05-21 15:11:23 +08:00
lly
88eb4a0820
ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_*
2020-05-20 11:33:46 +00:00
Marius Vikhammer
fbb54184ef
doc: add generation of tags from sdkconfig and x_caps.h headers
...
Also updates the way we handle exclude_patterns to use the new tags
Closes IDF-1484
2020-05-13 07:09:01 +00:00
Alexey Gerenkov
b441df7cf1
docs: Fixes OpenOCD debug level option
2020-05-07 16:02:13 +03:00
Angus Gratton
f9552baf97
Merge branch 'feature/dfu_build_flash_s2' into 'master'
...
Add build system support for programming ESP32-S2 using DFU utils
Closes IDF-579
See merge request espressif/esp-idf!8294
2020-05-04 14:57:51 +08:00
Krzysztof Budzynski
39c5db4c38
Merge branch 'bugfix/make_docs_ldgen' into 'master'
...
docs: remove quotes in ldgen documentation for adding fragment file
See merge request espressif/esp-idf!8501
2020-05-04 03:22:59 +08:00
Roland Dobai
ab9f714248
Add build system support for programming ESP32-S2 using DFU utils
2020-04-30 07:59:18 +02:00
Renz Bagaporo
da91172616
docs: remove quotes in ldgen documentation for adding fragment file
...
Closes https://github.com/espressif/esp-idf/issues/5142
2020-04-27 15:22:38 +08:00
lly
2f6a4140fa
doc: Fix some ble mesh description
2020-04-26 06:22:33 +00:00
Angus Gratton
4358f3b573
doc: Add warnings about using JTAG debugging with hardware security features
...
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-01 17:36:08 +11:00
liying
572ef008a9
Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code
2020-03-29 16:50:40 +00:00
Wang Ning
168a623a07
Add translation for linker script generation
2020-03-26 00:48:58 +08:00
Wang Ning
3784d499af
Add translation for ota tool and partation tool
2020-03-25 21:44:33 +08:00
Ivan Grokhotkov
35560cb538
Merge branch 'doc/fix_example_links' into 'master'
...
doc: Fix invalid links
Closes DOC-67 and DOC-69
See merge request espressif/esp-idf!8065
2020-03-23 21:17:20 +08:00
Angus Gratton
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
Anton Maklakov
8046df875e
docs: Fixup format of a command line to build unit tests
2020-03-19 19:28:46 +07:00
Angus Gratton
207914a13a
Merge branch 'refactor/common_code_panic_handler' into 'master'
...
Panic handling common code refactor
See merge request espressif/esp-idf!7489
2020-03-19 11:23:57 +08:00
Natasha
ee0ae607da
Add translation for mesh document under api guide
2020-03-17 01:02:36 +08:00
Ivan Grokhotkov
b497819667
docs: update esp32s2 summary page
...
- Refer to the toolchain links on IDF Tools page
- Update the wording around v4.1/v4.2 releases
- Remove the section about 3 different versions (of S2-beta)
- Add link to the list of features maintained externally
2020-03-16 14:40:37 +11:00
Renz Christian Bagaporo
20cfc2ecdd
docs: update docs with panic handler changes
2020-03-10 19:56:24 +08:00
morris
46ea7d815d
parttool: don't print target name
2020-03-09 15:05:04 +08:00
Marius Vikhammer
9b56892bfe
doc: fix broken .. only:: in JTAG guide
...
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
Mahavir Jain
5f897fd33c
Merge branch 'feat/secure_boot_v2_v41' into 'master'
...
feat/secure_boot_v2: Adding secure boot v2 support to ESP32-ECO3
Closes IDF-799
See merge request espressif/esp-idf!6778
2020-02-27 18:54:08 +08:00
lly
7cd08b5824
ble_mesh: Miscellaneous modifications
...
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-02-26 17:37:44 +08:00
Supreet Deshpande
073ba0a608
feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3
2020-02-25 01:28:22 +05:30
Angus Gratton
3b498a0576
Merge branch 'bugfix/confserver_hex_types' into 'master'
...
confserver: Standardize and document the handling of hex values
See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Ivan Grokhotkov
75d0f38108
Merge branch 'doc/unit_test_multiple_targets' into 'master'
...
doc: add multi-target rules for writing unit tests
See merge request espressif/esp-idf!7438
2020-02-18 23:30:02 +08:00
Angus Gratton
e95ba301d8
Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master'
...
ulp: use quotes when specifying files for embedding ulp binaries
See merge request espressif/esp-idf!7606
2020-02-18 09:15:50 +08:00
Renz Christian Bagaporo
bb639bb91d
ulp: use quotes when specifying files for embedding ulp binaries
2020-02-18 00:12:56 +00:00
Angus Gratton
99cdddeb63
docs: Fix broken or incorrect link roles to IDF files & directories
2020-02-18 10:34:11 +11:00
Angus Gratton
d9d7a906b1
confserver docs: Merge the build-system docs info about confserver into the README
...
Add link into the README from the docs
2020-02-17 17:21:22 +11:00
Tian Yang Min
63ed8a4aed
docs: Add Chinese translation for esp-ble-mesh-faq
...
This commit adds the Chinese translation for the
esp-ble-mesh-faq document.
2020-02-17 04:58:56 +08:00
Michael (XIAO Xufeng)
699c6db836
doc: add multi-target rules for writing unit tests
2020-02-14 14:54:30 +08:00
suda-morris
75cadc2e41
console: simplify examples
...
1. simplify console examples
2. add "quit" command
3. support console command overwrite
4. add API reference
2020-02-07 20:15:06 +08:00
Angus Gratton
eb85cfb9f6
docs: Temporarily mark RF calibration chapter as ESP32 only
...
Can be re-enabled once ESP32-S2 calibration support is added
2020-02-07 16:37:45 +11:00
Angus Gratton
11fac8637a
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c
Replace all TRM urls will generic template variable and remove duplicate sections
...
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +11:00
Marius Vikhammer
1a90470f02
doc: Split HW-Reference into seperate files/folders for different chips
2020-02-07 16:37:44 +11:00
Marius Vikhammer
cfeb9e68cb
doc: Changed Chinese doc to use dynamic chip name
2020-02-07 16:37:43 +11:00
Marius Vikhammer
a7bac4721a
doc: Add external ram note link to CN translation
2020-02-07 16:37:43 +11:00
Angus Gratton
66462ca26f
docs: Apply the same basic ESP32/ESP32-S2 warning filters to Chinese docs
2020-02-07 16:37:43 +11:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
Krzysztof Budzynski
ac27ab29fd
doc: Fix broken links to examples
2020-01-20 12:10:18 +08:00
Angus Gratton
13f67d4279
doc: Remove duplicate ulp-cmake
...
This file was renamed in 62ed221
when CMake became default, but 8fe3ecd
accidentally reintroduced it.
A redirect is still generated from ulp-cmake to ulp, so the old URL continues to work.
2020-01-10 16:38:06 +11:00
Tian Yang Min
666337eb7a
Add Chinese translation for ble-mesh-architecture; add a link for ble-mesh-architecture-en.
2019-12-18 14:37:09 +08:00
Tian Yang Min
2b589fbabd
Add Chinese translation for esp-ble-mesh-index.
2019-12-18 14:34:56 +08:00
Tian Yang Min
ee93da1826
Add Chinese translation for esp-ble-mesh-terminology. Add link to Chinese version in English original text.
2019-12-18 14:34:01 +08:00
Dmitry Yakovlev
8fe3ecd000
Added description for difference between ESP32 ULP and ESP32-S2 ULP
...
Jumpr instruction updated.
2019-12-13 18:38:57 +08:00
Hao Ning
8070746530
add updates to some files in api guides
...
modified errors in making html
add modifications based on the first review
modified grammar problems of the original text
2019-12-05 15:12:12 +08:00
Anton Maklakov
def05480b8
docs: Fix up some OpenOCD cmdline-s
2019-11-26 19:44:22 +08:00
Ivan Grokhotkov
477e66103c
Merge branch 'feature/esp32s2beta_apptrace_port' into 'master'
...
esp32s2: Adds apptrace support
Closes IDF-510 and IDF-1032
See merge request espressif/esp-idf!5610
2019-11-22 05:33:35 +08:00
Alexey Gerenkov
1626f827d3
docs: Updates OpenOCD configuration file names
2019-11-18 13:33:32 +03:00
Alexey Gerenkov
30ff7198b8
apptrace: Renames Kconfig options
2019-11-13 15:24:01 +03:00
lly
7fde866d8c
doc: fix wrong title of ble mesh terminology
2019-10-31 17:06:17 +08:00
Krzysztof Budzynski
2c3548b65e
Provide BLE Mesh documentation
2019-10-30 17:01:18 +08:00
Angus Gratton
7016cb8864
Merge branch 'doc/add_doc_for_socket_error_usage' into 'master'
...
doc: add LW-IP socket error usage
See merge request espressif/esp-idf!5856
2019-10-17 06:17:34 +08:00
ronghulin
4e1ccd8b6f
doc: add LWIP socket error usage
2019-10-11 12:09:10 +08:00
Angus Gratton
f44d99b509
app_update: Remove deprecated "make erase_ota" target
...
Deprecated in v3.2
2019-09-13 09:44:07 +10:00
suda-morris
43b29e4f4d
doc: update translation of ulp install instuctions
2019-08-21 21:52:48 +08:00
Ivan Grokhotkov
02c7c3885e
Merge branch 'bugfix/openocd_ulp_install_instructions' into 'master'
...
docs: jtag-debugging: update for IDF Tools installation method
Closes IDF-824
See merge request espressif/esp-idf!5803
2019-08-20 21:34:45 +08:00
suda-morris
7237e6fab7
docs: jtag-debugging: update translation
2019-08-20 14:49:48 +02:00
Ivan Grokhotkov
209fdc1e05
docs: jtag-debugging: update for IDF Tools installation method
...
- rely on OPENOCD_SCRIPTS variable in all cases, remove -s flags
- replace installation section with a reference to the Getting Started
guides
- add Windows-specific commands in a few cases
2019-08-20 14:49:48 +02:00
suda-morris
ab406f8429
zh_CN translation of bootloader document
2019-08-19 11:37:59 +08:00
Ivan Grokhotkov
83277fe0f2
docs: add tools section and IDF docker image page
2019-07-18 06:18:04 +00:00
Angus Gratton
05ac8cfb6d
docs: Update description for Eclipse+Cmake support not ready yet
2019-07-09 14:32:26 +10:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Angus Gratton
47bbb107a8
build system: Use CMake-based build system as default when describing commands
2019-07-08 17:31:27 +10:00
suda-morris
471f4b2f0e
zh_CN translation of fatal_error
2019-07-04 14:01:53 +08:00
Wang Fang
b24341a664
Merge make-related documents:
...
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Roland Dobai
f56b7d4a1d
tools: Accept CTRL-T + A for app-flash in idf_monitor
...
"CTRL-A" cannot be captured in Windows command line, so "A" can be used
instead.
2019-06-27 12:21:09 +02:00
Wang Fang
9fbb27b194
Add Chinese translation for exteral-ram.rst in api-guides:
...
- The draft should be first reviewed by Technical Reviewers;
- Then by Language Reviewer.
2019-06-26 19:59:21 +08:00
Jiang Jiang Jian
291e25baa6
Merge branch 'bugfix/btdm_add_readme_for_BLE_demos' into 'master'
...
Component/bt: add readme doc for BLE demos
See merge request idf/esp-idf!4890
2019-06-26 16:04:28 +08:00
Angus Gratton
a54a3fc92e
Merge branch 'bugfix/idfpy_print_filter' into 'master'
...
tools: Port the filtering option of IDF Monitor to the idf.py toolchain
Closes IDF-543
See merge request idf/esp-idf!4416
2019-06-25 13:36:03 +08:00
zhiweijian
4d8a46b376
component/bt: add readme doc for BLE demos
...
- Closes:https://github.com/espressif/esp-idf/issues/3341
2019-06-17 07:05:41 +00:00
Sergei Silnov
a77f01ec9d
Update order of arguments for idf.py in docs
2019-06-14 19:51:39 +02:00
Roland Dobai
da978bc5a1
tools: Port the filtering option of IDF Monitor to the idf.py toolchain
2019-06-14 17:45:20 +02:00
Angus Gratton
eac356ef4a
Merge branch 'feature/idf_version_header' into 'master'
...
esp_common: add esp_idf_version.h header to define IDF version
Closes IDF-253
See merge request idf/esp-idf!4596
2019-06-13 09:41:35 +08:00
Wang Fang
a37ec9bae6
add translation for ulp cmake
...
fix formatting
update translation
update translation
formatting
2019-06-11 01:48:36 +08:00
Natasha
96db6f906a
Docs/update idf monitor
2019-05-29 18:11:40 +08:00
Renz Christian Bagaporo
b3b6ce2eea
docs: remove reference of using link groups
2019-05-28 13:01:43 +08:00
Roland Dobai
6c0a7a66f3
Rename Kconfig options (components/app_trace)
2019-05-21 09:32:55 +02:00
Roland Dobai
c5000c83d2
Rename Kconfig options (root)
2019-05-21 09:09:01 +02:00
Ivan Grokhotkov
6ca07eca68
esp_common: add version definitions in code and build system
...
Closes https://github.com/espressif/esp-idf/issues/2482
Closes IDF-253
2019-05-20 13:14:56 +08:00
Renz Christian Bagaporo
ee92352bf8
docs: update with build system changes
2019-05-13 19:57:39 +08:00
Renz Christian Bagaporo
c6dc47b3e2
cmake: build system changes
2019-05-13 19:57:39 +08:00
Ivan Grokhotkov
6890ea09cd
docs: add event handling API guide
2019-04-11 12:04:58 +08:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Ivan Grokhotkov
bf5e3de955
Merge branch 'doc/app_trace_zh_CN' into 'master'
...
zh_CN translation of app_trace
See merge request idf/esp-idf!4087
2019-03-21 18:58:32 +08:00
Ivan Grokhotkov
416b756ea4
Merge branch 'bugfix/name_conflict_esp32_project_ld' into 'master'
...
esp32: Rename esp32.common.ld to esp32.project.ld to avoid build errors when downgrading
See merge request idf/esp-idf!4484
2019-03-15 11:42:20 +08:00
Angus Gratton
a79c5b8271
esp32: Rename esp32.common.ld to esp32.project.ld to avoid build errors when downgrading
...
Linker script generator produces build/esp32/esp32.common.ld from
components/esp32/ld/esp32.common.ld.in
This works fine until IDF is downgraded to V3.1 which uses components/esp32/ld/esp32.common.ld and
doesn't track build/esp32/esp32.common.ld at all.
At this point, the linker runs in the build/esp32 directory and "-T esp32.common.ld" picks up the
linker script generated .ld file, which causes mis-builds.
As reported on forums: https://esp32.com/viewtopic.php?f=13&t=9684&p=40105
2019-03-14 09:59:31 +11:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00
Angus Gratton
79ca95ddf6
Merge branch 'doc/jtag_debug_zh_CN' into 'master'
...
zh_CN translation of JTAG debugging
See merge request idf/esp-idf!3709
2019-03-11 16:35:04 +08:00
Wang Fang
19939e5b60
zh_CN translation of build system (cmake version)
2019-03-05 15:02:48 +08:00
morris
94e5fba46b
doc: zh_CN translation of linker script generation
...
Translate linker-script-generation to zh_CN.
2019-02-26 10:22:30 +08:00
zhuying
61839fc4a5
esp-idf | revise app_trace EN version
2019-01-30 11:39:23 +08:00
morris
fb2ebb19c6
translate app_trace to zh_CN
2019-01-30 11:35:15 +08:00
zhuying
5b938199ab
doc(esp-idf) | JTAG debugging EN update
2019-01-30 11:34:04 +08:00
morris
7ffd0f95d2
doc/jtag_debug: translation of jtag debugging
...
translate JTAG Debugging to zh_CN
2019-01-30 11:34:04 +08:00
krzychb
f675334ebb
Included missing links between English and Chinese documentation, where translation into Chinese is available
2019-01-27 19:01:34 +01:00
He Yin Ling
783cb692e8
unit-test-app: support passing parameter with signals
2019-01-10 09:51:17 +00:00
Jiang Jiang Jian
e07c5a22f2
Merge branch 'doc/RF_calibration' into 'master'
...
doc: add documentation for RF calibration
See merge request idf/esp-idf!3828
2018-11-30 21:50:29 +08:00
Xia Xiaotian
59761b0fcb
doc: add documentation for RF calibration
...
Add an API to erase phy namespace of NVS
2018-11-30 16:26:56 +08:00
morris
8dc66d3f0f
doc: translate part of build-system
...
Translate the make_size part in build system.
2018-11-30 12:29:38 +11:00
Angus Gratton
8915f48208
Merge branch 'feature/linker_script_generator' into 'master'
...
Linker script generator
See merge request idf/esp-idf!2286
2018-11-19 12:43:27 +08:00
Krzysztof Budzynski
6fbc3c4361
Added wireshark instruction to provide a common workflow for users submitting diagnostic data for Wi-Fi troubleshooting
2018-11-16 14:44:58 +08:00
Renz Bagaporo
63411fc556
tools: implement linker script generation
2018-11-16 12:42:02 +08:00
morris
71b9720309
doc/console: translate console.rst into zh_CN
2018-11-07 17:27:15 +08:00
liying
9894d35839
(doc)update_CN/EN_partition_tables
2018-11-05 18:58:54 +08:00
morris
d61680b211
doc/partition-tables: translation of zh_CN
...
1. Translated partition-tables.rst into Chinese.
2. Fixed some error in the English version.
2018-11-05 18:58:22 +08:00
Renz Bagaporo
cc774111bf
cmake: Add support for test build
2018-10-20 12:07:24 +08:00