alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
23,088 Commits 20 Branches 148 Tags 384 MiB
94d7ae03da
Commit Graph

232 Commits

Author SHA1 Message Date
Roland Dobai
47f67f8b81 tools: Prefer python3 during install and export 
Install and export script should work on systems without "python"
executable.

Closes https://github.com/espressif/esp-idf/pull/6471

Closes https://github.com/espressif/esp-idf/issues/6532

Related to https://github.com/espressif/esp-idf/issues/6421 and
https://github.com/espressif/arduino-esp32/issues/4717
 2021-02-13 11:34:40 +01:00
Wang Ning
aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +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
Krzysztof Budzynski
9a5bd86d54 Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master' 
docs: update documents based on doc-855, doc-885, doc-889, doc-897

See merge request espressif/esp-idf!12124
 2021-01-26 16:21:26 +08:00
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00: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
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
Angus Gratton
e2910d2ff5 doc: Add libusb package dependencies for Arch, CentOS 
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible

Related to https://github.com/espressif/esp-idf/issues/4095
 2021-01-13 05:15:27 +00:00
mjdr
f12544a04e doc: Add libusb dependency for Ubuntu 
Patch from https://github.com/espressif/esp-idf/pull/4669

Closes https://github.com/espressif/esp-idf/issues/4095
Related to https://github.com/espressif/esp-idf/issues/5181
 2021-01-13 05:15:27 +00:00
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08:00
Wang Fang
cf505d0ead docs: update the documents based on customer feedbacks 2020-12-31 05:40:43 +00:00
Wang Fang
8dbd5a48a8 provide user guide for the development board ESP32-PICO-DevKitM-2 2020-12-14 18:26:44 +08:00
Ivan Grokhotkov
46cfc436ad Merge branch 'feature/idf_tools_github_mirror' into 'master' 
Add GitHub mirror option for IDF tools installs

Closes IDF-2028

See merge request espressif/esp-idf!10616
 2020-12-14 15:58:51 +08:00
Wang Fang
bdeb3a2fb6 upload user guide for development board: ESP32-PICO-KIT-1 2020-12-09 08:27:25 +00:00
Angus Gratton
291af6e766 tools: Use GitHub download URLs for all files that can be downloaded from GitHub 2020-12-03 17:50:42 +11:00
Angus Gratton
4a738721f1 idf_tools: Add option to replace all GitHub tools download URLs with dl.espressif.com 
Via new IDF_GITHUB_ASSETS environment variable.
 2020-12-03 17:49:37 +11:00
Krzysztof Budzynski
5f5ae17bc8 Merge branch 'feature/python2-deprecation-warn' into 'master' 
Tools: Add Python 2 deprecation warning

Closes IDF-1677

See merge request espressif/esp-idf!11115
 2020-12-02 19:26:46 +08:00
daiziyan
33c414087b add CN translation for adding python2 deprecation warning(MR 11115) 2020-12-02 11:11:57 +01:00
martin.gano
f4ea2dcb74 Tools: add Python 2 deprecation warning 2020-12-02 11:08:48 +01:00
daiziyan
62f7a1b545 fix merge conflicts 2020-12-02 16:50:07 +08:00
Juraj Michálek
5a2d84324d docs: add ESP-IDF Windows Installation limitations. 2020-12-01 07:33:47 +01:00
Dai Zi Yan
c7bebb0413 Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 17:58:27 +08:00
Dai Zi Yan
c2818e775c Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync 2020-11-25 14:45:26 +08:00
Ivan Grokhotkov
e9e6d970f3 Merge branch 'feature/add-shell-autocompletion' into 'master' 
idf.py: Enable autocompletion for command idf.py

Closes IDF-1540

See merge request espressif/esp-idf!10742
 2020-11-06 20:14:38 +08:00
Wang Ning
f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide 
Update 1 based on comments

Fix typo

Add annotation to UFL connector

Add UFL connector to description table
 2020-11-06 00:50:33 +00:00
martin.gano
346b002d9a enable autocompletion for command idf.py 2020-11-03 23:27:58 +01:00
Krzysztof Budzynski
077bbb8647 docs: Clarify how to establish a serial connection to the device using macOS 2020-10-15 15:26:46 +08:00
Wang Fang
00a99cfb9d docs: fix formatting issues in api-guides 2020-09-24 15:30:28 +08:00
Krzysztof Budzynski
4547c0876a Merge branch 'feature/guide_change_for_catalina' into 'master' 
docs: Add profile file name used by zsh shell

Closes DOC-325

See merge request espressif/esp-idf!10320
 2020-09-11 16:42:30 +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 Budzynski
2d4e0a4496 docs: Add explanation of hello_world folder contents 2020-09-10 22:29:24 +08:00
Roland Dobai
23eadafd38 Fix the setup instructions in the main README 2020-09-07 16:06:05 +02:00
Soumesh Banerjee
22301653c6 VSCode Extension Setup Guide 2020-09-02 00:07:31 +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
d16a17b01a docs: Add missing target setting in step 7 of Getting Started documentation 2020-08-28 20:23:17 +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
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
Marius Vikhammer
4d6030e03f doc: update chip features in getting started 
Fixed number of cores for ESP32 and ESP32S2 being wrong.

Updated S2 to reflect that we have to ULP coprocessors

Closes IDFGH-3616
Closes https://github.com/espressif/esp-idf/issues/5556
 2020-07-10 09:50:55 +08:00
Krzysztof Budzynski
7099c2b444 Merge branch 'doc/generate_idf_project_tags' into 'master' 
doc: add generation of tags from sdkconfig and x_caps.h headers

Closes IDF-1484

See merge request espressif/esp-idf!8577
 2020-05-20 23:46:47 +08:00
Angus Gratton
ee8796b169 Merge branch 'bugfix/doc_version_links' into 'master' 
doc: Fix broken Release page links when building a stable version

See merge request espressif/esp-idf!8819
 2020-05-20 13:16:46 +08:00
Angus Gratton
fdfb029711 doc: Fix broken Release page links when building a stable version 2020-05-20 10:50:44 +10:00
Krzysztof
789c42abcd Add another case and recomendation to use Python 3 instead of Python 2 2020-05-13 21:57:51 +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
Wang Ning
8b8d03f7bd Update Build and Flash with Eclipse IDE to make terminology consistent 2020-05-11 16:51:30 +08: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
Roland Dobai
ab9f714248 Add build system support for programming ESP32-S2 using DFU utils 2020-04-30 07:59:18 +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
Fu Hanxi
5b2fa1a5ad build_app: make multi target support readable 2020-04-09 16:40:57 +08:00
Wang Ning
a0c37ae1bd Add ESP32-S2-Saola-1 User Guide 2020-03-26 18:40:05 +08:00
Angus Gratton
52d888a68b docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
Wang Ning
b85358e593 Updated index 
components/esp_wifi/lib_esp32/
 2020-03-11 06:43:31 +08:00
Krzysztof Budzynski
2178e3fba4 docs: Update getting started guide for ESP32-S2 target 2020-03-05 05:05:23 +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
Roland Dobai
5c0cd9417d Docs: Encourage to used Python 3 2020-02-24 12:55:55 +01:00
Ivan Grokhotkov
700161921c docs: update version of IDF tools installer for windows to v2.3 2020-02-11 19:05:17 +01: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
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 2020-02-07 16:37:43 +11:00
Angus Gratton
b0748b4364 docs: Mark some more docs sections as ESP32 only 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
Angus Gratton
e6211c7864 docs: add new top-level docs builder that builds docs for a single chip 2020-02-07 16:37:43 +11:00
Konstantin Kondrashov
2c793cef06 idf: Support a custom toolchain with time_t wide 64-bits 
Allows resolving the Y2K38 problem.

Closes: IDF-350

Closes: https://github.com/espressif/esp-idf/issues/584
 2020-01-10 12:58:54 +08:00
Roland Dobai
bbbc12478a Docs: Update Debian & Ubuntu install prerequisites 
Latest versions of apt-get don't install as much packages by default
as older ones. This fix adds some missing packages discovered for an OS
derived from the latest stable Debian. These packages exist for older
Debian derivatives as well (tested with Ubuntu 16.04 LTS).

Closes https://github.com/espressif/esp-idf/issues/4480
 2019-12-16 11:41:28 +01:00
Ivan Grokhotkov
f91c5c6f23 docs: update Windows tools installer link 2019-12-13 15:03:09 +01:00
Roland Dobai
105267d537 Doc: Remove menuconfig tool which is not used anymore 2019-11-28 10:07:49 +01:00
Roland Dobai
bd2fc9f832 Make menuconfig colors configurable 
Closes https://github.com/espressif/esp-idf/issues/4387
 2019-11-26 10:40:34 +01:00
Roland Dobai
01887f71e7 Update kconfiglib to upstream version and replace mconf-idf 
Special thanks to @ulfalizer for the helpful suggestions regarding
kconfiglib.

"rsource" option is available for relative path includes
Closes https://github.com/espressif/esp-idf/issues/4064
 2019-10-29 10:40:04 +01:00
Natasha
b0f2bb2adc Add translation for getting started guide - batch 1 2019-10-10 16:52:07 +08:00
Ivan Grokhotkov
847537c862 docs: update get-started to use Tools Installer v2.1 2019-09-24 10:39:27 +02:00
Kondal Kolipaka
41a1eebbd4 docs: Update eclipse setup doc with the IDF Eclipse Plugins github link 2019-09-17 13:42:32 +05:30
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
Andrei Gramakov
79dd142ab8 tools: add install.ps1, export.ps1 
Closes IDF-855
 2019-08-27 13:45:50 +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
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
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
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
Ivan Grokhotkov
0e6ffd08b7 docs: update msys environment links for esp32-2019r1 toolchain 2019-06-11 22:22:14 +08:00
Krzysztof
4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 2019-06-06 15:45:45 +08:00
Natasha
440c42693d Add translation for ESP32-WROVER-KIT Getting Started Guides 2019-05-27 07:53:20 +08:00
Alexey Gerenkov
8c6a924cdf sys_view: Adds processing scripts for heap & log traces 2019-04-01 19:31:45 +03:00
liying
957301f293 add translation for devkitc guides and index files 2019-03-27 17:41:36 +00:00
Kirill Chalov
a1c39e4a53 Doc/review get st wrover kit 2019-03-26 16:12:42 +08:00
Kirill Chalov
bae824439e Doc/review get st pico 2019-03-26 16:11:11 +08: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
Roland Dobai
f0194f2a5e docs: Update package dependencies 
Closes https://github.com/espressif/esp-idf/issues/2384
 2019-03-07 14:46:59 +01:00
Angus Gratton
aa4a5668b0 Merge branch 'bugfix/add_missing_links_to_translation' into 'master' 
Included missing links between English and Chinese documentation, where…

See merge request idf/esp-idf!4176
 2019-01-30 11:32:15 +08:00
Anton Maklakov
1332d3ba9c docs: Correct priorities in the PATH string 
Fixes https://github.com/espressif/esp-idf/pull/2944
 2019-01-28 11:28:55 +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
krzychb
7fa8eb91dd Small updates of wording 2019-01-24 19:50:55 +08:00
ShellAddicted
aa364961d0 docs(en): dialout-linux added specific command for Arch linux the correct group is 'uucp' 
Merges https://github.com/espressif/esp-idf/pull/2940
 2019-01-24 19:50:55 +08:00
Angus Gratton
88150cb9bb docs: Make Getting Started (CMake) guides version-aware 
Also clean up some changes in Chinese CMake guide which were not propagated from the English guide.
 2018-12-21 19:13:20 +11:00