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
michael
37fdcc1eb5
esp_ringbuf: add documents for SendAcquire and SendComplete
2019-10-11 15:44:27 +08:00
ronghulin
4e1ccd8b6f
doc: add LWIP socket error usage
2019-10-11 12:09:10 +08:00
Natasha
b0f2bb2adc
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
Jakob Hasse
e33153f633
Added basic C++ style guide
...
* C++ style guide
* Changed headings to "Title Case"
2019-10-09 12:25:48 +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
Ivan Grokhotkov
5830f529d8
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-02 19:01:39 +02:00
David Cermak
5cde268cce
docs: fix minor parameter description inconsistency for idf_component_set_property
2019-09-26 10:51:04 +02:00
Ivan Grokhotkov
847537c862
docs: update get-started to use Tools Installer v2.1
2019-09-24 10:39:27 +02:00
David Cermak
380801c6fa
docs: update windows msys2 installer notes to unzip all-in-one toolchain to path without spaces
2019-09-23 12:00:00 +02:00
Angus Gratton
b5f74522a3
doc: Add page explaining ESP32-S2 status
2019-09-20 10:28:46 +10: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
d559ccb23c
Merge branch 'bugfix/IDF-997' into 'master'
...
docs: Update eclipse setup doc with the IDF Eclipse Plugins github link
Closes IDF-997 and IDF-194
See merge request espressif/esp-idf!6105
2019-09-18 15:15:21 +08:00
Wang Fang
412a766a2a
Add Chinese transaltion to sdmmc in storage folder
...
The translation should be first reviewed by technical reviewer Xiao Xufeng and then by Carrie
The translation for the other documents in storage folder can be found in MR5613, MR5620 and MR5737.
2019-09-18 13:28:16 +08:00
Kondal Kolipaka
41a1eebbd4
docs: Update eclipse setup doc with the IDF Eclipse Plugins github link
2019-09-17 13:42:32 +05:30
Wang Fang
fb0bf099a3
Add Chinese translation for touch_pad.rst in api-reference:
...
1. Add link to en/api-reference/peripherals/touch_pad.rst
2. Add Chinese translation to zh_CN/api-reference/peripherals/touch_pad.rst
2019-09-17 11:22:30 +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
Sergei Silnov
2d03af30ab
Add idf.py --version option
...
Update docs on how to check IDF version
Show dependencies check information only in verbose mode
2019-09-16 20:32:26 +08:00
Angus Gratton
438d513a95
Merge branch 'master' into feature/esp32s2beta_merge
2019-09-16 16:18:48 +10:00
Angus Gratton
ff5018d3ee
Merge branch 'doc/add-extension-sphinx.ext.todo' into 'master'
...
Add extension "sphinx.ext.todo" for todo notes in rst files. Add info how to use it.
See merge request espressif/esp-idf!6084
2019-09-13 14:46:09 +08:00
Angus Gratton
9d19f4fc8e
driver docs: Fix some doxygen warnings
2019-09-13 14:30:06 +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
Kirill Chalov
f0dc5f8dc2
Apply suggestion to docs/en/contribute/documenting-code.rst
2019-09-12 12:36:13 +08:00
Kirill Chalov
7c491d2335
Allow the extension for adding todo notes to rst files. Add information on how to use this extension to the contribution section.
2019-09-11 17:15:00 +08:00
Angus Gratton
2402d0952d
Merge branch 'bugfix/flash_encryption_disable_plaintext' into 'master'
...
flash encryption: Always disable plaintext reflashes in Release mode
See merge request espressif/esp-idf!6051
2019-09-11 07:59:33 +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
5c5770dddb
docs: Small cleanup of flash encryption docs
2019-09-10 11:28:11 +10: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
Krzysztof Budzynski
56231a998b
Merge branch 'doc/review_api-ref_periph-sdspi_host' into 'master'
...
Review the file api-reference/peripherals/sdspi_host.rst
See merge request espressif/esp-idf!5732
2019-09-09 19:59:56 +08:00
Kirill Chalov
95552d4d13
Review the file api-reference/peripherals/sdspi_host.rst
2019-09-09 19:14:39 +08:00
Wang Fang
758abe6e01
Add Chinese translation for the rst documents in storage folder, including:
...
1. docs/zh_CN/api-reference/storage/fatfs.rst
2. docs/zh_CN/api-reference/storage/index.rst
3. docs/zh_CN/api-reference/storage/sdmmc.rst
4. docs/zh_CN/api-reference/storage/spiffs.rst
5. docs/zh_CN/api-reference/storage/wear-levelling.rst
2019-09-06 19:12:36 +08: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
Hao Ning
eb2ddbfe48
add chinese translation for timer.rst in api-reference folder
2019-09-04 17:09:13 +08:00
Angus Gratton
9a7ab28cc2
idf.py: Add environment variable to enable ccache by default
2019-09-03 10:25:28 +10:00
joedeveloper
70b1ff7bc6
docs: Explain ncurses5 for other distributions as well
...
Ran into ncurses5 dependency issue on popOS
stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was
mentioned it was too easy to skip over the section
Merges https://github.com/espressif/esp-idf/pull/3236
2019-08-30 18:16:30 +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
Andrei Gramakov
79dd142ab8
tools: add install.ps1, export.ps1
...
Closes IDF-855
2019-08-27 13:45:50 +08:00
Dmitry
a0730fec2a
Performance monitor component. The component contains APIs, example and
...
documentation.
2019-08-23 11:20:12 +03:00
Angus Gratton
99a58e5839
Merge branch 'doc/cbor_copyright' into 'master'
...
docs: Add TinyCBOR copyright line
See merge request espressif/esp-idf!5880
2019-08-23 15:49:10 +08:00
Mahavir Jain
141a287c8a
Merge branch 'bugfix/fix_code_snippet_in_http_server_docs' into 'master'
...
Fixed syntax error in esp_http_server.rst
See merge request espressif/esp-idf!5844
2019-08-23 14:26:03 +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
Angus Gratton
e28b6e59b6
docs: Add TinyCBOR copyright line
2019-08-23 09:20:08 +10: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
Michael
b7e73025fe
Fixed syntax error in esp_http_server.rst
...
Changed the "const char[] name" into "const char name[]", so now the code doesn't produce the "expected identifier or '(' before '[' token" error.
Closes https://github.com/espressif/esp-idf/pull/3940
2019-08-21 12:31:46 +05:30
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
Angus Gratton
0a0bb09585
Merge 'master' into feature/esp32s2beta_update
2019-08-20 13:55:23 +10:00
Angus Gratton
6990a7cd54
Merge branch 'master' into feature/esp32s2beta_update
2019-08-19 15:03:43 +10: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
Angus Gratton
04ae56806c
Merge branch 'master' into feature/esp32s2beta_update
2019-08-08 15:26:58 +10:00
Angus Gratton
24d26fccde
Merge branch 'master' into feature/esp32s2beta_update
2019-08-08 13:44:24 +10:00
Michael (XIAO Xufeng)
07166a6b18
sdio_slave: rewrite the doc and highlight efuse-burning as the default option for 3.3V modules
2019-08-07 17:10:34 +08:00
fuzhibo
572084821b
add Comment for touchpad
2019-08-07 11:39:17 +08:00
Krzysztof Budzynski
6517c5033a
Merge branch 'bugfix/docs_broken_links' into 'master'
...
Fix broken links in 'Getting Started' gudes
See merge request espressif/esp-idf!5685
2019-08-05 21:28:50 +08:00
Wang Fang
8d8ea6f698
Add Chinese translation for modules-and-boards.rst in hw-reference folder.
...
Note: Also modify the table in en version
2019-08-05 21:25:15 +08:00
Krzysztof
164fd5ad29
More link corrections
2019-08-02 17:58:08 +08:00
Krzysztof
d163b9e615
Fix broken links in 'Getting Started' gudes
2019-08-02 17:09:33 +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
Ivan Grokhotkov
b1bb90a596
Merge branch 'bugfix/partition_tables_update_note' into 'master'
...
global: update note in the partition tables
See merge request espressif/esp-idf!5636
2019-07-29 19:00:44 +08:00
zhangyanjiao
62bb107b31
docs: fix the bug in wifi doc
2019-07-29 14:55:17 +08:00
Angus Gratton
62780234a3
Merge branch 'bugfix/get-started-legacy-links' into 'master'
...
docs: getting-started: fix broken links
See merge request espressif/esp-idf!5549
2019-07-29 10:56:01 +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
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Wang Ning
d767e0edc7
Add Chinese translation to api-reference/network/esp_smartconfig.rst
2019-07-19 19:04:44 +08:00
Kirill Chalov
75d7ca4b60
Review the file api-reference/peripherals/timer.rst
2019-07-19 15:06:52 +08:00
Krzysztof Budzynski
4be0fdb24c
Merge branch 'doc/review_api-ref_periph-ledc' into 'master'
...
Doc/review api ref periph ledc
See merge request espressif/esp-idf!5342
2019-07-18 20:33:27 +08:00
chenjianqiang
e43513b610
bugfix(uart): uniform AT_CMD char configuration
2019-07-18 19:24:13 +08:00
Kirill Chalov
d8b3676797
Review the file api-reference/peripherals/ledc.rst
2019-07-18 16:38:59 +08:00
Ivan Grokhotkov
83277fe0f2
docs: add tools section and IDF docker image page
2019-07-18 06:18:04 +00:00
Ivan Grokhotkov
e431bfd6c2
docs: getting-started: correct style of "macOS" name
2019-07-17 08:31:35 +02:00
Ivan Grokhotkov
7feea26404
docs: getting-started: fix broken links
2019-07-17 08:30:53 +02:00
Angus Gratton
0f27c38855
docs: Add notes about thread safety and using heap from ISRs
...
Closes https://github.com/espressif/esp-idf/issues/3768
2019-07-12 11:09:00 +10:00
Angus Gratton
80e9faaf1c
docs: Move Legacy Get Started guide to the Related Documents section
2019-07-09 20:35:34 +10:00
Angus Gratton
9583c8d037
docs: Rephrase the warning about not requiring MSYS2 on Windows
2019-07-09 14:32:26 +10: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
Mahavir Jain
0a65cf73fa
Merge branch 'feature/prov_mgr_event_loop' into 'master'
...
Wi-Fi Provisioning : Add support for esp_event
See merge request espressif/esp-idf!4857
2019-07-07 13:40:18 +08:00
qiyuexia
068a2dcb32
mesh: update mesh events demonstration
2019-07-05 21:14:33 +08:00
Anurag Kar
0e8bd1699d
Wi-Fi Provisioning : Manager docs updated with information about esp_event_loop support
2019-07-05 08:41:27 +00:00
wangmengyang
50af558df9
update pm document with changes in bluetooth that supports automatic light sleep in case that external 32.768KHz crystal is used as the sleep clock
...
If bluetooth modem sleep is enabled and "External 32kHz crystal" is used as bluetooth sleep clock, the power management lock "ESP_PM_NO_LIGHT_SLEEP" in bluetooth is released for the periods of time when Bluetooth enters modem sleep. In this case automatic light sleep is allowed.
2019-07-04 07:14:02 +00: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
Mahavir Jain
28f1cdf5ed
Merge branch 'feature/local_ctrl_no_sec' into 'master'
...
ESP Local Ctrl Feature Added
See merge request idf/esp-idf!5348
2019-07-04 00:45:29 +08:00
Anurag Kar
b75f8b1b20
ESP Local Control Feature Added
...
List of changes:
* New component esp_local_ctrl added
* Example added under examples/protocols/esp_local_ctrl
* Documentation added under protocols/esp_local_ctrl
* Demo client side app esp_local_ctrl.py added under examples/protocols/esp_local_ctrl/scripts
* protocomm_ble : protocomm_ble_config_t given struct name for allowing forward declaration
* esp_prov/transport_softap renamed to transport_http
* transport_http module supports verification of server certificate
* transport_http module performs name resolution before connection
2019-07-03 21:31:04 +05:30
Krzysztof
5aa019fce6
Replace hardcoded links with link roles
2019-07-02 21:01:52 +08:00
Wojciech Szczurek
82b3779b2b
Fix broken link to components/wifi_provisioning/proto
...
Merges https://github.com/espressif/esp-idf/pull/3668
2019-07-02 21:00:38 +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