Commit Graph

2046 Commits

Author SHA1 Message Date
Krzysztof Budzynski
d9202304cd Merge branch 'docs/update_freertos_additions_EN' into 'master'
docs: add more information on how to return an item to the ring buffer

See merge request espressif/esp-idf!10125
2020-09-11 14:32:40 +08:00
He Hui Zi
874876cbf9 docs: add more information on how to return an item to the ring buffer 2020-09-11 14:32:39 +08:00
Marius Vikhammer
c8cd68fbe6 docs: add sphinx warnings in format_idf_target
format_idf_target will now log sphinx warnings for any
{IDF_TARGET_X} that were not replaced.
2020-09-11 09:32:28 +08:00
Krzysztof
b686e7d349 doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-11 01:43:21 +08:00
Krzysztof
156fe090be docs: Add profile file name used by zsh shell 2020-09-11 00:33:48 +08:00
Krzysztof
db0c6d7921 docs: Add esp_rom_printf to API Reference 2020-09-10 22:55:43 +08:00
Krzysztof Budzynski
0640181b46 Merge branch 'feature/explain_hello_world_files' into 'master'
docs: Add explanation of hello_world folder contents

Closes DOC-456

See merge request espressif/esp-idf!10319
2020-09-10 22:29:27 +08:00
Krzysztof Budzynski
2d4e0a4496 docs: Add explanation of hello_world folder contents 2020-09-10 22:29:24 +08:00
Ivan Grokhotkov
b6467257b9 Merge branch 'feature/cmock_component' into 'master'
cmock as component replacing unity

See merge request espressif/esp-idf!9859
2020-09-10 16:06:20 +08:00
martin.gano
7a9abe3ec5 add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
Martin Gano
9e099f97d9 add script with support parsing releases from git 2020-09-09 11:08:05 +02:00
Roland Dobai
23eadafd38 Fix the setup instructions in the main README 2020-09-07 16:06:05 +02:00
Krzysztof Budzynski
6211d5297d Merge branch 'doc/warn_doxygen_ver' into 'master'
docs: add warning for doxygen version

See merge request espressif/esp-idf!10219
2020-09-03 13:48:40 +08:00
Marius Vikhammer
9b552ce004 docs: add warning for doxygen version
Running with a newer doxygen version than what's
used in CI may raise warnings locally that are not
present when built by CI
2020-09-03 13:48:40 +08:00
Wu Bo Wen
658b56a690 doc/adc: modifications in the adc documentation and adc headers 2020-09-02 11:30:48 +00:00
Jakob Hasse
20c068ef3b cmock: added cmock as component
* changing dependencies from unity->cmock
* added component.mk and Makefile.projbuild
* ignore test dir in gen_esp_err_to_name.py
* added some brief introduction of CMock in IDF
2020-09-02 16:38:37 +08:00
Krzysztof Budzynski
f90b6eb639 Merge branch 'enhancement/docs/add-vscode-extension-info' into 'master'
VSCode Extension Setup Guide

Closes VSC-421

See merge request espressif/esp-idf!9995
2020-09-02 00:07:32 +08:00
Soumesh Banerjee
22301653c6 VSCode Extension Setup Guide 2020-09-02 00:07:31 +08:00
Michael (XIAO Xufeng)
5425ef4ee4 hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
Krzysztof Budzynski
94cc8fc4b3 Merge branch 'doc/tinyusb' into 'master'
TinyUSB documentation

See merge request espressif/esp-idf!8862
2020-08-31 20:57:29 +08:00
Krzysztof Budzynski
4c4b25f391 Merge branch 'docs/add_instructions_to_create_esp_folder_before_clone_esp-idf' into 'master'
Add a command to create an esp directory before cloning esp-idf DOC-346

Closes DOC-346

See merge request espressif/esp-idf!10003
2020-08-31 20:46:02 +08:00
Krzysztof Budzynski
634482953d Merge branch 'docs/update_the_module_list_available_for_esp32-devkitc' into 'master'
Update the module list available for ESP32-DevKitC V4 development board

Closes DOC-422

See merge request espressif/esp-idf!10137
2020-08-31 18:37:33 +08:00
Wang Fang
a5e5794059 docs: add a command to create an esp directory before cloning esp-idf 2020-08-31 09:12:21 +00:00
Krzysztof Budzynski
0fa3ff8bf0 Merge branch 'bugfix/copybutton_requirements' into 'master'
docs: Provide missing python requirement

See merge request espressif/esp-idf!10204
2020-08-31 15:54:25 +08:00
Krzysztof Budzynski
1e1eeac132 Merge branch 'docs/efuse' into 'master'
Docs: correct a chapter number

Closes IDFGH-3700

See merge request espressif/esp-idf!10135
2020-08-31 15:50:20 +08:00
Krzysztof Budzynski
a0d0971101 Merge branch 'doc/remove_lts_versions' into 'master'
docs: Update Versions file in line with the latest Support Policy document

Closes IDF-2037

See merge request espressif/esp-idf!10168
2020-08-31 15:41:02 +08:00
Michael (XIAO Xufeng)
2b323e7180 Merge branch 'bugfix/fix_dac_driver_ut' into 'master'
Driver(dac): fix DAC-DMA driver and unit test

Closes IDF-1407

See merge request espressif/esp-idf!8814
2020-08-31 00:05:34 +08:00
Michael (XIAO Xufeng)
65fff4dbf3 Merge branch 'docs/remove_docs_of_non_existent_limitation' into 'master'
docs: remove no longer existent limitation of spi slave

Closes IDF-1916

See merge request espressif/esp-idf!10111
2020-08-29 23:12:45 +08:00
Krzysztof
1f565c2313 docs: Provide missing python requirement 2020-08-29 02:50:55 +08:00
yiying
0e6803c7b2 docs: remove chapter numbers and make them common to both targets 2020-08-28 14:04:06 +00:00
r0mpage
5d71968bab Fix typo
Merges https://github.com/espressif/esp-idf/pull/5628
2020-08-28 14:04:06 +00:00
Krzysztof Budzynski
f92433b946 Merge branch 'bugfix/get_started_inconsistency' into 'master'
docs: Add missing target setting in step 7 of Getting Started documentation

Closes IDFGH-3863

See merge request espressif/esp-idf!10127
2020-08-28 20:23:17 +08:00
Krzysztof Budzynski
d16a17b01a docs: Add missing target setting in step 7 of Getting Started documentation 2020-08-28 20:23:17 +08:00
Krzysztof Budzynski
ad7a1e3761 Merge branch 'doc/local_build_version_note' into 'master'
docs: fix version specific note on local build

See merge request espressif/esp-idf!10089
2020-08-27 19:54:19 +08:00
Andrei Gramakov
c863b4c777 docs: tinyusb documentation 2020-08-27 13:49:33 +02:00
Angus Gratton
d02a9bddf2 docs: Update Versions file in line with the latest Support Policy document 2020-08-27 20:32:44 +10:00
Wang Fang
79b63189b4 docs: update the module list available for ESP32-DevKitC V4 development board 2020-08-27 04:05:18 +00:00
kirill.chalov
954d55bad0 Docs: Add copybutton package to conf_common.py 2020-08-27 02:48:43 +00:00
Krzysztof Budzynski
4322433386 Merge branch 'doc/add_Chinese_translation_for_i2c_in_peripherals_folder' into 'master'
Add Chinese translation to I2C.rst

See merge request espressif/esp-idf!9488
2020-08-26 22:08:54 +08:00
Dai Zi Yan
7bc6662184 Add Chinese translation to I2C.rst 2020-08-26 22:08:50 +08:00
Armando
725a8e6de0 docs: remove no longer existent limitation of spi slave 2020-08-26 09:00:34 +00:00
Victor Lamoine
f09f3c9d07 Fix ccache documentation: environment variable is IDF_CCACHE_ENABLE
Merges https://github.com/espressif/esp-idf/pull/5753
2020-08-26 16:39:33 +10:00
fuzhibo
0914dfbb6a dfiver(dac): add dac dma driver and unit test 2020-08-26 06:23:24 +00:00
Angus Gratton
ad295037a8 idf.py: Disable CMake --warn-uninitialized option by default
Can still be enabled by passing --cmake-warn-uninitialized on the command line

Prevents CMake warnings printed by default if IDF_PATH is underneath the CMake
project directory.

The reason for this is that CMake --warn-uninitialized only enables checks
inside the project directory (ie top-level CMakeLists.txt directory and
subdirectories), it doesn't enable for files included from other directories.

(The only way to enable warnings in other directories is to pass
--check-system-dirs and this looks like it's only useful for CMake's own
developers as it prints a lot of warnings from inside CMake otherwise - see
https://gitlab.kitware.com/cmake/cmake/-/issues/19645 )

Plan to follow up with a later commit to clean up most of the warnings (which
aren't problems for CMake execution), but we'll also disable this option by
default to avoid this unexpected triggering of IDF warnings.
2020-08-26 09:53:56 +10:00
Michael (XIAO Xufeng)
8a9dc46b14 Merge branch 'bugfix/spi_master_add_dummy_check' into 'master'
spi_master: add dummy check when both mosi and miso are set

Closes IDF-1872 and IDF-266

See merge request espressif/esp-idf!9406
2020-08-23 12:47:18 +08:00
Marius Vikhammer
3a95cf733f docs: fix version specific note on local build 2020-08-21 09:24:41 +00:00
David Čermák
e2f72f449c Merge branch 'feature/ethernet_flow_control' into 'master'
ethernet: support flow control

Closes IDF-1207, WIFI-2510, WIFI-2290, WIFI-2291, WIFI-2507, WIFI-2508, WIFI-2612, and IDFGH-3465

See merge request espressif/esp-idf!9643
2020-08-21 14:33:30 +08:00
He Yin Ling
685c3fc70c Merge branch 'test/merge_ble_mesh_node_and_provioner_in_console' into 'master'
Test:merge ble mesh node and provioner in console

See merge request espressif/esp-idf!8897
2020-08-21 11:01:37 +08:00
Lu Chang Jie
cd3cf630a5 Test: merge ble mesh node and provioner in console 2020-08-21 11:01:37 +08:00
Krzysztof Budzynski
6c17e3a64c Merge branch 'docs/Specify_two_calls_to_RingbufferReceive_is_required_in_wrap_mode' into 'master'
Add a note to specify that two calls to RingbufferReceive are required in wrap mode

Closes IDF-1980

See merge request espressif/esp-idf!9999
2020-08-19 20:00:27 +08:00
Angus Gratton
7547820393 Merge branch 'refactor/sleep_modes' into 'master'
Refactor sleep modes code

Closes IDF-1119

See merge request espressif/esp-idf!8404
2020-08-19 12:51:43 +08:00
Krzysztof Budzynski
060638cf51 Merge branch 'doc/hw-ref/esp32-s2/kaluga-kit-v1.3-upd' into 'master'
Small update to user guide for Kaluga Kit v1.3

See merge request espressif/esp-idf!10062
2020-08-18 16:21:53 +08:00
Armando
fc6010c959 spi_master: add dummy check when both mosi and miso are set
Closes https://github.com/espressif/esp-idf/issues/2715
2020-08-18 10:30:30 +08:00
Armando
9d1c5df7ab spi_master: add docs for dummy check when both mosi and miso are set 2020-08-18 10:30:30 +08:00
Renz Bagaporo
b30522f701 esp32, esp32s2: move sleep modes code to esp_system 2020-08-17 19:09:23 +08:00
Angus Gratton
0d5220bb46 Merge branch 'bugfix/docs_building_on_windows' into 'master'
Docs building: added encoding check suitable for windows

See merge request espressif/esp-idf!9672
2020-08-17 12:09:46 +08:00
kirill.chalov
1a81163802 Update description of power regulators for CAM v1.0 and v1.1 2020-08-17 11:32:14 +08:00
Krzysztof Budzynski
6b92062fcf Merge branch 'doc/hw-ref/esp32-s2/kaluga-kit-v1.3' into 'master'
Add user guide for Kaluga Kit v1.3

Closes DOC-173, DOC-184, DOC-297, and DOC-206

See merge request espressif/esp-idf!9779
2020-08-14 18:39:18 +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
kirill.chalov
dee1ff0218 Add user guide for Kaluga Kit v1.3 2020-08-12 17:56:59 +08:00
Wang Fang
12c91ee362 Update the description to reflect Python3 as the default interpreter DOC-258 2020-08-11 20:43:31 +08:00
Andrei Gramakov
dd192a2113 docs: adds to build_docs.py an encoding check suitable for windows 2020-08-11 13:52:21 +02:00
morris
4e38aab1b0 ethernet: support flow control for esp32 emac 2020-08-10 18:54:25 +08:00
Wang Fang
ee135b8e28 Add a note to specify that two calls to RingbufferReceive are required in wrap mode 2020-08-10 18:25:51 +08:00
Michael (XIAO Xufeng)
bfd71ae7ec Merge branch 'feature/dma_memcpy' into 'master'
esp32s2: async memcpy

Closes IDF-1573

See merge request espressif/esp-idf!8436
2020-08-06 11:32:43 +08:00
morris
b30bd7a2ef esp32s2: add CP_DMA driver 2020-08-04 15:28:32 +08:00
Angus Gratton
a9dd9e3017 Merge branch 'feature/embed_generated_files' into 'master'
cmake: allow embedding files to be dependent on a target

See merge request espressif/esp-idf!8535
2020-08-04 14:39:49 +08:00
Krzysztof Budzynski
bda580f3ec Merge branch 'doc/version_specific_inc_bugfix' into 'master'
docs: wrong version specific includes

Closes DOC-322 and IDFGH-3734

See merge request espressif/esp-idf!9809
2020-07-31 14:31:30 +08:00
Marius Vikhammer
b529b757aa doc: fall back to CI_COMMIT_REF_NAME as a branch name
In some cases gen_version_specific_includes.py would fail to find a branch/tag name for a commit
and would fall back to using commit SHA-1.

This should never happen in docs that should be published as we use the branch/tag name to generate
example commands for our users. E.g. "git clone -b $branch_name"

Closes https://github.com/espressif/esp-idf/issues/5657
2020-07-29 18:22:51 +08:00
Angus Gratton
e7b89e6ddc Merge branch 'bugfix/esp32s2_panic_handler_iram' into 'master'
esp_common: allow placing panic handler into IRAM on ESP32-S2

Closes IDF-1639

See merge request espressif/esp-idf!9749
2020-07-29 13:54:19 +08:00
Angus Gratton
18fded7abb Merge branch 'feature/build_doc_ci_tests' into 'master'
docs: add CI tests

Closes IDF-1648

See merge request espressif/esp-idf!9110
2020-07-29 13:54:01 +08:00
Marius Vikhammer
ba546a0d91 docs: Adds CI tests for the doc building process.
Adds test_sphinx_idf_extensions.py and test_docs.py for testing the documentation building process.
Both are run as a part of the host_test stage.

Closes IDF-1648
2020-07-28 17:48:19 +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
Ivan Grokhotkov
16c73edc67 Merge branch 'refactor/add_alias_name_for_ets_common_api' into 'master'
esp_rom: extract common ets apis into esp_rom_sys.h

See merge request espressif/esp-idf!9701
2020-07-28 15:04:55 +08:00
Krzysztof Budzynski
a6c1834327 Merge branch 'docs/provide_User_Guide_for_ESP32-Ethernet-Kit-V1.2' into 'master'
Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1

See merge request espressif/esp-idf!9786
2020-07-28 13:49:34 +08:00
Wang Fang
5773767b81 Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1 2020-07-28 13:49:33 +08:00
Ivan Grokhotkov
580fe804a8 Merge branch 'doc/esp32s2_jtag_guide' into 'master'
docs: update JTAG debugging guide for ESP32-S2

Closes FCS-469

See merge request espressif/esp-idf!9473
2020-07-27 19:17:46 +08:00
morris
2917651478 esp_rom: extract common ets apis into esp_rom_sys.h 2020-07-27 15:27:01 +08:00
Krzysztof Budzynski
03cd3d1758 Merge branch 'doc/freertos' into 'master'
add a note about ESP-IDF FreeRTOS version

Closes DOC-315

See merge request espressif/esp-idf!9762
2020-07-27 14:40:50 +08:00
Yi Ying
755aee4178 add a note about ESP-IDF FreeRTOS version 2020-07-27 14:40:47 +08:00
Anton Maklakov
5593eae8cd Merge branch 'bugfix/build_docs_check_link' into 'master'
build_docs: fix incorrect arguments for linkcheck

Closes IDFCI-65

See merge request espressif/esp-idf!9772
2020-07-27 11:09:21 +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
ebf67f7972 docs: jtag-debugging: fix ups in English 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
Ivan Grokhotkov
1b661c31d5 docs: minor typos in JTAG debugging section 2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
a421ea8d42 docs: formatting fix in idf.py debugging section 2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
d9b6ee1d46 docs: move target-specific parts of JTAG guide into include files
{esp32,esp32s2}.inc files contain most of the bits and code snippets
which are different between targets. These bits are included from the
rest of the source files.

Also included is an update to the section about OpenOCD configuration
variables and files. This section wasn't updated when some of the
files and variables got renamed.
2020-07-24 15:54:47 +02:00
Marius Vikhammer
c54e9d9d5c build_docs: fix incorrect arguments for linkcheck 2020-07-24 19:27:52 +08:00
Krzysztof Budzynski
a60dccb8c2 Merge branch 'doc/update_ws_api_ref' into 'master'
doc/websocket: updates the API reference for ESP WebSocket Client

See merge request espressif/esp-idf!6494
2020-07-23 17:51:54 +08:00
Ivan Grokhotkov
24e9d6b26a esp_common: allow placing panic handler into IRAM on ESP32-S2 2020-07-22 21:57:58 +02:00
yiying
0cca898e19 docs: change redirection link in get-started
This link is supposed to go to Step 3, but it goes to Step 2.
2020-07-22 16:19:11 +08:00
Krzysztof Budzynski
7f8aa3b303 Merge branch 'docs/update_high_level_interrupt_command' into 'master'
Update high level interrupt command DOC-280

See merge request espressif/esp-idf!9522
2020-07-22 04:32:32 +08:00
Wang Fang
7c31aec2c2 Update high level interrupt command DOC-280 2020-07-22 04:32:29 +08:00
Ivan Grokhotkov
ba874ccb04 Merge branch 'feature/freemodbus_add_tcp_master_slave' into 'master'
freemodbus:  add tcp master and slave support

Closes IDFGH-1147 and IDF-452

See merge request espressif/esp-idf!7506
2020-07-22 00:34:06 +08:00
Alex Lisitsyn
d0b9829eef examples: freemodbus add tcp support for common master/slave iface
Add TCP port files to provide Modbus TCP interface for communication
Add freemodbus add tcp support for common master/slave iface and tcp example based on socket API
The communication between master and slave checked for each example serial_master, serial_slave (use ModbusPoll TCP)
update tcp example according netif changes, fix ci issues
update TCP slave implementation
update example_test.py to to set IP through stdin
update API documentation
event bit instead of semahore to lock communication resource
update default options and master/slave port files

Closes https://github.com/espressif/esp-idf/issues/858
Closes IDF-452
2020-07-22 00:34:04 +08:00
Ivan Grokhotkov
c7e54fd277 Merge branch 'bugfix/doc_rs485_fix_incorrect_sch_label' into 'master'
doc: uart rs485 fix incorrect sch circuit label

Closes DOC-302

See merge request espressif/esp-idf!9649
2020-07-21 22:07:47 +08:00
Marius Vikhammer
09f240c1e1 doc/websocket: updates the API reference for ESP WebSocket Client 2020-07-21 15:44:16 +08:00