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
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 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
Angus Gratton
783856d557
docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers
2020-02-07 16:37:12 +11:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
Angus Gratton
c1ab87b580
Merge branch 'bugfix/fix_broken_example_link' into 'master'
...
doc:fix icmp initialization and broken example links
Closes IDFGH-2563
See merge request espressif/esp-idf!7402
2020-01-23 14:32:55 +08:00
morris
e30cd361a8
global: rename esp32s2beta to esp32s2
2020-01-22 12:14:38 +08:00
morris
f2cb6bd4b6
doc: fix broken example links
2020-01-21 12:11:24 +08:00
Krzysztof Budzynski
ac27ab29fd
doc: Fix broken links to examples
2020-01-20 12:10:18 +08:00
Wang Ning
0093f50214
Add Chinese translation to LEDC.
...
Need technical and language review.
2020-01-16 10:13:40 +08: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
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
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
Angus Gratton
17b5df4d72
Merge branch 'feature/function_call_with_stack' into 'master'
...
esp_common: added a macro to allow call functions using user allocated stack
Closes IDF-535
See merge request espressif/esp-idf!6709
2019-12-31 15:08:27 +08:00
Natasha
1b740c55a3
Add translation for Network files
2019-12-31 14:53:55 +08:00
Felipe Neves
88dd15c806
docs: synchronized the contents of en with cn folders adding the esp-expression-with-stack documentation
2019-12-20 13:18:13 -03:00
Krzysztof Budzynski
2fa24d6e39
Merge branch 'doc/hr-ref/gs-wrover-kit-v4.1-fix-header-name' into 'master'
...
JP8 -> JP2
See merge request espressif/esp-idf!7053
2019-12-19 17:44:43 +08:00
Natasha
0c444c06a7
add translation for esp_mesh doc
2019-12-19 15:16:50 +08:00
Kirill Chalov
db32140eea
JP8 -> JP2 syncing changes in cn version
...
Fixes https://github.com/espressif/esp-idf/pull/4147
2019-12-19 13:52:33 +08: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
2b589fbabd
Add Chinese translation for esp-ble-mesh-index.
2019-12-18 14:34:56 +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
David Cermak
ac47c74ec4
esp_netif, docs: Added programmer's manual section
...
Also added guide for creating a custom network capable I/O driver
And added notes about default wifi interfaces and implications of using
default short-hand creation functions.
2019-12-17 09:02:51 +01: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
Angus Gratton
433d046a2a
Merge branch 'feature/tools_installer_v2.2' into 'master'
...
tools: bump windows tools installer version to v2.2
Closes IDFGH-2036 and IDFGH-2202
See merge request espressif/esp-idf!6999
2019-12-16 07:20:43 +08:00
Ivan Grokhotkov
f91c5c6f23
docs: update Windows tools installer link
2019-12-13 15:03:09 +01:00
Wang Ning
63b0d6c977
Add Chinese translation to Documenting Code
2019-12-13 20:13:50 +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
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
Angus Gratton
70cfd7e24c
Merge branch 'bugfix/ethernet_pm_lock' into 'master'
...
ethernet: add pm lock
Closes IDF-1053
See merge request espressif/esp-idf!6881
2019-12-04 15:06:12 +08:00
Michael (XIAO Xufeng)
087c8f6065
essl: new component to communicate with esp serial slave devices
2019-12-03 22:58:41 +08:00
morris
57ef88a91f
ethernet: add pm lock
2019-12-03 16:10:20 +08:00
tianyangmin
be3e52b49c
doc: Finalize Ethernet get-started guide. Add Chinese translation.
2019-12-03 02:22:06 +00:00
weitianhua
7c18299571
Add AG component API_REFERENCE
...
Expose esp_hf_indchange_notification to this example.
2019-11-27 13:35:35 +00:00
Fu Zhi Bo
3a468a1ffd
Refactor the touch sensor driver
2019-11-27 20:08:44 +08:00
Anton Maklakov
def05480b8
docs: Fix up some OpenOCD cmdline-s
2019-11-26 19:44:22 +08:00
David Cermak
1a012b7ad2
esp_netif: docs update to include tcpip_adapter migration guide
...
added migration guide link to the esp-netif page and network page
added redirects from tcpip_adapter to new esp_netif
2019-11-25 08:32:11 +01: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
Alexey Gerenkov
1626f827d3
docs: Updates OpenOCD configuration file names
2019-11-18 13:33:32 +03:00
Krzysztof Budzynski
29b2235506
Merge branch 'doc/mdns_zh_CN' into 'master'
...
zh_CN translation of mdns service
See merge request espressif/esp-idf!4590
2019-11-18 16:42:20 +08:00
morris
9691a755f6
zh_CN translation of mdns service
2019-11-14 13:28:04 +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
c5ef1cae04
Merge branch 'feature/perfmon' into 'master'
...
Performance monitor component
See merge request espressif/esp-idf!4705
2019-11-04 18:25:14 +08:00
Krzysztof Budzynski
0abb3b99c1
Update missing description of board A and B connectors. Add a note about incorrect GPIO pin labels on the silkscreen besides the function switch.
2019-11-04 10:44:00 +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
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
Angus Gratton
7ce75a42c7
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-25 15:13:52 +11:00
Angus Gratton
3caa54e546
Merge branch 'feature/add_ping_example' into 'master'
...
add ping example
Closes WIFI-1196 and IDF-1068
See merge request espressif/esp-idf!6340
2019-10-24 11:37:38 +08:00
Hao Ning
9ecc34e086
add chinese translation into flash encryption
2019-10-22 19:37:28 +08:00
Natasha
56ce449e7f
SYNC CN translation with the lastest EN translation, to make CMAKE the default system
...
update CN translation
2019-10-22 17:57:37 +08:00
suda-morris
7bdd5f639b
doc: add api reference for icmp_echo
2019-10-22 04:38:09 +00: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
Natasha
c70d234ee6
Update board getting started guides to make cmake default
2019-10-15 17:15:15 +08:00
Angus Gratton
496ede9bcd
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-15 14:59:27 +11: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
Ivan Grokhotkov
5830f529d8
Merge branch 'master' into feature/esp32s2beta_merge
2019-10-02 19:01:39 +02:00
Wang Fang
32adfdc307
Add Chinese translation for the 2nd batch of the files in storage folder in api-reference.
...
1. The translation should be first reviewed by technical reviewers;
2. and then by language reviewers.
For the translation for the first batch of files, please see !MR5620 and !MR5613
2019-09-20 12:32:55 +08: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
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
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
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
f44d99b509
app_update: Remove deprecated "make erase_ota" target
...
Deprecated in v3.2
2019-09-13 09:44:07 +10:00
Wang Fang
bea507378e
Add Chinese translation for README files in components and tools folders, including:
...
1. components/nvs_flash/nvs_partition_generator/README_CN.rst
2. components/wear_levelling/README_CN.rst
3. tools/mass_mfg/docs/README_CN.rst
2019-09-06 20:18:19 +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
Hao Ning
eb2ddbfe48
add chinese translation for timer.rst in api-reference folder
2019-09-04 17:09:13 +08:00
Dmitry
a0730fec2a
Performance monitor component. The component contains APIs, example and
...
documentation.
2019-08-23 11:20:12 +03:00
suda-morris
43b29e4f4d
doc: update translation of ulp install instuctions
2019-08-21 21:52:48 +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
suda-morris
ab406f8429
zh_CN translation of bootloader document
2019-08-19 11:37:59 +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
fuzhibo
572084821b
add Comment for touchpad
2019-08-07 11:39:17 +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
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
Ivan Grokhotkov
83277fe0f2
docs: add tools section and IDF docker image page
2019-07-18 06:18:04 +00: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
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
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
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
Ivan Grokhotkov
6f5c7a21ac
docs: update CMake getting started guide to use install.bat and export.bat
2019-07-01 18:08:02 +02:00
Hrishikesh Dhayagude
cba69dd088
Bluetooth examples restructuring
...
The existing Bluetooth examples are split as:
1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples
a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples
b. examples/bluetooth/bluedroid/ble - BLE examples
c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples
d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples
i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder
2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples
3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples
4. Update documentation references
2019-07-01 19:21:57 +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
32954e5f90
Add Chinese translation to api-reference/system/power-management.rst
...
1. Add translation to docs/zh_CN/api-reference/system/power_management.rst
2. Add a link to docs/en/api-reference/system/power_management.rst
2019-06-26 20:42:56 +08: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