Angus Gratton
66462ca26f
docs: Apply the same basic ESP32/ESP32-S2 warning filters to Chinese docs
2020-02-07 16:37:43 +11:00
Angus Gratton
a148d8e6ba
docs: Refactor extensions into packages, update the add-ons-reference docs page
...
Includes converting some of the remaining standalone scripts into Sphinx extensions.
Make flake8 clean
2020-02-07 16:37:43 +11:00
Angus Gratton
e753c1b509
docs: Edit out some unnecessary instances of "ESP32" in the doc text
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs
2020-02-07 16:37:43 +11:00
Ivan Grokhotkov
036a29bb3d
docs: update build system guide on setting IDF_TARGET
2020-01-31 10:19:44 +01:00
Felipe Neves
5cbb3f05c0
freertos: Added experimental, optional FPU usage on level 1 ISR
2020-01-27 10:55:03 -03:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
Felipe Neves
73592d9bc4
spin_lock: added new spinlock interface and decoupled it from RTOS
...
spin_lock: cleaned-up port files and removed portmux files
components/soc: decoupled compare and set operations from FreeRTOS
soc/spinlock: filled initial implementation of spinlock refactor
It will decouple the spinlocks into separated components with not depencences of freertos
an similar interface was provided focusing the readabillity and maintenance, also
naming to spinlocks were adopted. On FreeRTOS side the legacy portMUX macros
gained a form of wrapper functions that calls the spinlocks component thus
minimizing the impact on RTOS side.
This feature aims to close IDF-967
soc/spinlock: spinlocks passed on unit test, missing test corner cases
components/compare_set: added better function namings plus minor performance optimization on spinlocks
soc/spinlock: code reordering to remove ISC C90 mix error
freertos/portmacro: gor rid of critical sections multiline macros, placed inline functions instead
soc/spinlock: improved spinlock performance from internal RAM
For cases where the spinlock is executed from IRAM, there is no
need to check where the spinlock object is placed on memory,
removing this checks caused a great improvement on performance.
2020-01-22 06:20:34 +08:00
Krzysztof Budzynski
ac27ab29fd
doc: Fix broken links to examples
2020-01-20 12:10:18 +08:00
KonstantinKondrashov
b49a657448
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig
2020-01-15 11:02:27 +00:00
Krzysztof Budzynski
5aa21584cf
Merge branch 'doc/ulp_cmake_fix' into 'master'
...
doc: Remove duplicate ulp-cmake
See merge request espressif/esp-idf!7259
2020-01-10 15:29:56 +08:00
Angus Gratton
b2404513db
Merge branch 'doc/cmake_external_lib' into 'master'
...
docs: Add example of using IDF APIs from an external CMake library
See merge request espressif/esp-idf!6527
2020-01-10 14:13:07 +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
Angus Gratton
8bc618f070
Merge branch 'feature/sntp_add_desc' into 'master'
...
docs: Add System time chapter and for sntp a description about using...
Closes IDFGH-2237, IDF-1199, and IDF-38
See merge request espressif/esp-idf!6818
2020-01-10 13:29:47 +08:00
KonstantinKondrashov
c23549c04f
docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option
...
Closes: https://github.com/espressif/esp-idf/issues/4386
Closes: IDFGH-2237
Closes: IDF-1199
2020-01-10 14:49:07 +11:00
Ivan Grokhotkov
a559014ff0
Merge branch 'bugfix/coredump_bin_fmt_ver_update' into 'master'
...
Fixes coredump compatibility with legacy binary core dumps
See merge request espressif/esp-idf!6794
2020-01-10 10:04:17 +08:00
Angus Gratton
e1833fa3de
docs: Add example of using IDF APIs from an external CMake library
2020-01-09 13:51:30 +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
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
Renz Christian Bagaporo
91b421c35f
cmake: implement utility to import prebuilt libraries
2019-12-10 19:22:25 +08:00
lly
2daa8e6587
doc: update ble mesh docs based on the feature and example update
2019-12-09 14:57:15 +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
Roland Dobai
105267d537
Doc: Remove menuconfig tool which is not used anymore
2019-11-28 10:07:49 +01:00
weitianhua
7c18299571
Add AG component API_REFERENCE
...
Expose esp_hf_indchange_notification to this example.
2019-11-27 13:35:35 +00:00
Anton Maklakov
def05480b8
docs: Fix up some OpenOCD cmdline-s
2019-11-26 19:44:22 +08:00
Sagar Bijwe
e679b3c79e
wifi: Add PMF and WPA3 documentation
2019-11-26 11:00:20 +05:30
Alexey Gerenkov
e092d6f858
coredump: Makes compatible with legacy binary core dumps
...
Also:
- improves coredump versioning scheme
- Moves some API funtions to respective flash/UART dependent code
2019-11-25 22:44:51 +03:00
Alexey Gerenkov
27ce4d13df
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
Angus Gratton
7eb89ae868
Merge branch 'feature/idfpy_unknown_targets_fallback' into 'master'
...
idf.py: run build system target for unknown sub-commands
Closes IDF-748
See merge request espressif/esp-idf!6644
2019-11-22 13:22:23 +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
Ivan Grokhotkov
8ff801766a
Merge branch 'docs/update_oocd_config_on_cmd_line' into 'master'
...
Updates OpenOCD configuration file names in documentation
See merge request espressif/esp-idf!6226
2019-11-22 05:32:35 +08:00
Sergei Silnov
87c979ae09
docs: add idf.py fallback commands and subcommand options
2019-11-20 12:23:03 +01:00
Kirill Chalov
1d06b6b07e
Add information on compatibility issue between JTAG and AT firmware.
2019-11-20 15:01:56 +08:00
Alexey Gerenkov
1626f827d3
docs: Updates OpenOCD configuration file names
2019-11-18 13:33:32 +03:00
Renz Christian Bagaporo
df26ab13e2
test_utils: implement performance timer
2019-11-18 10:29:01 +08:00
Alexey Gerenkov
30ff7198b8
apptrace: Renames Kconfig options
2019-11-13 15:24:01 +03:00
David Cermak
d471266b46
esp_netif: documentation udpated and grouped the esp-netif API
...
structure. Updated rst documenentation and diagram of esp-netif
cooperation with other components.
2019-11-13 12:36:25 +01:00
Angus Gratton
c37cb2b5dc
Merge branch 'doc/lwip_apis' into 'master'
...
lw_ip: Add lw_IP API Guide
Closes IDF-35
See merge request espressif/esp-idf!6473
2019-11-07 19:32:38 +08:00
Angus Gratton
a771b94183
lwip: Add lwIP API Guide
...
Try to provide a full overview of lwIP features as implemented in esp-lwip and ESP-IDF
2019-11-07 18:12:47 +08:00
Renz Christian Bagaporo
d43cc4fa4b
cmake: allow multiple sdkconfig defaults to be specified
2019-11-03 16:43:58 +08: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
7ce75a42c7
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-25 15:13:52 +11:00
Renz Christian Bagaporo
d44e3d9f56
docs: cmake docs fixes
2019-10-18 12:51:46 +08:00
Angus Gratton
ae21d669b9
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-17 18:22:08 +11: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
Angus Gratton
496ede9bcd
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-15 14:59:27 +11:00
Angus Gratton
8fbece32a9
Merge branch 'bugfix/msys2_toolchain_path_note' into 'master'
...
docs: update windows msys2 installer notes to unzip all-in-one toolchain to path without spaces
See merge request espressif/esp-idf!6181
2019-10-14 15:31:49 +08:00
ronghulin
4e1ccd8b6f
doc: add LWIP socket error usage
2019-10-11 12:09:10 +08:00
Per-Olov Jernberg
6435c9f3d5
idf_monitor: Exit with CTRL+X in menu
...
Currently, the only way of exiting the idf_monitor program is to hit the CTRL+] button, if your keyboard doesn't have that key unless you hit another modifier key, it's not super trivial to exit.
This change adds the option to exit with CTRL+T (for menu) then hitting X (or CTRL+X) for exiting.
Closes https://github.com/espressif/esp-idf/pull/4167
Closes https://github.com/espressif/esp-idf/issues/4129
2019-10-08 08:15:51 +00:00
David Cermak
5cde268cce
docs: fix minor parameter description inconsistency for idf_component_set_property
2019-09-26 10:51:04 +02:00
Angus Gratton
adfc06a530
Merge branch 'master' into feature/esp32s2beta_merge
2019-09-20 10:28:37 +10:00
Jiang Jiang Jian
d78831ab2b
Merge branch 'bugfix/remove_v40_deprecations' into 'master'
...
Remove features deprecated before ESP-IDF V4.0
Closes IDF-507
See merge request espressif/esp-idf!5841
2019-09-19 16:07:01 +08:00
Angus Gratton
96b96ae244
Merge branch 'bugfix/cmake_component_names' into 'master'
...
CMake: Component name related bugfixes
See merge request espressif/esp-idf!5921
2019-09-17 11:16:25 +08:00
Angus Gratton
438d513a95
Merge branch 'master' into feature/esp32s2beta_merge
2019-09-16 16:18:48 +10:00
Angus Gratton
f44d99b509
app_update: Remove deprecated "make erase_ota" target
...
Deprecated in v3.2
2019-09-13 09:44:07 +10:00
Hrudaynath Dhabe
d740769916
docs: wifi: wifi_guide update for disconnection warning in case of invalid initiation in WIFI_MODE_APSTA
.
...
Added warning to expect momentary disconnection of exSTA if channel of exAP is different than that of softAP and a prescribed solution.
2019-09-12 13:45:44 +08:00
Angus Gratton
88c0e012df
Merge branch 'doc/build_system_requirements' into 'master'
...
docs: Explain build system REQUIRES & PRIV_REQUIRES in more detail
See merge request espressif/esp-idf!5965
2019-09-10 13:10:03 +08:00
Angus Gratton
b0710f9d0b
docs: Explain build system REQUIRES & PRIV_REQUIRES in more detail
...
Including an example.
2019-09-10 09:48:46 +10:00
Alex Lisitsyn
7ff9538c48
espcoredump: fix issue with spi_flash access
...
spi_flash has been updated and its functions work from flash by default instead of IRAM that cause issue
add Kconfig value into espcoredump to enable spi_flash legacy mode (CONFIG_SPI_FLASH_USE_LEGACY_IMPL) when core dump is selected
fix spi_flash issues to work correctly with legacy mode when CONFIG_SPI_FLASH_USE_LEGACY_IMPL is used
2019-09-06 15:37:55 +08:00
Angus Gratton
9a7ab28cc2
idf.py: Add environment variable to enable ccache by default
2019-09-03 10:25:28 +10:00
Darian Leung
de682a13b1
examples: Update system examples README
...
The following commit updates the first half of the the system
example README files. Some other changes were also made:
* Updated base_mac_address example
* Moved contents in GCOV README to GCOV docs
* Some *main.c file names updated
* Updated example README template
2019-08-28 16:19:40 +08:00
Renz Christian Bagaporo
fe9edc3ebe
docs: fix typo of build component aliases name
2019-08-28 14:52:09 +08:00
Angus Gratton
a21ca2270a
Merge branch 'feature/deep_sleep_fast_wake' into 'master'
...
bootloader: Reduce the time spent in image validation when waking from deep sleep
See merge request espressif/esp-idf!5140
2019-08-28 08:54:28 +08:00
Renz Christian Bagaporo
826568a120
cmake: introduce BUILD_COMPONENT_ALIASES
...
This commit makes it so that BUILD_COMPONENT holds only the component,
and a new property BUILD_COMPONENT_ALIASES hold the full name of the
component.
This also removes erroneous check for duplicate components, as this can
never happen:
(1) if two components have the same name but different prefixes,
the internal names are still unique between them
(2)if two components happen to have the same name and same prefix, the
latter would override the former
2019-08-27 20:40:29 +08:00
Angus Gratton
2f557d1a59
Merge branch 'bugfix/openocd_ulp_install_instructions' into 'master'
...
docs: ulp: update for IDF Tools installation method
Closes IDF-825
See merge request espressif/esp-idf!5860
2019-08-23 09:38:47 +08:00
Ivan Grokhotkov
5ba9be9c2e
docs: ulp: update for IDF Tools installation method
...
binutils-esp32ulp is installed automatically by install.sh/install.bat
or the IDF Tools Installer for Windows.
2019-08-21 14:45:33 +02:00
KonstantinKondrashov
abffc3b11d
docs: Add a description of the fast wakeup
2019-08-21 11:44:37 +00:00
Renz Christian Bagaporo
4690152eca
cmake: make default version 1
2019-08-21 12:46:38 +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
Angus Gratton
6007ef4b08
Merge branch 'feature/cmake_build_internals_docs' into 'master'
...
Docs: Enchance build system internals docs
See merge request espressif/esp-idf!5753
2019-08-15 16:22:50 +08:00
Renz Christian Bagaporo
6b16928fbc
docs: build system internals
2019-08-15 14:25:47 +08:00
Darian Leung
75adefe437
docs: Alphbetically sort toctree
...
This commit sorts the entries of variuos toctrees
alphabetically. Indentation was also fixed. The order
of some toctrees were not modified if the existing
order had some form of suggested reading order.
2019-08-13 16:04:12 +08:00
Ivan Grokhotkov
16b300bd7a
Merge branch 'bugfix/fix_the_bug_in_wifi_doc' into 'master'
...
docs: fix the bug in wifi doc
Closes IDFGH-1590
See merge request espressif/esp-idf!5647
2019-07-30 09:42:23 +08:00
zhangyanjiao
62bb107b31
docs: fix the bug in wifi doc
2019-07-29 14:55:17 +08:00
Ivan Grokhotkov
26800ed71e
global: update note in the partition tables
...
The build system automatically determines offsets of partitions from
the partition table, so no manual changes are needed. Instead, add a
note that partition offsets may need to be updated when increasing
the bootloader size.
2019-07-27 10:28:16 +02: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
62ed221daf
docs: Functional renaming commit for CMake-as-default
...
Rename all the files which will be edited substantially in the next commit, without changing their
contents
Docs will not build for this ocmmit.
This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-07-08 17:31:27 +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
Stefan Venz
82ba58db22
Fix reference in jtag debugging section
...
Merges https://github.com/espressif/esp-idf/pull/3617
Signed-off-by: Stefan Venz <stefan.venz@protonmail.com>
2019-07-02 17:49:49 +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
Angus Gratton
396131433a
Merge branch 'feature/idf_size_json' into 'master'
...
idf_size: Support JSON output
Closes IDF-264
See merge request idf/esp-idf!4987
2019-06-24 19:06:12 +08:00
Kirill Chalov
32c3730c33
Review the file api-guides/external-ram.rst
2019-06-24 08:24:44 +08:00
Angus Gratton
d1da76e369
Merge branch 'bugfix/misc_cmake_changes' into 'master'
...
Follow up CMake changes/fixes
See merge request idf/esp-idf!5267
2019-06-21 13:27:55 +08:00
Angus Gratton
e2b8f4c6ae
Merge branch 'feature/docs_for_updated_idf_argparsing' into 'master'
...
docs: Update order of arguments for idf.py and add click linux package
Closes IDF-501
See merge request idf/esp-idf!5166
2019-06-21 11:42:59 +08:00
Renz Christian Bagaporo
11924d76cb
cmake: clarify build trimming docs
...
How idf_build_component and the COMPONENTS argument to idf_build_process
interact is not clear/misleading. Clarify their interaction in the docs.
Closes: https://github.com/espressif/esp-idf/issues/3630
2019-06-20 16:02:22 +08:00
Ivan Grokhotkov
ce5653c257
Merge branch 'doc/openocd_build2win_update' into 'master'
...
Updated building-openocd-windows.rst instruction
See merge request idf/esp-idf!5049
2019-06-19 00:14:22 +08:00
suda-morris
c5c716e9d7
esp_wifi: fix wrong path of phy_init_data
...
Closes https://github.com/espressif/esp-idf/issues/3482
2019-06-18 11:29:09 +08:00