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
krzychb
29b1f86f16
Extended information on using pins of ESP-WROVER-KIT that are shared among peripherals. Inspired by https://esp32.com/viewtopic.php?f=12&t=6856 .
2018-11-29 16:56:49 +01:00
Renz Christian Bagaporo
1600c3144c
docs: add pyparsing install to setup guide
2018-11-22 22:09:43 +08:00
Prasad Alatkar
b1189e9645
Docs: Change makes Eclipse setup inline with Mac OS and Linux.
2018-11-19 12:15:53 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
Ivan Grokhotkov
c8fe9f696c
docs: fix instructions for building toolchain on macOS
...
Closes https://github.com/espressif/esp-idf/issues/503
Closes https://github.com/espressif/esp-idf/issues/2607
2018-10-26 12:42:38 +08:00
Angus Gratton
b964f389db
Merge branch 'bugfix/gcc8_compatibility' into 'master'
...
gcc8 compatibility for master branch
See merge request idf/esp-idf!3481
2018-10-22 11:11:04 +08:00
Krzysztof Budzynski
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
Anton Maklakov
4a126e18ed
docs: Correct Linux port names for more relevance
2018-10-21 15:11:45 +08:00
Angus Gratton
9509c7c1c1
docs: Recommend native 'cryptography' package on Linux as well
2018-10-18 09:56:16 +11:00
Angus Gratton
7313e39fde
Merge branch 'feature_add_path_tools_pr2410' into 'master'
...
add_path.sh: cmake: add tools folder to the path
See merge request idf/esp-idf!3344
2018-10-05 12:34:10 +08:00
Angus Gratton
319fa2264f
windows: Update MSYS2 environment, add Python requirements to setup script
2018-10-01 16:16:49 +10:00
Anton Maklakov
7c8d5d2782
docs, scripts: Correct the priority of the PATH setting
2018-09-27 14:55:37 +08:00
Ivan Grokhotkov
e1ac237169
Merge branch 'doc/fix_config_links' into 'master'
...
doc: Fix config links, add navigation lists to config items page
See merge request idf/esp-idf!3310
2018-09-25 18:23:24 +08:00
Ivan Grokhotkov
91fa1764e5
docs: generate toolchain download links
2018-09-20 18:53:14 +08:00
Angus Gratton
8721173109
doc: Replace :envvar: config links with :ref:
2018-09-19 17:27:48 +10:00
Ivan Grokhotkov
789855e71b
esp32: abort when running on single core chip in dual core mode
...
Ref. https://esp32.com/viewtopic.php?f=2&t=7307
2018-09-19 15:05:26 +08:00
Roland Dobai
c3d99dd2e4
Encourage to install python packages without administrative rights
...
Using 'sudo pip install' can cause a lot of problems because usually
there are a couple of Python interpreters installed. This fix encourages
developers to use `pip install --user` instead which is safer.
2018-09-11 08:54:37 +02:00
Roland Dobai
5eb452f72e
Add required Python packages
...
On some systems pip and setuptools are no longer installed as
dependencies of the python packages. This commit adds the requirement
for these packages.
2018-09-11 08:54:37 +02:00
Angus Gratton
229fe8e2e4
Merge branch 'feature/esp-wrover-kit-v4_1' into 'master'
...
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'. Closes https://github.com/espressif/esp-idf/issues/2363 . Closes https://github.com/espressif/esp-idf/issues/2365 .
See merge request idf/esp-idf!3161
2018-09-10 14:48:41 +08:00
Angus Gratton
e7243a2cdd
Merge branch 'doc/eclipse_parallel_build' into 'master'
...
doc: Add parallel builds to the Eclipse setup guide
See merge request idf/esp-idf!3209
2018-09-07 16:03:53 +08:00
Angus Gratton
70cacc8b4e
doc: Add parallel builds to the Eclipse setup guide
2018-09-07 11:48:17 +08:00
Angus Gratton
cff2ef695a
Merge branch 'master' into feature/cmake
2018-09-06 20:23:04 +08:00
krzychb
91c7149f6e
Included information about power on and diagnostics LEDs. Closes https://github.com/espressif/esp-idf/issues/2365 .
2018-09-06 11:28:23 +02:00
krzychb
1d99531328
Corrected RGB LED pin assignment. Closes https://github.com/espressif/esp-idf/issues/2363 .
2018-09-05 22:10:42 +02:00
krzychb
62389b6be6
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'
2018-09-05 22:10:42 +02:00
Ivan Grokhotkov
a0d2dd0385
Merge branch 'bugfix/eclipse_compiler_command_cpp' into 'master'
...
docs/eclipse: update command to get compiler specs
See merge request idf/esp-idf!3167
2018-09-05 18:35:25 +08:00
Ivan Grokhotkov
312424b5ac
docs: update command to get compiler specs in a few more places
2018-09-05 11:05:52 +08:00
Darian Leung
d268677017
doc: Add environemt variable overriding to get started
...
This comit adds details about the overriding of environment variables such as
ESPPORT and ESPBAUD to the get started guide.
2018-09-05 02:05:31 +08:00
Dennis Damen
d8cf8074ec
Updated command to get compiler specs.
...
Eclipse was unable to resolve the std::mutex type eventhough the mutex header file was succesfully included. By adding this modification, the issues was resolved.
2018-08-30 22:00:47 +02:00
Angus Gratton
a9c4ed7139
Merge branch 'master' into feature/cmake
2018-08-30 18:51:01 +08:00
Roland Dobai
52d11dcfb0
docs: make the use of pip install clear
2018-08-23 11:41:56 +02:00
Roland Dobai
62cad3a7d7
Add python-future by using python requirements file
2018-08-23 08:28:57 +02:00
krzychb
1857bca871
Corrected pinout of the Camera / J4 connector
2018-08-21 22:01:28 +02:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Krzysztof Budzynski
df5d3ea692
Provided a table with development boards by Espressif together with USB-to-serial driver names
2018-08-16 05:24:40 +08:00
Angus Gratton
191557db02
docs: Copy CMake docs to a separate set of directories
...
Required first step before merging back to mainline.
2018-08-13 15:37:03 +10:00
Angus Gratton
f341c5c944
Merge branch 'doc/versions' into 'master'
...
docs: Add version-specific include files, version documentation
See merge request idf/esp-idf!2858
2018-08-10 08:08:10 +08:00
Angus Gratton
ffaa71bcd6
docs: Add version-specific include files, version documentation
...
* "git clone" command and a small version header are generated
depending on git properties.
* Add Versions page with details about each version
* Make it clear using master branch is living on the "bleeding
edge"
2018-08-06 15:38:32 +10:00
Konstantin Kondrashov
de2b1cb02a
make: Add feature to cmd 'make flash' - reset ota_data partition
...
Add a command `make erase_ota` - erases otadata if it there is in the
partition table otherwise error 'Partition table does not have ota_data partition'.
Closes https://github.com/espressif/esp-idf/issues/1821
2018-07-25 11:22:15 +00:00
krzychb
ca15dbd05e
Added description of ESP32-PICO-KIT V4.1 board
2018-07-18 20:02:43 +02:00
Ivan Grokhotkov
b354770f42
Merge branch 'bugfix/fixes_from_github' into 'master'
...
Fixes from Github
See merge request idf/esp-idf!2730
2018-07-13 15:03:50 +08:00
Angus Gratton
a67d5d89e0
Replace all DOS line endings with Unix
...
Command run was:
git ls-tree -r HEAD --name-only | xargs dos2unix
2018-07-12 19:10:37 +08:00
Carney Wu
fab55e3266
alias should set in .bashrc
...
Merges https://github.com/espressif/esp-idf/pull/2097
2018-07-09 14:36:47 +08:00
Angus Gratton
c07ec696dc
Merge branch 'bugfix/eclipse_regex' into 'master'
...
Docs: Fix bugs in Eclipse setup
See merge request idf/esp-idf!2617
2018-06-27 09:38:47 +08:00
krzychb
b101e118f2
Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15.
2018-06-26 18:08:47 +02:00