Commit graph

1051 commits

Author SHA1 Message Date
Krzysztof Budzynski ad9e514ff4 Merge branch 'doc/documenting_code_format_fix' into 'master'
docs: change descriptions of substitution defines to use literal blocks

See merge request espressif/esp-idf!8699
2020-05-14 15:03:41 +08:00
Krzysztof 789c42abcd Add another case and recomendation to use Python 3 instead of Python 2 2020-05-13 21:57:51 +02:00
Roland Dobai 6aaff0887b Update DFU flashing with fixes and known issues 2020-05-13 15:40:55 +02:00
Kirill Chalov 2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit 2020-05-13 07:12:42 +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
Marius Vikhammer 6d56ac8b84 docs: change descriptions of substitution defines to use literal blocks
Copy-pasting the "local substitution" example would result in an error,
due to the ASCII quotation marks being replaced by unicode double quotation marks
when outputting the HTML.
2020-05-12 11:32:34 +08:00
Wang Ning 8b8d03f7bd Update Build and Flash with Eclipse IDE to make terminology consistent 2020-05-11 16:51:30 +08:00
Marius Vikhammer 27fa1dc0dd doc: add peripheral_types.h as API reference for peripheral docs
Closes DOC-136
Closes IDF-1673
2020-05-11 11:20:39 +08:00
Krzysztof Budzynski e30185c166 Merge branch 'docs/fix_oocd_debug_level_opt' into 'master'
docs: Fixes OpenOCD debug level option

See merge request espressif/esp-idf!8646
2020-05-08 16:31:36 +08:00
Krzysztof Budzynski f318dab0ad Merge branch 'doc/review_security-flash-encryption' into 'master'
Review security/flash-encryption.rst

See merge request espressif/esp-idf!7672
2020-05-08 03:31:29 +08:00
Alexey Gerenkov b441df7cf1 docs: Fixes OpenOCD debug level option 2020-05-07 16:02:13 +03:00
Valerii Koval bc397f8b7d Add new section about using ESP-IDF with PlatformIO
This adds a description of PlatformIO ecosystem, tutorials, examples

Merges https://github.com/espressif/esp-idf/pull/5132
2020-05-06 12:55:22 +02:00
Krzysztof Budzynski 9b309a0a97 Merge branch 'bugfix/doc_fix_dfu' into 'master'
docs: Fix and extend the DFU documentation page

See merge request espressif/esp-idf!8602
2020-05-06 05:17:12 +08:00
Ivan Grokhotkov b0f448a972 Merge branch 'feature/console_no_empty_lines' into 'master'
console: allow not returning empty lines (Github PR)

Closes IDFGH-2869

See merge request espressif/esp-idf!8232
2020-05-05 16:12:50 +08:00
Roland Dobai 00d638f4d6 docs: Fix and extend the DFU documentation page 2020-05-04 18:02:01 +02:00
Felipe Neves 6f5e43e26a heap: added alloc failed hook and configuration options
heap/test: added alloc failed hook tests

docs: added alloc failed hook documentation

heap: add function to register allocation failed hook

docs: allocation failed hook docs improvements
2020-05-04 10:58:38 -03:00
Ivan Grokhotkov a9c7db135d Merge branch 'bugfix/get_started_export_profile' into 'master'
docs: remove suggestion about running export.sh from .profile script

Closes IDFGH-1640

See merge request espressif/esp-idf!8320
2020-05-04 15:46:24 +08: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
Wang Ning 158945aebf Add translation for modules-and-boards 2020-04-30 18:50:36 +08:00
Roland Dobai ab9f714248 Add build system support for programming ESP32-S2 using DFU utils 2020-04-30 07:59:18 +02:00
Ivan Grokhotkov ece41b04e3 console: make empty line behavior run-time configurable 2020-04-29 23:44:46 +02:00
Ivan Grokhotkov 01b3ffa8e3 docs: remove suggestion about running export.sh from .profile script
This was quite obviously a bad suggestion, and it seems that some
users have actually read the docs attentively enough to have followed
it. Replace be recommendation to create an alias.

Closes https://github.com/espressif/esp-idf/issues/3889
2020-04-29 23:43:14 +02:00
Felipe Neves c78ddb770a docs: added information of task states on fatal errors documentation. 2020-04-27 14:41:55 +00:00
Krzysztof Budzynski c5c026557e Merge branch 'doc/hmac_S2' into 'master'
Doc: Documentation for HMAC module

See merge request espressif/esp-idf!8383
2020-04-27 19:03:01 +08: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
Michael (XIAO Xufeng) 9d98111652 Merge branch 'bugfix/spi_bus_lock_missing_semphrstatic' into 'master'
spi: fix config break and reduce overhead of the bus lock on SPI1

Closes IDFGH-3017

See merge request espressif/esp-idf!8221
2020-04-27 12:57:19 +08:00
Jakob Hasse 2da7e65646 Doc: S2 HMAC documentation 2020-04-27 12:25:46 +08:00
lly 2f6a4140fa doc: Fix some ble mesh description 2020-04-26 06:22:33 +00:00
Michael (XIAO Xufeng) 7ec4d64b80 spi: Update documents about the bus lock and how to use SPI Master on SPI1 bus 2020-04-23 12:27:25 +08:00
Krzysztof Budzynski 0842aed2bc Merge branch 'doc/submodule_links' into 'master'
doc: roles for linking files now correctly links to submodule repositories

Closes IDF-1584

See merge request espressif/esp-idf!8405
2020-04-22 01:49:18 +08:00
Angus Gratton 2433fe664d Merge branch 'doc/wdt_config' into 'master'
docs: Add details about WDT config

See merge request espressif/esp-idf!7838
2020-04-21 11:51:42 +08:00
Marius Vikhammer e7d92b857e doc: roles for linking files now correctly links to submodule repositories
Closes IDF-1584
2020-04-20 15:59:41 +08:00
Krzysztof Budzynski e45794d0cb Merge branch 'doc/pdf_generation' into 'master'
PDF generation for build doc

Closes IDF-1217 and IDF-1464

See merge request espressif/esp-idf!8110
2020-04-20 01:44:42 +08:00
Wang Ning efba523b54 Add links to translation in Saola board user guide 2020-04-15 22:23:26 +08:00
Marius Vikhammer 407275f681 doc: add latex and PDF generation to build_docs
Adds options for generating tex-files and PDFs when building documentation

Closes IDF-1217
Closes IDF-1464
2020-04-15 17:14:22 +08:00
Angus Gratton b18ce2f686 doc: Add configuration information about INT & Task WDTs 2020-04-15 17:30:05 +10:00
Fu Hanxi 5b2fa1a5ad build_app: make multi target support readable 2020-04-09 16:40:57 +08:00
Angus Gratton 8ded54a65d Merge branch 'feature/easy_debug' into 'master'
idf.py: add debug related targets

Closes IDF-890

See merge request espressif/esp-idf!5602
2020-04-08 16:08:10 +08:00
Ivan Grokhotkov 651dbe48e7 Merge branch 'feature/gcovr' into 'master'
app_trace: Add coverage generations by gcovr

Closes IDF-780

See merge request espressif/esp-idf!8168
2020-04-08 15:57:08 +08:00
Marius Vikhammer d193790f85 doc: update flash encryption with S2 specific content 2020-04-08 11:17:31 +08:00
Kirill Chalov 0cc9ffb8f7 Implement comments and add info on ESP32S2 2020-04-08 10:30:22 +08:00
Kirill Chalov 9ed60af1f2 Review security/flash-encryption.rst 2020-04-08 10:30:22 +08:00
David Cermak 3b5c3d6521 idf.py: debug targets for easier execution of openocd, gdb, gdbui
Support for execution of asynchronous target, such as openocd, which
by default runs in the background, but if it's the only target idf.py
outputs the openocd in the console waiting for termination by user.

Supports also blocking commands gdb and gdbtui to start a debugging
session in an active console.

Supports running gdbgui running a UI debugging session in a browser
window, using the active console for other commands, such as openocd
or monitor.

Supports combining the debug targets in one action list, such as
idf.py openocd gdbgui monitor
2020-04-07 17:37:48 +02:00
Renz Bagaporo 07f9978df7 cmake: add elf dir information
Solves https://www.esp32.com/viewtopic.php?f=13&t=14784&p=57557&hilit=assumes#p57557
2020-04-07 17:19:33 +08:00
Krzysztof Budzynski 7a92dd431f Merge branch 'bugfix/partition_types_cxx' into 'master'
docs: Explain custom partition types/subtypes in more detail

Closes IDFGH-2882

See merge request espressif/esp-idf!8192
2020-04-02 21:52:52 +08:00
Angus Gratton d76bf19ffd docs: Explain custom partition types/subtypes in more detail
Including how to use with C++ (closes https://github.com/espressif/esp-idf/pull/1832)
2020-04-02 10:00:17 +11:00
Mahavir Jain 05d95c0e7e Merge branch 'bugfix/esp_http_server_docs' into 'master'
Fixed syntax error in esp_http_server.rst

See merge request espressif/esp-idf!8170
2020-04-01 17:48:16 +08: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
morsisko 9759aa4ad2 Fixed syntax error in esp_http_server.rst
Merges: https://github.com/espressif/esp-idf/pull/5021
2020-03-31 14:59:27 +00:00
Roland Dobai 26695df5c8 app_trace: Add coverage generation by gcovr 2020-03-30 13:34:06 +02:00
Angus Gratton fe64ab6de0 docs: secure boot v2: Add a note about maximum bootloader size 2020-03-30 18:13:42 +11:00
Angus Gratton 142f69448f secure boot v2: esp32: Prevent read disabling additional efuses
Also reduce the number of eFuse write cycles during first boot when
Secure Boot and/or Flash Encryption are enabled.
2020-03-30 18:00:40 +11:00
Krzysztof Budzynski 82e2b4a0d4 Merge branch 'docs/add_translation_for_7637' into 'master'
Add translation for the update in 7637 and 8095

See merge request espressif/esp-idf!8059
2020-03-30 06:43:01 +08:00
Krzysztof Budzynski de74cfdcad Merge branch 'doc/ethernet_api_reference' into 'master'
add Ethernet API reference

Closes IDF-911

See merge request espressif/esp-idf!7270
2020-03-30 02:04:53 +08:00
Krzysztof Budzynski 6aa3179d71 Merge branch 'doc/feedback_target_exact_version' into 'master'
doc: Add exact git version & target SoC to feedback form parameters

See merge request espressif/esp-idf!8123
2020-03-30 01:20:46 +08: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
Angus Gratton ef7ebbe39c doc: Add exact git version & target SoC to feedback form parameters
Currently squeezed into the "version" field as we don't have separate fields for these.
2020-03-27 11:29:59 +11:00
Angus Gratton 02fe8fb1eb Merge branch 'bugfix/monitor_encrypted_target' into 'master'
tools: Fix flashing encrypted binaries from IDF Monitor

Closes IDF-822

See merge request espressif/esp-idf!8090
2020-03-27 08:11:38 +08:00
morris 279e8dd6c2 add Ethernet doc 2020-03-26 11:04:55 +00:00
Wang Ning a0c37ae1bd Add ESP32-S2-Saola-1 User Guide 2020-03-26 18:40:05 +08:00
Roland Dobai 9b16594444 tools: Fix flashing encrypted binaries from IDF Monitor 2020-03-26 07:51:59 +01:00
Michael (XIAO Xufeng) 826cc7ecb6 Merge branch 'feature/bringup_723_cmake_rmt_driver_update' into 'master'
RMT new features in ESP32S2

Closes IDF-1286

See merge request espressif/esp-idf!7401
2020-03-26 10:24:18 +08: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
morris 9f035edb64 rmt: update doc 2020-03-25 17:14:00 +08:00
morris 0c17af3ea4 rmt: support tx loop count 2020-03-25 17:14:00 +08:00
morris 855b316045 rmt: better support rx demodulation 2020-03-25 13:19:03 +08:00
Angus Gratton 520802d6cb doc: Rephrase the support for ESP32 & ESP32-S on the home page 2020-03-24 15:00:27 +11: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
Angus Gratton b4d97a8076 Merge branch 'feature/add_heap_info_per_task_example' into 'master'
Add Task Heap Tracking example

See merge request espressif/esp-idf!7750
2020-03-23 14:07:00 +08:00
Angus Gratton 111f596275 Merge branch 'bugfix/doc_build_ut_cmdline' into 'master'
docs: Fixup format of a command line to build unit tests

See merge request espressif/esp-idf!8033
2020-03-23 13:43:42 +08:00
Angus Gratton bd827a4d2f Merge branch 'doc/small_fixes' into 'master'
doc: Two small fixes

See merge request espressif/esp-idf!8050
2020-03-23 08:06:07 +08:00
Angus Gratton 5fbf95d691 docs: Expand the description of per-target custom macro directives 2020-03-20 19:57:18 +11:00
Anton Maklakov 8046df875e docs: Fixup format of a command line to build unit tests 2020-03-19 19:28:46 +07:00
Shubham Kulkarni 6e09056c25 example: Add Heap Task Tracking example 2020-03-19 15:07:41 +05:30
David Čermák 1d3dbb239a Merge branch 'feature/ws_server' into 'master'
http_server: adds WebSocket support

Closes IDFGH-2151 and IDFGH-2752

See merge request espressif/esp-idf!7893
2020-03-19 17:20:56 +08: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
David Cermak 0c13082b20 http_server docs: document websocket feature and corresponding example 2020-03-18 20:24:46 +00:00
Natasha ee0ae607da Add translation for mesh document under api guide 2020-03-17 01:02:36 +08:00
Mahavir Jain 88fd09111c Merge branch 'feature/prov_example_restructure' into 'master'
wifi_provisioning: Example restructuring

See merge request espressif/esp-idf!6901
2020-03-16 15:38:11 +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
Angus Gratton cb7f2d737a docs: Bump copyright date to 2020 2020-03-16 14:36:23 +11:00
Angus Gratton e0eb218e7a docs: Add a note about what target this doc version is for 2020-03-16 14:36:23 +11:00
Angus Gratton 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
Piyush Shah 156ae68275 provisioning_examples: Move older examples to legacy/ folder
Change the manager example folder name to wifi_prov_mgr to sound more meaningful.

Signed-off-by: Piyush Shah <piyush@espressif.com>
2020-03-13 06:23:15 +00:00
Wang Ning b85358e593 Updated index
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Renz Christian Bagaporo 20cfc2ecdd docs: update docs with panic handler changes 2020-03-10 19:56:24 +08:00
Krzysztof Budzynski 37997407df Merge branch 'doc/review_api-ref_periph-esp-slave-protocol' into 'master'
Doc/review api ref periph esp slave protocol

See merge request espressif/esp-idf!6968
2020-03-09 19:19:01 +08:00
morris 46ea7d815d parttool: don't print target name 2020-03-09 15:05:04 +08:00
Angus Gratton a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master'
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2

Closes IDFGH-1715

See merge request espressif/esp-idf!7614
2020-03-06 15:03:52 +08:00
Angus Gratton b393203b27 Merge branch 'feature/x509_cert_management' into 'master'
X509 certificate management

Closes IDF-296

See merge request espressif/esp-idf!5346
2020-03-06 14:29:53 +08:00
Krzysztof Budzynski 2178e3fba4 docs: Update getting started guide for ESP32-S2 target 2020-03-05 05:05:23 +08:00
Marius Vikhammer 947e3e94ed Add ESP certificate bundle feature
Adds the ESP certificate bundle feature that enables users to bundle a
root certificate bundle together with their application.

Default bundle includes all Mozilla root certificates

Closes IDF-296
2020-03-04 10:51:43 +08:00
Angus Gratton 3490c14298 Merge branch 'doc/multi_target_inc_dir' into 'master'
docs: multi target include dir support

Closes IDF-1371

See merge request espressif/esp-idf!7763
2020-03-04 07:35:10 +08:00
Kirill Chalov 1ead668d77 Issues with entering Download mode automatically
Add description to Getting started guides of possible issues preventing Development boards from entering Firmware Download mode automatically while trying to flash the boards

Closes https://jira.espressif.com:8443/browse/DOC-11
2020-03-04 04:58:29 +08:00
morris 0e4d82bc55 rmt: support REF_TICK as channel clock source
Closes https://github.com/espressif/esp-idf/pull/3952
2020-03-03 20:14:46 +08:00
Kirill Chalov b2d38cf324 Review the file api-reference/peripherals/esp_slave_protocol.rst 2020-03-03 18:12:56 +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